org.opendaylight.controller.connectionmanager

Interface IConnectionManager

public interface IConnectionManager

Connection Manager provides south-bound connectivity services. The APIs are currently focused towards Active-Active Clustering support wherein the node can connect to any of the Active Controller in the Cluster. This component can also host the necessary logic for south-bound connectivity when partial cluster is identified during Partition scenarios. This (and its corresponding implementation) component can also be enhanced further for more fancy algorithms/criteria for connection acceptance.

Method Summary

Methods

Modifier and Type	Method and Description
org.opendaylight.controller.sal.core.Node	connect(String connectionIdentifier, Map<org.opendaylight.controller.sal.connection.ConnectionConstants,String> params) Connect to a node
org.opendaylight.controller.sal.core.Node	connect(String type, String connectionIdentifier, Map<org.opendaylight.controller.sal.connection.ConnectionConstants,String> params) Connect to a node
org.opendaylight.controller.sal.utils.Status	disconnect(org.opendaylight.controller.sal.core.Node node) Disconnect a Node from the controller.
ConnectionMgmtScheme	getActiveScheme() This method returns Connectivity Algorithm (Scheme) that is currently being used.
Set<InetAddress>	getControllers(org.opendaylight.controller.sal.core.Node node) Retrieve list of cluster-members to which Node is connected to
org.opendaylight.controller.sal.connection.ConnectionLocality	getLocalityStatus(org.opendaylight.controller.sal.core.Node node) getLocalityStatus provides the tri-state connectivity status as opposed to the binary status returned by isLocal.
Set<org.opendaylight.controller.sal.core.Node>	getLocalNodes() Method that will retrieve and return a Set of Nodes that is currently connected to the controller on which this method is executed.
Set<org.opendaylight.controller.sal.core.Node>	getNodes(InetAddress controller) Method that will retrieve and return a Set of Nodes that is currently connected to the given controller.
boolean	isLocal(org.opendaylight.controller.sal.core.Node node) Deprecated. Use getLocalityStatus(Node node) instead. Method to test if a node is local to a controller.

Method Detail

getActiveScheme

ConnectionMgmtScheme getActiveScheme()

This method returns Connectivity Algorithm (Scheme) that is currently being used.

Returns:

ConnectionMgmtScheme Enum that represents the active scheme.

getNodes

Set<org.opendaylight.controller.sal.core.Node> getNodes(InetAddress controller)

Method that will retrieve and return a Set of Nodes that is currently connected to the given controller.

Parameters:

controller - InetAddress of the Controller that is currently connected to a set of Nodes.

Returns:

Set Set of Nodes connected to a controller.

getLocalNodes

Set<org.opendaylight.controller.sal.core.Node> getLocalNodes()

Method that will retrieve and return a Set of Nodes that is currently connected to the controller on which this method is executed.

Returns:

Set Set of Nodes connected to this controller.

isLocal

boolean isLocal(org.opendaylight.controller.sal.core.Node node)

Deprecated. Use getLocalityStatus(Node node) instead. Method to test if a node is local to a controller.

Parameters:

node - The node for which the locality is being tested

Returns:

true if node is local to this controller.
false if either node is not connected to this controller or not connected to any other controllers in the cluster.

getLocalityStatus

org.opendaylight.controller.sal.connection.ConnectionLocality getLocalityStatus(org.opendaylight.controller.sal.core.Node node)

getLocalityStatus provides the tri-state connectivity status as opposed to the binary status returned by isLocal. ConnectionLocality enum that is returned by this method also includes the case of a Node not connected to any of the controllers in the cluster.

Parameters:

node - The node for which the locality is being verified

Returns:

ConnectionLocality

disconnect

org.opendaylight.controller.sal.utils.Status disconnect(org.opendaylight.controller.sal.core.Node node)

Disconnect a Node from the controller.

Returns:

Status of the disconnect Operation.

connect

org.opendaylight.controller.sal.core.Node connect(String connectionIdentifier,
                                                Map<org.opendaylight.controller.sal.connection.ConnectionConstants,String> params)

Connect to a node

Parameters:

connectionIdentifier - identifier with which the application would refer to a given connection.

params - Connection Params in Map format. This is entirely handled by the south-bound plugins and is an opaque value for SAL or Connection Manager. Typical values keyed inside this params are Management IP-Address, Username, Password, Security Keys, etc...

Returns:

Node Node connected to.

connect

org.opendaylight.controller.sal.core.Node connect(String type,
                                                String connectionIdentifier,
                                                Map<org.opendaylight.controller.sal.connection.ConnectionConstants,String> params)

Connect to a node

Parameters:

type - Type of the node representing NodeIDType.

connectionIdentifier - identifier with which the application would refer to a given connection.

params - Connection Params in Map format. This is entirely handled by the south-bound plugins and is an opaque value for SAL or Connection Manager. Typical values keyed inside this params are Management IP-Address, Username, Password, Security Keys, etc...

Returns:

Status of the Connect Operation.

getControllers

Set<InetAddress> getControllers(org.opendaylight.controller.sal.core.Node node)

Retrieve list of cluster-members to which Node is connected to

Parameters:

node - Node for which cluster-members to be retrieved

Returns:

Set List of cluster-member addresses to which the node is connected