org.opendaylight.vtn.manager.internal.routing

Class SetPathPolicyTask

java.lang.Object

org.opendaylight.vtn.manager.internal.util.tx.AbstractTxTask<T>

org.opendaylight.vtn.manager.internal.util.tx.AbstractRpcTask<V>

org.opendaylight.vtn.manager.internal.util.tx.AbstractDataTask<D,VtnUpdateType>

org.opendaylight.vtn.manager.internal.util.tx.PutDataTask<VtnPathPolicy>

org.opendaylight.vtn.manager.internal.routing.SetPathPolicyTask

All Implemented Interfaces:

TxTask<VtnUpdateType>, RpcOutputGenerator<VtnUpdateType,SetPathPolicyOutput>

public final class SetPathPolicyTask
extends PutDataTask<VtnPathPolicy>
implements RpcOutputGenerator<VtnUpdateType,SetPathPolicyOutput>

SetPathPolicyTask describes the MD-SAL transaction task that creates or updates the specified path policy configuration.

See Also:

create(TopologyGraph, SetPathPolicyInput)

Method Summary

Modifier and Type	Method and Description
static SetPathPolicyTask	create(org.opendaylight.vtn.manager.internal.routing.TopologyGraph topo, SetPathPolicyInput input) Construct a new task that creates or updates the specified path policy configuration.
SetPathPolicyOutput	createOutput(VtnUpdateType result) Generate the output of the RPC request.
protected boolean	fixMissingParents() Determine whether missing parent nodes should be created or not.
Class<SetPathPolicyOutput>	getOutputType() Return a class which indicates the type of the RPC output.
protected void	onStarted(TxContext ctx, VtnPathPolicy current) Invoked when the MD-SAL datastore transaction has started.
void	onSuccess(VTNManagerProvider provider, VtnUpdateType result) Invoked when the task has completed successfully.

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

execute, getDataObject, setDataObject

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

getDatastoreType, getTargetPath

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

needErrorLog

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

addBackgroundTask, execute, getBackgroundTasks, getMaxRetry, onFailure

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.TxTask

isAsync

Method Detail

create

public static SetPathPolicyTask create(org.opendaylight.vtn.manager.internal.routing.TopologyGraph topo,
                                       SetPathPolicyInput input)
                                throws RpcException

Construct a new task that creates or updates the specified path policy configuration.

Parameters:

topo - The network topology graph.

input - A SetPathPolicyInput instance.

Returns:

A SetPathPolicyTask instance associated with the task that set the given path policy configuration.

Throws:

RpcException - The given input contains invalid value.

fixMissingParents

protected boolean fixMissingParents()

Determine whether missing parent nodes should be created or not.

This method always return true in order to create the root container for the path policy if missing.

Overrides:

fixMissingParents in class PutDataTask<VtnPathPolicy>

Returns:

true.

onStarted

protected void onStarted(TxContext ctx,
                         VtnPathPolicy current)
                  throws VTNException

Invoked when the MD-SAL datastore transaction has started.

Overrides:

onStarted in class PutDataTask<VtnPathPolicy>

Parameters:

ctx - A runtime context for transaction task.

current - The current value at the target path in the MD-SAL datastore. Note that null is passed if the target data is not present.

Throws:

VTNException - An error occurred.

onSuccess

public void onSuccess(VTNManagerProvider provider,
                      VtnUpdateType result)

Invoked when the task has completed successfully.

This method of this class does nothing.

Specified by:

onSuccess in interface TxTask<VtnUpdateType>

Overrides:

onSuccess in class AbstractTxTask<VtnUpdateType>

Parameters:

provider - VTN Manager provider service.

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

getOutputType

public Class<SetPathPolicyOutput> getOutputType()

Return a class which indicates the type of the RPC output.

Specified by:

getOutputType in interface RpcOutputGenerator<VtnUpdateType,SetPathPolicyOutput>

Returns:

A class which indicates the type of the RPC output.

createOutput

public SetPathPolicyOutput createOutput(VtnUpdateType result)

Generate the output of the RPC request.

Specified by:

createOutput in interface RpcOutputGenerator<VtnUpdateType,SetPathPolicyOutput>

Parameters:

result - The result of the RPC main procedure.

Returns:

The output of the RPC request.