Package com.hybris.cockpitng.core.spring

Class RequestOperationContextHolder

java.lang.Object

com.hybris.cockpitng.core.spring.RequestOperationContextHolder

public class RequestOperationContextHolder
extends java.lang.Object

Singleton object which holds scope contexts specific to thread tree

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RequestOperationContextHolder.ContextRequest	An object representing a request for scope context.

Method Summary

Modifier and Type	Method	Description
void	attachToContext(RequestOperationContextHolder.ContextRequest contextRequest)	Joins operation performed by current thread to scope context prepared earlier by calling prepareForOperation().
protected RequestOperationContext	createContext()
protected RequestOperationContextHolder.ContextRequest	createContextRequest()
void	detachFromContext()	Disjoints operation performed by current thread from scope context prepared earlier by calling prepareForOperation().
protected void	detachRequestThreadFromContext(java.lang.Object requestId)
protected void	detachThreadFromContext(java.lang.Thread thread)
RequestOperationContext	getContext()	Obtains a context for current thread if available, otherwise throws IllegalStateException
boolean	hasContext()	Checks if context for current thread is available
void	initializeContext()	Initializes new request operation context and binds it to current thread.
static RequestOperationContextHolder	instance()	Retrieve the instance of the singleton
RequestOperationContextHolder.ContextRequest	prepareForOperation()	Prepares a context for current thread (if not yet created).

Methods inherited from class java.lang.Object

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

Method Detail

instance

public static RequestOperationContextHolder instance()

Retrieve the instance of the singleton

Returns:

The RequestOperationContextHolder singleton instance

initializeContext

public void initializeContext()

Initializes new request operation context and binds it to current thread. If any other context is already bound with current thread, thread detaches from it (see detachFromContext()).

prepareForOperation

public RequestOperationContextHolder.ContextRequest prepareForOperation()

Prepares a context for current thread (if not yet created). Method should be called in the thread that has a context already attached or is a root thread. It reserves resources for new operation context. It is required that an operation is actually started and attaches itself by calling attachToContext(ContextRequest).

Returns:

a handle to prepared context

See Also:

attachToContext(ContextRequest)

createContextRequest

protected RequestOperationContextHolder.ContextRequest createContextRequest()

createContext

protected RequestOperationContext createContext()

attachToContext

public void attachToContext(RequestOperationContextHolder.ContextRequest contextRequest)

Joins operation performed by current thread to scope context prepared earlier by calling prepareForOperation(). Method should be called in the operation's thread.

Parameters:

contextRequest - scope context request enquired by prepareForOperation() call

detachFromContext

public void detachFromContext()

Disjoints operation performed by current thread from scope context prepared earlier by calling prepareForOperation(). Method should be called in the operation's thread. If context is no longer used, then it is cleared and removed.

detachRequestThreadFromContext

protected void detachRequestThreadFromContext(java.lang.Object requestId)

detachThreadFromContext

protected void detachThreadFromContext(java.lang.Thread thread)

hasContext

public boolean hasContext()

Checks if context for current thread is available

Returns:

true if there is a context correlated with this thread

See Also:

initializeContext()

getContext

public RequestOperationContext getContext()

Obtains a context for current thread if available, otherwise throws IllegalStateException

Returns:

context correlated with this thread

See Also:

initializeContext()