implemented a distributed default flow registration mechanism to avoid duplicate requests from other onos instances

Change-Id: Ib2abb483456538e3e08e9790c4b4b0d50db8b384

implemented a distributed default flow registration mechanism to avoid
duplicate requests from other onos instances

Change-Id: I620cc51ac29cddaffa73cdbb20e9a9acbdd9ea69
diff --git a/core/api/src/main/java/org/onosproject/net/packet/DefaultPacketRequest.java b/core/api/src/main/java/org/onosproject/net/packet/DefaultPacketRequest.java
new file mode 100644
index 0000000..0efcc7f
--- /dev/null
+++ b/core/api/src/main/java/org/onosproject/net/packet/DefaultPacketRequest.java
@@ -0,0 +1,95 @@
+/*
+ * Copyright 2015 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.net.packet;
+
+import com.google.common.base.MoreObjects;
+import org.onosproject.core.ApplicationId;
+import org.onosproject.net.flow.FlowRule;
+import org.onosproject.net.flow.TrafficSelector;
+
+/**
+ * Default implementation of a packet request.
+ */
+public final class DefaultPacketRequest implements PacketRequest {
+    private final TrafficSelector selector;
+    private final PacketPriority priority;
+    private final ApplicationId appId;
+    private final FlowRule.Type tableType;
+
+    public DefaultPacketRequest(TrafficSelector selector, PacketPriority priority,
+                                ApplicationId appId, FlowRule.Type tableType) {
+        this.selector = selector;
+        this.priority = priority;
+        this.appId = appId;
+        this.tableType = tableType;
+    }
+
+    public TrafficSelector selector() {
+        return selector;
+    }
+
+    public PacketPriority priority() {
+        return priority;
+    }
+
+    public ApplicationId appId() {
+        return appId;
+    }
+
+    public FlowRule.Type tableType() {
+        return tableType;
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) {
+            return true;
+        }
+        if (o == null || getClass() != o.getClass()) {
+            return false;
+        }
+
+        DefaultPacketRequest that = (DefaultPacketRequest) o;
+
+        if (priority != that.priority) {
+            return false;
+        }
+        if (!selector.equals(that.selector)) {
+            return false;
+        }
+        if (!tableType.equals(that.tableType)) {
+            return false;
+        }
+
+        return true;
+    }
+
+    @Override
+    public int hashCode() {
+        int result = selector.hashCode();
+        result = 31 * result + priority.hashCode();
+        return result;
+    }
+
+    @Override
+    public String toString() {
+        return MoreObjects.toStringHelper(this.getClass())
+                .add("selector", selector)
+                .add("priority", priority)
+                .add("appId", appId)
+                .add("table-type", tableType).toString();
+    }
+}
\ No newline at end of file
diff --git a/core/api/src/main/java/org/onosproject/net/packet/PacketPriority.java b/core/api/src/main/java/org/onosproject/net/packet/PacketPriority.java
index de9fe31..68c0a83 100644
--- a/core/api/src/main/java/org/onosproject/net/packet/PacketPriority.java
+++ b/core/api/src/main/java/org/onosproject/net/packet/PacketPriority.java
@@ -46,4 +46,8 @@
     public int priorityValue() {
         return priorityValue;
     }
+
+    public String toString() {
+        return String.valueOf(priorityValue);
+    }
 }
\ No newline at end of file
diff --git a/core/api/src/main/java/org/onosproject/net/packet/PacketRequest.java b/core/api/src/main/java/org/onosproject/net/packet/PacketRequest.java
new file mode 100644
index 0000000..7a95ef4
--- /dev/null
+++ b/core/api/src/main/java/org/onosproject/net/packet/PacketRequest.java
@@ -0,0 +1,51 @@
+/*
+ * Copyright 2015 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.net.packet;
+
+import org.onosproject.core.ApplicationId;
+import org.onosproject.net.flow.FlowRule;
+import org.onosproject.net.flow.TrafficSelector;
+
+/**
+ * Represents a packet request made to devices.
+ */
+public interface PacketRequest {
+
+    /**
+     * Obtain the traffic selector.
+     * @return a traffic selector
+     */
+    public TrafficSelector selector();
+
+    /**
+     * Obtain the priority.
+     * @return a PacketPriority
+     */
+    public PacketPriority priority();
+
+    /**
+     * Obtain the application id.
+     * @return an application id
+     */
+    public ApplicationId appId();
+
+    /**
+     * Obtain the table type.
+     * @return a table type
+     */
+    public FlowRule.Type tableType();
+
+}
diff --git a/core/api/src/main/java/org/onosproject/net/packet/PacketStore.java b/core/api/src/main/java/org/onosproject/net/packet/PacketStore.java
index c38605d..a54b8fa 100644
--- a/core/api/src/main/java/org/onosproject/net/packet/PacketStore.java
+++ b/core/api/src/main/java/org/onosproject/net/packet/PacketStore.java
@@ -17,6 +17,8 @@
 
 import org.onosproject.store.Store;
 
+import java.util.Set;
+
 /**
  * Manages routing of outbound packets.
  */
@@ -31,4 +33,21 @@
      */
     void emit(OutboundPacket packet);
 
+    /**
+     * Register a request for packets. If the registration
+     * is successful the manager can proceed, otherwise it should
+     * consider these packet already available in the system.
+     *
+     * @param request a packet request
+     * @return a boolean indicating registration state.
+     */
+    boolean requestPackets(PacketRequest request);
+
+    /**
+     * Obtains all existing requests in the system.
+     *
+     * @return a set of packet requests
+     */
+    Set<PacketRequest> existingRequests();
+
 }