com.bea.wlcp.wlng.api.plugin.context
Interface RequestContext

public interface RequestContext

Interface defining a RequestContext. A RequestContext is available in all new traffic paths for application facing and network facing requests.

Method Summary

abstract java.lang.Object	get(java.lang.String key) Fetches the value associated with this key.
abstract java.lang.String	getCurrentAppAccountId()
abstract java.lang.String	getCurrentAppInstanceGroupId()
abstract java.lang.String	getCurrentSessionId()
abstract java.lang.String	getCurrentSpAccountId()
abstract java.lang.String	getCurrentSpGroup()
abstract java.lang.Object	getEdr(java.lang.String key) Fetches the value associated with this key only if it is available to EDRs.
abstract java.util.Map	getMap() Returns the map of the request context.
abstract java.util.Map	getMapEdr() Returns the map of the request context that is available to EDRs.
abstract java.io.Serializable	getRmiGlobally(java.lang.String key)
abstract java.lang.String	getTransactionId()
abstract java.lang.String	getXParam(java.lang.String key) Fetches the String associated with this key.
abstract java.util.Map	getXParamMap()
abstract void	lockEdrData()
abstract void	put(java.util.Map value) Puts a map in the request context.
abstract void	put(java.lang.String key, java.lang.Object value) Associates a value with a key in the request context.
abstract void	putEdr(java.util.Map value) Puts a map in the request context.
abstract void	putEdr(java.lang.String key, java.lang.Object value) Associates a value with a key in the request context.
abstract void	putRmiGlobally(java.lang.String key, java.io.Serializable value)
abstract void	putXParam(java.lang.String key, java.lang.String value) Allows adding params to the SOAP Header being sent to the application.
abstract void	setCurrentSessionId(java.lang.String sessionId)
abstract void	setTransactionId(java.lang.String id) Deprecated.
abstract void	unlockEdrData()

Method Detail

get

public java.lang.Object get(java.lang.String key)

Fetches the value associated with this key.

Parameters:

key - The key.

Returns:

The value associated with the key.

getCurrentAppAccountId

public java.lang.String getCurrentAppAccountId()

getCurrentAppInstanceGroupId

public java.lang.String getCurrentAppInstanceGroupId()

getCurrentSessionId

public java.lang.String getCurrentSessionId()

getCurrentSpAccountId

public java.lang.String getCurrentSpAccountId()

getCurrentSpGroup

public java.lang.String getCurrentSpGroup()

getEdr

public java.lang.Object getEdr(java.lang.String key)

Fetches the value associated with this key only if it is available to EDRs.

Parameters:

key - The key.

Returns:

The value associated with the key.

getMap

public java.util.Map getMap()

Returns the map of the request context.

Returns:

The map of the request context.

getMapEdr

public java.util.Map getMapEdr()

Returns the map of the request context that is available to EDRs.

Returns:

The map of the request context.

getRmiGlobally

public java.io.Serializable getRmiGlobally(java.lang.String key)

getTransactionId

public java.lang.String getTransactionId()

getXParam

public java.lang.String getXParam(java.lang.String key)

Fetches the String associated with this key. It tries to retrieve this information from the extending parameter that can be added by a client through the SOAP Header. Example of a client sending the a SOAP Header and retrieving a value:

 
   ...
   
     
     
   
 
 

The value "1" can be retrieved using getXParam("a");. If the value does not exist, null will be returned.

Parameters:

key - The key.

Returns:

The value associated with the key.

getXParamMap

public java.util.Map getXParamMap()

Returns:

- The map containing values added with putXParam(String, String), separate from the values available via getXParam(String).

lockEdrData

public void lockEdrData()

put

public void put(java.util.Map value)

Puts a map in the request context. Note: This map will not be available to Edrs. Use the alternate putEdr() method to make this map available to Edrs.

Parameters:

value - The map to put in the request context.

put

public void put(java.lang.String key,
                java.lang.Object value)

Associates a value with a key in the request context. Note: this key/value will not be available to EDRs. Use the alternate putEdr() method to make this key/value available to EDRs.

Parameters:

key - The key.

value - The value to associate with the key.

putEdr

public void putEdr(java.util.Map value)

Puts a map in the request context. This map will be included in all Edrs for the current thread.

Parameters:

value - The map to put in the request context.

putEdr

public void putEdr(java.lang.String key,
                   java.lang.Object value)

Associates a value with a key in the request context. This key/value pair will be included in all EDRs for the current thread.

Parameters:

key - The key.

value - The value to associate with the key.

putRmiGlobally

public void putRmiGlobally(java.lang.String key,
                           java.io.Serializable value)

putXParam

public void putXParam(java.lang.String key,
                      java.lang.String value)

Allows adding params to the SOAP Header being sent to the application. Application terminated requests as well as responses to application requests could potentially contain a header with extended parameters.

Parameters:

key - key.

value - value.

setCurrentSessionId

public void setCurrentSessionId(java.lang.String sessionId)

setTransactionId

public void setTransactionId(java.lang.String id)

Deprecated.

unlockEdrData

public void unlockEdrData()