Initial opendaylight infrastructure commit!!

[controller.git] / opendaylight / sal / api / src / main / java / org / opendaylight / controller / sal / flowprogrammer / IPluginInFlowProgrammerService.java

diff --git a/opendaylight/sal/api/src/main/java/org/opendaylight/controller/sal/flowprogrammer/IPluginInFlowProgrammerService.java b/opendaylight/sal/api/src/main/java/org/opendaylight/controller/sal/flowprogrammer/IPluginInFlowProgrammerService.java
new file mode 100644 (file)
index 0000000..1fb99e0
--- /dev/null
+++ b/opendaylight/sal/api/src/main/java/org/opendaylight/controller/sal/flowprogrammer/IPluginInFlowProgrammerService.java
@@ -0,0 +1,52 @@
+
+/*
+ * 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.sal.flowprogrammer;
+
+import org.opendaylight.controller.sal.core.Node;
+import org.opendaylight.controller.sal.utils.Status;
+
+/**
+ * @file   IPluginOutFlowProgrammer.java
+ *
+ * @brief  Flow programmer interface to be implemented by protocol plugins
+ *
+ *
+ *
+ */
+public interface IPluginInFlowProgrammerService {
+    /**
+     * Add a flow to the network node
+     *
+     * @param node
+     * @param flow
+     */
+       Status addFlow(Node node, Flow flow);
+
+    /**
+     * Modify existing flow on the switch
+     *
+     * @param node
+     * @param flow
+     */
+       Status modifyFlow(Node node, Flow oldFlow, Flow newFlow);
+
+    /**
+     * Remove the flow from the network node
+     * @param node
+     * @param flow
+     */
+       Status removeFlow(Node node, Flow flow);
+
+    /**
+     * Remove all flows present on the network node
+     * @param node
+     */
+       Status removeAllFlows(Node node);
+}