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

Class VBridgeIfIdentifier

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

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

public final class VBridgeIfIdentifier
extends VInterfaceIdentifier<Vbridge>

VBridgeIfIdentifier describes an identifier for a virtual interface attached to a vBridge.

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
VBridgeIfIdentifier(VBridgeIdentifier vbrId, VnodeName iname) Construct a new instance.
VBridgeIfIdentifier(VnodeName tname, VnodeName bname, VnodeName iname) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
static VBridgeIfIdentifier	create(String tname, String bname, String iname, boolean find) Create a new identifier.
VBridgeIdentifier	getBridgeIdentifier() Return an identifier for the vBridge that contains the virtual interface specified by this instance.
protected String	getBridgeName(VnodePathFields vpath) Return the vBridge 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.
VBridgeIfIdentifier	getVNodeIdentifier() Return a VNodeIdentifier that specifies a virtual network element.
VBridgeIfIdentifier	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 vBridge 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

VBridgeIfIdentifier

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

Construct a new instance.

Parameters:

tname - The name of the VTN.

bname - The name of the vBridge.

iname - The name of the virtual interface.

VBridgeIfIdentifier

public VBridgeIfIdentifier(VBridgeIdentifier vbrId,
                           VnodeName iname)

Construct a new instance.

Parameters:

vbrId - A VBridgeIdentifier instance that specifies the vBridge.

iname - The name of the virtual interface.

Method Detail

create

public static VBridgeIfIdentifier 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 vBridge.

iname - The name of the virtual interface.

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

Returns:

A VBridgeIfIdentifier instance.

Throws:

RpcException - Invalid name is specified.

replaceTenantName

public VBridgeIfIdentifier 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<Vbridge>

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

Returns:

A RedirectDestination instance.

getBridgeIdentifier

public VBridgeIdentifier getBridgeIdentifier()

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

Specified by:

getBridgeIdentifier in class TenantNodeIdentifier<Vinterface,Vbridge>

Returns:

A VBridgeIdentifier instance.

setBridgeName

protected VirtualNodePathBuilder setBridgeName(VirtualNodePathBuilder builder)

Set the vBridge name into the specified VirtualNodePathBuilder instance.

Specified by:

setBridgeName in class TenantNodeIdentifier<Vinterface,Vbridge>

Parameters:

builder - A VirtualNodePathBuilder instance.

Returns:

builder.

getBridgeName

protected String getBridgeName(VnodePathFields vpath)

Return the vBridge name configured in the given VnodePathFields instance.

Specified by:

getBridgeName in class TenantNodeIdentifier<Vinterface,Vbridge>

Parameters:

vpath - A VnodePathFields instance. null cannot be specified.

Returns:

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

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.VBRIDGE_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 VBridgeIfIdentifier 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.