org.opendaylight.vtn.manager.internal.routing

Class ClearPathPolicyTask

java.lang.Object

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

org.opendaylight.vtn.manager.internal.routing.ClearPathPolicyTask

All Implemented Interfaces:

TxTask<VtnUpdateType>, RpcOutputGenerator<VtnUpdateType,ClearPathPolicyOutput>

public final class ClearPathPolicyTask
extends AbstractTxTask<VtnUpdateType>
implements RpcOutputGenerator<VtnUpdateType,ClearPathPolicyOutput>

ClearPathPolicyTask describes the MD-SAL datastore transaction task that clears the path policy container.

Constructor Summary

Constructors

Constructor and Description
ClearPathPolicyTask()

Method Summary

Modifier and Type	Method and Description
ClearPathPolicyOutput	createOutput(VtnUpdateType result) Generate the output of the RPC request.
protected VtnUpdateType	execute(TxContext ctx) Clear the root container of the path policy.
Class<ClearPathPolicyOutput>	getOutputType() Return a class which indicates the type of the RPC output.
void	onSuccess(VTNManagerProvider provider, VtnUpdateType result) Invoked when the task has completed successfully.

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, needErrorLog

Constructor Detail

ClearPathPolicyTask

public ClearPathPolicyTask()

Method Detail

execute

protected VtnUpdateType execute(TxContext ctx)
                         throws VTNException

Clear the root container of the path policy.

Specified by:

execute in class AbstractTxTask<VtnUpdateType>

Parameters:

ctx - A runtime context for transaction task.

Returns:

VtnUpdateType.REMOVED if at least one path policy has been removed. null is returned if no path policy is 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<ClearPathPolicyOutput> getOutputType()

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

Specified by:

getOutputType in interface RpcOutputGenerator<VtnUpdateType,ClearPathPolicyOutput>

Returns:

A class which indicates the type of the RPC output.

createOutput

public ClearPathPolicyOutput createOutput(VtnUpdateType result)

Generate the output of the RPC request.

Specified by:

createOutput in interface RpcOutputGenerator<VtnUpdateType,ClearPathPolicyOutput>

Parameters:

result - The result of the RPC main procedure.

Returns:

The output of the RPC request.