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

Class VTerminalIdentifier

java.lang.Object

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

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

org.opendaylight.vtn.manager.internal.util.vnode.BridgeIdentifier<Vterminal>

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

public final class VTerminalIdentifier
extends BridgeIdentifier<Vterminal>

VTerminalIdentifier describes an identifier for a vTerminal.

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
VTerminalIdentifier(VNodeIdentifier<?> ident, VnodeName bname) Construct a new instance.
VTerminalIdentifier(VnodeName tname, VnodeName bname) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
VTerminalIfIdentifier	childInterface(VnodeName iname) Construct a new identifier for a virtual interface inside the vTerminal specified by this instance.
static VTerminalIdentifier	create(String tname, String bname, boolean find) Create a new identifier.
static VTerminalIdentifier	create(VterminalPathFields path, boolean find) Create a new identifier.
VTerminalIdentifier	getBridgeIdentifier() Return an identifier for the vTerminal.
protected String	getBridgeName(VnodePathFields vpath) Return the vTerminal name configured in the given VnodePathFields instance.
org.opendaylight.yangtools.yang.binding.InstanceIdentifier.InstanceIdentifierBuilder<Vterminal>	getIdentifierBuilder() Return an instance identifier builder rooted at the virtual node specified by this instance.
VNodeType	getType() Return a VNodeType instance which indicates the type of the virtual node.
VTerminalIdentifier	getVNodeIdentifier() Return a VNodeIdentifier that specifies a virtual network element.
protected List<String>	newComponents() Create a new list which contains all path components configured in this instance.
protected org.opendaylight.yangtools.yang.binding.InstanceIdentifier<BridgeStatus>	newStatusPath() Construct a new instance identifier for the virtual bridge status.
protected VirtualNodePathBuilder	setBridgeName(VirtualNodePathBuilder builder) Set the vTerminal name into the specified VirtualNodePathBuilder instance.

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

getStatusPath

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

contains, getVBridgeIdentifierBuilder, getVirtualNodePathBuilder, 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

VTerminalIdentifier

public VTerminalIdentifier(VnodeName tname,
                           VnodeName bname)

Construct a new instance.

Parameters:

tname - The name of the VTN.

bname - The name of the vTerminal.

VTerminalIdentifier

public VTerminalIdentifier(VNodeIdentifier<?> ident,
                           VnodeName bname)

Construct a new instance.

Parameters:

ident - A VNodeIdentifier instance that specifies the VTN.

bname - The name of the vTerminal.

Method Detail

create

public static VTerminalIdentifier create(String tname,
                                         String bname,
                                         boolean find)
                                  throws RpcException

Create a new identifier.

Parameters:

tname - The name of the VTN.

bname - The name of the vTerminal.

find - true indicates the given name is used for finding existing virtual node.

Returns:

A VTerminalIdentifier instance.

Throws:

RpcException - Invalid name is specified.

create

public static VTerminalIdentifier create(VterminalPathFields path,
                                         boolean find)
                                  throws RpcException

Create a new identifier.

Parameters:

path - A VterminalPathFields instance.

find - true indicates the given name is used for finding existing virtual node.

Returns:

A VTerminalIdentifier instance.

Throws:

RpcException - Invalid name is specified.

childInterface

public VTerminalIfIdentifier childInterface(VnodeName iname)

Construct a new identifier for a virtual interface inside the vTerminal specified by this instance.

Specified by:

childInterface in class BridgeIdentifier<Vterminal>

Parameters:

iname - The name of the virtual interface.

Returns:

A VTerminalIfIdentifier instance.

newStatusPath

protected org.opendaylight.yangtools.yang.binding.InstanceIdentifier<BridgeStatus> newStatusPath()

Construct a new instance identifier for the virtual bridge status.

Specified by:

newStatusPath in class BridgeIdentifier<Vterminal>

Returns:

An InstanceIdentifier instance for the virtual bridge status.

getBridgeIdentifier

public VTerminalIdentifier getBridgeIdentifier()

Return an identifier for the vTerminal.

Specified by:

getBridgeIdentifier in class TenantNodeIdentifier<Vterminal,Vterminal>

Returns:

This instance.

getBridgeName

protected String getBridgeName(VnodePathFields vpath)

Return the vTerminal name configured in the given VnodePathFields instance.

Specified by:

getBridgeName in class TenantNodeIdentifier<Vterminal,Vterminal>

Parameters:

vpath - A VnodePathFields instance. null cannot be specified.

Returns:

The name of the vTerminal configured in vpath. null if the vTerminal name is not configured in vpath.

setBridgeName

protected VirtualNodePathBuilder setBridgeName(VirtualNodePathBuilder builder)

Set the vTerminal name into the specified VirtualNodePathBuilder instance.

Specified by:

setBridgeName in class TenantNodeIdentifier<Vterminal,Vterminal>

Parameters:

builder - A VirtualNodePathBuilder instance.

Returns:

builder.

getType

public VNodeType getType()

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

Specified by:

getType in class VNodeIdentifier<Vterminal>

Returns:

VNodeType.VTERMINAL.

getIdentifierBuilder

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

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

Specified by:

getIdentifierBuilder in class VNodeIdentifier<Vterminal>

Returns:

An InstanceIdentifier.InstanceIdentifierBuilder instance.

getVNodeIdentifier

public VTerminalIdentifier getVNodeIdentifier()

Return a VNodeIdentifier that specifies a virtual network element.

This method always returns this instance because vTerminal is virtual network element.

Specified by:

getVNodeIdentifier in class VNodeIdentifier<Vterminal>

Returns:

This 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<Vterminal>

Returns:

A list of path components.