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

Class TenantNodeIdentifier<T extends org.opendaylight.yangtools.yang.binding.DataObject,B extends VtnPortMappableBridge>

java.lang.Object

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

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

Type Parameters:

T - The type of the target data model.

B - The type of the virtual bridge.

Direct Known Subclasses:

BridgeIdentifier, VBridgeMapIdentifier, VInterfaceIdentifier

public abstract class TenantNodeIdentifier<T extends org.opendaylight.yangtools.yang.binding.DataObject,B extends VtnPortMappableBridge>
extends VNodeIdentifier<T>

TenantNodeIdentifier describes an identifier for a virtual node inside VTN, such as vBridge and virtual interface.

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

Method Summary

Modifier and Type	Method and Description
boolean	contains(VirtualNodePath vpath) Determine whether the virtua node specified by this instance contains the virtual node specified by VirtualNodePath instance.
abstract BridgeIdentifier<B>	getBridgeIdentifier() Return an identifier for the virtual bridge that contains the data object specified by this instance.
protected abstract String	getBridgeName(VnodePathFields vpath) Return the virtual bridge name configured in the given VnodePathFields instance.
protected org.opendaylight.yangtools.yang.binding.InstanceIdentifier.InstanceIdentifierBuilder<Vbridge>	getVBridgeIdentifierBuilder() Return an instance identifier builder which contains the key of the vBridge.
protected VirtualNodePathBuilder	getVirtualNodePathBuilder() Create a new VirtualNodePathBuilder instance that contains the path components configured in this instance.
protected org.opendaylight.yangtools.yang.binding.InstanceIdentifier.InstanceIdentifierBuilder<Vterminal>	getVTerminalIdentifierBuilder() Return an instance identifier builder which contains the key of the vTerminal.
protected abstract VirtualNodePathBuilder	setBridgeName(VirtualNodePathBuilder builder) Set the virtual bridge name into the specified VirtualNodePathBuilder instance.

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, getIdentifierBuilder, getInterfaceName, getInterfaceNameString, getNotFoundException, getTenantName, getTenantNameString, getType, getVirtualNodePath, getVNodeIdentifier, getVtnIdentifierBuilder, hashCode, newComponents, read, readVtenantConfig, toString

Methods inherited from class java.lang.Object

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

Method Detail

getBridgeIdentifier

public abstract BridgeIdentifier<B> getBridgeIdentifier()

Return an identifier for the virtual bridge that contains the data object specified by this instance.

Returns:

An identifier for the virtual bridge.

getBridgeName

protected abstract String getBridgeName(VnodePathFields vpath)

Return the virtual bridge name configured in the given VnodePathFields instance.

Parameters:

vpath - A VnodePathFields instance. null cannot be specified.

Returns:

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

setBridgeName

protected abstract VirtualNodePathBuilder setBridgeName(VirtualNodePathBuilder builder)

Set the virtual bridge name into the specified VirtualNodePathBuilder instance.

Parameters:

builder - A VirtualNodePathBuilder instance.

Returns:

builder.

getVBridgeIdentifierBuilder

protected final org.opendaylight.yangtools.yang.binding.InstanceIdentifier.InstanceIdentifierBuilder<Vbridge> getVBridgeIdentifierBuilder()

Return an instance identifier builder which contains the key of the vBridge.

Returns:

An instance identifier builder.

getVTerminalIdentifierBuilder

protected final org.opendaylight.yangtools.yang.binding.InstanceIdentifier.InstanceIdentifierBuilder<Vterminal> getVTerminalIdentifierBuilder()

Return an instance identifier builder which contains the key of the vTerminal.

Returns:

An instance identifier builder.

contains

public boolean contains(VirtualNodePath vpath)

Determine whether the virtua node specified by this instance contains the virtual node specified by VirtualNodePath instance.

This method in this class checks only the VTN and virtual bridge name. Subclass may override this method.

Overrides:

contains in class VNodeIdentifier<T extends org.opendaylight.yangtools.yang.binding.DataObject>

Parameters:

vpath - A VirtualNodePath instance that specifies the virtual node. null cannot be specified.

Returns:

true if the virtual node specified by this instance contains the virtual node specified by vpath. false otherwise.

getVirtualNodePathBuilder

protected VirtualNodePathBuilder getVirtualNodePathBuilder()

Create a new VirtualNodePathBuilder instance that contains the path components configured in this instance.

This method in this class sets only the VTN and virtual bridge name. Subclass may override this method.

Overrides:

getVirtualNodePathBuilder in class VNodeIdentifier<T extends org.opendaylight.yangtools.yang.binding.DataObject>

Returns:

A VirtualNodePathBuilder instance.