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

Class VTenantIdentifier

java.lang.Object

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

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

public final class VTenantIdentifier
extends VNodeIdentifier<Vtn>

VTenantIdentifier describes an identifier for a VTN.

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
VTenantIdentifier(VnodeName tname) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
static VTenantIdentifier	create(String tname, boolean find) Create a new identifier.
protected org.opendaylight.yangtools.yang.binding.InstanceIdentifier.InstanceIdentifierBuilder<VtnInputFilter>	getFlowFilterListIdentifierBuilder(boolean output) Return an instance identifier builder rooted at the specified container for the flow filter list.
org.opendaylight.yangtools.yang.binding.InstanceIdentifier.InstanceIdentifierBuilder<Vtn>	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.
VTenantIdentifier	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.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

VTenantIdentifier

public VTenantIdentifier(VnodeName tname)

Construct a new instance.

Parameters:

tname - The name of the VTN.

Method Detail

create

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

Create a new identifier.

Parameters:

tname - The name of the VTN.

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

Returns:

A VTenantIdentifier instance.

Throws:

RpcException - Invalid name is specified.

getType

public VNodeType getType()

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

Specified by:

getType in class VNodeIdentifier<Vtn>

Returns:

VNodeType.VTN.

getIdentifierBuilder

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

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

Specified by:

getIdentifierBuilder in class VNodeIdentifier<Vtn>

Returns:

An InstanceIdentifier.InstanceIdentifierBuilder instance.

getVNodeIdentifier

public VTenantIdentifier getVNodeIdentifier()

Return a VNodeIdentifier that specifies a virtual network element.

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

Specified by:

getVNodeIdentifier in class VNodeIdentifier<Vtn>

Returns:

This instance.

getFlowFilterListIdentifierBuilder

protected org.opendaylight.yangtools.yang.binding.InstanceIdentifier.InstanceIdentifierBuilder<VtnInputFilter> getFlowFilterListIdentifierBuilder(boolean output)

Return an instance identifier builder rooted at the specified container for the flow filter list.

Overrides:

getFlowFilterListIdentifierBuilder in class VNodeIdentifier<Vtn>

Parameters:

output - Always ignored because VTN has a flow filter list only for incoming packets.

Returns:

An instance identifier builder rooted at the specified container for the flow filter list.

newComponents

protected List<String> newComponents()

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

Specified by:

newComponents in class VNodeIdentifier<Vtn>

Returns:

A list of path components.