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

Class ReadTxContext

java.lang.Object

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

All Implemented Interfaces:

AutoCloseable, TxContext

public final class ReadTxContext
extends Object
implements TxContext

Implementation of read-only MD-SAL transaction context.

Note that this class is not synchronized.

Constructor Summary

Constructors

Constructor and Description
ReadTxContext(VTNManagerProvider provider) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
void	addPostSubmitHook(TxHook hook) This method always throws an exception because transaction post-submit hook is not supported.
void	addPreSubmitHook(TxHook hook) This method always throws an exception because transaction pre-submit hook is not supported.
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() This method always throws an exception because this transaction is read-only.
<T> T	getSpecific(Class<T> type) This method always throws an exception because this transaction is read-only.
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReadTxContext

public ReadTxContext(VTNManagerProvider provider)

Construct a new instance.

Parameters:

provider - A VTNManagerProvider instance.

Method Detail

getTransaction

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

Return read-only transaction for MD-SAL datastore.

Specified by:

getTransaction in interface TxContext

Returns:

A ReadTransaction instance.

getReadWriteTransaction

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

This method always throws an exception because this transaction is read-only.

Specified by:

getReadWriteTransaction in interface TxContext

Returns:

Never returns.

Throws:

IllegalStateException - Always thrown.

cancelTransaction

public void cancelTransaction()

Cancel current transaction for MD-SAL datastore.

Specified by:

cancelTransaction in interface TxContext

getReadSpecific

public <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.

Specified by:

getReadSpecific in interface TxContext

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

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

This method always throws an exception because this transaction is read-only.

Specified by:

getSpecific in interface TxContext

Type Parameters:

T - The type of the transaction specific data.

Parameters:

type - A class that specifies the type of data.

Returns:

Never returns.

Throws:

IllegalStateException - Always thrown.

addPreSubmitHook

public void addPreSubmitHook(TxHook hook)

This method always throws an exception because transaction pre-submit hook is not supported.

Specified by:

addPreSubmitHook in interface TxContext

Parameters:

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

Throws:

IllegalStateException - Always thrown.

addPostSubmitHook

public void addPostSubmitHook(TxHook hook)

This method always throws an exception because transaction post-submit hook is not supported.

Specified by:

addPostSubmitHook in interface TxContext

Parameters:

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

Throws:

IllegalStateException - Always thrown.

getProvider

public VTNManagerProvider getProvider()

Return a VTNManagerProvider service instance.

Specified by:

getProvider in interface TxContext

Returns:

A VTNManagerProvider instance.

log

public 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.

Specified by:

log in interface TxContext

Parameters:

logger - A Logger instance.

level - A VTNLogLevel instance that specifies the logging level.

msg - A message to be logged.

log

public 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.

Specified by:

log in interface TxContext

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

public 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.

Specified by:

log in interface TxContext

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

public 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.

Specified by:

log in interface TxContext

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

public void close()

Close this transaction context.

Note that this method discards unsubmitted data in the transaction.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface TxContext