com.edorasware.commons.core.audit

Class BusinessTransactionState

java.lang.Object

com.edorasware.commons.core.audit.BusinessTransactionState

public final class BusinessTransactionState
extends Object

This class holds a stack of business transaction states. The stack allows for nesting of business transaction states and is bound to the current thread.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BusinessTransactionState.InitialState Describes the initial state of a new business transaction.

Method Summary

Modifier and Type	Method and Description
static void	clear() Removes the top business transaction state from the stack bound to the current thread.
static void	ensureInitialized(Function2<com.google.common.base.Optional<BusinessTransactionState>,BusinessTransactionState.InitialState,Map<String,Object>> initializationAction) Initializes the business transactions on the stack bound to the current thread from outermost to innermost.
static com.google.common.base.Optional<BusinessTransactionState>	get() Returns the top business transaction state from the stack bound to the current thread.
<T> com.google.common.base.Optional<T>	getAttribute(String attributeName, Class<T> expectedType) Returns the value of the attribute with the given name from the active state of the business transaction.
static com.google.common.base.Optional<BusinessTransactionState>	getBottom() Returns the bottom business transaction state from the stack bound to the current thread.
static BusinessTransactionState	pushWith(BusinessTransactionState.InitialState initialState) Pushes a new business transaction state onto the top of the stack bound to the current thread.

Methods inherited from class java.lang.Object

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

Method Detail

getAttribute

public <T> com.google.common.base.Optional<T> getAttribute(String attributeName,
                                                           Class<T> expectedType)

Returns the value of the attribute with the given name from the active state of the business transaction.

Type Parameters:

T - the type of the class

Parameters:

attributeName - the name of the attribute

expectedType - the expected type of the attribute value

Returns:

the attribute value

pushWith

public static BusinessTransactionState pushWith(BusinessTransactionState.InitialState initialState)

Pushes a new business transaction state onto the top of the stack bound to the current thread. The provided initial state will be processed when calling ensureInitialized(Function2) for the first time.

Parameters:

initialState - the initial state of the new business transaction

Returns:

the business transaction state bound to the current thread

get

public static com.google.common.base.Optional<BusinessTransactionState> get()

Returns the top business transaction state from the stack bound to the current thread.

Returns:

the top business transaction state bound to the current thread

getBottom

public static com.google.common.base.Optional<BusinessTransactionState> getBottom()

Returns the bottom business transaction state from the stack bound to the current thread.

Returns:

the bottom business transaction state bound to the current thread

clear

public static void clear()

Removes the top business transaction state from the stack bound to the current thread.

ensureInitialized

public static void ensureInitialized(Function2<com.google.common.base.Optional<BusinessTransactionState>,BusinessTransactionState.InitialState,Map<String,Object>> initializationAction)

Initializes the business transactions on the stack bound to the current thread from outermost to innermost. The given action processes the current initial state and the result becomes the active state of the business transaction. Each action is also passed the closest outer business transaction to enable linking from the inner one to the outer one. This method can be invoked multiple times, but only the first invocation on a given business transaction causes any state change to it.

Parameters:

initializationAction - the action that processes the current initial state, never null