org.opendaylight.vtn.manager.internal.flow.add

Class PutFlowTxTask

java.lang.Object

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

org.opendaylight.vtn.manager.internal.flow.add.PutFlowTxTask

All Implemented Interfaces:

TxTask<VtnDataFlow>

public final class PutFlowTxTask
extends AbstractTxTask<VtnDataFlow>

PutFlowTxTask describes the MD-SAL datastore transaction task that installs a new VTN flow information into the datastore.

This task returns a VtnDataFlow instance corresponding to a new VTN data flow.

Constructor Summary

Constructors

Constructor and Description
PutFlowTxTask(FlowAddContext ctx, VTNThreadPool thread, TxQueue txq) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
VtnDataFlow	execute(TxContext ctx) Modify the MD-SAL datastore using the given transaction.
protected int	getMaxRetry() Return the number of times for retrying transaction.
void	onFailure(VTNManagerProvider provider, Throwable t) Invoked when the task has failed.
void	onSuccess(VTNManagerProvider provider, VtnDataFlow result) Invoked when the task has completed successfully.

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

addBackgroundTask, execute, getBackgroundTasks

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

PutFlowTxTask

public PutFlowTxTask(FlowAddContext ctx,
                     VTNThreadPool thread,
                     TxQueue txq)

Construct a new instance.

Parameters:

ctx - A FlowAddContext instance.

thread - A VTNThreadPool instance used to install flow entries.

txq - A TxQueue instance that runs this task.

Method Detail

getMaxRetry

protected int getMaxRetry()

Return the number of times for retrying transaction.

This method in this class returns MAX_FLOW_RETRY.

Overrides:

getMaxRetry in class AbstractTxTask<VtnDataFlow>

Returns:

The number of times for retrying transaction.

execute

public VtnDataFlow execute(TxContext ctx)
                    throws VTNException

Modify the MD-SAL datastore using the given transaction.

Note that this method may be called more than once when a MD-SAL datastore transaction is aborted due to data conflict.

Specified by:

execute in class AbstractTxTask<VtnDataFlow>

Parameters:

ctx - A runtime context for transaction task.

Returns:

Result of this task.

Throws:

VTNException - An error occurred.

onSuccess

public void onSuccess(VTNManagerProvider provider,
                      VtnDataFlow result)

Invoked when the task has completed successfully.

Specified by:

onSuccess in interface TxTask<VtnDataFlow>

Overrides:

onSuccess in class AbstractTxTask<VtnDataFlow>

Parameters:

provider - VTN Manager provider service.

result - The result of this task.

onFailure

public void onFailure(VTNManagerProvider provider,
                      Throwable t)

Invoked when the task has failed.

Specified by:

onFailure in interface TxTask<VtnDataFlow>

Overrides:

onFailure in class AbstractTxTask<VtnDataFlow>

Parameters:

provider - VTN Manager provider service.

t - A Throwable thrown by the task.