X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=blobdiff_plain;f=opendaylight%2Fforwardingrulesmanager%2Fapi%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fforwardingrulesmanager%2FIForwardingRulesManager.java;h=4b8257488ef08c072785a5cef76f56c550ba882a;hp=d0efe4a83f7782d8225b79d483f446df49c5d280;hb=7c595c8a6f3c4dfaa11cb616b937faf414e74852;hpb=69bbdbb02e3f4755b95fa62b9a3610a3a11c9724 diff --git a/opendaylight/forwardingrulesmanager/api/src/main/java/org/opendaylight/controller/forwardingrulesmanager/IForwardingRulesManager.java b/opendaylight/forwardingrulesmanager/api/src/main/java/org/opendaylight/controller/forwardingrulesmanager/IForwardingRulesManager.java index d0efe4a83f..4b8257488e 100644 --- a/opendaylight/forwardingrulesmanager/api/src/main/java/org/opendaylight/controller/forwardingrulesmanager/IForwardingRulesManager.java +++ b/opendaylight/forwardingrulesmanager/api/src/main/java/org/opendaylight/controller/forwardingrulesmanager/IForwardingRulesManager.java @@ -18,7 +18,6 @@ import org.opendaylight.controller.sal.utils.Status; /** * Interface that describes methods for installing or removing forwarding rules * and to access to the flows database. - * */ public interface IForwardingRulesManager { @@ -27,7 +26,7 @@ public interface IForwardingRulesManager { * SDN protocol plugin to install the flow on the network node. Based on the * result of this operation FRM will update its database accordingly and * will return the proper {@code Status} code. - * + * * @param flow * the flow entry to install * @return the {@code Status} object indicating the result of this action. @@ -39,13 +38,26 @@ public interface IForwardingRulesManager { * protocol plugin to uninstall the flow from the network node. Based on the * result of this operation FRM will update its database accordingly and * will return the proper {@code Status} code. - * + * * @param flow * the flow entry to uninstall * @return the {@code Status} object indicating the result of this action */ public Status uninstallFlowEntry(FlowEntry flow); + /** + * It requests FRM to remove all the Flow Entry that are part of the + * specified group. FRM will request the SDN protocol plugin to uninstall + * the flows from the network node one by one. Based on the result of this + * operation FRM will update its database accordingly and will return the + * proper {@code Status} code. + * + * @param groupName + * the group name + * @return the {@code Status} object indicating the result of this action + */ + public Status uninstallFlowEntryGroup(String groupName); + /** * It requests FRM to replace the currently installed Flow Entry with the * new one. It is up to the SDN protocol plugin to decide how to convey this @@ -53,7 +65,7 @@ public interface IForwardingRulesManager { * modify message depending on the SDN protocol specifications If the * current flow is equal to the new one it will be a no op and success code * is returned. - * + * * @param current * the current flow entry to modify * @param newone @@ -72,16 +84,113 @@ public interface IForwardingRulesManager { * it, it will request plugin to add the new flow. If the passed entry is * not valid an error code is returned. If the existing flow is equal to the * passed one it will be a no op and success code is returned. - * + * * @param newone * the new flow entry to install * @return the {@code Status} object indicating the result of this action */ public Status modifyOrAddFlowEntry(FlowEntry newone); + /** + * It requests FRM to install the passed Flow Entry through an asynchronous + * call. A unique request id is returned to the caller. FRM will request the + * SDN protocol plugin to install the flow on the network node. As immediate + * result of this asynchronous call, FRM will update its flow database as if + * the flow was successfully installed. + * + * @param flow + * the flow entry to install + * @return the status of this request containing the request id associated + * to this asynchronous request + */ + public Status installFlowEntryAsync(FlowEntry flow); + + /** + * It requests FRM to remove the passed Flow Entry through an asynchronous + * call. A unique request id is returned to the caller. FRM will request the + * SDN protocol plugin to uninstall the flow from the network node. As + * immediate result of this asynchronous call, FRM will update its flow + * database as if the flow was successfully removed. + * + * @param flow + * the flow entry to uninstall + * @return the status of this request containing the unique id associated to + * this asynchronous request + */ + public Status uninstallFlowEntryAsync(FlowEntry flow); + + /** + * It requests FRM to remove all the Flow Entry that are part of the + * specified group through an asynchronous call. FRM will request the SDN + * protocol plugin to uninstall the flows from the network node one by one. + * As immediate result of this asynchronous call, FRM will update its flow + * database as if the flow was successfully removed. + * + * @param groupName + * the group name + * @return the {@code Status} object indicating the result of this action + */ + public Status uninstallFlowEntryGroupAsync(String groupName); + + /** + * It requests FRM to replace the currently installed Flow Entry with the + * new one through an asynchronous call. A unique request id is returned to + * the caller. It is up to the SDN protocol plugin to decide how to convey + * this message to the network node. It could be a delete + add or a single + * modify message depending on the SDN protocol specifications. If the + * current flow is equal to the new one it will be a no op. + * + * @param current + * the current flow entry to modify + * @param newone + * the new flow entry which will replace the current one + * @return the status of this request containing the request id associated + * to this asynchronous request + */ + public Status modifyFlowEntryAsync(FlowEntry current, FlowEntry newone); + + /** + * It requests the FRM to replace the currently installed Flow Entry with + * the new one through an asynchronous call. A unique request id is returned + * to the caller. The currently installed entry is derived by the Match + * portion of the passed Flow. FRM looks in its database for a previously + * installed FlowEntry which Match equals the Match of the passed Flow. If + * it finds it, it will request the SDN protocol plugin to replace the + * existing flow with the new one on the network node. If it does not find + * it, it will request plugin to add the new flow. If the passed entry is + * not valid a zero request id is returned. If the existing flow is equal to + * the passed one it will be a no op. + * + * @param newone + * the new flow entry to install + * @return the unique id associated to this request. In case of not + * acceptable request -1 will be returned. + */ + public Status modifyOrAddFlowEntryAsync(FlowEntry newone); + + /** + * Requests ForwardingRulesManager to solicit the network node to inform us + * about the status of its execution on the asynchronous requests that were + * sent to it so far. It is a way for an application to poke the network + * node in order to get a feedback asap on the asynchronous requests + * generated by the application. The caller may decide if this is a blocking + * or non-blocking operation. If blocking is set to true, the caller will be + * blocked until the solicitation response is received from the network node + * or receive timeout. Otherwise, it is a non-blocking call and does not + * guarantee the node will respond in any given time. + * + * @param node + * The network node to solicit a response + * @param blocking + * The blocking mode + * @return the status of this request containing the request id associated + * to this asynchronous request + */ + public Status solicitStatusResponse(Node node, boolean blocking); + /** * Check whether the passed flow entry conflicts with the Container flows - * + * * @param flow * the flow entry to test * @return true if conflicts, false otherwise @@ -91,7 +200,7 @@ public interface IForwardingRulesManager { /** * Returns the list of Flow entries across network nodes which are part of * the same flow group, policy - * + * * @param group * the group name * @return the list of flow entries belonging to the specified group @@ -101,7 +210,7 @@ public interface IForwardingRulesManager { /** * Add a list of output port to the flow with the specified name on the * specified network node - * + * * @param node * the network node * @param flowName @@ -109,13 +218,12 @@ public interface IForwardingRulesManager { * @param dstPort * the list of ports to be added to the flow output actions */ - public void addOutputPort(Node node, String flowName, - List dstPort); + public void addOutputPort(Node node, String flowName, List dstPort); /** * Remove a list of output port from the flow with the specified name on the * specified network node - * + * * @param node * the network node * @param flowName @@ -123,13 +231,12 @@ public interface IForwardingRulesManager { * @param dstPortthe * list of ports to be removed from the flow output actions */ - public void removeOutputPort(Node node, String flowName, - List dstPort); + public void removeOutputPort(Node node, String flowName, List dstPort); /** * Replace the current output port in the specified flow with the specified * one - * + * * @param node * the network node * @param groupName @@ -139,12 +246,11 @@ public interface IForwardingRulesManager { * @param dstPort * the new output action port */ - public void replaceOutputPort(Node node, String flowName, - NodeConnector outPort); + public void replaceOutputPort(Node node, String flowName, NodeConnector outPort); /** * Returns the output port configured on the specified flow - * + * * @param node * the network node * @param flowName @@ -157,14 +263,14 @@ public interface IForwardingRulesManager { * Returns all the troubleshooting information that applications have set * along with the policy they have configured through forwarding rules * manger. - * + * * @return the collection of troubleshooting objects */ public Map getTSPolicyData(); /** * Set the troubleshooting information for the policy - * + * * @param policyname * the flow group name * @param o @@ -177,7 +283,7 @@ public interface IForwardingRulesManager { /** * Returns the troubleshooting information that was set for the specified * policy - * + * * @param groupName * the flows group name * @return the troubleshooting info object @@ -187,7 +293,7 @@ public interface IForwardingRulesManager { /** * Returns the specifications of all the flows configured for all the * switches on the current container - * + * * @return the list of flow configurations present in the database */ public List getStaticFlows(); @@ -195,7 +301,7 @@ public interface IForwardingRulesManager { /** * Returns the specifications of all the flows configured for the given * switch on the current container - * + * * @param node * the network node identifier * @return the list of {@code FlowConfig} objects @@ -205,11 +311,11 @@ public interface IForwardingRulesManager { /** * Returns the specification of the flow configured for the given network * node on the current container - * + * * @param name * the flow name * @param n - * the netwrok node identifier + * the network node identifier * @return the {@code FlowConfig} object */ public FlowConfig getStaticFlow(String name, Node n); @@ -217,7 +323,7 @@ public interface IForwardingRulesManager { /** * Returns the list of names of flows configured for the given Network node * on the current container - * + * * @param node * the network node identifier * @return the list of flow names @@ -226,14 +332,14 @@ public interface IForwardingRulesManager { /** * Returns the list of Node(s) for which a static flow has been configured - * + * * @return the list of network nodes */ public List getListNodeWithConfiguredFlows(); /** * Save the flow configured so far to file - * + * * @return the {@code Status} object indicating the result of this action. */ public Status saveConfig(); @@ -241,20 +347,17 @@ public interface IForwardingRulesManager { /** * Add a flow specified by the {@code FlowConfig} object on the current * container - * + * * @param config * the {@code FlowConfig} object representing the static flow - * @param restore - * if set to true, the config object validation will be skipped. - * Used only internally, always set it to false. * @return the {@code Status} object indicating the result of this action. */ - public Status addStaticFlow(FlowConfig config, boolean restore); + public Status addStaticFlow(FlowConfig config); /** * Remove a flow specified by the {@code FlowConfig} object on the current * container - * + * * @param config * the {@code FlowConfig} object representing the static flow * @return the {@code Status} object indicating the result of this action @@ -265,7 +368,7 @@ public interface IForwardingRulesManager { * Replace the flow identified by the {@code FlowConfig.name} name for the * {@code FlowConfig.node} network node with the new flow specified by * {@code FlowConfig} object - * + * * @param config * the {@code FlowConfig} object * @returnthe {@code Status} object indicating the result of this action @@ -274,7 +377,7 @@ public interface IForwardingRulesManager { /** * Remove the flow specified by name on the passed network node - * + * * @param name * for the static flow * @param node @@ -287,7 +390,7 @@ public interface IForwardingRulesManager { * Toggle the installation status of the specified configured flow If the * flow configuration status is active, this call will change the flow * status to inactive and vice-versa - * + * * @param configObject * the {@code FlowConfig} object * @return the {@code Status} object indicating the result of this action @@ -298,7 +401,7 @@ public interface IForwardingRulesManager { * Toggle the installation status of the specified configured flow If the * flow configuration status is active, this call will change the flow * status to inactive and vice-versa - * + * * @param name * for the static flow * @param node