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

Class VTerminalIfIdentifier

java.lang.Object

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

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

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

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

public final class VTerminalIfIdentifier
extends VInterfaceIdentifier<Vterminal>

VTerminalIfIdentifier describes an identifier for a virtual interface attached to a vTerminal.

Field Summary

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

DESCRIPTION

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
VTerminalIfIdentifier(VnodeName tname, VnodeName bname, VnodeName iname) Construct a new instance.
VTerminalIfIdentifier(VTerminalIdentifier vtmId, VnodeName iname) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
static VTerminalIfIdentifier	create(String tname, String bname, String iname, boolean find) Create a new identifier.
VTerminalIdentifier	getBridgeIdentifier() Return an identifier for the vTerminal that contains the virtual interface specified by this instance.
protected String	getBridgeName(VnodePathFields vpath) Return the vTerminal name configured in the given VnodePathFields instance.
org.opendaylight.yangtools.yang.binding.InstanceIdentifier.InstanceIdentifierBuilder<Vinterface>	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.
VTerminalIfIdentifier	getVNodeIdentifier() Return a VNodeIdentifier that specifies a virtual network element.
VTerminalIfIdentifier	replaceTenantName(VnodeName tname) Create a shallow copy of this instance, and replace the VTN name with the given name.
protected VirtualNodePathBuilder	setBridgeName(VirtualNodePathBuilder builder) Set the vTerminal name into the specified VirtualNodePathBuilder instance.
RedirectDestination	toRedirectDestination() Convert this instance into a RedirectDestination instance.

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

checkName, contains, create, getFlowFilterListIdentifierBuilder, getNoRedirectDestinationException, getStatusPath, getVirtualNodePathBuilder, newComponents

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, 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

VTerminalIfIdentifier

public VTerminalIfIdentifier(VnodeName tname,
                             VnodeName bname,
                             VnodeName iname)

Construct a new instance.

Parameters:

tname - The name of the VTN.

bname - The name of the vTerminal.

iname - The name of the virtual interface.

VTerminalIfIdentifier

public VTerminalIfIdentifier(VTerminalIdentifier vtmId,
                             VnodeName iname)

Construct a new instance.

Parameters:

vtmId - A VTerminalIdentifier instance that specifies the vTerminal.

iname - The name of the virtual interface.

Method Detail

create

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

Create a new identifier.

Parameters:

tname - The name of the VTN.

bname - The name of the vTerminal.

iname - The name of the virtual interface.

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

Returns:

A VTerminalIfIdentifier instance.

Throws:

RpcException - Invalid name is specified.

replaceTenantName

public VTerminalIfIdentifier replaceTenantName(VnodeName tname)

Create a shallow copy of this instance, and replace the VTN name with the given name.

Specified by:

replaceTenantName in class VInterfaceIdentifier<Vterminal>

Parameters:

tname - The VTN name to be configured into a new instance.

Returns:

A constructed instance.

toRedirectDestination

public RedirectDestination toRedirectDestination()

Convert this instance into a RedirectDestination instance.

Specified by:

toRedirectDestination in class VInterfaceIdentifier<Vterminal>

Returns:

A RedirectDestination instance.

getBridgeIdentifier

public VTerminalIdentifier getBridgeIdentifier()

Return an identifier for the vTerminal that contains the virtual interface specified by this instance.

Specified by:

getBridgeIdentifier in class TenantNodeIdentifier<Vinterface,Vterminal>

Returns:

A VTerminalIdentifier instance.

getBridgeName

protected String getBridgeName(VnodePathFields vpath)

Return the vTerminal name configured in the given VnodePathFields instance.

Specified by:

getBridgeName in class TenantNodeIdentifier<Vinterface,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<Vinterface,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<Vinterface>

Returns:

VNodeType.VTERMINAL_IF.

getIdentifierBuilder

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

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

Specified by:

getIdentifierBuilder in class VNodeIdentifier<Vinterface>

Returns:

An InstanceIdentifier.InstanceIdentifierBuilder instance.

getVNodeIdentifier

public VTerminalIfIdentifier getVNodeIdentifier()

Return a VNodeIdentifier that specifies a virtual network element.

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

Specified by:

getVNodeIdentifier in class VNodeIdentifier<Vinterface>

Returns:

This instance.