org.opendaylight.vtn.manager.internal.routing

Class VTNRoutingManager

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<VtnLink,org.opendaylight.vtn.manager.internal.routing.TopologyEventContext>

org.opendaylight.vtn.manager.internal.routing.VTNRoutingManager

All Implemented Interfaces:

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

public final class VTNRoutingManager
extends DataStoreListener<VtnLink,org.opendaylight.vtn.manager.internal.routing.TopologyEventContext>
implements VTNSubSystem, VtnPathPolicyService

Internal routing manager.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addListener(VTNRoutingListener l) Add the given VTN routing listener.
Future<org.opendaylight.yangtools.yang.common.RpcResult<ClearPathPolicyOutput>>	clearPathPolicy() Remove all the path policies.
void	close() Close the VTN routing service.
protected org.opendaylight.vtn.manager.internal.routing.TopologyEventContext	enterEvent() Invoked when AbstractDataChangeListener.onDataTreeChanged(Collection) has just been called.
protected void	exitEvent(org.opendaylight.vtn.manager.internal.routing.TopologyEventContext ectx) Invoked when AbstractDataChangeListener.onDataTreeChanged(Collection) is going to leave.
protected org.slf4j.Logger	getLogger() Return a logger instance.
RouteResolver	getRouteResolver(Integer id) Return a packet route resolver.
protected org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VtnLink>	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(VtnLink before, VtnLink after) Determine whether the specified data was updated or not.
protected void	onCreated(org.opendaylight.vtn.manager.internal.routing.TopologyEventContext ectx, IdentifiedData<VtnLink> data) Invoked when a new data has been created in the datastore.
protected void	onRemoved(org.opendaylight.vtn.manager.internal.routing.TopologyEventContext ectx, IdentifiedData<VtnLink> data) Invoked when a data has been removed from the datastore.
protected void	onUpdated(org.opendaylight.vtn.manager.internal.routing.TopologyEventContext ectx, ChangedData<VtnLink> data) Invoked when a data in the datastore has been updated.
Future<org.opendaylight.yangtools.yang.common.RpcResult<RemovePathCostOutput>>	removePathCost(RemovePathCostInput input) Remove link cost configurations for all the given switch ports in the given path policy configuration.
Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>>	removePathPolicy(RemovePathPolicyInput input) Remove the path policy specified by the path policy identifier.
Future<org.opendaylight.yangtools.yang.common.RpcResult<SetPathCostOutput>>	setPathCost(SetPathCostInput input) Associate the cost of transmitting a packet with the specified switch port in the specified path policy.
Future<org.opendaylight.yangtools.yang.common.RpcResult<SetPathPolicyOutput>>	setPathPolicy(SetPathPolicyInput input) Create or modify the path policy.

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

Methods inherited from class java.lang.Object

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

Constructor Detail

VTNRoutingManager

public VTNRoutingManager(VTNManagerProvider provider)

Construct a new instance.

Parameters:

provider - VTN Manager provider service.

Method Detail

addListener

public void addListener(VTNRoutingListener l)

Add the given VTN routing listener.

Parameters:

l - A VTN routing listener.

getRouteResolver

public RouteResolver getRouteResolver(Integer id)

Return a packet route resolver.

Parameters:

id - The identifier of the path policy.

Returns:

A RouteResolver instance if found. null if not fonud.

close

public void close()

Close the VTN routing service.

Specified by:

close in interface AutoCloseable

Overrides:

close in class CloseableContainer

enterEvent

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

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

Specified by:

enterEvent in class AbstractDataChangeListener<VtnLink,org.opendaylight.vtn.manager.internal.routing.TopologyEventContext>

Returns:

A new event context.

exitEvent

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

Parameters:

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

onCreated

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

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

Specified by:

onCreated in class DataStoreListener<VtnLink,org.opendaylight.vtn.manager.internal.routing.TopologyEventContext>

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.TopologyEventContext ectx,
                         ChangedData<VtnLink> data)

Invoked when a data in the datastore has been updated.

Specified by:

onUpdated in class DataStoreListener<VtnLink,org.opendaylight.vtn.manager.internal.routing.TopologyEventContext>

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.TopologyEventContext ectx,
                         IdentifiedData<VtnLink> data)

Invoked when a data has been removed from the datastore.

Specified by:

onRemoved in class DataStoreListener<VtnLink,org.opendaylight.vtn.manager.internal.routing.TopologyEventContext>

Parameters:

ectx - An event context created by this instance.

data - An IdentifiedData instance which contains the removed data.

isUpdated

protected boolean isUpdated(@Nonnull
                            VtnLink before,
                            @Nonnull
                            VtnLink 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<VtnLink,org.opendaylight.vtn.manager.internal.routing.TopologyEventContext>

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<VtnLink> getWildcardPath()

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

Specified by:

getWildcardPath in class AbstractDataChangeListener<VtnLink,org.opendaylight.vtn.manager.internal.routing.TopologyEventContext>

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.

setPathPolicy

public Future<org.opendaylight.yangtools.yang.common.RpcResult<SetPathPolicyOutput>> setPathPolicy(SetPathPolicyInput input)

Create or modify the path policy.

• If the path policy specified by the path policy ID does not exist, a new path policy will be associated with the specified ID.
• If the path policy specified by the path policy ID already exists, it will be modified as specified by the RPC input.

Specified by:

setPathPolicy in interface VtnPathPolicyService

Parameters:

input - Input of the RPC.

Returns:

A Future associated with the RPC task.

removePathPolicy

public Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>> removePathPolicy(RemovePathPolicyInput input)

Remove the path policy specified by the path policy identifier.

Specified by:

removePathPolicy in interface VtnPathPolicyService

Parameters:

input - Input of the RPC.

Returns:

A Future associated with the RPC task.

setPathCost

public Future<org.opendaylight.yangtools.yang.common.RpcResult<SetPathCostOutput>> setPathCost(SetPathCostInput input)

Associate the cost of transmitting a packet with the specified switch port in the specified path policy.

Specified by:

setPathCost in interface VtnPathPolicyService

Parameters:

input - Input of the RPC.

Returns:

A Future associated with the RPC task.

removePathCost

public Future<org.opendaylight.yangtools.yang.common.RpcResult<RemovePathCostOutput>> removePathCost(RemovePathCostInput input)

Remove link cost configurations for all the given switch ports in the given path policy configuration.

Specified by:

removePathCost in interface VtnPathPolicyService

Parameters:

input - Input of the RPC.

Returns:

A Future associated with the RPC task.

clearPathPolicy

public Future<org.opendaylight.yangtools.yang.common.RpcResult<ClearPathPolicyOutput>> clearPathPolicy()

Remove all the path policies.

Specified by:

clearPathPolicy in interface VtnPathPolicyService

Returns:

A Future associated with the RPC task.