org.opendaylight.vtn.manager.internal.util.inventory

Class InventoryReader

java.lang.Object

org.opendaylight.vtn.manager.internal.util.inventory.InventoryReader

public final class InventoryReader
extends Object

Helper class to read VTN node and port information using the given MD-SAL datastore transaction.

Note that this class is not synchronized.

Constructor Summary

Constructors

Constructor and Description
InventoryReader(org.opendaylight.controller.md.sal.binding.api.ReadTransaction rtx) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
void	collectUpEdgePorts(Set<SalPort> portSet) Collect node connectors associated with edge switch ports in up state.
void	collectUpEdgePorts(Set<SalPort> portSet, PortFilter filter) Collect node connectors associated with edge switch ports in up state.
boolean	exists(SalNode snode) Determine whether the given node is present or not.
SalPort	findPort(SalNode snode, VtnSwitchPort vswp) Find a SalPort instance that meets the specified condition.
VtnNode	get(SalNode snode) Return the VTN node information specified by the given SalNode instance.
VtnPort	get(SalPort sport) Return the VTN port information specified by the given SalPort instance.
org.opendaylight.controller.md.sal.binding.api.ReadTransaction	getReadTransaction() Return read transaction.
Set<SalPort>	getReverseStaticLinks(SalPort dst) Search for static inter-switch link configurations by the destination port of the link.
SalPort	getStaticLink(SalPort src) Search for a static inter-switch link configuration by the source port of the link.
List<VtnNode>	getVtnNodes() Return all node information as a list.
boolean	isEnabled(SalPort sport) Determine whether the given port is enabled or not.
boolean	isStaticEdgePort(SalPort sport) Determine whether the given switch port is configured as an edge port or not.
void	prefetch(Collection<VtnPort> vports) Put all VTN port information in the given collection into the VTN port cache.
void	prefetch(SalNode snode, VtnNode vnode) Put the given VTN node information into the cache.
void	prefetch(SalPort sport, VtnPort vport) Put the given VTN port information into the VTN port cache.
void	prefetch(VtnPort vport) Put the given VTN port information into the VTN port cache.
void	prefetch(VtnStaticTopology vstopo) Put the given VTN static network topology information into the static network topology cache.
void	purge(SalPort sport) Purge the cached information about the given VTN port.

Methods inherited from class java.lang.Object

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

Constructor Detail

InventoryReader

public InventoryReader(org.opendaylight.controller.md.sal.binding.api.ReadTransaction rtx)

Construct a new instance.

Parameters:

rtx - A ReadTransaction instance.

Method Detail

getReadTransaction

public org.opendaylight.controller.md.sal.binding.api.ReadTransaction getReadTransaction()

Return read transaction.

Returns:

A ReadTransaction instance.

get

public VtnNode get(SalNode snode)
            throws VTNException

Return the VTN node information specified by the given SalNode instance.

Parameters:

snode - A SalNode instance which specifies the VTN node information.

Returns:

A VtnNode instance if present. null if not present.

Throws:

VTNException - Failed to read VTN node information.

get

public VtnPort get(SalPort sport)
            throws VTNException

Return the VTN port information specified by the given SalPort instance.

Parameters:

sport - A SalPort instance which specifies the VTN port information.

Returns:

A VtnPort instance if present. null if not present.

Throws:

VTNException - Failed to read VTN port information.

prefetch

public void prefetch(SalNode snode,
                     VtnNode vnode)

Put the given VTN node information into the cache.

Parameters:

snode - A SalNode instance.

vnode - A VtnNode instance.

prefetch

public void prefetch(Collection<VtnPort> vports)

Put all VTN port information in the given collection into the VTN port cache.

Parameters:

vports - A collection of VtnPort instances.

prefetch

public void prefetch(VtnPort vport)

Put the given VTN port information into the VTN port cache.

Parameters:

vport - A VtnPort instance.

prefetch

public void prefetch(SalPort sport,
                     VtnPort vport)

Put the given VTN port information into the VTN port cache.

Parameters:

sport - A SalPort instance

vport - A VtnPort instance associated with sport.

prefetch

public void prefetch(VtnStaticTopology vstopo)

Put the given VTN static network topology information into the static network topology cache.

Parameters:

vstopo - A VtnStaticTopology instance or null.

getVtnNodes

public List<VtnNode> getVtnNodes()
                          throws VTNException

Return all node information as a list.

Returns:

A list of VtnNode instances.

Throws:

VTNException - An error occurred.

exists

public boolean exists(SalNode snode)
               throws VTNException

Determine whether the given node is present or not.

Parameters:

snode - A SalNode instance.

Returns:

true if the given node is present. Otherwise false.

Throws:

VTNException - An error occurred.

isEnabled

public boolean isEnabled(SalPort sport)
                  throws VTNException

Determine whether the given port is enabled or not.

Parameters:

sport - A SalPort instance.

Returns:

true if the given port is enabled. Otherwise false.

Throws:

VTNException - An error occurred.

findPort

public SalPort findPort(SalNode snode,
                        VtnSwitchPort vswp)
                 throws VTNException

Find a SalPort instance that meets the specified condition.

Parameters:

snode - A SalNode instance corresponding to a physical switch.

vswp - A VtnSwitchPort instance which specifies the condition to select switch port.

Returns:

A SalPort instance if found. null is returned if not found.

Throws:

VTNException - An error occurred.

collectUpEdgePorts

public void collectUpEdgePorts(Set<SalPort> portSet)
                        throws VTNException

Collect node connectors associated with edge switch ports in up state.

Parameters:

portSet - A set of SalPort instances to store results.

Throws:

VTNException - An error occurred.

collectUpEdgePorts

public void collectUpEdgePorts(Set<SalPort> portSet,
                               PortFilter filter)
                        throws VTNException

Collect node connectors associated with edge switch ports in up state.

Switch ports to be collected can be selected by specifying PortFilter instance to filter. If a PortFilter instance is specified, this method collects switch ports accepted by PortFilter.accept(SalPort, VtnPort).

Parameters:

portSet - A set of SalPort instances to store results.

filter - A PortFilter instance which filters switch port. All switch ports are stored to portSet if null is specified.

Throws:

VTNException - An error occurred.

getStaticLink

public SalPort getStaticLink(SalPort src)
                      throws VTNException

Search for a static inter-switch link configuration by the source port of the link.

Note that a static inter-switch link is ignored if source or destination port of that link is configured as a static edge port.

Parameters:

src - A SalPort instance which specifies the source port of the link.

Returns:

A SalPort which specifies the destination port of the link if found. null if not found.

Throws:

VTNException - Failed to reead static inter-switch link configuration.

getReverseStaticLinks

public Set<SalPort> getReverseStaticLinks(SalPort dst)
                                   throws VTNException

Search for static inter-switch link configurations by the destination port of the link.

Parameters:

dst - A SalPort instance which specifies the destination port of the link.

Returns:

A Set which contains source ports of the links. Note that an empty set is returned if no static inter-switch link configuration is present.

Throws:

VTNException - Failed to reead static inter-switch link configuration.

isStaticEdgePort

public boolean isStaticEdgePort(SalPort sport)
                         throws VTNException

Determine whether the given switch port is configured as an edge port or not.

Parameters:

sport - A SalPort instance which specifies the switch port.

Returns:

true if the given port should be treated as an edge port. Otherwise false.

Throws:

VTNException - Failed to reead static edge port configuration.

purge

public void purge(SalPort sport)

Purge the cached information about the given VTN port.

Parameters:

sport - A SalPort instance which specifies the switch port.