Additions to southbound API interfaces
added API interfaces for topology
added rough API interfaces for flow
Change-Id: I84ee2b70dd33dcbca98c1863e7f1766cc02642c5
diff --git a/net/api/src/main/java/net/onrc/onos/api/flow/FlowDescription.java b/net/api/src/main/java/net/onrc/onos/api/flow/FlowDescription.java
new file mode 100644
index 0000000..80fc051
--- /dev/null
+++ b/net/api/src/main/java/net/onrc/onos/api/flow/FlowDescription.java
@@ -0,0 +1,12 @@
+package net.onrc.onos.api.flow;
+
+package net.onrc.onos.api.Description;
+
+/**
+ * Information about a flow rule.
+ */
+public interface FlowDescription extends Description {
+
+ // Match and action, possibly reason for flow rule, unless reason is too OF-specific.
+
+}
diff --git a/net/api/src/main/java/net/onrc/onos/api/flow/FlowRuleProvider.java b/net/api/src/main/java/net/onrc/onos/api/flow/FlowRuleProvider.java
new file mode 100644
index 0000000..acb63b4
--- /dev/null
+++ b/net/api/src/main/java/net/onrc/onos/api/flow/FlowRuleProvider.java
@@ -0,0 +1,9 @@
+package net.onrc.onos.api.flow;
+
+import net.onrc.onos.api.Provider;
+
+/**
+ * Abstraction of a flow rule provider.
+ */
+public interface FlowRuleProvider extends Provider {
+}
\ No newline at end of file
diff --git a/net/api/src/main/java/net/onrc/onos/api/flow/FlowRuleProviderBroker.java b/net/api/src/main/java/net/onrc/onos/api/flow/FlowRuleProviderBroker.java
new file mode 100644
index 0000000..27f1ca6
--- /dev/null
+++ b/net/api/src/main/java/net/onrc/onos/api/flow/FlowRuleProviderBroker.java
@@ -0,0 +1,10 @@
+package net.onrc.onos.api.flow;
+
+import net.onrc.onos.api.ProviderBroker;
+
+/**
+ * Abstraction for a flow rule provider brokerage.
+ */
+public interface FlowRuleProviderBroker
+ extends ProviderBroker<FlowRuleProvider, FlowRuleProviderService> {
+}
diff --git a/net/api/src/main/java/net/onrc/onos/api/flow/FlowRuleProviderService.java b/net/api/src/main/java/net/onrc/onos/api/flow/FlowRuleProviderService.java
new file mode 100644
index 0000000..8f90c32
--- /dev/null
+++ b/net/api/src/main/java/net/onrc/onos/api/flow/FlowRuleProviderService.java
@@ -0,0 +1,35 @@
+package net.onrc.onos.api.flow;
+
+import net.onrc.onos.api.ProviderService;
+
+/**
+ * Service through which flowrule providers can inject flowrule information into
+ * the core.
+ */
+public interface FlowRuleProviderService extends ProviderService {
+
+ /**
+ * Signals that a flow that was previously installed has been removed.
+ *
+ * @param flowDescription information about the removed flow
+ */
+ void flowRemoved(FlowDescription flowDescription);
+
+ /**
+ * Signals that a flowrule is missing for some network traffic.
+ *
+ * @param flowDescription information about traffic in need of flow rule(s)
+ */
+ void flowMissing(FlowDescription flowDescription);
+
+ /**
+ * Signals that a flowrule has been added.
+ *
+ * TODO think about if this really makes sense, e.g. if stats collection or
+ * something can leverage it.
+ *
+ * @param flowDescription the rule that was added
+ */
+ void flowAdded(FlowDescription flowDescription);
+
+}
\ No newline at end of file