org.opendaylight.vtn.manager.internal.routing

Class PathCostTask<T extends AbstractTxTask<VtnUpdateType>,O>

java.lang.Object

org.opendaylight.vtn.manager.internal.util.tx.AbstractTxTask<List<V>>

org.opendaylight.vtn.manager.internal.util.tx.CompositeTxTask<VtnUpdateType,T>

org.opendaylight.vtn.manager.internal.routing.PathCostTask<T,O>

Type Parameters:

T - The type of MD-SAL datastore transaction task that updates path cost configuration.

O - The type of the output of the RPC.

All Implemented Interfaces:

TxTask<List<VtnUpdateType>>, RpcOutputGenerator<List<VtnUpdateType>,O>

Direct Known Subclasses:

RemovePathCostTask, SetPathCostTask

public abstract class PathCostTask<T extends AbstractTxTask<VtnUpdateType>,O>
extends CompositeTxTask<VtnUpdateType,T>
implements RpcOutputGenerator<List<VtnUpdateType>,O>

Abstract base class for a task that updates the path cost configurations in the path map.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PathCostTask(org.opendaylight.vtn.manager.internal.routing.TopologyGraph topo, Integer id, List<T> tasks) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
protected void	onStarted(TxContext ctx) Invoked when the MD-SAL datastore transaction has started.
void	onSuccess(VTNManagerProvider provider, List<VtnUpdateType> result) Invoked when the task has completed successfully.

Methods inherited from class org.opendaylight.vtn.manager.internal.util.tx.CompositeTxTask

execute, getSubTasks, needErrorLog, onCompleted, onFailure

Methods inherited from class org.opendaylight.vtn.manager.internal.util.tx.AbstractTxTask

addBackgroundTask, execute, getBackgroundTasks, getMaxRetry

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opendaylight.vtn.manager.internal.util.rpc.RpcOutputGenerator

createOutput, getOutputType

Methods inherited from interface org.opendaylight.vtn.manager.internal.TxTask

isAsync

Constructor Detail

PathCostTask

protected PathCostTask(org.opendaylight.vtn.manager.internal.routing.TopologyGraph topo,
                       Integer id,
                       List<T> tasks)

Construct a new instance.

Parameters:

topo - The network topology graph.

id - The identifier of the target path policy.

tasks - A list of tasks that update link cost configuration.

Method Detail

onStarted

protected final void onStarted(TxContext ctx)
                        throws VTNException

Invoked when the MD-SAL datastore transaction has started.

Overrides:

onStarted in class CompositeTxTask<VtnUpdateType,T extends AbstractTxTask<VtnUpdateType>>

Parameters:

ctx - A runtime context for transaction task.

Throws:

VTNException - An error occurred.

onSuccess

public final void onSuccess(VTNManagerProvider provider,
                            List<VtnUpdateType> result)

Invoked when the task has completed successfully.

This method of this class does nothing.

Specified by:

onSuccess in interface TxTask<List<VtnUpdateType>>

Overrides:

onSuccess in class CompositeTxTask<VtnUpdateType,T extends AbstractTxTask<VtnUpdateType>>

Parameters:

provider - VTN Manager provider service.

result - An object returned by AbstractTxTask.execute(TxContext, int).