org.opendaylight.vtn.manager.internal.routing

Class RemovePathPolicyTask

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.DeleteDataTask<VtnPathPolicy>

org.opendaylight.vtn.manager.internal.routing.RemovePathPolicyTask

All Implemented Interfaces:

TxTask<VtnUpdateType>, RpcOutputGenerator<VtnUpdateType,Void>

public final class RemovePathPolicyTask
extends DeleteDataTask<VtnPathPolicy>
implements RpcOutputGenerator<VtnUpdateType,Void>

RemovePathPolicyTask describes the MD-SAL transaction task that deletes the specified path policy configuration.

See Also:

create(TopologyGraph, RemovePathPolicyInput)

Method Summary

Modifier and Type	Method and Description
static RemovePathPolicyTask	create(org.opendaylight.vtn.manager.internal.routing.TopologyGraph topo, RemovePathPolicyInput input) Create a new task that removes the specified path policy.
Void	createOutput(VtnUpdateType result) Generate the output of the RPC request.
Class<Void>	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.DeleteDataTask

execute, onDeleted

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 RemovePathPolicyTask create(org.opendaylight.vtn.manager.internal.routing.TopologyGraph topo,
                                          RemovePathPolicyInput input)
                                   throws RpcException

Create a new task that removes the specified path policy.

Parameters:

topo - The network topology graph.

input - A RemovePathPolicyInput instance.

Returns:

A RemovePathPolicyTask associated with the task that removes the given path policy.

Throws:

RpcException - The given input contains invalid value.

onStarted

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

Invoked when the MD-SAL datastore transaction has started.

Overrides:

onStarted in class DeleteDataTask<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<Void> getOutputType()

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

Specified by:

getOutputType in interface RpcOutputGenerator<VtnUpdateType,Void>

Returns:

A class which indicates the type of the RPC output.

createOutput

public Void createOutput(VtnUpdateType result)

Generate the output of the RPC request.

Specified by:

createOutput in interface RpcOutputGenerator<VtnUpdateType,Void>

Parameters:

result - The result of the RPC main procedure.

Returns:

The output of the RPC request.