org.opendaylight.vtn.manager.internal.util.vnode

Class VTNPortMapConfig

java.lang.Object

org.opendaylight.vtn.manager.internal.util.vnode.VTNPortMapConfig

All Implemented Interfaces:

VtnSwitchPort, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject

public final class VTNPortMapConfig
extends Object
implements VtnSwitchPort

VTNPortMapConfig describes configuration information about a port mapping configured in a virtual interface.

Field Summary

Fields inherited from interface org.opendaylight.yang.gen.v1.urn.opendaylight.vtn.types.rev150209.VtnSwitchPort

QNAME

Constructor Summary

Constructors

Constructor and Description
VTNPortMapConfig(VtnPortMapConfig vpmc) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) Determine whether the given object is identical to this object.
Class<VtnSwitchPort>	getImplementedInterface() Return a class which indicates the data model type implemented by this instance.
PortVlan	getMappedVlan(SalPort mapped) Return a PortVlan instance that indicates the VLAN mapped by the port mapping.
String	getPortId() Return the target switch port identifier.
String	getPortName() Return the name of the target switch port.
SalNode	getTargetNode() Return the target switch identifier.
int	getVlanId() Return the VLAN ID to be mapped.
int	hashCode() Return the hash code of this object.
boolean	match(SalPort sport, VtnPort vport) Determine whether the given switch port satisfies the condition specified by this instance.
PortMapConfig	toPortMapConfig() Convert this instance into a PortMapConfig instance.
void	verify() Verify the contents of this instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

VTNPortMapConfig

public VTNPortMapConfig(VtnPortMapConfig vpmc)
                 throws RpcException

Construct a new instance.

Parameters:

vpmc - A VtnPortMapConfig instance.

Throws:

RpcException - vpmc contains invalid configuration.

Method Detail

getTargetNode

public SalNode getTargetNode()

Return the target switch identifier.

Returns:

A SalNode instance.

getVlanId

public int getVlanId()

Return the VLAN ID to be mapped.

Returns:

A VLAN ID.

verify

public void verify()
            throws RpcException

Verify the contents of this instance.

Throws:

RpcException - Verification failed.

toPortMapConfig

public PortMapConfig toPortMapConfig()

Convert this instance into a PortMapConfig instance.

Returns:

A PortMapConfig instance.

match

public boolean match(SalPort sport,
                     VtnPort vport)

Determine whether the given switch port satisfies the condition specified by this instance.

Parameters:

sport - A SalPort instance that specifies the physical switch port.

vport - A VtnPort instance that represents information about the switch port specified by sport.

Returns:

true only if the given switch port satisfies the condition.

getMappedVlan

public PortVlan getMappedVlan(SalPort mapped)

Return a PortVlan instance that indicates the VLAN mapped by the port mapping.

Parameters:

mapped - A SalPort instance that specifies the switch port mapped by the port mapping.

Returns:

A PortVlan instance if mapped is not null. null otherwise.

getImplementedInterface

public Class<VtnSwitchPort> getImplementedInterface()

Return a class which indicates the data model type implemented by this instance.

Specified by:

getImplementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer

Returns:

A class instance of VtnSwitchPort.

getPortName

public String getPortName()

Return the name of the target switch port.

Specified by:

getPortName in interface VtnSwitchPort

Returns:

A port name if configured. null if not configured.

getPortId

public String getPortId()

Return the target switch port identifier.

Specified by:

getPortId in interface VtnSwitchPort

Returns:

A port identifier if configured. null if not configured.

equals

public boolean equals(Object o)

Determine whether the given object is identical to this object.

Overrides:

equals in class Object

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 Object

Returns:

The hash code.