org.opendaylight.vtn.manager.internal.routing

Class PathMapManager

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.DataStoreListener<VtnPathMap,org.opendaylight.vtn.manager.internal.routing.GlobalPathMapChange>

org.opendaylight.vtn.manager.internal.routing.PathMapManager

All Implemented Interfaces:

AutoCloseable, EventListener, org.opendaylight.controller.md.sal.binding.api.DataTreeChangeListener<VtnPathMap>, VTNSubSystem, VtnPathMapService, org.opendaylight.yangtools.yang.binding.RpcService

public final class PathMapManager
extends DataStoreListener<VtnPathMap,org.opendaylight.vtn.manager.internal.routing.GlobalPathMapChange>
implements VTNSubSystem, VtnPathMapService

Path map manager.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Future<org.opendaylight.yangtools.yang.common.RpcResult<ClearPathMapOutput>>	clearPathMap(ClearPathMapInput input) Remove all the path map configurations present in the global or VTN path map container.
protected org.opendaylight.vtn.manager.internal.routing.GlobalPathMapChange	enterEvent() Invoked when AbstractDataChangeListener.onDataTreeChanged(Collection) has just been called.
protected void	exitEvent(org.opendaylight.vtn.manager.internal.routing.GlobalPathMapChange 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<VtnPathMap>	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	isUpdated(VtnPathMap before, VtnPathMap after) Determine whether the specified data was updated or not.
protected void	onCreated(org.opendaylight.vtn.manager.internal.routing.GlobalPathMapChange ectx, IdentifiedData<VtnPathMap> data) Invoked when a new data has been created in the datastore.
protected void	onRemoved(org.opendaylight.vtn.manager.internal.routing.GlobalPathMapChange ectx, IdentifiedData<VtnPathMap> data) Invoked when a data has been removed from the datastore.
protected void	onUpdated(org.opendaylight.vtn.manager.internal.routing.GlobalPathMapChange ectx, ChangedData<VtnPathMap> data) Invoked when a data in the datastore has been updated.
Future<org.opendaylight.yangtools.yang.common.RpcResult<RemovePathMapOutput>>	removePathMap(RemovePathMapInput input) Remove the path map configuration in the global or VTN path map.
Future<org.opendaylight.yangtools.yang.common.RpcResult<SetPathMapOutput>>	setPathMap(SetPathMapInput input) Create or modify the global or VTN path map.

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

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

PathMapManager

public PathMapManager(VTNManagerProvider provider)

Construct a new instance.

Parameters:

provider - VTN Manager provider service.

Method Detail

enterEvent

protected org.opendaylight.vtn.manager.internal.routing.GlobalPathMapChange enterEvent()

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

Specified by:

enterEvent in class AbstractDataChangeListener<VtnPathMap,org.opendaylight.vtn.manager.internal.routing.GlobalPathMapChange>

Returns:

A new event context.

exitEvent

protected void exitEvent(org.opendaylight.vtn.manager.internal.routing.GlobalPathMapChange 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<VtnPathMap,org.opendaylight.vtn.manager.internal.routing.GlobalPathMapChange>

Parameters:

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

onCreated

protected void onCreated(org.opendaylight.vtn.manager.internal.routing.GlobalPathMapChange ectx,
                         IdentifiedData<VtnPathMap> data)

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

Specified by:

onCreated in class DataStoreListener<VtnPathMap,org.opendaylight.vtn.manager.internal.routing.GlobalPathMapChange>

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.routing.GlobalPathMapChange ectx,
                         ChangedData<VtnPathMap> data)

Invoked when a data in the datastore has been updated.

Specified by:

onUpdated in class DataStoreListener<VtnPathMap,org.opendaylight.vtn.manager.internal.routing.GlobalPathMapChange>

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.routing.GlobalPathMapChange ectx,
                         IdentifiedData<VtnPathMap> data)

Invoked when a data has been removed from the datastore.

Specified by:

onRemoved in class DataStoreListener<VtnPathMap,org.opendaylight.vtn.manager.internal.routing.GlobalPathMapChange>

Parameters:

ectx - An event context created by this instance.

data - An IdentifiedData instance which contains the removed data.

isUpdated

protected boolean isUpdated(@Nonnull
                            VtnPathMap before,
                            @Nonnull
                            VtnPathMap after)

Determine whether the specified data was updated or not.

DataStoreListener.onUpdated(Object, ChangedData) is called only if this method returns true.

Specified by:

isUpdated in class DataStoreListener<VtnPathMap,org.opendaylight.vtn.manager.internal.routing.GlobalPathMapChange>

Parameters:

before - The target data object before modification.

after - The target data object after modification.

Returns:

true if the target data was updated. false otherwise.

getWildcardPath

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

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

Specified by:

getWildcardPath in class AbstractDataChangeListener<VtnPathMap,org.opendaylight.vtn.manager.internal.routing.GlobalPathMapChange>

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.

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.

setPathMap

public Future<org.opendaylight.yangtools.yang.common.RpcResult<SetPathMapOutput>> setPathMap(SetPathMapInput input)

Create or modify the global or VTN path map.

If the name of the VTN is specified in the RPC input, this operation creates or modifies VTN path map that affect flows in the specified VTN. Otherwise this operation creates or modifies global path map that affect flows in all the VTNs.

• If the path map specified by the VTN name and map index does not exist, a new path map will be associated with the specified index.
• If the path map specifie by the VTN name and map index already exists, it will be modified as specified the RPC input.

Specified by:

setPathMap in interface VtnPathMapService

Parameters:

input - Input of the RPC.

Returns:

A Future associated with the RPC task.

removePathMap

public Future<org.opendaylight.yangtools.yang.common.RpcResult<RemovePathMapOutput>> removePathMap(RemovePathMapInput input)

Remove the path map configuration in the global or VTN path map.

If the name of the VTN is specified in the RPC input, this operation removes VTN path map. Otherwise this operation removes global path map.

Specified by:

removePathMap in interface VtnPathMapService

Parameters:

input - Input of the RPC.

Returns:

A Future associated with the RPC task.

clearPathMap

public Future<org.opendaylight.yangtools.yang.common.RpcResult<ClearPathMapOutput>> clearPathMap(ClearPathMapInput input)

Remove all the path map configurations present in the global or VTN path map container.

Specified by:

clearPathMap in interface VtnPathMapService

Parameters:

input - Input of the RPC.

Returns:

A Future associated with the RPC task.