[ONOS-7942] Implement k8s ingress service and watcher with unit tests
Change-Id: I8089336916e882bd31b40facf73c46c5ee541718
diff --git a/apps/k8s-networking/api/src/main/java/org/onosproject/k8snetworking/api/K8sIngressAdminService.java b/apps/k8s-networking/api/src/main/java/org/onosproject/k8snetworking/api/K8sIngressAdminService.java
new file mode 100644
index 0000000..5e2b95b
--- /dev/null
+++ b/apps/k8s-networking/api/src/main/java/org/onosproject/k8snetworking/api/K8sIngressAdminService.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.extensions.Ingress;
+
+/**
+ * Service for administering the inventory of kubernetes ingress.
+ */
+public interface K8sIngressAdminService extends K8sIngressService {
+
+ /**
+ * Creates kubernetes ingress with the given information.
+ *
+ * @param ingress the new kubernetes ingress
+ */
+ void createIngress(Ingress ingress);
+
+ /**
+ * Updates the kubernetes ingress with the given information.
+ *
+ * @param ingress the updated kubernetes ingress
+ */
+ void updateIngress(Ingress ingress);
+
+ /**
+ * Removes the kubernetes ingress.
+ *
+ * @param uid kubernetes ingress UID
+ */
+ void removeIngress(String uid);
+
+ /**
+ * Clears the existing ingresses.
+ */
+ void clear();
+}
diff --git a/apps/k8s-networking/api/src/main/java/org/onosproject/k8snetworking/api/K8sIngressEvent.java b/apps/k8s-networking/api/src/main/java/org/onosproject/k8snetworking/api/K8sIngressEvent.java
new file mode 100644
index 0000000..c6e92fc
--- /dev/null
+++ b/apps/k8s-networking/api/src/main/java/org/onosproject/k8snetworking/api/K8sIngressEvent.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.extensions.Ingress;
+import org.onosproject.event.AbstractEvent;
+
+/**
+ * Describes kubernetes ingress event.
+ */
+public class K8sIngressEvent extends AbstractEvent<K8sIngressEvent.Type, Ingress> {
+
+ /**
+ * Creates an event of a given type for the specified kubernetes ingress.
+ *
+ * @param type kubernetes ingress event type
+ * @param subject kubernetes ingress
+ */
+ public K8sIngressEvent(Type type, Ingress subject) {
+ super(type, subject);
+ }
+
+ /**
+ * Kubernetes ingress events.
+ */
+ public enum Type {
+
+ /**
+ * Signifies that a new kubernetes ingress is created.
+ */
+ K8S_INGRESS_CREATED,
+
+ /**
+ * Signifies that the kubernetes ingress is updated.
+ */
+ K8S_INGRESS_UPDATED,
+
+ /**
+ * Signifies that the kubernetes ingress is removed.
+ */
+ K8S_INGRESS_REMOVED,
+ }
+}
diff --git a/apps/k8s-networking/api/src/main/java/org/onosproject/k8snetworking/api/K8sIngressListener.java b/apps/k8s-networking/api/src/main/java/org/onosproject/k8snetworking/api/K8sIngressListener.java
new file mode 100644
index 0000000..0429ad3
--- /dev/null
+++ b/apps/k8s-networking/api/src/main/java/org/onosproject/k8snetworking/api/K8sIngressListener.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 ingress event.
+ */
+public interface K8sIngressListener extends EventListener<K8sIngressEvent> {
+}
diff --git a/apps/k8s-networking/api/src/main/java/org/onosproject/k8snetworking/api/K8sIngressService.java b/apps/k8s-networking/api/src/main/java/org/onosproject/k8snetworking/api/K8sIngressService.java
new file mode 100644
index 0000000..370dd79
--- /dev/null
+++ b/apps/k8s-networking/api/src/main/java/org/onosproject/k8snetworking/api/K8sIngressService.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.extensions.Ingress;
+import org.onosproject.event.ListenerService;
+
+import java.util.Set;
+
+/**
+ * Service for interacting with the inventory of kubernetes ingress.
+ */
+public interface K8sIngressService
+ extends ListenerService<K8sIngressEvent, K8sIngressListener> {
+
+ /**
+ * Returns the kubernetes ingress with the supplied ingress UID.
+ *
+ * @param uid ingress UID
+ * @return kubernetes ingress
+ */
+ Ingress ingress(String uid);
+
+ /**
+ * Returns all kubernetes ingresses registered.
+ *
+ * @return set of kubernetes ingresses
+ */
+ Set<Ingress> ingresses();
+}
diff --git a/apps/k8s-networking/api/src/main/java/org/onosproject/k8snetworking/api/K8sIngressStore.java b/apps/k8s-networking/api/src/main/java/org/onosproject/k8snetworking/api/K8sIngressStore.java
new file mode 100644
index 0000000..1025202
--- /dev/null
+++ b/apps/k8s-networking/api/src/main/java/org/onosproject/k8snetworking/api/K8sIngressStore.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.extensions.Ingress;
+import org.onosproject.store.Store;
+
+import java.util.Set;
+
+/**
+ * Manages inventory of kubernetes ingresses; not intended for direct use.
+ */
+public interface K8sIngressStore
+ extends Store<K8sIngressEvent, K8sIngressStoreDelegate> {
+
+ /**
+ * Creates the new kubernetes ingress.
+ *
+ * @param ingress kubernetes ingress
+ */
+ void createIngress(Ingress ingress);
+
+ /**
+ * Updates the kubernetes ingress.
+ *
+ * @param ingress kubernetes ingress
+ */
+ void updateIngress(Ingress ingress);
+
+ /**
+ * Removes the kubernetes ingress with the given ingress UID.
+ *
+ * @param uid kubernetes ingress UID.
+ * @return removed kubernetes ingress; null if failed
+ */
+ Ingress removeIngress(String uid);
+
+ /**
+ * Returns the kubernetes ingress with the given ingress UID.
+ *
+ * @param uid kubernetes ingress UID
+ * @return kubernetes ingress; null if not found
+ */
+ Ingress ingress(String uid);
+
+ /**
+ * Returns all kubernetes ingresses.
+ *
+ * @return set of kubernetes ingresses
+ */
+ Set<Ingress> ingresses();
+
+ /**
+ * Removes all kubernetes ingresses.
+ */
+ void clear();
+}
diff --git a/apps/k8s-networking/api/src/main/java/org/onosproject/k8snetworking/api/K8sIngressStoreDelegate.java b/apps/k8s-networking/api/src/main/java/org/onosproject/k8snetworking/api/K8sIngressStoreDelegate.java
new file mode 100644
index 0000000..4bfa16b
--- /dev/null
+++ b/apps/k8s-networking/api/src/main/java/org/onosproject/k8snetworking/api/K8sIngressStoreDelegate.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 ingress store delegate abstraction.
+ */
+public interface K8sIngressStoreDelegate extends StoreDelegate<K8sIngressEvent> {
+}