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

Class VlanMapIdentifier

java.lang.Object

org.opendaylight.vtn.manager.internal.util.vnode.VNodeIdentifier<T>

org.opendaylight.vtn.manager.internal.util.vnode.TenantNodeIdentifier<T,Vbridge>

org.opendaylight.vtn.manager.internal.util.vnode.VBridgeMapIdentifier<VlanMap>

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

public final class VlanMapIdentifier
extends VBridgeMapIdentifier<VlanMap>

VlanMapIdentifier describes an identifier for a VLAN mapping configured in a vBridge.

Field Summary

Fields inherited from class org.opendaylight.vtn.manager.internal.util.vnode.VNodeIdentifier

TYPEBIT_MACMAP, TYPEBIT_MACMAP_HOST, TYPEBIT_VBRIDGE, TYPEBIT_VINTERFACE, TYPEBIT_VLANMAP, TYPEBIT_VTERMINAL, TYPEBIT_VTN

Constructor Summary

Constructors

Constructor and Description
VlanMapIdentifier(BridgeIdentifier<Vbridge> vbrId, String id) Construct a new instance.
VlanMapIdentifier(VnodeName tname, VnodeName bname, String id) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
boolean	contains(VirtualNodePath vpath) Determine whether the VLAN mapping specified by this instance is equal to the VLAN mapping specified by VirtualNodePath instance.
static VlanMapIdentifier	create(String tname, String bname, String id) Create a new identifier.
protected BridgeMapInfo	getBridgeMapInfo() Return a BridgeMapInfo instance that indicates the VLAN mapping specified by this instance.
org.opendaylight.yangtools.yang.binding.InstanceIdentifier.InstanceIdentifierBuilder<VlanMap>	getIdentifierBuilder() Return an instance identifier builder rooted at the virtual node specified by this instance.
String	getMapId() Return an identifier assigned to the VLAN mapping.
org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VlanMapStatus>	getStatusPath() Return the path to the VLAN mapping status.
VNodeType	getType() Return a VNodeType instance which indicates the type of the virtual node.
protected List<String>	newComponents() Create a new list which contains all path components configured in this instance.

Methods inherited from class org.opendaylight.vtn.manager.internal.util.vnode.VBridgeMapIdentifier

getBridgeIdentifier, getBridgeName, getVirtualNodePathBuilder, getVNodeIdentifier, setBridgeName

Methods inherited from class org.opendaylight.vtn.manager.internal.util.vnode.TenantNodeIdentifier

getVBridgeIdentifierBuilder, getVTerminalIdentifierBuilder

Methods inherited from class org.opendaylight.vtn.manager.internal.util.vnode.VNodeIdentifier

clearFlowFilter, contains, create, create, create, equals, fetch, getBadPathException, getBridgeName, getBridgeNameString, getComponents, getDataExistsException, getFlowFilterIdentifier, getFlowFilterListIdentifierBuilder, getFlowFilterUnsupportedException, getIdentifier, getInterfaceName, getInterfaceNameString, getNotFoundException, getTenantName, getTenantNameString, getVirtualNodePath, getVtnIdentifierBuilder, hashCode, read, readVtenantConfig, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

VlanMapIdentifier

public VlanMapIdentifier(VnodeName tname,
                         VnodeName bname,
                         String id)

Construct a new instance.

Parameters:

tname - The name of the VTN.

bname - The name of the vBridge.

id - The identifier assigned to the VLAN mapping.

VlanMapIdentifier

public VlanMapIdentifier(BridgeIdentifier<Vbridge> vbrId,
                         String id)

Construct a new instance.

Parameters:

vbrId - A BridgeIdentifier instance that specifies the vBridge.

id - The identifier assigned to the VLAN mapping.

Method Detail

create

public static VlanMapIdentifier create(String tname,
                                       String bname,
                                       String id)
                                throws RpcException

Create a new identifier.

Parameters:

tname - The name of the VTN.

bname - The name of the vBridge.

id - The identifier assigned to the VLAN mapping.

Returns:

A VBridgeIdentifier instance.

Throws:

RpcException - Invalid name is specified.

getMapId

public String getMapId()

Return an identifier assigned to the VLAN mapping.

Returns:

A VLAN mapping identifier.

getStatusPath

public org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VlanMapStatus> getStatusPath()

Return the path to the VLAN mapping status.

Returns:

An InstanceIdentifier instance for the VLAN mapping status.

getType

public VNodeType getType()

Return a VNodeType instance which indicates the type of the virtual node.

Specified by:

getType in class VNodeIdentifier<VlanMap>

Returns:

VNodeType.VLANMAP.

getIdentifierBuilder

public org.opendaylight.yangtools.yang.binding.InstanceIdentifier.InstanceIdentifierBuilder<VlanMap> getIdentifierBuilder()

Return an instance identifier builder rooted at the virtual node specified by this instance.

Specified by:

getIdentifierBuilder in class VNodeIdentifier<VlanMap>

Returns:

An InstanceIdentifier.InstanceIdentifierBuilder instance.

newComponents

protected List<String> newComponents()

Create a new list which contains all path components configured in this instance.

Specified by:

newComponents in class VNodeIdentifier<VlanMap>

Returns:

A list of path components.

contains

public boolean contains(VirtualNodePath vpath)

Determine whether the VLAN mapping specified by this instance is equal to the VLAN mapping specified by VirtualNodePath instance.

Overrides:

contains in class TenantNodeIdentifier<VlanMap,Vbridge>

Parameters:

vpath - A VirtualNodePath instance that specifies the virtual node. null cannot be specified.

Returns:

true if the VLAN mapping specified by this instance is equal to the VLAN mapping specified by vpath. false otherwise.

getBridgeMapInfo

protected BridgeMapInfo getBridgeMapInfo()

Return a BridgeMapInfo instance that indicates the VLAN mapping specified by this instance.

Specified by:

getBridgeMapInfo in class VBridgeMapIdentifier<VlanMap>

Returns:

A BridgeMapInfo instance.