ONOS-5182 Refactored SONA to cache network states
Change-Id: Ib316fa5fa5d36e9da370a1578ac55de4a8dd9b04
diff --git a/apps/openstacknetworking/src/main/java/org/onosproject/openstacknetworking/api/OpenstackNetworkService.java b/apps/openstacknetworking/src/main/java/org/onosproject/openstacknetworking/api/OpenstackNetworkService.java
new file mode 100644
index 0000000..78ac42d
--- /dev/null
+++ b/apps/openstacknetworking/src/main/java/org/onosproject/openstacknetworking/api/OpenstackNetworkService.java
@@ -0,0 +1,97 @@
+/*
+ * Copyright 2017-present Open Networking Laboratory
+ *
+ * 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.openstacknetworking.api;
+
+import org.onosproject.event.ListenerService;
+import org.openstack4j.model.network.Network;
+import org.openstack4j.model.network.Port;
+import org.openstack4j.model.network.Subnet;
+
+import java.util.Set;
+
+/**
+ * Service for interacting with the inventory of OpenStack network and port.
+ */
+public interface OpenstackNetworkService
+ extends ListenerService<OpenstackNetworkEvent, OpenstackNetworkListener> {
+ /**
+ * Returns the network with the supplied network ID.
+ *
+ * @param networkId network id
+ * @return openstack network
+ */
+ Network network(String networkId);
+
+ /**
+ * Returns all networks registered in the service.
+ *
+ * @return set of networks
+ */
+ Set<Network> networks();
+
+ /**
+ * Returns the subnet with the supplied subnet ID.
+ *
+ * @param subnetId subnet id
+ * @return subnet
+ */
+ Subnet subnet(String subnetId);
+
+ /**
+ * Returns all subnets registered in the service.
+ *
+ * @return set of subnet
+ */
+ Set<Subnet> subnets();
+
+ /**
+ * Returns all subnets associated with the supplied network.
+ *
+ * @param networkId network id
+ * @return set of subnet
+ */
+ Set<Subnet> subnets(String networkId);
+
+ /**
+ * Returns the OpenStack port with the supplied port ID.
+ *
+ * @param portId openstack port id
+ * @return openstack port
+ */
+ Port port(String portId);
+
+ /**
+ * Returns the OpenStack port with the supplied ONOS port.
+ *
+ * @param port onos port
+ * @return openstack port
+ */
+ Port port(org.onosproject.net.Port port);
+
+ /**
+ * Returns all OpenStack ports registered in the service.
+ *
+ * @return set of ports
+ */
+ Set<Port> ports();
+
+ /**
+ * Returns all OpenStack ports associated with the supplied network.
+ * @param networkId network id
+ * @return set of ports
+ */
+ Set<Port> ports(String networkId);
+}