org.opendaylight.vtn.manager.internal.vnode

Class VTenantManager

java.lang.Object

org.opendaylight.vtn.manager.internal.util.CloseableContainer

org.opendaylight.vtn.manager.internal.util.AbstractDataChangeListener<T,C>

org.opendaylight.vtn.manager.internal.util.MultiDataStoreListener<Vtn,org.opendaylight.vtn.manager.internal.vnode.VTenantChange>

org.opendaylight.vtn.manager.internal.vnode.VTenantManager

All Implemented Interfaces:

AutoCloseable, EventListener, org.opendaylight.controller.md.sal.binding.api.DataTreeChangeListener<Vtn>, VTNInventoryListener, VTNPacketListener, VTNRoutingListener, VTNSubSystem, VtnFlowFilterService, VtnService, VtnVterminalService, org.opendaylight.yangtools.yang.binding.RpcService

public final class VTenantManager
extends MultiDataStoreListener<Vtn,org.opendaylight.vtn.manager.internal.vnode.VTenantChange>
implements VTNSubSystem, VTNInventoryListener, VTNRoutingListener, VTNPacketListener, VtnService, VtnVterminalService, VtnFlowFilterService

Virtual tenant manager.

Constructor Summary

Constructors

Constructor and Description
VTenantManager(VTNManagerProvider provider) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
protected org.opendaylight.vtn.manager.internal.vnode.VTenantChange	enterEvent() Invoked when AbstractDataChangeListener.onDataTreeChanged(Collection) has just been called.
protected void	exitEvent(org.opendaylight.vtn.manager.internal.vnode.VTenantChange ectx) Invoked when AbstractDataChangeListener.onDataTreeChanged(Collection) is going to leave.
protected org.slf4j.Logger	getLogger() Return a logger instance.
protected org.opendaylight.yangtools.yang.binding.InstanceIdentifier<Vtn>	getWildcardPath() Return a wildcard instance identifier that specifies data objects to be listened.
VTNFuture<?>	initConfig(boolean master) Post a MD-SAL datastore transaction task that initializes the configuration.
void	initRpcServices(org.opendaylight.controller.sal.binding.api.RpcProviderRegistry rpcReg, CompositeAutoCloseable regs) Register RPC implementation required by the subsystem.
protected boolean	isDepth(VtnUpdateType type) Return a boolean value which specifies the order of tree traversal.
protected boolean	isLeafNode(Class<?> type) Determine whether the specified type of the tree node should be treated as a leaf node.
protected boolean	isRequiredType(Class<?> type) Determine whether the specified type of the tree node is required to be notified or not.
protected boolean	isUpdated(org.opendaylight.vtn.manager.internal.vnode.VTenantChange ectx, ChangedData<?> data) Determine whether the specified data was updated or not.
void	notifyPacket(PacketInEvent ev) Invoked when a packet has been received.
void	notifyVtnNode(VtnNodeEvent ev) Invoked when a node information has been added or removed.
void	notifyVtnPort(VtnPortEvent ev) Invoked when a port information has been added, removed, or changed.
protected void	onCreated(org.opendaylight.vtn.manager.internal.vnode.VTenantChange ectx, IdentifiedData<?> data) Invoked when a new data has been created in the datastore.
protected void	onRemoved(org.opendaylight.vtn.manager.internal.vnode.VTenantChange ectx, IdentifiedData<?> data) Invoked when a data has been removed from the datastore.
protected void	onUpdated(org.opendaylight.vtn.manager.internal.vnode.VTenantChange ectx, ChangedData<?> data) Invoked when a data in the datastore has been updated.
Future<org.opendaylight.yangtools.yang.common.RpcResult<RemoveFlowFilterOutput>>	removeFlowFilter(RemoveFlowFilterInput input) Remove the specified flow filters.
Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>>	removeVterminal(RemoveVterminalInput input) Remove the specified vTerminal.
Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>>	removeVtn(RemoveVtnInput input) Remove the specified VTN.
void	routingUpdated(RoutingEvent ev) Invoked when the packet routing table has been updated.
Future<org.opendaylight.yangtools.yang.common.RpcResult<SetFlowFilterOutput>>	setFlowFilter(SetFlowFilterInput input) Create or modify the flow filter.
void	shutdown() Trigger the system shutdownn sequence.
Future<org.opendaylight.yangtools.yang.common.RpcResult<UpdateVterminalOutput>>	updateVterminal(UpdateVterminalInput input) Create or modify the specified vTerminal.
Future<org.opendaylight.yangtools.yang.common.RpcResult<UpdateVtnOutput>>	updateVtn(UpdateVtnInput input) Create or modify the specified VTN.

Methods inherited from class org.opendaylight.vtn.manager.internal.util.MultiDataStoreListener

handleTree

Methods inherited from class org.opendaylight.vtn.manager.internal.util.AbstractDataChangeListener

checkPath, getTargetType, isRequiredEvent, nullValue, onDataTreeChanged, registerListener

Methods inherited from class org.opendaylight.vtn.manager.internal.util.CloseableContainer

addCloseable, close

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.AutoCloseable

close

Constructor Detail

VTenantManager

public VTenantManager(VTNManagerProvider provider)

Construct a new instance.

Parameters:

provider - A VTN Manager provider service.

Method Detail

shutdown

public void shutdown()

Trigger the system shutdownn sequence.

initConfig

public VTNFuture<?> initConfig(boolean master)

Post a MD-SAL datastore transaction task that initializes the configuration.

Specified by:

initConfig in interface VTNSubSystem

Parameters:

master - true if the local node is the configuration provider.

Returns:

A VTNFuture instance associated with the task for initialization. null means that there is nothing to do on initialization.

initRpcServices

public void initRpcServices(org.opendaylight.controller.sal.binding.api.RpcProviderRegistry rpcReg,
                            CompositeAutoCloseable regs)

Register RPC implementation required by the subsystem.

Specified by:

initRpcServices in interface VTNSubSystem

Parameters:

rpcReg - A RpcProviderRegistry service instance.

regs - A CompositeAutoCloseable instance to store RPC registration.

isDepth

protected boolean isDepth(VtnUpdateType type)

Return a boolean value which specifies the order of tree traversal.

Specified by:

isDepth in class MultiDataStoreListener<Vtn,org.opendaylight.vtn.manager.internal.vnode.VTenantChange>

Parameters:

type - A VtnUpdateType instance which specifies the type of event.

Returns:

true means that each tree node's children need to be processed after the tree node itself (from outer to innter). false means that each tree node's children need to be processed before the tree node itself (from inner to outer).

isRequiredType

protected boolean isRequiredType(@Nonnull
                                 Class<?> type)

Determine whether the specified type of the tree node is required to be notified or not.

Specified by:

isRequiredType in class MultiDataStoreListener<Vtn,org.opendaylight.vtn.manager.internal.vnode.VTenantChange>

Parameters:

type - A class that specifies the type of the tree node.

Returns:

true if the specified type of the tree node needs to be notified. false otherwise.

isLeafNode

protected boolean isLeafNode(@Nonnull
                             Class<?> type)

Determine whether the specified type of the tree node should be treated as a leaf node.

Overrides:

isLeafNode in class MultiDataStoreListener<Vtn,org.opendaylight.vtn.manager.internal.vnode.VTenantChange>

Parameters:

type - A class that specifies the type of the tree node. Note that this value may not be the target data type specified by isRequiredType(Class).

Returns:

true if the specified type of the tree node should be treated as a leaf node. false otherwise.

isUpdated

protected boolean isUpdated(org.opendaylight.vtn.manager.internal.vnode.VTenantChange ectx,
                            ChangedData<?> data)

Determine whether the specified data was updated or not.

MultiDataStoreListener.onUpdated(Object, ChangedData) is called only if this method returns true. This method is called only if MultiDataStoreListener.isRequiredType(Class) with specifying type returns true.

Specified by:

isUpdated in class MultiDataStoreListener<Vtn,org.opendaylight.vtn.manager.internal.vnode.VTenantChange>

Parameters:

ectx - An event context created by this instance.

data - A ChangedData instance which contains the changed data.

Returns:

true if the target data was updated. false otherwise.

enterEvent

protected org.opendaylight.vtn.manager.internal.vnode.VTenantChange enterEvent()

Invoked when AbstractDataChangeListener.onDataTreeChanged(Collection) has just been called.

Specified by:

enterEvent in class AbstractDataChangeListener<Vtn,org.opendaylight.vtn.manager.internal.vnode.VTenantChange>

Returns:

A new event context.

exitEvent

protected void exitEvent(org.opendaylight.vtn.manager.internal.vnode.VTenantChange ectx)

Invoked when AbstractDataChangeListener.onDataTreeChanged(Collection) is going to leave.

Note that this method may be called even if no modified data was notified.

Specified by:

exitEvent in class AbstractDataChangeListener<Vtn,org.opendaylight.vtn.manager.internal.vnode.VTenantChange>

Parameters:

ectx - An event context created by AbstractDataChangeListener.enterEvent().

onCreated

protected void onCreated(org.opendaylight.vtn.manager.internal.vnode.VTenantChange ectx,
                         IdentifiedData<?> data)

Invoked when a new data has been created in the datastore.

Specified by:

onCreated in class MultiDataStoreListener<Vtn,org.opendaylight.vtn.manager.internal.vnode.VTenantChange>

Parameters:

ectx - An event context created by this instance.

data - An IdentifiedData instance which contains the created data.

onUpdated

protected void onUpdated(org.opendaylight.vtn.manager.internal.vnode.VTenantChange ectx,
                         ChangedData<?> data)

Invoked when a data in the datastore has been updated.

Specified by:

onUpdated in class MultiDataStoreListener<Vtn,org.opendaylight.vtn.manager.internal.vnode.VTenantChange>

Parameters:

ectx - An event context created by this instance.

data - A ChangedData instance which contains the changed data.

onRemoved

protected void onRemoved(org.opendaylight.vtn.manager.internal.vnode.VTenantChange ectx,
                         IdentifiedData<?> data)

Invoked when a data has been removed from the datastore.

Specified by:

onRemoved in class MultiDataStoreListener<Vtn,org.opendaylight.vtn.manager.internal.vnode.VTenantChange>

Parameters:

ectx - An event context created by this instance.

data - An IdentifiedData instance which contains the removed data.

getWildcardPath

protected org.opendaylight.yangtools.yang.binding.InstanceIdentifier<Vtn> getWildcardPath()

Return a wildcard instance identifier that specifies data objects to be listened.

Specified by:

getWildcardPath in class AbstractDataChangeListener<Vtn,org.opendaylight.vtn.manager.internal.vnode.VTenantChange>

Returns:

A wildcard instance identifier.

getLogger

protected org.slf4j.Logger getLogger()

Return a logger instance.

Note that this method will be called before the constructor returns.

Specified by:

getLogger in class CloseableContainer

Returns:

A Logger instance.

notifyVtnNode

public void notifyVtnNode(VtnNodeEvent ev)
                   throws VTNException

Invoked when a node information has been added or removed.

Specified by:

notifyVtnNode in interface VTNInventoryListener

Parameters:

ev - A VtnNodeEvent instance.

Throws:

VTNException - An error occurred.

notifyVtnPort

public void notifyVtnPort(VtnPortEvent ev)
                   throws VTNException

Invoked when a port information has been added, removed, or changed.

Specified by:

notifyVtnPort in interface VTNInventoryListener

Parameters:

ev - A VtnPortEvent instance.

Throws:

VTNException - An error occurred.

routingUpdated

public void routingUpdated(RoutingEvent ev)
                    throws VTNException

Invoked when the packet routing table has been updated.

Specified by:

routingUpdated in interface VTNRoutingListener

Parameters:

ev - A RoutingEvent instance.

Throws:

VTNException - An error occurred.

notifyPacket

public void notifyPacket(PacketInEvent ev)

Invoked when a packet has been received.

Specified by:

notifyPacket in interface VTNPacketListener

Parameters:

ev - A PacketInEvent instance.

updateVtn

public Future<org.opendaylight.yangtools.yang.common.RpcResult<UpdateVtnOutput>> updateVtn(UpdateVtnInput input)

Create or modify the specified VTN.

Specified by:

updateVtn in interface VtnService

Parameters:

input - Input of the RPC.

Returns:

A Future associated with the RPC task.

removeVtn

public Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>> removeVtn(RemoveVtnInput input)

Remove the specified VTN.

Specified by:

removeVtn in interface VtnService

Parameters:

input - Input of the RPC.

Returns:

A Future associated with the RPC task.

updateVterminal

public Future<org.opendaylight.yangtools.yang.common.RpcResult<UpdateVterminalOutput>> updateVterminal(UpdateVterminalInput input)

Create or modify the specified vTerminal.

Specified by:

updateVterminal in interface VtnVterminalService

Parameters:

input - Input of the RPC.

Returns:

A Future associated with the RPC task.

removeVterminal

public Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>> removeVterminal(RemoveVterminalInput input)

Remove the specified vTerminal.

Specified by:

removeVterminal in interface VtnVterminalService

Parameters:

input - Input of the RPC.

Returns:

A Future associated with the RPC task.

setFlowFilter

public Future<org.opendaylight.yangtools.yang.common.RpcResult<SetFlowFilterOutput>> setFlowFilter(SetFlowFilterInput input)

Create or modify the flow filter.

Specified by:

setFlowFilter in interface VtnFlowFilterService

Parameters:

input - Input of the RPC.

Returns:

A Future associated with the RPC task.

removeFlowFilter

public Future<org.opendaylight.yangtools.yang.common.RpcResult<RemoveFlowFilterOutput>> removeFlowFilter(RemoveFlowFilterInput input)

Remove the specified flow filters.

Specified by:

removeFlowFilter in interface VtnFlowFilterService

Parameters:

input - Input of the RPC.

Returns:

A Future associated with the RPC task.