[ONOS-8014] Add a set of interfaces for Kubernetes namespace
Change-Id: I2448e8ccd1bf3608710404fe8e9146ee1dfb6f9e
diff --git a/apps/k8s-networking/api/src/main/java/org/onosproject/k8snetworking/api/K8sNamespaceAdminService.java b/apps/k8s-networking/api/src/main/java/org/onosproject/k8snetworking/api/K8sNamespaceAdminService.java
new file mode 100644
index 0000000..697e675
--- /dev/null
+++ b/apps/k8s-networking/api/src/main/java/org/onosproject/k8snetworking/api/K8sNamespaceAdminService.java
@@ -0,0 +1,50 @@
+/*
+ * Copyright 2019-present Open Networking Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.onosproject.k8snetworking.api;
+
+import io.fabric8.kubernetes.api.model.Namespace;
+
+/**
+ * Service for administering the inventory of kubernetes namespace.
+ */
+public interface K8sNamespaceAdminService extends K8sNamespaceService {
+
+ /**
+ * Creates a kubernetes namespace with the given information.
+ *
+ * @param namespace the new kubernetes namespace
+ */
+ void createNamespace(Namespace namespace);
+
+ /**
+ * Updates the kubernetes namespace with the given information.
+ *
+ * @param namespace the updated kubernetes namespace
+ */
+ void updateNamespace(Namespace namespace);
+
+ /**
+ * Removes the kubernetes namespace.
+ *
+ * @param uid kubernetes namespace UID
+ */
+ void removeNamespace(String uid);
+
+ /**
+ * Clears the existing namespaces.
+ */
+ void clear();
+}
diff --git a/apps/k8s-networking/api/src/main/java/org/onosproject/k8snetworking/api/K8sNamespaceEvent.java b/apps/k8s-networking/api/src/main/java/org/onosproject/k8snetworking/api/K8sNamespaceEvent.java
new file mode 100644
index 0000000..f1e050c
--- /dev/null
+++ b/apps/k8s-networking/api/src/main/java/org/onosproject/k8snetworking/api/K8sNamespaceEvent.java
@@ -0,0 +1,56 @@
+/*
+ * Copyright 2019-present Open Networking Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.onosproject.k8snetworking.api;
+
+import io.fabric8.kubernetes.api.model.Namespace;
+import org.onosproject.event.AbstractEvent;
+
+/**
+ * Describes kubernetes namespace event.
+ */
+public class K8sNamespaceEvent extends AbstractEvent<K8sNamespaceEvent.Type, Namespace> {
+
+ /**
+ * Creates an event of a given type for the specified kubernetes namespace policy.
+ *
+ * @param type kubernetes namespace event type
+ * @param subject kubernetes namespace
+ */
+ public K8sNamespaceEvent(Type type, Namespace subject) {
+ super(type, subject);
+ }
+
+ /**
+ * Kubernetes namespace events.
+ */
+ public enum Type {
+
+ /**
+ * Signifies that a new kubernetes namespace is created.
+ */
+ K8S_NAMESPACE_CREATED,
+
+ /**
+ * Signifies that a new kubernetes namespace is updated.
+ */
+ K8S_NAMESPACE_UPDATED,
+
+ /**
+ * Signifies that a new kubernetes namespace is removed.
+ */
+ K8S_NAMESPACE_REMOVED,
+ }
+}
diff --git a/apps/k8s-networking/api/src/main/java/org/onosproject/k8snetworking/api/K8sNamespaceListener.java b/apps/k8s-networking/api/src/main/java/org/onosproject/k8snetworking/api/K8sNamespaceListener.java
new file mode 100644
index 0000000..72e9093
--- /dev/null
+++ b/apps/k8s-networking/api/src/main/java/org/onosproject/k8snetworking/api/K8sNamespaceListener.java
@@ -0,0 +1,24 @@
+/*
+ * Copyright 2019-present Open Networking Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.onosproject.k8snetworking.api;
+
+import org.onosproject.event.EventListener;
+
+/**
+ * Listener for kubernetes network policy event.
+ */
+public interface K8sNamespaceListener extends EventListener<K8sNamespaceEvent> {
+}
diff --git a/apps/k8s-networking/api/src/main/java/org/onosproject/k8snetworking/api/K8sNamespaceService.java b/apps/k8s-networking/api/src/main/java/org/onosproject/k8snetworking/api/K8sNamespaceService.java
new file mode 100644
index 0000000..1467720
--- /dev/null
+++ b/apps/k8s-networking/api/src/main/java/org/onosproject/k8snetworking/api/K8sNamespaceService.java
@@ -0,0 +1,43 @@
+/*
+ * Copyright 2019-present Open Networking Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.onosproject.k8snetworking.api;
+
+import io.fabric8.kubernetes.api.model.Namespace;
+import org.onosproject.event.ListenerService;
+
+import java.util.Set;
+
+/**
+ * Service for interacting with the inventory of kubernetes namespace.
+ */
+public interface K8sNamespaceService
+ extends ListenerService<K8sNamespaceEvent, K8sNamespaceListener> {
+
+ /**
+ * Returns the kubernetes namespaces with the supplied namespace UID.
+ *
+ * @param uid namespace UID
+ * @return kubernetes namespace
+ */
+ Namespace namespace(String uid);
+
+ /**
+ * Returns all kubernetes namespaces registered.
+ *
+ * @return set of kubernetes namespaces
+ */
+ Set<Namespace> namespaces();
+}
diff --git a/apps/k8s-networking/api/src/main/java/org/onosproject/k8snetworking/api/K8sNamespaceStore.java b/apps/k8s-networking/api/src/main/java/org/onosproject/k8snetworking/api/K8sNamespaceStore.java
new file mode 100644
index 0000000..2bc0318
--- /dev/null
+++ b/apps/k8s-networking/api/src/main/java/org/onosproject/k8snetworking/api/K8sNamespaceStore.java
@@ -0,0 +1,70 @@
+/*
+ * Copyright 2019-present Open Networking Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.onosproject.k8snetworking.api;
+
+import io.fabric8.kubernetes.api.model.Namespace;
+import org.onosproject.store.Store;
+
+import java.util.Set;
+
+/**
+ * Manages inventory of kubernetes namespace; not intended for direct use.
+ */
+public interface K8sNamespaceStore
+ extends Store<K8sNamespaceEvent, K8sNamespaceStoreDelegate> {
+
+ /**
+ * Creates the new kubernetes namespace.
+ *
+ * @param namespace kubernetes namespace
+ */
+ void createNamespace(Namespace namespace);
+
+ /**
+ * Updates the kubernetes namespace.
+ *
+ * @param namespace kubernetes namespace
+ */
+ void updateNamespace(Namespace namespace);
+
+ /**
+ * Removes the kubernetes namespace with the given namespace UID.
+ *
+ * @param uid kubernetes namespace UID
+ * @return removed kubernetes namespace; null if failed
+ */
+ Namespace removeNamespace(String uid);
+
+ /**
+ * Returns the kubernetes namespace with the given namespace UID.
+ *
+ * @param uid kubernetes namespace UID
+ * @return kubernetes namespace; null if not found
+ */
+ Namespace namespace(String uid);
+
+ /**
+ * Returns all kubernetes namespaces.
+ *
+ * @return set of kubernetes namespaces
+ */
+ Set<Namespace> namespaces();
+
+ /**
+ * Removes all kubernetes namespaces.
+ */
+ void clear();
+}
diff --git a/apps/k8s-networking/api/src/main/java/org/onosproject/k8snetworking/api/K8sNamespaceStoreDelegate.java b/apps/k8s-networking/api/src/main/java/org/onosproject/k8snetworking/api/K8sNamespaceStoreDelegate.java
new file mode 100644
index 0000000..68b39b6
--- /dev/null
+++ b/apps/k8s-networking/api/src/main/java/org/onosproject/k8snetworking/api/K8sNamespaceStoreDelegate.java
@@ -0,0 +1,24 @@
+/*
+ * Copyright 2019-present Open Networking Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.onosproject.k8snetworking.api;
+
+import org.onosproject.store.StoreDelegate;
+
+/**
+ * Kubernetes namespace store delegate abstraction.
+ */
+public interface K8sNamespaceStoreDelegate extends StoreDelegate<K8sNamespaceEvent> {
+}