org.opendaylight.controller.topologymanager

Interface ITopologyManager

public interface ITopologyManager

The Interface provides methods to interact with network topology database.

Method Summary

Methods

Modifier and Type	Method and Description
org.opendaylight.controller.sal.utils.Status	addUserLink(TopologyUserLinkConfig link) Adds user configured link
org.opendaylight.controller.sal.utils.Status	deleteUserLink(String linkName) Deletes user configured link
Map<org.opendaylight.controller.sal.core.Edge,Set<org.opendaylight.controller.sal.core.Property>>	getEdges() Retrieves a map of all known link connections between nodes including their properties
org.opendaylight.controller.sal.core.Host	getHostAttachedToNodeConnector(org.opendaylight.controller.sal.core.NodeConnector p) Deprecated.
List<org.opendaylight.controller.sal.core.Host>	getHostsAttachedToNodeConnector(org.opendaylight.controller.sal.core.NodeConnector p) Returns a list of hosts attached to a NodeConnector
Set<org.opendaylight.controller.sal.core.NodeConnector>	getNodeConnectorWithHost() Return a set of NodeConnector that have hosts attached to them
Map<org.opendaylight.controller.sal.core.Node,Set<org.opendaylight.controller.sal.core.Edge>>	getNodeEdges() Returns an unmodifiable map indexed by the Node and reporting all the edges getting out/in from/to the Node
Map<org.opendaylight.controller.sal.core.Node,Set<org.opendaylight.controller.sal.core.NodeConnector>>	getNodesWithNodeConnectorHost() Returns a copy map which associates every node with all the NodeConnectors of the node that have an Host attached to it
ConcurrentMap<String,TopologyUserLinkConfig>	getUserLinks() Gets all the user configured links
boolean	isInternal(org.opendaylight.controller.sal.core.NodeConnector p) Query to determine if the specified NodeConnector is connected to another Node or is a leaf for the network
org.opendaylight.controller.sal.utils.Status	saveConfig() Saves user configured links into config file
void	updateHostLink(org.opendaylight.controller.sal.core.NodeConnector p, org.opendaylight.controller.sal.core.Host h, org.opendaylight.controller.sal.core.UpdateType t, Set<org.opendaylight.controller.sal.core.Property> props) Add or Update an Host port in the topology manager DB

Method Detail

isInternal

boolean isInternal(org.opendaylight.controller.sal.core.NodeConnector p)

Query to determine if the specified NodeConnector is connected to another Node or is a leaf for the network

Parameters:

p - The node connector

Returns:

true if the NodeConnector is connected to another switch false otherwise

getEdges

Map<org.opendaylight.controller.sal.core.Edge,Set<org.opendaylight.controller.sal.core.Property>> getEdges()

Retrieves a map of all known link connections between nodes including their properties

Returns:

the map as specified

getNodeEdges

Map<org.opendaylight.controller.sal.core.Node,Set<org.opendaylight.controller.sal.core.Edge>> getNodeEdges()

Returns an unmodifiable map indexed by the Node and reporting all the edges getting out/in from/to the Node

Returns:

the map as specified

updateHostLink

void updateHostLink(org.opendaylight.controller.sal.core.NodeConnector p,
                  org.opendaylight.controller.sal.core.Host h,
                  org.opendaylight.controller.sal.core.UpdateType t,
                  Set<org.opendaylight.controller.sal.core.Property> props)

Add or Update an Host port in the topology manager DB

Parameters:

p - NodeConnector to which an host is connected

h - the Host connected to the NodeConnector

t - type of update if Add/Delete/Update

getNodeConnectorWithHost

Set<org.opendaylight.controller.sal.core.NodeConnector> getNodeConnectorWithHost()

Return a set of NodeConnector that have hosts attached to them

Returns:

A set with all the NodeConnectors known to have an host attached

getHostAttachedToNodeConnector

@Deprecated
org.opendaylight.controller.sal.core.Host getHostAttachedToNodeConnector(org.opendaylight.controller.sal.core.NodeConnector p)

Deprecated.

Return the Host attached to a NodeConnector with Host. Multiple hosts maybe attached to a node connector. This method returns the first one only. Hence it has been deprecated. Use the new method getHostsAttachedToNodeConnector that returns the complete list of hosts.

Returns:

The Host attached to a NodeConnector

getHostsAttachedToNodeConnector

List<org.opendaylight.controller.sal.core.Host> getHostsAttachedToNodeConnector(org.opendaylight.controller.sal.core.NodeConnector p)

Returns a list of hosts attached to a NodeConnector

Parameters:

p - NodeConnector

Returns:

The list of hosts attached to a NodeConnector

getNodesWithNodeConnectorHost

Map<org.opendaylight.controller.sal.core.Node,Set<org.opendaylight.controller.sal.core.NodeConnector>> getNodesWithNodeConnectorHost()

Returns a copy map which associates every node with all the NodeConnectors of the node that have an Host attached to it

Returns:

A map of all the Nodes with NodeConnectors

addUserLink

org.opendaylight.controller.sal.utils.Status addUserLink(TopologyUserLinkConfig link)

Adds user configured link

Parameters:

link - User configured link

Returns:

"Success" or error reason

deleteUserLink

org.opendaylight.controller.sal.utils.Status deleteUserLink(String linkName)

Deletes user configured link

Parameters:

linkName - The name of the user configured link

Returns:

"Success" or error reason

saveConfig

org.opendaylight.controller.sal.utils.Status saveConfig()

Saves user configured links into config file

Returns:

"Success" or error reason

getUserLinks

ConcurrentMap<String,TopologyUserLinkConfig> getUserLinks()

Gets all the user configured links

Returns:

The map of the user configured links