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

Class VInterfaceIdentifier<B extends VtnPortMappableBridge>

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

Type Parameters:

B - The type of the virtual bridge.

Direct Known Subclasses:

VBridgeIfIdentifier, VTerminalIfIdentifier

public abstract class VInterfaceIdentifier<B extends VtnPortMappableBridge>
extends TenantNodeIdentifier<Vinterface,B>

VInterfaceIdentifier describes an identifier for a virtual interface which can have port mapping configuration.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DESCRIPTION A brief description about virtual interface.

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
static VnodeName	checkName(String name) Verify the name of the virtual interface.
boolean	contains(VirtualNodePath vpath) Determine whether the virtua interface specified by this instance is equal to the virtual interface specified by VirtualNodePath instance.
static VInterfaceIdentifier<?>	create(RedirectDestination rdest) Create a new virtual interface identifier which specifies the destination of the redirection flow filter.
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.
static RpcException	getNoRedirectDestinationException() Return an exception that indicates the destination of redirect flow filter is missing.
org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VinterfaceStatus>	getStatusPath() Return the path to the virtual interface status.
protected VirtualNodePathBuilder	getVirtualNodePathBuilder() Create a new VirtualNodePathBuilder instance that contains the path components configured in this instance.
protected List<String>	newComponents() Create a new list which contains all path components configured in this instance.
abstract VInterfaceIdentifier	replaceTenantName(VnodeName tname) Create a shallow copy of this instance, and replace the VTN name with the given name.
abstract RedirectDestination	toRedirectDestination() Convert this instance into a RedirectDestination instance.

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

getBridgeIdentifier, getBridgeName, getVBridgeIdentifierBuilder, getVTerminalIdentifierBuilder, setBridgeName

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

Methods inherited from class java.lang.Object

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

Field Detail

DESCRIPTION

public static final String DESCRIPTION

A brief description about virtual interface.

See Also:

Constant Field Values

Method Detail

checkName

public static final VnodeName checkName(String name)
                                 throws RpcException

Verify the name of the virtual interface.

Parameters:

name - The name of the virtual interface.

Returns:

A VnodeName instance that contains the given name.

Throws:

RpcException - The given name is invalid.

getNoRedirectDestinationException

public static final RpcException getNoRedirectDestinationException()

Return an exception that indicates the destination of redirect flow filter is missing.

Returns:

A RpcException instance.

create

public static final VInterfaceIdentifier<?> create(RedirectDestination rdest)
                                            throws RpcException

Create a new virtual interface identifier which specifies the destination of the redirection flow filter.

Parameters:

rdest - A RedirectDestination instance.

Returns:

A VInterfaceIdentifier instance.

Throws:

RpcException - The given instance contains invalid configuration.

getStatusPath

public final org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VinterfaceStatus> getStatusPath()

Return the path to the virtual interface status.

Returns:

An InstanceIdentifier instance for the virtual interface status.

replaceTenantName

public abstract VInterfaceIdentifier replaceTenantName(VnodeName tname)

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

Parameters:

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

Returns:

A constructed instance.

toRedirectDestination

public abstract RedirectDestination toRedirectDestination()

Convert this instance into a RedirectDestination instance.

Returns:

A RedirectDestination instance.

contains

public final boolean contains(VirtualNodePath vpath)

Determine whether the virtua interface specified by this instance is equal to the virtual interface specified by VirtualNodePath instance.

Overrides:

contains in class TenantNodeIdentifier<Vinterface,B extends VtnPortMappableBridge>

Parameters:

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

Returns:

true if vpath specifies the same virtual interface as specified by this instance. false otherwise.

getVirtualNodePathBuilder

protected final 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 TenantNodeIdentifier<Vinterface,B extends VtnPortMappableBridge>

Returns:

A VirtualNodePathBuilder 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<Vinterface>

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 final List<String> newComponents()

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

Specified by:

newComponents in class VNodeIdentifier<Vinterface>

Returns:

A list of path components.