X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=blobdiff_plain;f=opendaylight%2Fswitchmanager%2Fapi%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fswitchmanager%2FISwitchManager.java;h=ee2c2c20398cf2c5deefa4b0b03bdceecde56fbb;hp=ddc5f8ffee2777cd098148e05abe0c2ee741e7ea;hb=0b203f52cbe128efa17a6c400b6653c8e6a84ba8;hpb=59cc8f34c24d81a8890a94c11dedd4b21caa0adf diff --git a/opendaylight/switchmanager/api/src/main/java/org/opendaylight/controller/switchmanager/ISwitchManager.java b/opendaylight/switchmanager/api/src/main/java/org/opendaylight/controller/switchmanager/ISwitchManager.java index ddc5f8ffee..ee2c2c2039 100644 --- a/opendaylight/switchmanager/api/src/main/java/org/opendaylight/controller/switchmanager/ISwitchManager.java +++ b/opendaylight/switchmanager/api/src/main/java/org/opendaylight/controller/switchmanager/ISwitchManager.java @@ -19,12 +19,6 @@ import org.opendaylight.controller.sal.core.NodeConnector; import org.opendaylight.controller.sal.core.Property; import org.opendaylight.controller.sal.utils.Status; -import org.opendaylight.controller.switchmanager.SpanConfig; -import org.opendaylight.controller.switchmanager.Subnet; -import org.opendaylight.controller.switchmanager.SubnetConfig; -import org.opendaylight.controller.switchmanager.Switch; -import org.opendaylight.controller.switchmanager.SwitchConfig; - /** * Primary purpose of this interface is to provide methods for application to * access various system resources and inventory data including nodes, node @@ -44,7 +38,7 @@ public interface ISwitchManager { /** * Remove a subnet configuration * - * @param configObject refer to {@link Open Declaration org.opendaylight.controller.switchmanager.SubnetConfig} + * @param configObject refer to {@link Open Declaration org.opendaylight.controller.switchmanager.SubnetConfig} * @return "Success" or failure reason */ public Status removeSubnet(SubnetConfig configObject); @@ -53,14 +47,14 @@ public interface ISwitchManager { * Remove a subnet configuration given the name * * @param name subnet name - * @return "Success" or failure reason + * @return "Success" or failure reason */ public Status removeSubnet(String name); /** * Return a list of all known devices in the system * - * @return returns a list of {@link org.opendaylight.controller.switchmanager.Switch} + * @return returns a list of {@link org.opendaylight.controller.switchmanager.Switch} */ public List getNetworkDevices(); @@ -82,8 +76,8 @@ public interface ISwitchManager { /** * Return a subnet configuration given the network address * - * @param networkAddress the ip address in long format - * @return the {@link org.opendaylight.controller.switchmanager.Subnet} + * @param networkAddress the ip address in long format + * @return the {@link org.opendaylight.controller.switchmanager.Subnet} */ public Subnet getSubnetByNetworkAddress(InetAddress networkAddress); @@ -98,7 +92,7 @@ public interface ISwitchManager { * Add a span port configuration * * @param SpanConfig refer to {@link Open Declaration org.opendaylight.controller.switchmanager.SpanConfig} - * @return status code + * @return status code */ public Status addSpanConfig(SpanConfig configObject); @@ -106,7 +100,7 @@ public interface ISwitchManager { * Remove a span port configuration * * @param SpanConfig refer to {@link Open Declaration org.opendaylight.controller.switchmanager.SpanConfig} - * @return status code + * @return status code */ public Status removeSpanConfig(SpanConfig cfgObject); @@ -129,14 +123,40 @@ public interface ISwitchManager { * Update Switch specific configuration such as Switch Name and Tier * * @param cfgConfig refer to {@link Open Declaration org.opendaylight.controller.switchmanager.SwitchConfig} + * + * @deprecated replaced by updateNodeConfig(switchConfig) */ + @Deprecated public void updateSwitchConfig(SwitchConfig cfgObject); + /** + * Update Node specific configuration such as Node Name and Tier + * + * @param cfgConfig + * refer to {@link Open Declaration + * org.opendaylight.controller.switchmanager.SwitchConfig} + * @return "Success" or failure reason + */ + public Status updateNodeConfig(SwitchConfig switchConfig); + + /** + * Removes node properties configured by the user + * + * @param nodeId + * Node Identifier as specified by + * {@link org.opendaylight.controller.sal.core.Node} + * @return "Success" or failure reason + */ + public Status removeNodeConfig(String nodeId); + /** * Return the previously configured Switch Configuration given the node id * - * @param nodeId Node Identifier as specified by {@link org.opendaylight.controller.sal.core.Node} - * @return {@link org.opendaylight.controller.switchmanager.SwitchConfig} resources + * @param nodeId + * Node Identifier as specified by + * {@link org.opendaylight.controller.sal.core.Node} + * @return {@link org.opendaylight.controller.switchmanager.SwitchConfig} + * resources */ public SwitchConfig getSwitchConfig(String nodeId); @@ -152,8 +172,8 @@ public interface ISwitchManager { /** * Remove node connectors from a subnet * - * @param name the subnet config name - * @param nodeConnectors nodePorts string specified by {@link Open Declaration org.opendaylight.controller.switchmanager.SubnetConfig} + * @param name the subnet config name + * @param nodeConnectors nodePorts string specified by {@link Open Declaration org.opendaylight.controller.switchmanager.SubnetConfig} * @return "Success" or failure reason */ public Status removePortsFromSubnet(String name, String nodeConnectors); @@ -170,16 +190,16 @@ public interface ISwitchManager { * * @param node {@link org.opendaylight.controller.sal.core.Node} * @return map of {@link org.opendaylight.controller.sal.core.Property} such as - * {@link org.opendaylight.controller.sal.core.Description} and/or - * {@link org.opendaylight.controller.sal.core.Tier} etc. + * {@link org.opendaylight.controller.sal.core.Description} and/or + * {@link org.opendaylight.controller.sal.core.Tier} etc. */ public Map getNodeProps(Node node); /** * Return a specific property of a node given the property name * - * @param node {@link org.opendaylight.controller.sal.core.Node} - * @param propName the property name specified by {@link org.opendaylight.controller.sal.core.Property} and its extended classes + * @param node {@link org.opendaylight.controller.sal.core.Node} + * @param propName the property name specified by {@link org.opendaylight.controller.sal.core.Property} and its extended classes * @return {@link org.opendaylight.controller.sal.core.Property} */ public Property getNodeProp(Node node, String propName); @@ -187,23 +207,23 @@ public interface ISwitchManager { /** * Set a specific property of a node * - * @param node {@link org.opendaylight.controller.sal.core.Node} - * @param prop {@link org.opendaylight.controller.sal.core.Property} + * @param node {@link org.opendaylight.controller.sal.core.Node} + * @param prop {@link org.opendaylight.controller.sal.core.Property} */ public void setNodeProp(Node node, Property prop); /** * Remove a property of a node - * - * @param nc {@link org.opendaylight.controller.sal.core.Node} - * @param propName the property name specified by {@link org.opendaylight.controller.sal.core.Property} and its extended classes + * + * @param nc {@link org.opendaylight.controller.sal.core.Node} + * @param propName the property name specified by {@link org.opendaylight.controller.sal.core.Property} and its extended classes * @return success or failed reason */ public Status removeNodeProp(Node node, String propName); /** * Remove all the properties of a node - * + * * @param node {@link org.opendaylight.controller.sal.core.Node} * @return success or failed reason */ @@ -238,8 +258,8 @@ public interface ISwitchManager { * * @param nodeConnector {@link org.opendaylight.controller.sal.core.NodeConnector} * @return map of {@link org.opendaylight.controller.sal.core.Property} such as - * {@link org.opendaylight.controller.sal.core.Description} and/or - * {@link org.opendaylight.controller.sal.core.State} etc. + * {@link org.opendaylight.controller.sal.core.Description} and/or + * {@link org.opendaylight.controller.sal.core.State} etc. */ public Map getNodeConnectorProps( NodeConnector nodeConnector); @@ -266,7 +286,7 @@ public interface ISwitchManager { /** * Remove a property of a node connector - * + * * @param nc {@link org.opendaylight.controller.sal.core.NodeConnector} * @param propName property name specified by {@link org.opendaylight.controller.sal.core.Property} and its extended classes * @return success or failed reason @@ -275,7 +295,7 @@ public interface ISwitchManager { /** * Remove all the properties of a node connector - * + * * @param nodeConnector {@link org.opendaylight.controller.sal.core.NodeConnector} * @return success or failed reason */ @@ -284,7 +304,7 @@ public interface ISwitchManager { /** * Return the node connector given its name * - * @param node {@link org.opendaylight.controller.sal.core.Node} + * @param node {@link org.opendaylight.controller.sal.core.Node} * @param nodeConnectorName node connector identifier specified by {@link org.opendaylight.controller.sal.core.NodeConnector} * @return {@link org.opendaylight.controller.sal.core.NodeConnector} */ @@ -309,7 +329,7 @@ public interface ISwitchManager { /** * Return controller MAC address - * + * * @return MAC address in byte array */ public byte[] getControllerMAC(); @@ -317,7 +337,7 @@ public interface ISwitchManager { /** * Return MAC address for a given node * - * @param node {@link org.opendaylight.controller.sal.core.Node} + * @param node {@link org.opendaylight.controller.sal.core.Node} * @return MAC address in byte array */ public byte[] getNodeMAC(Node node); @@ -338,24 +358,25 @@ public interface ISwitchManager { */ public int getHostRetryCount(); - /** - * Create a Name/Tier/Bandwidth Property object based on given property - * name and value. Other property types are not supported yet. - * + /** + * Create a Name/Tier/Bandwidth Property object based on given property + * name and value. Other property types are not supported yet. + * * @param propName Name of the Property specified by {@link org.opendaylight.controller.sal.core.Property} and its extended classes * @param propValue Value of the Property specified by {@link org.opendaylight.controller.sal.core.Property} and its extended classes - * @return {@link org.opendaylight.controller.sal.core.Property} - */ + * @return {@link org.opendaylight.controller.sal.core.Property} + */ public Property createProperty(String propName, String propValue); - + /** - * Returns the description for the specified node. It is either the one + * Returns the description for the specified node. It is either the one * configured by user or the description advertised by the node. - * + * * @param node the network node identifier - * @return the description of the specified node. If no description is + * @return the description of the specified node. If no description is * configured and the network node does not provide its description, * an empty string is returned. */ + @Deprecated public String getNodeDescription(Node node); }