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

Class SalPort

java.lang.Object

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

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

public final class SalPort
extends SalNode

This class represents SAL node connector identifier corresponding to physical port in OpenFlow switch.

Field Summary

Fields inherited from class org.opendaylight.vtn.manager.internal.util.inventory.SalNode

MD_ID_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
SalPort(long nodeId, long portId) Construct a new instance.
SalPort(long nodeId, long portId, String str) Construct a new instance with specifying a string representation of this instance.

Method Summary

Modifier and Type	Method and Description
static SalPort	create(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.link.attributes.Destination dst) Convert a link termination point within destination node into a SalPort instance.
static SalPort	create(long nodeId, String portId) Create a SalPort instance from the given pair of node and port identifier.
static SalPort	create(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId id) Convert a MD-SAL node connector ID into a SalPort instance.
static SalPort	create(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorRef ref) Convert a MD-SAL node connector reference into a SalPort instance.
static SalPort	create(SalNode snode, org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId id) Convert a MD-SAL node connector ID into a SalPort instance.
static SalPort	create(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.link.attributes.Source src) Convert a link termination point within source node into a SalPort instance.
static SalPort	create(String id) Convert a string representation of MD-SAL node connector ID into a SalPort instance.
static SalPort	create(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TpId tpId) Convert a link termination point into a SalPort instance.
static SalPort	create(VtnPortLocation vpl) Convert the given VtnPortLocation instance into a SalPort instance.
boolean	equals(Object o) Determine whether the given object is identical to this object.
boolean	equalsPort(SalPort sport) Determine whether the given port is identical to this instance or not.
org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId	getNodeConnectorId() Return a NodeConnectorId instance corresponding to this instance.
org.opendaylight.yangtools.yang.binding.InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnector>	getNodeConnectorIdentifier() Return an instance identifier that specifies MD-SAL node instance.
org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorKey	getNodeConnectorKey() Return a NodeConnectorKey instance corresponding to this instance.
org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorRef	getNodeConnectorRef() Return a NodeConnectorRef instance corresponding to this instance.
org.opendaylight.yangtools.yang.binding.InstanceIdentifier<PortLink>	getPortLinkIdentifier(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.LinkId linkId) Return an instance identifier that specifies a link connected to the switch port corresponding to this instance.
long	getPortNumber() Return a port number.
SalNode	getSalNode() Return a new SalNode instance which represents the location of the swtich to which this switch port belongs.
org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VtnPort>	getVtnPortIdentifier() Return an instance identifier that specifies VTN port instance.
VtnPortKey	getVtnPortKey() Return a VtnPortKey instance corresponding to this instance.
int	hashCode() Return the hash code of this object.
static boolean	isLogicalPort(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId id) Determine whether the given MD-SAL node connector ID indicates a logical port of OpenFlow switch or not.
String	toNodeString() Return a string which identifies the switch corresponding to this instance.
protected StringBuilder	toStringBuilder() Return a StringBuilder instance that contains a string representation of this instance.

Methods inherited from class org.opendaylight.vtn.manager.internal.util.inventory.SalNode

checkedCreate, checkedCreate, create, create, create, equalsNode, getFlowIdentifier, getFlowNodeIdentifier, getFlowTableIdentifier, getNodeId, getNodeIdentifier, getNodeIdentifierBuilder, getNodeKey, getNodeNumber, getNodeRef, getVtnNodeIdentifier, getVtnNodeIdentifierBuilder, getVtnNodeKey, toNodeStringBuilder, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SalPort

public SalPort(long nodeId,
               long portId)

Construct a new instance.

Parameters:

nodeId - A node identifier.

portId - A port identifier.

SalPort

public SalPort(long nodeId,
               long portId,
               String str)

Construct a new instance with specifying a string representation of this instance.

Parameters:

nodeId - A node identifier.

portId - A port identifier.

str - A string representation of this instance.

Method Detail

isLogicalPort

public static boolean isLogicalPort(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId id)

Determine whether the given MD-SAL node connector ID indicates a logical port of OpenFlow switch or not.

Parameters:

id - A NodeConnectorId instance.

Returns:

true if the given ID indicates a logical port of OpenFlow switch. Otherwise false.

create

public static SalPort create(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId id)

Convert a MD-SAL node connector ID into a SalPort instance.

Parameters:

id - A NodeConnectorId instance.

Returns:

A SalPort instance on success. null on failure.

create

public static SalPort create(SalNode snode,
                             org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId id)

Convert a MD-SAL node connector ID into a SalPort instance.

Parameters:

snode - A SalNode instance that specifies the node. This parameter is used only if id does not contain node ID.

id - A NodeConnectorId instance.

Returns:

A SalPort instance on success. null on failure.

create

public static SalPort create(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorRef ref)

Convert a MD-SAL node connector reference into a SalPort instance.

Parameters:

ref - A NodeConnectorRef instance.

Returns:

A SalPort instance on success. null on failure.

create

public static SalPort create(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.link.attributes.Source src)

Convert a link termination point within source node into a SalPort instance.

Parameters:

src - A Source instance.

Returns:

A SalPort instance on success. null on failure.

create

public static SalPort create(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.link.attributes.Destination dst)

Convert a link termination point within destination node into a SalPort instance.

Parameters:

dst - A Destination instance.

Returns:

A SalPort instance on success. null on failure.

create

public static SalPort create(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TpId tpId)

Convert a link termination point into a SalPort instance.

Parameters:

tpId - A TpId instance.

Returns:

A SalPort instance on success. null on failure.

create

public static SalPort create(String id)

Convert a string representation of MD-SAL node connector ID into a SalPort instance.

Parameters:

id - A string representation of MD-SAL node connector ID.

Returns:

A SalPort instance on success. null on failure.

create

public static SalPort create(long nodeId,
                             String portId)

Create a SalPort instance from the given pair of node and port identifier.

Parameters:

nodeId - A node identifier.

portId - A string representation of the port number.

Returns:

A SalPort instance on success. null on failure.

create

public static SalPort create(VtnPortLocation vpl)

Convert the given VtnPortLocation instance into a SalPort instance.

Parameters:

vpl - A VtnPortLocation instance.

Returns:

A SalPort instance on success. null on failure.

getPortNumber

public long getPortNumber()

Return a port number.

Returns:

A port number.

getSalNode

public SalNode getSalNode()

Return a new SalNode instance which represents the location of the swtich to which this switch port belongs.

Returns:

A SalNode instance.

getNodeConnectorId

public org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId getNodeConnectorId()

Return a NodeConnectorId instance corresponding to this instance.

Returns:

A NodeConnectorId instance.

getNodeConnectorKey

public org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorKey getNodeConnectorKey()

Return a NodeConnectorKey instance corresponding to this instance.

Returns:

A NodeConnectorKey instance.

getNodeConnectorRef

public org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorRef getNodeConnectorRef()

Return a NodeConnectorRef instance corresponding to this instance.

Returns:

An NodeConnectorRef instance.

getNodeConnectorIdentifier

public org.opendaylight.yangtools.yang.binding.InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnector> getNodeConnectorIdentifier()

Return an instance identifier that specifies MD-SAL node instance.

Returns:

An InstanceIdentifier instance.

getVtnPortKey

public VtnPortKey getVtnPortKey()

Return a VtnPortKey instance corresponding to this instance.

Returns:

A VtnPortKey instance.

getVtnPortIdentifier

public org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VtnPort> getVtnPortIdentifier()

Return an instance identifier that specifies VTN port instance.

Returns:

An InstanceIdentifier instance.

getPortLinkIdentifier

public org.opendaylight.yangtools.yang.binding.InstanceIdentifier<PortLink> getPortLinkIdentifier(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.LinkId linkId)

Return an instance identifier that specifies a link connected to the switch port corresponding to this instance.

Parameters:

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

Returns:

An InstanceIdentifier instance.

equalsPort

public boolean equalsPort(SalPort sport)

Determine whether the given port is identical to this instance or not.

Parameters:

sport - A SalPort instance to be compared.

Returns:

true only if the given port is identical to this instance.

toNodeString

public String toNodeString()

Return a string which identifies the switch corresponding to this instance.

Overrides:

toNodeString in class SalNode

Returns:

A string which identifies the switch.

toStringBuilder

protected StringBuilder toStringBuilder()

Return a StringBuilder instance that contains a string representation of this instance.

Overrides:

toStringBuilder in class SalNode

Returns:

A StringBuilder instance.

equals

public boolean equals(Object o)

Determine whether the given object is identical to this object.

Overrides:

equals in class SalNode

Parameters:

o - An object to be compared.

Returns:

true if identical. Otherwise false.

hashCode

public int hashCode()

Return the hash code of this object.

Overrides:

hashCode in class SalNode

Returns:

The hash code.