org.opendaylight.vtn.manager.internal.util.inventory

Class InventoryUtils

java.lang.Object

org.opendaylight.vtn.manager.internal.util.inventory.InventoryUtils

public final class InventoryUtils
extends Object

InventoryUtils class is a collection of utility class methods for MD-SAL based inventory management.

Method Summary

Modifier and Type	Method and Description
static void	clearPortLink(org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction tx, SalPort sport, VtnPort vport) Remove all the VTN links configured in the given VTN port.
static org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.LinkId	getLinkId(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<?> path) Return a MD-SAL inter-switch link ID in the given instance identifier.
static long	getLinkSpeed(org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.port.rev130925.PortFeatures pf) Determine the link speed from the current port feature.
static org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId	getNodeConnectorId(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<?> path) Return a MD-SAL node connector ID in the given instance identifier.
static org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId	getNodeId(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<?> path) Return a MD-SAL node ID in the given instance identifier.
static VtnOpenflowVersion	getOpenflowVersion(org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeConnector fcnc) Estimate the OpenFlow protocol version from the given NodeConnector instance.
static VtnOpenflowVersion	getOpenflowVersion(org.opendaylight.controller.md.sal.binding.api.ReadTransaction rtx, SalNode snode) Return the OpenFlow protocol version used by the specified switch.
static VnodeState	getPortState(VtnPort vport) Return the state of the given switch port.
static VtnOpenflowVersion	getVtnPorts(List<VtnPort> list, org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node node) Return a list of VTN ports associated with the switch ports in the given MD-SAL node.
static boolean	hasEdgePort(VtnNode vnode) Determine whether the given node has at least one edge port in up state or not.
static boolean	hasPortLink(VtnPort vport) Determine whether the given VTN port has at least one inter-switch link or not.
static boolean	isEdge(VtnPort vport) Determine whether the given VTN port is an edge port or not.
static boolean	isEnabled(VtnPort vport) Determine whether the given VTN port is enabled or not.
static boolean	isEnabledEdge(VtnPort vport) Determine whether the given VTN port is an enabled edge port or not.
static void	removeIgnoredLink(org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction tx, SalNode snode) Remove all VTN links in ignored-links affected by the removed VTN node.
static void	removePortLink(org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction tx, SalPort sport, org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.LinkId lid) Remove the specified port link.
static void	removeVtnLink(org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction tx, SalNode snode) Remove all VTN links affected by the the removed VTN node.
static void	removeVtnLink(org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction tx, VtnPort vport) Remove all VTN links affected by the removed VTN port.
static void	removeVtnTopologyLink(org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction tx, SalNode snode) Remove all VTN links in vtn-topology affected by the removed VTN node.
static IgnoredLinkBuilder	toIgnoredLinkBuilder(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.LinkId lid, SalPort src, SalPort dst) Create an ignored link builder associated with the given inter-switch link.
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<IgnoredLink>	toIgnoredLinkIdentifier(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.LinkId lid) Convert a given topology link ID into an instance identifier of ignored inter-switch link.
static PortLinkBuilder	toPortLinkBuilder(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.LinkId lid, SalPort peer) Create a port link builder associated with the given inter-switch link.
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<StaticEdgePort>	toStaticEdgePortIdentifier(SalPort sport) Convert the given switch port ID into an instance identifier for a static edge port.
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<StaticSwitchLink>	toStaticSwitchLinkIdentifier(SalPort sport) Convert the given switch port ID into an instance identifier for a static inter-switch link.
static String	toString(VtnLink vlink) Return a string representation of the given VTN link information.
static String	toString(VtnPort vport) Return a string representation of the given VTN port.
static String	toString(VtnSwitchLink vslink) Return a string representation of the given link information.
static VtnLinkBuilder	toVtnLinkBuilder(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.LinkId lid, SalPort src, SalPort dst) Create a VTN link builder associated with the given inter-switch link.
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VtnLink>	toVtnLinkIdentifier(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.LinkId lid) Convert a given topology link ID into an instance identifier of VTN topology link.
static VtnNodeBuilder	toVtnNodeBuilder(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node node) Create a VTN node builder associated with the given MD-SAL node.
static VtnNodeBuilder	toVtnNodeBuilder(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId nid) Create a VTN node builder associated with the given MD-SAL node ID.
static VtnPortBuilder	toVtnPortBuilder(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId ncid, org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeConnector fcnc) Create a VTN port builder associated with the given MD-SAL node connector ID.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

hasPortLink

public static boolean hasPortLink(VtnPort vport)

Determine whether the given VTN port has at least one inter-switch link or not.

Parameters:

vport - A VtnPort instance.

Returns:

true only if the given port has at least one inter-switch link.

isEdge

public static boolean isEdge(VtnPort vport)

Determine whether the given VTN port is an edge port or not.

Parameters:

vport - A VtnPort instance.

Returns:

true only if the given port is an edge port.

isEnabled

public static boolean isEnabled(VtnPort vport)

Determine whether the given VTN port is enabled or not.

Parameters:

vport - A VtnPort instance.

Returns:

true only if the given port is enabled.

isEnabledEdge

public static boolean isEnabledEdge(VtnPort vport)

Determine whether the given VTN port is an enabled edge port or not.

Parameters:

vport - A VtnPort instance.

Returns:

true only if the given port is an enabled edge port.

hasEdgePort

public static boolean hasEdgePort(VtnNode vnode)

Determine whether the given node has at least one edge port in up state or not.

Parameters:

vnode - A VtnNode instance.

Returns:

true is returned if the given node has at least one edge port in up state. Otherwise false is returned.

getPortState

public static VnodeState getPortState(VtnPort vport)

Return the state of the given switch port.

Parameters:

vport - A VtnPort instance.

Returns:

A VnodeState instance which represents the state of the given switch port.

toString

public static String toString(VtnPort vport)

Return a string representation of the given VTN port.

Parameters:

vport - A VtnPort instance.

Returns:

A string representation of the given VTN port.

toString

public static String toString(VtnSwitchLink vslink)

Return a string representation of the given link information.

Parameters:

vslink - A VtnSwitchLink instance.

Returns:

A string representation of the given link.

toString

public static String toString(VtnLink vlink)

Return a string representation of the given VTN link information.

Parameters:

vlink - A VtnLink instance.

Returns:

A string representation of the given link.

toVtnLinkIdentifier

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VtnLink> toVtnLinkIdentifier(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.LinkId lid)

Convert a given topology link ID into an instance identifier of VTN topology link.

Parameters:

lid - A topology link ID.

Returns:

An instance identifier for a VTN topology link.

toIgnoredLinkIdentifier

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<IgnoredLink> toIgnoredLinkIdentifier(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.LinkId lid)

Convert a given topology link ID into an instance identifier of ignored inter-switch link.

Parameters:

lid - A topology link ID.

Returns:

An instance identifier for a ignored link.

toStaticSwitchLinkIdentifier

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<StaticSwitchLink> toStaticSwitchLinkIdentifier(SalPort sport)

Convert the given switch port ID into an instance identifier for a static inter-switch link.

Parameters:

sport - A SalPort instance.

Returns:

An instance identifier for a static inter-switch link.

toStaticEdgePortIdentifier

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<StaticEdgePort> toStaticEdgePortIdentifier(SalPort sport)

Convert the given switch port ID into an instance identifier for a static edge port.

Parameters:

sport - A SalPort instance.

Returns:

An instance identifier for a static edge port.

toVtnNodeBuilder

public static VtnNodeBuilder toVtnNodeBuilder(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node node)

Create a VTN node builder associated with the given MD-SAL node.

Parameters:

node - A MD-SAL node.

Returns:

A VTN node builder.

toVtnNodeBuilder

public static VtnNodeBuilder toVtnNodeBuilder(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId nid)

Create a VTN node builder associated with the given MD-SAL node ID.

Parameters:

nid - A MD-SAL node ID.

Returns:

A VTN node builder.

toVtnPortBuilder

public static VtnPortBuilder toVtnPortBuilder(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId ncid,
                                              org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeConnector fcnc)

Create a VTN port builder associated with the given MD-SAL node connector ID.

Parameters:

ncid - A MD-SAL node connector ID.

fcnc - A FlowCapableNodeConnector instance.

Returns:

A VTN port builder.

toVtnLinkBuilder

public static VtnLinkBuilder toVtnLinkBuilder(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.LinkId lid,
                                              SalPort src,
                                              SalPort dst)

Create a VTN link builder associated with the given inter-switch link.

Parameters:

lid - A LinkId instance which represents an inter-switch link ID.

src - A SalPort instance which represents the source port of the inter-switch link.

dst - A SalPort instance which represents the destination port of the inter-switch link.

Returns:

A VTN link builder.

toIgnoredLinkBuilder

public static IgnoredLinkBuilder toIgnoredLinkBuilder(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.LinkId lid,
                                                      SalPort src,
                                                      SalPort dst)

Create an ignored link builder associated with the given inter-switch link.

Parameters:

lid - A LinkId instance which represents an inter-switch link ID.

src - A SalPort instance which represents the source port of the inter-switch link.

dst - A SalPort instance which represents the destination port of the inter-switch link.

Returns:

An ignored link builder.

toPortLinkBuilder

public static PortLinkBuilder toPortLinkBuilder(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.LinkId lid,
                                                SalPort peer)

Create a port link builder associated with the given inter-switch link.

Parameters:

lid - A LinkId instance which represents an inter-switch link ID.

peer - A SalPort instance which represents the peer of the inter-switch link.

Returns:

A port link builder.

getVtnPorts

public static VtnOpenflowVersion getVtnPorts(List<VtnPort> list,
                                             org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node node)

Return a list of VTN ports associated with the switch ports in the given MD-SAL node.

Parameters:

list - A list of VtnPort to store results.

node - A MD-SAL node.

Returns:

Estimated OpenFlow protocol version. null is returned if no port is created.

getOpenflowVersion

public static VtnOpenflowVersion getOpenflowVersion(org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeConnector fcnc)

Estimate the OpenFlow protocol version from the given NodeConnector instance.

Parameters:

fcnc - A FlowCapableNodeConnector instance.

Returns:

Estimated OpenFlow protocol version number.

getOpenflowVersion

public static VtnOpenflowVersion getOpenflowVersion(org.opendaylight.controller.md.sal.binding.api.ReadTransaction rtx,
                                                    SalNode snode)
                                             throws VTNException

Return the OpenFlow protocol version used by the specified switch.

Parameters:

rtx - A read-only MD-SAL datastore transaction.

snode - A SalNode instance that specifies the target switch.

Returns:

A VtnOpenflowVersion instance on success. null if the specified switch is not present or the protocol version is not yet determined.

Throws:

VTNException - An error occurred.

getLinkSpeed

public static long getLinkSpeed(org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.port.rev130925.PortFeatures pf)

Determine the link speed from the current port feature.

Parameters:

pf - A PortFeatures instance.

Returns:

A link speed in bps.

getNodeId

public static org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId getNodeId(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<?> path)

Return a MD-SAL node ID in the given instance identifier.

Parameters:

path - An InstanceIdentifier instance.

Returns:

A MD-SAL node ID if found. null if not found.

getNodeConnectorId

public static org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId getNodeConnectorId(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<?> path)

Return a MD-SAL node connector ID in the given instance identifier.

Parameters:

path - An InstanceIdentifier instance.

Returns:

A MD-SAL node connector ID if found. null if not found.

getLinkId

public static org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.LinkId getLinkId(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<?> path)

Return a MD-SAL inter-switch link ID in the given instance identifier.

Parameters:

path - An InstanceIdentifier instance.

Returns:

A MD-SAL inter-switch link ID if found. null if not found.

removeVtnLink

public static void removeVtnLink(org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction tx,
                                 SalNode snode)
                          throws VTNException

Remove all VTN links affected by the the removed VTN node.

Parameters:

tx - A ReadWriteTransaction instance.

snode - A SalNode instance corresponding to the removed VTN node.

Throws:

VTNException - An error occurred.

removeVtnTopologyLink

public static void removeVtnTopologyLink(org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction tx,
                                         SalNode snode)
                                  throws VTNException

Remove all VTN links in vtn-topology affected by the removed VTN node.

Parameters:

tx - A ReadWriteTransaction instance.

snode - A SalNode instance corresponding to the removed VTN node.

Throws:

VTNException - An error occurred.

removeIgnoredLink

public static void removeIgnoredLink(org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction tx,
                                     SalNode snode)
                              throws VTNException

Remove all VTN links in ignored-links affected by the removed VTN node.

Parameters:

tx - A ReadWriteTransaction instance.

snode - A SalNode instance corresponding to the removed VTN node.

Throws:

VTNException - An error occurred.

removeVtnLink

public static void removeVtnLink(org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction tx,
                                 VtnPort vport)
                          throws VTNException

Remove all VTN links affected by the removed VTN port.

Note that this method does not remove port links configured in the given VTN port.

Parameters:

tx - A ReadWriteTransaction instance.

vport - A VtnPort instance corresponding to the removed VTN port.

Throws:

VTNException - An error occurred.

removePortLink

public static void removePortLink(org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction tx,
                                  SalPort sport,
                                  org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.LinkId lid)
                           throws VTNException

Remove the specified port link.

Parameters:

tx - A ReadWriteTransaction instance.

sport - A SalPort instance corresponding to a VTN port.

lid - A LinkId that specifies inter-switch link to be removed.

Throws:

VTNException - An error occurred.

clearPortLink

public static void clearPortLink(org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction tx,
                                 SalPort sport,
                                 VtnPort vport)
                          throws VTNException

Remove all the VTN links configured in the given VTN port.

Parameters:

tx - A ReadWriteTransaction instance.

sport - A SalPort instance which specifies the target VTN port.

vport - A VtnPort instance associated with sport.

Throws:

VTNException - An error occurred.