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

Class VBridgeIdentifier

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

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

public final class VBridgeIdentifier
extends BridgeIdentifier<Vbridge>

VBridgeIdentifier describes an identifier for 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
VBridgeIdentifier(VNodeIdentifier<?> ident, VnodeName bname) Construct a new instance.
VBridgeIdentifier(VnodeName tname, VnodeName bname) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
VBridgeIfIdentifier	childInterface(VnodeName iname) Construct a new identifier for a virtual interface inside the vBridge specified by this instance.
static VBridgeIdentifier	create(String tname, String bname, boolean find) Create a new identifier.
static VBridgeIdentifier	create(VbridgePathFields path, boolean find) Create a new identifier.
VBridgeIdentifier	getBridgeIdentifier() Return an identifier for the vBridge.
protected String	getBridgeName(VnodePathFields vpath) Return the vBridge name configured in the given VnodePathFields instance.
protected org.opendaylight.yangtools.yang.binding.InstanceIdentifier.InstanceIdentifierBuilder<? extends VtnFlowFilterList>	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<Vbridge>	getIdentifierBuilder() Return an instance identifier builder rooted at the virtual node specified by this instance.
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<MacTableEntry>	getMacEntryPath(BridgeIdentifier<Vbridge> ident, org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress mac) Create an instance identifier that specifies the MAC address table entry for the specified MAC address learned by the specified vBridge.
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<MacAddressTable>	getMacTablePath(BridgeIdentifier<Vbridge> ident) Create an instance identifier that specifies the MAC address table for the specified vBridge.
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<TenantMacTable>	getTenantMacTablePath(VNodeIdentifier<?> ident) Create an instance identifier that specifies the MAC address table list the specified VTN.
VNodeType	getType() Return a VNodeType instance which indicates the type of the virtual node.
VBridgeIdentifier	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 vBridge 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, 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

VBridgeIdentifier

public VBridgeIdentifier(VnodeName tname,
                         VnodeName bname)

Construct a new instance.

Parameters:

tname - The name of the VTN.

bname - The name of the vBridge.

VBridgeIdentifier

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

Construct a new instance.

Parameters:

ident - A VNodeIdentifier instance that specifies the VTN.

bname - The name of the vBridge.

Method Detail

create

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

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

Returns:

A VBridgeIdentifier instance.

Throws:

RpcException - Invalid name is specified.

create

public static VBridgeIdentifier create(VbridgePathFields path,
                                       boolean find)
                                throws RpcException

Create a new identifier.

Parameters:

path - A VbridgePathFields instance.

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

Returns:

A VBridgeIdentifier instance.

Throws:

RpcException - Invalid name is specified.

getTenantMacTablePath

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<TenantMacTable> getTenantMacTablePath(VNodeIdentifier<?> ident)

Create an instance identifier that specifies the MAC address table list the specified VTN.

Parameters:

ident - A virtual node identifier.

Returns:

An instance identifier that specifies the MAC address table list for the specified vBridge.

getMacTablePath

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<MacAddressTable> getMacTablePath(BridgeIdentifier<Vbridge> ident)

Create an instance identifier that specifies the MAC address table for the specified vBridge.

Parameters:

ident - An identifier for the vBridge.

Returns:

An instance identifier that specifies the MAC address table for the specified vBridge.

getMacEntryPath

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<MacTableEntry> getMacEntryPath(BridgeIdentifier<Vbridge> ident,
                                                                                                        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress mac)

Create an instance identifier that specifies the MAC address table entry for the specified MAC address learned by the specified vBridge.

Parameters:

ident - An identifier for the vBridge.

mac - A MAC adderss.

Returns:

An instance identifier that specifies the MAC address table entry.

childInterface

public VBridgeIfIdentifier childInterface(VnodeName iname)

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

Specified by:

childInterface in class BridgeIdentifier<Vbridge>

Parameters:

iname - The name of the virtual interface.

Returns:

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

Returns:

An InstanceIdentifier instance for the virtual bridge status.

getBridgeIdentifier

public VBridgeIdentifier getBridgeIdentifier()

Return an identifier for the vBridge.

Specified by:

getBridgeIdentifier in class TenantNodeIdentifier<Vbridge,Vbridge>

Returns:

This instance.

getBridgeName

protected String getBridgeName(VnodePathFields vpath)

Return the vBridge name configured in the given VnodePathFields instance.

Specified by:

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

setBridgeName

protected VirtualNodePathBuilder setBridgeName(VirtualNodePathBuilder builder)

Set the vBridge name into the specified VirtualNodePathBuilder instance.

Specified by:

setBridgeName in class TenantNodeIdentifier<Vbridge,Vbridge>

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

Returns:

VNodeType.VBRIDGE.

getIdentifierBuilder

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

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

Specified by:

getIdentifierBuilder in class VNodeIdentifier<Vbridge>

Returns:

An InstanceIdentifier.InstanceIdentifierBuilder instance.

getVNodeIdentifier

public VBridgeIdentifier getVNodeIdentifier()

Return a VNodeIdentifier that specifies a virtual network element.

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

Specified by:

getVNodeIdentifier in class VNodeIdentifier<Vbridge>

Returns:

This instance.

getFlowFilterListIdentifierBuilder

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

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

Overrides:

getFlowFilterListIdentifierBuilder in class VNodeIdentifier<Vbridge>

Parameters:

output - true indicates the output filter list. false indicates the input filter list.

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

Returns:

A list of path components.