org.opendaylight.vtn.manager.internal.routing

Class ClearPathMapTask

java.lang.Object

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

org.opendaylight.vtn.manager.internal.routing.ClearPathMapTask

All Implemented Interfaces:

TxTask<VtnUpdateType>, RpcOutputGenerator<VtnUpdateType,ClearPathMapOutput>

public final class ClearPathMapTask
extends AbstractTxTask<VtnUpdateType>
implements RpcOutputGenerator<VtnUpdateType,ClearPathMapOutput>

ClearPathMapTask describes the MD-SAL datastore transaction task that clears the global or VTN path map configuration.

See Also:

create(ClearPathMapInput)

Method Summary

Modifier and Type	Method and Description
static ClearPathMapTask	create(ClearPathMapInput input) Create a new task that clears the specified path map container.
ClearPathMapOutput	createOutput(VtnUpdateType result) Generate the output of the RPC request.
protected VtnUpdateType	execute(TxContext ctx) Clear the specified path map container.
Class<ClearPathMapOutput>	getOutputType() Return a class which indicates the type of the RPC output.
boolean	needErrorLog(Throwable t) Determine whether the transaction queue should log the given error or not.
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

Method Detail

create

public static ClearPathMapTask create(ClearPathMapInput input)
                               throws RpcException

Create a new task that clears the specified path map container.

Parameters:

input - A ClearPathMapInput instance.

Returns:

A ClearPathMapTask associated with the task that clears the specified path map container.

Throws:

RpcException - The given input contains invalid value.

execute

protected VtnUpdateType execute(TxContext ctx)
                         throws VTNException

Clear the specified path map container.

Specified by:

execute in class AbstractTxTask<VtnUpdateType>

Parameters:

ctx - A runtime context for transaction task.

Returns:

VtnUpdateType.REMOVED if at least one path map has been removed. null is returned if no path map is present in the specified path map container.

Throws:

VTNException - An error occurred.

needErrorLog

public boolean needErrorLog(Throwable t)

Determine whether the transaction queue should log the given error or not.

This method returns false if a RpcException is passed.

Specified by:

needErrorLog in interface TxTask<VtnUpdateType>

Parameters:

t - A Throwable that is going to be thrown.

Returns:

true if the transaction queue should log the given Throwable. Otherwise false.

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<ClearPathMapOutput> getOutputType()

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

Specified by:

getOutputType in interface RpcOutputGenerator<VtnUpdateType,ClearPathMapOutput>

Returns:

A class which indicates the type of the RPC output.

createOutput

public ClearPathMapOutput createOutput(VtnUpdateType result)

Generate the output of the RPC request.

Specified by:

createOutput in interface RpcOutputGenerator<VtnUpdateType,ClearPathMapOutput>

Parameters:

result - The result of the RPC main procedure.

Returns:

The output of the RPC request.