Move adsal into its own subdirectory.

[controller.git] / opendaylight / adsal / forwardingrulesmanager / api / src / main / java / org / opendaylight / controller / forwardingrulesmanager / FlowEntryInstall.java

diff --git a/opendaylight/adsal/forwardingrulesmanager/api/src/main/java/org/opendaylight/controller/forwardingrulesmanager/FlowEntryInstall.java b/opendaylight/adsal/forwardingrulesmanager/api/src/main/java/org/opendaylight/controller/forwardingrulesmanager/FlowEntryInstall.java
new file mode 100644 (file)
index 0000000..1318c97
--- /dev/null
+++ b/opendaylight/adsal/forwardingrulesmanager/api/src/main/java/org/opendaylight/controller/forwardingrulesmanager/FlowEntryInstall.java
@@ -0,0 +1,134 @@
+/*
+ * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+
+package org.opendaylight.controller.forwardingrulesmanager;
+
+import java.io.Serializable;
+
+import org.opendaylight.controller.sal.core.ContainerFlow;
+import org.opendaylight.controller.sal.core.Node;
+
+/**
+ * The flow database object representing the flow entry to install on the
+ * network node. It contains the original flow entry FRM was requested to
+ * install, the container flow with which that entry had to be merged and the
+ * resultant merged flow entry, which is the one that was eventually installed
+ * on the network node
+ *
+ * Note: If the container flow is null, the install entry will be a clone of the
+ * original entry
+ */
+public class FlowEntryInstall implements Serializable {
+    private static final long serialVersionUID = 1L;
+    private final FlowEntry original;
+    private final ContainerFlow cFlow;
+    private final FlowEntry install;
+    private transient long requestId; // async request id
+    private transient boolean deletePending;
+
+    public FlowEntryInstall(FlowEntry original, ContainerFlow cFlow) {
+        this.original = original;
+        this.cFlow = cFlow;
+        this.install = (cFlow == null) ? original.clone() : original.clone().mergeWith(cFlow);
+        deletePending = false;
+        requestId = 0;
+    }
+
+    /*
+     * Given FlowEntryInstall is used as key for FRM map which contains the
+     * software view of installed entries, having its hashcode tied to the one
+     * of the installed FlowEntry which takes into account the fields which
+     * uniquely identify a flow from switch point of view: node, match and
+     * priority.
+     */
+    @Override
+    public int hashCode() {
+        return install.hashCode();
+    }
+
+    @Override
+    public boolean equals(Object obj) {
+        if (this == obj) {
+            return true;
+        }
+        if (obj == null) {
+            return false;
+        }
+        if (getClass() != obj.getClass()) {
+            return false;
+        }
+        FlowEntryInstall other = (FlowEntryInstall) obj;
+        if (install == null) {
+            if (other.install != null) {
+                return false;
+            }
+        } else if (!install.equals(other.install)) {
+            return false;
+        }
+        return true;
+    }
+
+    public String getFlowName() {
+        return original.getFlowName();
+    }
+
+    public String getGroupName() {
+        return original.getGroupName();
+    }
+
+    public Node getNode() {
+        return original.getNode();
+    }
+
+    public boolean equalsByNodeAndName(Node node, String flowName) {
+        return original.equalsByNodeAndName(node, flowName);
+    }
+
+    public FlowEntry getOriginal() {
+        return original;
+    }
+
+    public ContainerFlow getContainerFlow() {
+        return cFlow;
+    }
+
+    public FlowEntry getInstall() {
+        return install;
+    }
+
+    public boolean isDeletePending() {
+        return deletePending;
+    }
+
+    public void toBeDeleted() {
+        this.deletePending = true;
+    }
+
+    public void setRequestId(long rid) {
+        this.requestId = rid;
+    }
+
+    public long getRequestId() {
+        return requestId;
+    }
+
+    /**
+     * Returns whether this entry is the result of an internal generated static
+     * flow
+     *
+     * @return true if internal generated static flow, false otherwise
+     */
+    public boolean isInternal() {
+        return original.isInternal();
+    }
+
+    @Override
+    public String toString() {
+        return "[Install = " + install + " Original = " + original + " cFlow = " + cFlow + " rid = " + requestId + "]";
+    }
+}