com.sap.netweaver.bc.rf.util.context

Class AbstractIndependentThreadContextFactory

java.lang.Object
  com.sap.netweaver.bc.rf.util.context.AbstractContextFactory
      com.sap.netweaver.bc.rf.util.context.AbstractIndependentThreadContextFactory

All Implemented Interfaces:

IContextFactory

Direct Known Subclasses:

AccessContextFactory

public abstract class AbstractIndependentThreadContextFactory
extends AbstractContextFactory

Abstract context factory base class for thread-local-based context factory interface implementations being independent from other context factory implementations. All writing optional operations can be supported in independent context factories.

See Also:

IContextFactory

Field Summary

protected ThreadLocal

threadLocal

Constructor Summary

protected

AbstractIndependentThreadContextFactory() Construct object of class AbstractIndependentThreadContextFactory.

Method Summary

protected IContextStack	getContextStack() Internally get the stack of contexts associated with the actual thread.
Object	getTypeUnsafeContext() Get actual context from stack of contexts.
Object	getTypeUnsafeContextOrNullIfUnavailable() Get actual context from stack of contexts.
boolean	isAvailable() Checks if there is at least one actual context stacked.
Object	popTypeUnsafeContext() Get and remove actual context from the stack of contexts.
void	pushTypeUnsafeContext(Object context) Add new context to the top of the stack of contexts.
void	removeTypeUnsafeContext() Remove actual context including all other stacked contexts completely (optional operation).
protected void	setContextStack(IContextStack contextStack) Internally get the stack of contexts associated with the actual thread.
void	setTypeUnsafeContext(Object context) Replace actual context with new one in stack of contexts.
int	size() Get the number of context entries in the stack of contexts.

Methods inherited from class java.lang.Object

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

Field Detail

threadLocal

protected ThreadLocal threadLocal

Constructor Detail

AbstractIndependentThreadContextFactory

protected AbstractIndependentThreadContextFactory()
                                           throws ContextFactoryRegistrationError

Construct object of class AbstractIndependentThreadContextFactory.

Throws:

ContextFactoryRegistrationError - when the context factory is already registered with the context factory registry

Method Detail

getContextStack

protected IContextStack getContextStack()

Internally get the stack of contexts associated with the actual thread.

Returns:

stack of contexts

setContextStack

protected void setContextStack(IContextStack contextStack)

Internally get the stack of contexts associated with the actual thread.

Parameters:

contextStack - The new contextStack value

isAvailable

public boolean isAvailable()

Checks if there is at least one actual context stacked.

Returns:

flag indicating whether there is at least one actual context stacked

size

public int size()

Get the number of context entries in the stack of contexts.

Returns:

number of context entries in the stack of contexts

getTypeUnsafeContext

public Object getTypeUnsafeContext()
                            throws ContextUnavailableException

Get actual context from stack of contexts.

Returns:

actual context on the context stack

Throws:

ContextUnavailableException - when no (more) context is available on the context stack

getTypeUnsafeContextOrNullIfUnavailable

public Object getTypeUnsafeContextOrNullIfUnavailable()

Get actual context from stack of contexts. Return null if none is availble and don't throw a ContextUnavailableException.

Returns:

actual context on the context stack

setTypeUnsafeContext

public void setTypeUnsafeContext(Object context)

Replace actual context with new one in stack of contexts. If no context is stored, this one will be added.

Parameters:

context - new actual context replacing the old one on the stack

removeTypeUnsafeContext

public void removeTypeUnsafeContext()
                             throws UnsupportedOperationException

Remove actual context including all other stacked contexts completely (optional operation).

Throws:

UnsupportedOperationException - when the context factory isn't supporting this writing optional operation

popTypeUnsafeContext

public Object popTypeUnsafeContext()
                            throws ContextUnavailableException

Get and remove actual context from the stack of contexts.

Returns:

last actual context on the context stack

Throws:

ContextUnavailableException - when no (more) context is available on the context stack

pushTypeUnsafeContext

public void pushTypeUnsafeContext(Object context)

Add new context to the top of the stack of contexts.

Parameters:

context - new actual context

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM