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

Class VNodeIdentifier<T extends org.opendaylight.yangtools.yang.binding.DataObject>

java.lang.Object

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

Type Parameters:

T - The type of the target data model.

Direct Known Subclasses:

TenantNodeIdentifier, VTenantIdentifier

public abstract class VNodeIdentifier<T extends org.opendaylight.yangtools.yang.binding.DataObject>
extends Object

VNodeIdentifier describes an identifier for the virtual node.

Field Summary

Fields

Modifier and Type	Field and Description
static int	TYPEBIT_MACMAP A bit which indicates a MAC mapping configured in a vBridge.
static int	TYPEBIT_MACMAP_HOST A bit which indicates a host mapped by a MAC mapping configured in a vBridge.
static int	TYPEBIT_VBRIDGE A bit which indicates a vBridge or a virtual node inside vBridge.
static int	TYPEBIT_VINTERFACE A bit which indicates a virtual interface.
static int	TYPEBIT_VLANMAP A bit which indicates a VLAN mapping configured in a vBridge.
static int	TYPEBIT_VTERMINAL A bit which indicates a vTerminal or a virtual node inside vTerminal.
static int	TYPEBIT_VTN A bit which indicates a VTN or a virtual node inside VTN.

Method Summary

Modifier and Type	Method and Description
List<FlowFilterResult>	clearFlowFilter(org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction tx, boolean output) Delete all the flow filters in the specified flow filter list.
boolean	contains(VirtualNodePath vpath) Determine whether the virtua node specified by this instance contains the virtual node specified by VirtualNodePath instance.
boolean	contains(VNodeIdentifier<?> ident) Determine whether the data model associated with this instance contains the data model specified by the given instance.
static VNodeIdentifier<?>	create(String str) Construct a new instance from a string representation of VNodeIdentifier instance.
static <T extends VNodeIdentifier<?>> T	create(String str, Class<T> type) Construct a new instance from a string representation of VNodeIdentifier instance with type checking.
static VNodeIdentifier<?>	create(VnodePathFields vpath, boolean find) Construct a new instance from the given VnodePathFields instance.
boolean	equals(Object o) Determine whether the given object is identical to this object.
T	fetch(org.opendaylight.controller.md.sal.binding.api.ReadTransaction rtx) Read the data object specified by this instance.
static RpcException	getBadPathException(Object o) Return an exception that notifies an invalid virtual node path.
VnodeName	getBridgeName() Return the name of the virtual bridge configured in this instance.
String	getBridgeNameString() Return the name of the virtual bridge configured in this instance.
List<String>	getComponents() Return a list which contains all path components configured in this instance.
RpcException	getDataExistsException() Return an exception that indicates the virtual node specified by this instance is already present.
org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VtnFlowFilter>	getFlowFilterIdentifier(boolean output, Integer index) Return an instance identifier that specifies a 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	getFlowFilterUnsupportedException(VNodeIdentifier<?> ident) Return an exception that indicates the virtual node does not support flow filter.
org.opendaylight.yangtools.yang.binding.InstanceIdentifier<T>	getIdentifier() Return an indentifier for the MD-SAL data model associated with this instance.
abstract org.opendaylight.yangtools.yang.binding.InstanceIdentifier.InstanceIdentifierBuilder<T>	getIdentifierBuilder() Return an instance identifier builder rooted at the virtual node specified by this instance.
VnodeName	getInterfaceName() Return the name of the virtual interface configured in this instance.
String	getInterfaceNameString() Return the name of the virtual interface configured in this instance.
RpcException	getNotFoundException() Return an exception that indicates the virtual node specified by this instance is not present.
VnodeName	getTenantName() Return the name of the VTN configured in this instance.
String	getTenantNameString() Return the name of the VTN configured in this instance.
abstract VNodeType	getType() Return a VNodeType instance which indicates the type of the virtual node.
VirtualNodePath	getVirtualNodePath() Return a VirtualNodePath instance that specifies the same virtual node as this instance.
protected VirtualNodePathBuilder	getVirtualNodePathBuilder() Create a new VirtualNodePathBuilder instance that contains the path components configured in this instance.
abstract VNodeIdentifier<?>	getVNodeIdentifier() Return a VNodeIdentifier that specifies a virtual network element.
protected org.opendaylight.yangtools.yang.binding.InstanceIdentifier.InstanceIdentifierBuilder<Vtn>	getVtnIdentifierBuilder() Return an instance identifier builder which contains the VTN key.
int	hashCode() Return the hash code of this object.
protected abstract List<String>	newComponents() Create a new list which contains all path components configured in this instance.
com.google.common.base.Optional<T>	read(org.opendaylight.controller.md.sal.binding.api.ReadTransaction rtx) Read the data object specified by this instance.
com.google.common.base.Optional<VtenantConfig>	readVtenantConfig(org.opendaylight.controller.md.sal.binding.api.ReadTransaction rtx) Read the configuration for the VTN specified by this instance.
String	toString() Return a string representation of this instance.

Methods inherited from class java.lang.Object

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

Field Detail

TYPEBIT_VTN

public static final int TYPEBIT_VTN

A bit which indicates a VTN or a virtual node inside VTN.

See Also:

Constant Field Values

TYPEBIT_VBRIDGE

public static final int TYPEBIT_VBRIDGE

A bit which indicates a vBridge or a virtual node inside vBridge.

See Also:

Constant Field Values

TYPEBIT_VTERMINAL

public static final int TYPEBIT_VTERMINAL

A bit which indicates a vTerminal or a virtual node inside vTerminal.

See Also:

Constant Field Values

TYPEBIT_VINTERFACE

public static final int TYPEBIT_VINTERFACE

A bit which indicates a virtual interface.

See Also:

Constant Field Values

TYPEBIT_VLANMAP

public static final int TYPEBIT_VLANMAP

A bit which indicates a VLAN mapping configured in a vBridge.

See Also:

Constant Field Values

TYPEBIT_MACMAP

public static final int TYPEBIT_MACMAP

A bit which indicates a MAC mapping configured in a vBridge.

See Also:

Constant Field Values

TYPEBIT_MACMAP_HOST

public static final int TYPEBIT_MACMAP_HOST

A bit which indicates a host mapped by a MAC mapping configured in a vBridge.

See Also:

Constant Field Values

Method Detail

create

public static final VNodeIdentifier<?> create(String str)

Construct a new instance from a string representation of VNodeIdentifier instance.

Parameters:

str - A string representation of VNodeIdentifier instance returned by the call of toString().

Returns:

A VNodeIdentifier instance. Note that null is returned if str is null.

Throws:

IllegalArgumentException - An invalid string is passed to str.

create

public static final <T extends VNodeIdentifier<?>> T create(String str,
                                                            Class<T> type)

Construct a new instance from a string representation of VNodeIdentifier instance with type checking.

Type Parameters:

T - The type of VNodeIdentifier.

Parameters:

str - A string representation of VNodeIdentifier instance returned by the call of toString(). Unlike create(String), null cannot be passed.

type - A class which specifies the expected type of VNodeIdentifier.

Returns:

A VNodeIdentifier instance.

Throws:

IllegalArgumentException - An invalid string is passed to str.

IllegalStateException - The type of the VNode identifier constructed from str does not match the specified type.

create

public static VNodeIdentifier<?> create(VnodePathFields vpath,
                                        boolean find)
                                 throws RpcException

Construct a new instance from the given VnodePathFields instance.

Parameters:

vpath - A VnodePathFields instance.

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

Returns:

A VNodeIdentifier instance if vpath is not null. null if vpath is null.

Throws:

RpcException - vpath contains invalid value.

getBadPathException

public static final RpcException getBadPathException(Object o)

Return an exception that notifies an invalid virtual node path.

Parameters:

o - An object which indicates the cause of error.

Returns:

An RpcException instance.

getFlowFilterUnsupportedException

public static final RpcException getFlowFilterUnsupportedException(VNodeIdentifier<?> ident)

Return an exception that indicates the virtual node does not support flow filter.

Parameters:

ident - A VNodeIdentifier instance.

Returns:

An RpcException instance.

getTenantName

public final VnodeName getTenantName()

Return the name of the VTN configured in this instance.

Returns:

A VnodeName instance which contains the VTN name. null if not configured.

getTenantNameString

public final String getTenantNameString()

Return the name of the VTN configured in this instance.

Returns:

A string which indicates the VTN name. null if not configured.

getBridgeName

public final VnodeName getBridgeName()

Return the name of the virtual bridge configured in this instance.

Returns:

A VnodeName instance which contains the virtual bridge name. null if not configured.

getBridgeNameString

public final String getBridgeNameString()

Return the name of the virtual bridge configured in this instance.

Returns:

A string which indicates the virtual bridge name. null if not configured.

getInterfaceName

public final VnodeName getInterfaceName()

Return the name of the virtual interface configured in this instance.

Returns:

A VnodeName instance which contains the virtual interface name. null if not configured.

getInterfaceNameString

public final String getInterfaceNameString()

Return the name of the virtual interface configured in this instance.

Returns:

A string which indicates the virtual interface name. null if not configured.

getIdentifier

public final org.opendaylight.yangtools.yang.binding.InstanceIdentifier<T> getIdentifier()

Return an indentifier for the MD-SAL data model associated with this instance.

Returns:

An InstanceIdentifier instance.

getComponents

public final List<String> getComponents()

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

Returns:

A list of path components.

contains

public final boolean contains(VNodeIdentifier<?> ident)

Determine whether the data model associated with this instance contains the data model specified by the given instance.

Parameters:

ident - A VNodeIdentifier instance.

Returns:

true only if the data model associated with this instance contains the data model specified by ident.

contains

public boolean contains(VirtualNodePath vpath)

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

Note that this method returns true if the given VirtualNodePath specifies the same virtual node as specified by this instance.

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

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.

getVirtualNodePath

public final VirtualNodePath getVirtualNodePath()

Return a VirtualNodePath instance that specifies the same virtual node as this instance.

Returns:

A VirtualNodePath instance.

readVtenantConfig

public final com.google.common.base.Optional<VtenantConfig> readVtenantConfig(org.opendaylight.controller.md.sal.binding.api.ReadTransaction rtx)
                                                                       throws VTNException

Read the configuration for the VTN specified by this instance.

Parameters:

rtx - A read transaction.

Returns:

An Optional instance that contains the result.

Throws:

VTNException - An error occurred.

read

public final com.google.common.base.Optional<T> read(org.opendaylight.controller.md.sal.binding.api.ReadTransaction rtx)
                                              throws VTNException

Read the data object specified by this instance.

Parameters:

rtx - A read transaction.

Returns:

An Optional instance that contains the result.

Throws:

VTNException - An error occurred.

fetch

public final T fetch(org.opendaylight.controller.md.sal.binding.api.ReadTransaction rtx)
              throws VTNException

Read the data object specified by this instance.

This method throws an RpcException if the data object is not present.

Parameters:

rtx - A read transaction.

Returns:

The data object specified by this instance.

Throws:

VTNException - An error occurred.

getFlowFilterIdentifier

public final org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VtnFlowFilter> getFlowFilterIdentifier(boolean output,
                                                                                                               Integer index)
                                                                                                        throws RpcException

Return an instance identifier that specifies a flow filter.

Parameters:

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

index - A flow filter index.

Returns:

An instance identifier for the specified flow filter.

Throws:

RpcException - The virtual node specified by this instance does not support flow filter.

clearFlowFilter

public final List<FlowFilterResult> clearFlowFilter(org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction tx,
                                                    boolean output)
                                             throws VTNException

Delete all the flow filters in the specified flow filter list.

Parameters:

tx - A MD-SAL datastore transaction.

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

Returns:

A list of FlowFilterResult instances that contains all the removed flow filter indices. null if the specified flow filter list is empty.

Throws:

VTNException - An error occurred.

getNotFoundException

public final RpcException getNotFoundException()

Return an exception that indicates the virtual node specified by this instance is not present.

Returns:

An RpcException instance.

getDataExistsException

public final RpcException getDataExistsException()

Return an exception that indicates the virtual node specified by this instance is already present.

Returns:

An RpcException instance.

getVtnIdentifierBuilder

protected final org.opendaylight.yangtools.yang.binding.InstanceIdentifier.InstanceIdentifierBuilder<Vtn> getVtnIdentifierBuilder()

Return an instance identifier builder which contains the VTN key.

Returns:

An instance identifier builder.

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 name. Subclass may override this method.

Returns:

A VirtualNodePathBuilder instance.

getFlowFilterListIdentifierBuilder

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

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

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.

Throws:

RpcException - The virtual node specified by this instance does not support flow filter.

getType

public abstract VNodeType getType()

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

Returns:

A VNodeType instance.

getIdentifierBuilder

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

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

Returns:

An InstanceIdentifier.InstanceIdentifierBuilder instance.

getVNodeIdentifier

public abstract VNodeIdentifier<?> getVNodeIdentifier()

Return a VNodeIdentifier that specifies a virtual network element.

If this instance specifies a virtual network element, such as VTN and vBridge, this method returns this instance. If this instance specifies a virtual network mapping, such as VLAN mapping, this method returns a VNodeIdentifier instance that specfies a virtual network element in which contains that mapping.

Returns:

A VNodeIdentifier instance that specifies a virtual network element.

newComponents

protected abstract List<String> newComponents()

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

Returns:

A list of path components.

equals

public final boolean equals(Object o)

Determine whether the given object is identical to this object.

Overrides:

equals in class Object

Parameters:

o - An object to be compared.

Returns:

true if identical. Otherwise false.

hashCode

public final int hashCode()

Return the hash code of this object.

Overrides:

hashCode in class Object

Returns:

The hash code.

toString

public final String toString()

Return a string representation of this instance.

Overrides:

toString in class Object

Returns:

A string representation of this instance.