weblogic.workarea

Class WorkContextMapImpl

java.lang.Object

weblogic.workarea.WorkContextMapImpl

All Implemented Interfaces:

weblogic.workarea.spi.WorkContextMapInterceptor, WorkContextMap

final class WorkContextMapImpl
extends java.lang.Object
implements WorkContextMap, weblogic.workarea.spi.WorkContextMapInterceptor

Implementation of WorkContextMap. This instance holds a thread-local reference to the actual WorkContextMap implementation that does most of the work.

See Also:

WorkContextMap

Field Summary

Fields

Modifier and Type	Field and Description
private static weblogic.kernel.AuditableThreadLocal	localContextMap

Constructor Summary

Constructors

Constructor and Description
WorkContextMapImpl()

Method Summary

Modifier and Type	Method and Description
weblogic.workarea.spi.WorkContextMapInterceptor	copyThreadContexts(int mode) Return the thread-local contexts that should be propagated to new threads.
WorkContext	get(java.lang.String key) Get the current WorkContextMap's context data for key.
weblogic.workarea.spi.WorkContextMapInterceptor	getInterceptor()
private WorkContextMap	getMap()
private WorkContextMap	getMapMaybe()
int	getPropagationMode(java.lang.String key) Get the current WorkContextMap's PropagationMode value for key.
boolean	isEmpty() Tests to see whether there are any WorkContexts in existance in the map.
boolean	isPropagationModePresent(int propMode) Given a PropagationMode PropagationMode , this method will iterate over the map and return true if the propagation mode is present.
java.util.Iterator	iterator() Return a iterator for all of the current WorkContext entries.
java.util.Iterator	keys() Return a iterator for all of the current WorkContext keys.
WorkContext	put(java.lang.String key, WorkContext workContext) Adds context data with key key to the current WorkContextMap and associates it with the current thread.
WorkContext	put(java.lang.String key, WorkContext workContext, int propagationMode) Adds context data with key key to the current WorkContextMap and associates it with the current thread.
void	receiveRequest(WorkContextInput in) Transfer the protocol-specific WorkContextInput data to thread-local storage after receiving a request.
void	receiveResponse(WorkContextInput in) Transfer the protocol-specific WorkContextInput data to thread-local storage after receiving a response.
WorkContext	remove(java.lang.String key) Remove the context data for key from the current WorkContextMap.
private void	reset()
void	restoreThreadContexts(weblogic.workarea.spi.WorkContextMapInterceptor contexts) Restore thread-local contexts from contexts that should be propagated to new threads.
void	resumeThreadContexts(weblogic.workarea.spi.WorkContextMapInterceptor contexts) Resume thread-local contexts from contexts.
void	sendRequest(WorkContextOutput out, int propagationMode) Transfer WorkContexts from thread-local storage to the protocol-specific WorkContextOutput before making an outbound request.
void	sendResponse(WorkContextOutput out, int propagationMode) Transfer WorkContexts from thread-local storage to the protocol-specific WorkContextOutput before sending a response.
void	setInterceptor(weblogic.workarea.spi.WorkContextMapInterceptor interceptor)
weblogic.workarea.spi.WorkContextMapInterceptor	suspendThreadContexts() Remove and return all the thread-local contexts from the current thread.
int	version() Return a version indicator for the current WorkContextMap.

Methods inherited from class java.lang.Object

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

Field Detail

localContextMap

private static final weblogic.kernel.AuditableThreadLocal localContextMap

Constructor Detail

WorkContextMapImpl

WorkContextMapImpl()

Method Detail

put

public WorkContext put(java.lang.String key,
                       WorkContext workContext,
                       int propagationMode)
                throws PropertyReadOnlyException

Description copied from interface: WorkContextMap

Adds context data with key key to the current WorkContextMap and associates it with the current thread. This context data is propagated according to the provided mode propagationMode. Any existing value for key will be changed as per the property mode propertyModeType. It is legal for multiple context data items to be propagated as long as their keys differ. Properties that are set in the WorkContextMap are propagated based on propagation policies assigned to the property. By default a property is not propagated out of the current thread. Applying PropagationMode.WORK allows a property to be propagated to Work instances. Applying PropagationMode.RMI allows a property to be propagated in RMI calls. Applying PropagationMode.TRANSACTION allows a property to be propagated between different global transactions. Applying PropagationMode.JMS_QUEUE allows a property to be propagated to JMS consumers. Applying PropagationMode.JMS_TOPIC allows a property to be propagated from JMS producers. Applying PropagationMode.SOAP allows a property to be propagated across SOAP messages. Applying PropagationMode.MIME_HEADER allows a property to be propagated from mail messages or cookies. PropagationModes are additive and can be used together. PropagationMode.GLOBAL is an alias for PropagationMode.RMI, PropagationMode.SOAP, PropagationMode.JMS_QUEUE and PropagationMode.MIME_HEADERS

Specified by:

put in interface WorkContextMap

Parameters:

key - a unique String that is used to obtain a reference to a particular WorkContext. Keys are encoded as DataOutput.writeUTF(java.lang.String). In order to protect the key namespace a good convention is to use package names as a prefix. For example com.you.SomeKey.

workContext - The WorkContext to put in the map. specifies how the WorkContext entry can be modified.

propagationMode - a bitwise-OR of PropagationMode values prescribing how the WorkContext entry should be propagated.

Returns:

the previous WorkContext for key

Throws:

PropertyReadOnlyException - if the property already exists and is read-only.

See Also:

PropagationMode

put

public WorkContext put(java.lang.String key,
                       WorkContext workContext)
                throws PropertyReadOnlyException

Description copied from interface: WorkContextMap

Adds context data with key key to the current WorkContextMap and associates it with the current thread. The context data is propagated according to the default PropagationMode. The defaults are PropagationMode.DEFAULT.

Specified by:

put in interface WorkContextMap

Parameters:

key - a unique String that is used to obtain a reference to a particular WorkContext. Keys are encoded as DataOutput.writeUTF(java.lang.String). In order to protect the key namespace a good convention is to use package names as a prefix. For example com.you.SomeKey}.

workContext - The WorkContext to put in the map.

Returns:

the previous WorkContext for key

Throws:

PropertyReadOnlyException - if the property already exists and is read-only.

get

public WorkContext get(java.lang.String key)

Description copied from interface: WorkContextMap

Get the current WorkContextMap's context data for key. If the current WorkContextMap has no value for key then null is returned.

Specified by:

get in interface WorkContextMap

Parameters:

key - a unique String that is used to obtain a reference to a particular WorkContext

Returns:

a WorkContext value or null if there is none.

remove

public WorkContext remove(java.lang.String key)
                   throws NoWorkContextException,
                          PropertyReadOnlyException

Description copied from interface: WorkContextMap

Remove the context data for key from the current WorkContextMap. This will throw PropertyReadOnlyException if the permissions on the key do not allow deletion.

Specified by:

remove in interface WorkContextMap

Parameters:

key - a unique String that is used to obtain a reference to a particular WorkContext

Returns:

the removed WorkContext

Throws:

NoWorkContextException - if there is no mapping for key

PropertyReadOnlyException - if a mapping exists but is read-only.

getPropagationMode

public int getPropagationMode(java.lang.String key)

Description copied from interface: WorkContextMap

Get the current WorkContextMap's PropagationMode value for key. If the current WorkContextMap has no value for key then PropagationMode.LOCAL is returned.

Specified by:

getPropagationMode in interface WorkContextMap

Parameters:

key - a unique String that is used to obtain a reference to a particular WorkContext

Returns:

a bitwise-OR of PropagationMode values prescribing how the WorkContext entry should be propagated.

isPropagationModePresent

public boolean isPropagationModePresent(int propMode)

Description copied from interface: WorkContextMap

Given a PropagationMode PropagationMode , this method will iterate over the map and return true if the propagation mode is present. The method should return true if there exists at least one entry in the map which has at least one propagation mode specified by propMode

Specified by:

isPropagationModePresent in interface WorkContextMap

Parameters:

propMode - PropagationMode value

Returns:

boolean true or false

isEmpty

public boolean isEmpty()

Description copied from interface: WorkContextMap

Tests to see whether there are any WorkContexts in existance in the map. Returns true if there are no elements in the map, false otherwise.

Specified by:

isEmpty in interface WorkContextMap

Returns:

a boolean value

reset

private void reset()

iterator

public java.util.Iterator iterator()

Description copied from interface: WorkContextMap

Return a iterator for all of the current WorkContext entries. If there are no entries then null is returned.

Specified by:

iterator in interface WorkContextMap

Returns:

a Iterator representing the current entries.

keys

public java.util.Iterator keys()

Description copied from interface: WorkContextMap

Return a iterator for all of the current WorkContext keys. If there are no entries then null is returned.

Specified by:

keys in interface WorkContextMap

Returns:

a Iterator representing the current keys.

version

public int version()

Description copied from interface: weblogic.workarea.spi.WorkContextMapInterceptor

Return a version indicator for the current WorkContextMap. The version will change when properties in the map are added, removed or changed.

Specified by:

version in interface weblogic.workarea.spi.WorkContextMapInterceptor

Returns:

version indicator.

getMapMaybe

private final WorkContextMap getMapMaybe()

getMap

private final WorkContextMap getMap()

getInterceptor

public weblogic.workarea.spi.WorkContextMapInterceptor getInterceptor()

setInterceptor

public void setInterceptor(weblogic.workarea.spi.WorkContextMapInterceptor interceptor)

sendRequest

public void sendRequest(WorkContextOutput out,
                        int propagationMode)
                 throws java.io.IOException

Description copied from interface: weblogic.workarea.spi.WorkContextMapInterceptor

Transfer WorkContexts from thread-local storage to the protocol-specific WorkContextOutput before making an outbound request. This must be called at the appropriate time before any thread context-switches. This call does not affect the contents of thread-local storage in any way.

Specified by:

sendRequest in interface weblogic.workarea.spi.WorkContextMapInterceptor

Parameters:

out - TheWorkContextOutput implementation to marshal the WorkContextMap data to.

propagationMode - The PropagationMode being utilized in this call. This is a hint to the runtime system.

Throws:

java.io.IOException - if the data cannot be serialized.

sendResponse

public void sendResponse(WorkContextOutput out,
                         int propagationMode)
                  throws java.io.IOException

Description copied from interface: weblogic.workarea.spi.WorkContextMapInterceptor

Transfer WorkContexts from thread-local storage to the protocol-specific WorkContextOutput before sending a response. This must be called at the appropriate time before any thread context-switches. This call does not affect the contents of thread-local storage in any way.

Specified by:

sendResponse in interface weblogic.workarea.spi.WorkContextMapInterceptor

Parameters:

out - TheWorkContextOutput implementation to marshal the WorkContextMap data to.

propagationMode - The PropagationMode being utilized in this call. This is a hint to the runtime system.

Throws:

java.io.IOException - if the data cannot be serialized.

receiveRequest

public void receiveRequest(WorkContextInput in)
                    throws java.io.IOException

Description copied from interface: weblogic.workarea.spi.WorkContextMapInterceptor

Transfer the protocol-specific WorkContextInput data to thread-local storage after receiving a request. This must be called at the appropriate time after any thread context-switches. All existing thread-local contexts are overwritten, athough in general the thread execution model should ensure that there are no existing thread-local contexts.

Specified by:

receiveRequest in interface weblogic.workarea.spi.WorkContextMapInterceptor

Parameters:

in - The WorkContextInput implementation to read WorkContextMap data from.

Throws:

java.io.IOException - if the data cannot be read.

receiveResponse

public void receiveResponse(WorkContextInput in)
                     throws java.io.IOException

Description copied from interface: weblogic.workarea.spi.WorkContextMapInterceptor

Transfer the protocol-specific WorkContextInput data to thread-local storage after receiving a response. This must be called at the appropriate time after any thread context-switches. The data is merged with any existing thread-local contexts. in may be null which means that the callee removed all of the WorkContexts.

Specified by:

receiveResponse in interface weblogic.workarea.spi.WorkContextMapInterceptor

Parameters:

in - The WorkContextInput implementation to read WorkContextMap data from.

Throws:

java.io.IOException - if the data cannot be read.

copyThreadContexts

public weblogic.workarea.spi.WorkContextMapInterceptor copyThreadContexts(int mode)

Description copied from interface: weblogic.workarea.spi.WorkContextMapInterceptor

Return the thread-local contexts that should be propagated to new threads. Callers should not attempt to modify or use the returned object in any way other than to call WorkContextMapInterceptor.restoreThreadContexts(weblogic.workarea.spi.WorkContextMapInterceptor) or one of the interceptor functions. The existing thread-local contexts are not modified in any way. While the returned WorkContextMap is a new instance, the contained values are not, so developers should not attempt to update the contents of the values.

Specified by:

copyThreadContexts in interface weblogic.workarea.spi.WorkContextMapInterceptor

Parameters:

mode - only contexts with this PropagationMode will be copied. mode can be a bit-wise OR of PropagationModes

Returns:

a WorkContextMapInterceptor that contains the WorkContextMap data to be propagated.

restoreThreadContexts

public void restoreThreadContexts(weblogic.workarea.spi.WorkContextMapInterceptor contexts)

Description copied from interface: weblogic.workarea.spi.WorkContextMapInterceptor

Restore thread-local contexts from contexts that should be propagated to new threads. contexts must have been obtained as a result of calling WorkContextMapInterceptor.copyThreadContexts(int). Existing thread-local contexts are overwritten, although in general there should be none.

Specified by:

restoreThreadContexts in interface weblogic.workarea.spi.WorkContextMapInterceptor

Parameters:

contexts - an WorkContextMapInterceptor obtained via WorkContextMapInterceptor.copyThreadContexts(int).

suspendThreadContexts

public weblogic.workarea.spi.WorkContextMapInterceptor suspendThreadContexts()

Description copied from interface: weblogic.workarea.spi.WorkContextMapInterceptor

Remove and return all the thread-local contexts from the current thread. thread. Callers should not attempt to modify or use the returned object in any way other than to call WorkContextMapInterceptor.resumeThreadContexts(weblogic.workarea.spi.WorkContextMapInterceptor) or another interceptor function. The intention of this call is that a service provider will have already called WorkContextMapInterceptor.sendRequest(weblogic.workarea.WorkContextOutput, int) or WorkContextMapInterceptor.sendResponse(weblogic.workarea.WorkContextOutput, int) to transfer thread-local contexts to a remote message and this call is used to prevent other RMI mechnisms being involved.

Specified by:

suspendThreadContexts in interface weblogic.workarea.spi.WorkContextMapInterceptor

Returns:

a WorkContextMapInterceptor that contains the WorkContextMap data to be saved.

resumeThreadContexts

public void resumeThreadContexts(weblogic.workarea.spi.WorkContextMapInterceptor contexts)

Description copied from interface: weblogic.workarea.spi.WorkContextMapInterceptor

Resume thread-local contexts from contexts. contexts must have been obtained as a result of calling WorkContextMapInterceptor.suspendThreadContexts(). All existing thread-local contexts are overwritten, although in general there should be none.

Specified by:

resumeThreadContexts in interface weblogic.workarea.spi.WorkContextMapInterceptor

Parameters:

contexts - a WorkContextMapInterceptor obtained via WorkContextMapInterceptor.suspendThreadContexts().