weblogic.workarea

Interface UserWorkArea

All Superinterfaces:

java.io.Serializable

public interface UserWorkArea
extends java.io.Serializable

WARNING: very prelimanry APIs almost certainly subject to change. UserWorkArea provides end-users, ISVs and other mechanisms for tagging certain requests (whether remote or local) and propagating that information based on certain policy constraints. UserWorkArea is part of a client or applications JNDI environment and can be access through JNDI:

 UserWorkArea rc = (UserWorkArea)
 new InitialContext().lookup("java:comp/UserWorkArea");
 

Internal consumers of this service can also access the current UserWorkArea through a helper:

 UserWorkArea rc = WorkAreaHelper.
 getWorkAreaHelper().getWorkArea();
 

Excluded in public API Reference.

Method Summary

Modifier and Type	Method and Description
void	begin(java.lang.String name) Begin a new WorkArea, with remote propagation only, and associate it with the current thread.
void	begin(java.lang.String name, int propagationMode) Begin a new WorkArea, with propagation mode set to defaultPropertyMode, and associate it with the current thread.
void	complete() Complete the current, active WorkArea.
void	complete(java.lang.String name) Complete the active WorkArea named name.
java.lang.String[]	getKeys() Returns an array of all of the keys associated with the stack of WorkArea's for the current thread.
int	getMode(java.lang.String key) Get the current WorkArea's PropertyModeType value for key.
java.lang.String	getName() Returns the current WorkArea's name.
WorkContext	getProperty(java.lang.String key) Get the current WorkArea's value for key.
void	removeProperty(java.lang.String key) Remove the property for key from the current WorkArea.
void	setProperty(java.lang.String key, WorkContext ctx) Adds context data to the current WorkArea.
void	setProperty(java.lang.String key, WorkContext ctx, int propertyModeType) Adds context data to the current WorkArea.

Method Detail

begin

void begin(java.lang.String name)

Begin a new WorkArea, with remote propagation only, and associate it with the current thread. If a WorkArea is already associated with the current thread then the new WorkArea will overlay contexts within the already-existing WorkArea,

begin

void begin(java.lang.String name,
           int propagationMode)

Begin a new WorkArea, with propagation mode set to defaultPropertyMode, and associate it with the current thread. If a WorkArea is already associated with the current thread then the new WorkArea will overlay contexts within the already-existing WorkArea. Beginning a WorkArea merely assigns a unique name. Key value tuples that are set in the WorkArea are propagated based on propagation policies assigned to the WorkArea. By default a WorkArea is not propagated out of the current thread. Applying PropagationMode.THREAD allows a context to be propagated to Work instances. Applying PropagationMode.REMOTE allows a context to be propagated in RMI calls. Applying PropagationMode.TRANSACTION allows a context to be propagated between different global transactions. Applying PropagationMode.JMS_CONSUMER allows a context to be propagated to JMS consumers. Applying PropagationMode.JMS_PRODUCER allows a context to be propagated from JMS producers. Applying PropagationMode.SOAP allows a context to be propagated across SOAP messages. PropagationModes are additive and can be used together.

See Also:

PropagationMode

complete

void complete()
       throws NoWorkContextException

Complete the current, active WorkArea. Any nested values created by this WorkArea will be removed. If there is a parent WorkArea then that will become the new default WorkArea. Nested WorkAreas are not terminated by parent WorkAreas.

Throws:

NoWorkContextException

complete

void complete(java.lang.String name)
       throws NoWorkContextException

Complete the active WorkArea named name. Any nested values created by this WorkArea will be removed. If name corresponds to the current, active WorkArea and there is a parent WorkArea then that will become the new default WorkArea. Nested WorkAreas are not terminated by parent WorkAreas.

It is generally preferrable to end named work areas to avoid conflicts with other code using the WorkArea service.

Throws:

NoWorkContextException

getName

java.lang.String getName()

Returns the current WorkArea's name. Returns null if there is no active WorkArea. This method can be used to determine whether there is a current WorkArea.

getKeys

java.lang.String[] getKeys()

Returns an array of all of the keys associated with the stack of WorkArea's for the current thread. There is no guaranteed ordering of the returned keys. The set of keys includes all those of all enclosing WorkAreas.

setProperty

void setProperty(java.lang.String key,
                 WorkContext ctx)
          throws NoWorkContextException,
                 PropertyReadOnlyException

Adds context data to the current WorkArea. This context data is propagated according to the policyOptions that the context was started with. Any existing value for key will be overlaid.

Throws:

NoWorkContextException

PropertyReadOnlyException

setProperty

void setProperty(java.lang.String key,
                 WorkContext ctx,
                 int propertyModeType)
          throws NoWorkContextException,
                 PropertyReadOnlyException

Adds context data to the current WorkArea. This context data is propagated according to the provided policy. Any existing value for key will be overlaid. It is legal for multiple context data items to be propagated as long as their keys differ.

Throws:

NoWorkContextException

PropertyReadOnlyException

getProperty

WorkContext getProperty(java.lang.String key)

Get the current WorkArea's value for key. If the current WorkArea has no value for key then all parent WorkArea's are searched. If no WorkArea has a value for key then null is returned.

getMode

int getMode(java.lang.String key)

Get the current WorkArea's PropertyModeType value for key. If the current WorkArea has no value for key then all parent WorkArea's are searched. If no WorkArea has a value for key then null is PropertyModeType.NORMAL is returned.

removeProperty

void removeProperty(java.lang.String key)
             throws NoWorkContextException

Remove the property for key from the current WorkArea. This does not affect parent WorkAreas that have property values for key.

Throws:

NoWorkContextException