org.opendaylight.vtn.manager.internal.vnode.xml

Class XmlVTenant

java.lang.Object

org.opendaylight.vtn.manager.internal.vnode.xml.XmlVNode

org.opendaylight.vtn.manager.internal.vnode.xml.XmlVTenant

public final class XmlVTenant
extends XmlVNode

XmlVTenant provides XML binding to the data model for VTN.

Constructor Summary

Constructors

Constructor and Description
XmlVTenant(VtnInfo vtn) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) Determine whether the given object is identical to this object.
List<XmlVBridge>	getBridges() Return a list of vBridges.
VTenantIdentifier	getIdentifier() Return the identifier for this VTN.
FlowFilterList	getInputFilters() Return a list of input flow filters.
List<XmlPathMap>	getPathMaps() Return a list of VTN path map configurations.
List<XmlVTerminal>	getTerminals() Return a list of vTerminals.
int	hashCode() Return the hash code of this object.
VtnBuilder	toVtnBuilder(XmlLogger xlogger, String name) Create a VtnBuilder instance that contains the VTN configuration.

Methods inherited from class org.opendaylight.vtn.manager.internal.vnode.xml.XmlVNode

getDescription, getName

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlVTenant

public XmlVTenant(VtnInfo vtn)
           throws RpcException

Construct a new instance.

Parameters:

vtn - A VtnInfo instance.

Throws:

RpcException - An error occurred.

Method Detail

getIdentifier

public VTenantIdentifier getIdentifier()

Return the identifier for this VTN.

Returns:

A VTenantIdentifier instance.

toVtnBuilder

public VtnBuilder toVtnBuilder(XmlLogger xlogger,
                               String name)
                        throws RpcException

Create a VtnBuilder instance that contains the VTN configuration.

Note that returned instance contains only configuration for the VTN. Other information needs to be resumed by the caller.

• Runtime status
• vBridge
• vTerminal
• VTN path map

Parameters:

xlogger - A XmlLogger instance.

name - The expected name of this VTN.

Returns:

A VtnBuilder instance.

Throws:

RpcException - An error occurred.

getBridges

public List<XmlVBridge> getBridges()

Return a list of vBridges.

Returns:

A list of XmlVBridge instances or null.

getTerminals

public List<XmlVTerminal> getTerminals()

Return a list of vTerminals.

Returns:

A list of XmlVTerminal instances or null.

getPathMaps

public List<XmlPathMap> getPathMaps()

Return a list of VTN path map configurations.

Returns:

A list of XmlPathMap instances or null.

getInputFilters

public FlowFilterList getInputFilters()

Return a list of input flow filters.

Returns:

A FlowFilterList instance or null.

equals

public boolean equals(Object o)

Determine whether the given object is identical to this object.

Overrides:

equals in class XmlVNode

Parameters:

o - An object to be compared.

Returns:

true if identical. Otherwise false.

hashCode

public int hashCode()

Return the hash code of this object.

Overrides:

hashCode in class XmlVNode

Returns:

The hash code.