org.opendaylight.vtn.manager.internal.util.tx

Class CompositeTxTask<V,T extends AbstractTxTask<V>>

java.lang.Object

org.opendaylight.vtn.manager.internal.util.tx.AbstractTxTask<List<V>>

org.opendaylight.vtn.manager.internal.util.tx.CompositeTxTask<V,T>

Type Parameters:

V - The type of the object returned by the sub tasks.

T - The type of the sub task.

All Implemented Interfaces:

TxTask<List<V>>

Direct Known Subclasses:

FlowFilterTask, FlowMatchTask, PathCostTask, PathMapTask, RemoveMacEntryTask, RemoveVlanMapTask

public class CompositeTxTask<V,T extends AbstractTxTask<V>>
extends AbstractTxTask<List<V>>

An implementation of AbstractTxTask that executes multiple tasks on a single transaction.

This task returns a list of results of sub tasks. The order of results in the returned list is the same as the sub tasks configured in this task. Note that all sub tasks are required to return the same type of objects.

Constructor Summary

Constructors

Constructor and Description
CompositeTxTask(List<T> tasks) Construct a new task.

Method Summary

Modifier and Type	Method and Description
protected List<V>	execute(TxContext ctx) Execute all sub tasks on the given MD-SAL transaction context.
List<T>	getSubTasks() Return an immutable list of sub tasks.
boolean	needErrorLog(Throwable t) Determine whether the transaction queue should log the given error or not.
protected void	onCompleted(TxContext ctx, List<V> results) Invoked when all the sub tasks have completed.
void	onFailure(VTNManagerProvider provider, Throwable t) Invoked when the task has failed.
protected void	onStarted(TxContext ctx) Invoked when the MD-SAL datastore transaction has started.
void	onSuccess(VTNManagerProvider provider, List<V> result) Invoked when the task has completed successfully.

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

addBackgroundTask, execute, getBackgroundTasks, getMaxRetry

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

Constructor Detail

CompositeTxTask

public CompositeTxTask(List<T> tasks)

Construct a new task.

Parameters:

tasks - A list of tasks to be executed on a single transaction.

Throws:

IllegalArgumentException - The given task list is empty.

Method Detail

getSubTasks

public final List<T> getSubTasks()

Return an immutable list of sub tasks.

Returns:

An immutable list of sub tasks.

onStarted

protected void onStarted(TxContext ctx)
                  throws VTNException

Invoked when the MD-SAL datastore transaction has started.

Parameters:

ctx - A runtime context for transaction task.

Throws:

VTNException - An error occurred.

onCompleted

protected void onCompleted(TxContext ctx,
                           List<V> results)
                    throws VTNException

Invoked when all the sub tasks have completed.

Parameters:

ctx - A runtime context for transaction task.

results - A list of sub task results.

Throws:

VTNException - An error occurred.

execute

protected final List<V> execute(TxContext ctx)
                         throws VTNException

Execute all sub tasks on the given MD-SAL transaction context.

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<List<V>>

Parameters:

ctx - A runtime context for transaction task.

Returns:

Result of this task.

Throws:

VTNException - An error occurred.

needErrorLog

public boolean needErrorLog(Throwable t)

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

By default, this method returns true.

Parameters:

t - A Throwable that is going to be thrown.

Returns:

true if an error should be logged. false if an error log is not required.

onSuccess

public void onSuccess(VTNManagerProvider provider,
                      List<V> result)

Invoked when the task has completed successfully.

This method of this class does nothing.

Specified by:

onSuccess in interface TxTask<List<V>>

Overrides:

onSuccess in class AbstractTxTask<List<V>>

Parameters:

provider - VTN Manager provider service.

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

onFailure

public void onFailure(VTNManagerProvider provider,
                      Throwable t)

Invoked when the task has failed.

This method of this class does nothing.

Specified by:

onFailure in interface TxTask<List<V>>

Overrides:

onFailure in class AbstractTxTask<List<V>>

Parameters:

provider - VTN Manager provider service.

t - A Throwable thrown by the task.