org.opendaylight.vtn.manager.internal

Interface TxContext

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

ReadTxContext

public interface TxContext
extends AutoCloseable

TxContext represents a runtime context used by tasks that uses MD-SAL datastore.

See Also:

TxTask

Method Summary

Methods

Modifier and Type	Method and Description
void	addPostSubmitHook(TxHook hook) Add the given transaction post-submit hook to this context.
void	addPreSubmitHook(TxHook hook) Add the given transaction pre-submit hook to this context.
void	cancelTransaction() Cancel current transaction for MD-SAL datastore.
void	close() Close this transaction context.
VTNManagerProvider	getProvider() Return a VTNManagerProvider service instance.
<T> T	getReadSpecific(Class<T> type) Return read-only data specific to the current transaction.
org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction	getReadWriteTransaction() Return read/write transaction for MD-SAL datastore.
<T> T	getSpecific(Class<T> type) Return writable data specific to the current transaction.
org.opendaylight.controller.md.sal.binding.api.ReadTransaction	getTransaction() Return read-only transaction for MD-SAL datastore.
void	log(org.slf4j.Logger logger, VTNLogLevel level, String msg) Log the specified message.
void	log(org.slf4j.Logger logger, VTNLogLevel level, String format, Object... args) Log a message according to the specified format string and arguments.
void	log(org.slf4j.Logger logger, VTNLogLevel level, String msg, Throwable t) Log the specified message and exception.
void	log(org.slf4j.Logger logger, VTNLogLevel level, Throwable t, String format, Object... args) Log the specified throwable and a message according to the given format string and arguments.

Method Detail

getTransaction

org.opendaylight.controller.md.sal.binding.api.ReadTransaction getTransaction()

Return read-only transaction for MD-SAL datastore.

Returns:

A ReadTransaction instance.

getReadWriteTransaction

org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction getReadWriteTransaction()

Return read/write transaction for MD-SAL datastore.

Returns:

A ReadWriteTransaction instance.

cancelTransaction

void cancelTransaction()

Cancel current transaction for MD-SAL datastore.

getReadSpecific

<T> T getReadSpecific(Class<T> type)

Return read-only data specific to the current transaction.

If an object specified by the given class is not associated with the current transaction, a new object is instantiated and it is associated with the current transaction. All the transaction specific data will be discarded when the transaction is closed.

Type Parameters:

T - The type of the transaction specific data.

Parameters:

type - A class that specifies the type of data. Note that the class must have a public constructor that takes one ReadTransaction instance.

Returns:

An object associated with the current transaction.

getSpecific

<T> T getSpecific(Class<T> type)

Return writable data specific to the current transaction.

If an object specified by the given class is not associated with the current transaction, a new object is instantiated and it is associated with the current transaction. All the transaction specific data will be discarded when the transaction is closed.

Type Parameters:

T - The type of the transaction specific data.

Parameters:

type - A class that specifies the type of data. Note that the class must have a public constructor that takes one TxContext instance.

Returns:

An object associated with the current transaction.

addPreSubmitHook

void addPreSubmitHook(TxHook hook)

Add the given transaction pre-submit hook to this context.

TxHook.run(TxContext, TxTask) on the given hook instance will be invoked just before the transaction is submitted.

Note that all the registered hooks are removed from this context when the transaction is closed.

Parameters:

hook - A hook to be invoked when the transaction is going to be submitted.

addPostSubmitHook

void addPostSubmitHook(TxHook hook)

Add the given transaction post-submit hook to this context.

TxHook.run(TxContext, TxTask) on the given hook instance will be invoked just after the successful completion of the transaction.

Note that all the registered hooks are removed from this context when the transaction is closed.

Parameters:

hook - A hook to be invoked after the successful completion of the transaction.

getProvider

VTNManagerProvider getProvider()

Return a VTNManagerProvider service instance.

Returns:

A VTNManagerProvider instance.

log

void log(org.slf4j.Logger logger,
       VTNLogLevel level,
       String msg)

Log the specified message.

If the MD-SAL transaction associated with this context is writable, the specified message will be logged when the transaction completes. Note that the specified message will be discarded when the transaction is restarted due to data confliction.

Parameters:

logger - A Logger instance.

level - A VTNLogLevel instance that specifies the logging level.

msg - A message to be logged.

log

void log(org.slf4j.Logger logger,
       VTNLogLevel level,
       String format,
       Object... args)

Log a message according to the specified format string and arguments.

This method constructs a message using SLF4J log format.

If the MD-SAL transaction associated with this context is writable, the specified message will be logged when the transaction completes. Note that the specified message will be discarded when the transaction is restarted due to data confliction.

Parameters:

logger - A Logger instance.

level - A VTNLogLevel instance that specifies the logging level.

format - A format string used to construct log message.

args - An object array used to construct log message.

log

void log(org.slf4j.Logger logger,
       VTNLogLevel level,
       String msg,
       Throwable t)

Log the specified message and exception.

If the MD-SAL transaction associated with this context is writable, the specified message will be logged when the transaction completes. Note that the specified message will be discarded when the transaction is restarted due to data confliction.

Parameters:

logger - A Logger instance.

level - A VTNLogLevel instance that specifies the logging level.

msg - A message to be logged.

t - A Throwable to be logged.

log

void log(org.slf4j.Logger logger,
       VTNLogLevel level,
       Throwable t,
       String format,
       Object... args)

Log the specified throwable and a message according to the given format string and arguments.

Note that this method constructs a log message using String.format(String, Object[]).

If the MD-SAL transaction associated with this context is writable, the specified message will be logged when the transaction completes. Note that the specified message will be discarded when the transaction is restarted due to data confliction.

Parameters:

logger - A Logger instance.

level - A VTNLogLevel instance that specifies the logging level.

t - A Throwable to be logged.

format - A format string used to construct log message.

args - An object array used to construct log message.

close

void close()

Close this transaction context.

Note that this method discards unsubmitted data in the transaction.

Specified by:

close in interface AutoCloseable