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

Class TxEvent

java.lang.Object

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

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

All Implemented Interfaces:

TxTask<Void>

Direct Known Subclasses:

PacketInEvent, RoutingEvent, VtnNodeEvent, VtnPortEvent

public abstract class TxEvent
extends AbstractTxTask<Void>

A base class for event class delivered on a MD-SAL datastore transaction queue.

Constructor Summary

Constructors

Constructor and Description
TxEvent()

Method Summary

Modifier and Type	Method and Description
protected Void	execute(TxContext ctx) Deliver this event on a MD-SAL datastore transaction queue.
TxContext	getTxContext() Return a runtime context for transaction task.
boolean	isAsync() Determine whether this instance is associated with an asynchronous task or not.
protected abstract void	notifyEvent() Notify this event to event listener.
void	onFailure(VTNManagerProvider provider, Throwable t) Invoked when the task has failed.

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

addBackgroundTask, execute, getBackgroundTasks, getMaxRetry, onSuccess

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

needErrorLog

Constructor Detail

TxEvent

public TxEvent()

Method Detail

execute

protected Void execute(TxContext ctx)
                throws VTNException

Deliver this event on a MD-SAL datastore transaction queue.

Specified by:

execute in class AbstractTxTask<Void>

Parameters:

ctx - A runtime context for transaction task.

Returns:

null.

Throws:

VTNException - An error occurred.

getTxContext

public final TxContext getTxContext()

Return a runtime context for transaction task.

Returns:

A TxContext instance.

notifyEvent

protected abstract void notifyEvent()
                             throws VTNException

Notify this event to event listener.

Throws:

VTNException - An error occurred.

isAsync

public final boolean isAsync()

Determine whether this instance is associated with an asynchronous task or not.

This method always returns true because this instance is associated with an asynchronous event task.

Returns:

true.

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<Void>

Overrides:

onFailure in class AbstractTxTask<Void>

Parameters:

provider - VTN Manager provider service.

t - A Throwable thrown by the task.