Skip navigation links

Oracle Communications Services Gatekeeper Java API Reference
6.0

E55513-02


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

 

Method Detail

get

public Object get(String key)
Fetches the value associated with this key.
Parameters:
key - The key.
Returns:
The value associated with the key.

getCurrentAppAccountId

public String getCurrentAppAccountId()

getCurrentAppInstanceGroupId

public String getCurrentAppInstanceGroupId()

getCurrentSessionId

public String getCurrentSessionId()

getCurrentSpAccountId

public String getCurrentSpAccountId()

getCurrentSpGroup

public String getCurrentSpGroup()

getEdr

public Object getEdr(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 Map getMap()
Returns the map of the request context.
Returns:
The map of the request context.

getMapEdr

public Map getMapEdr()
Returns the map of the request context that is available to EDRs.
Returns:
The map of the request context.

getRmiGlobally

public Serializable getRmiGlobally(String key)

getTransactionId

public String getTransactionId()

getXParam

public String getXParam(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:
 <soapenv:Header>
   ...
   <xparams>
     

     

   </xparams>
 </soapenv:Header>
 
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 Map getXParamMap()
Returns:
- The map containing values added with putXParam(String, String), separate from the values available via getXParam(String).

put

public void put(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(String key,
                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(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(String key,
                   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(String key,
                           Serializable value)

putXParam

public void putXParam(String key,
                      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.

setCurrentSessionId

public void setCurrentSessionId(String sessionId)

setTransactionId

public void setTransactionId(String id)
Deprecated.  

Skip navigation links

Oracle Communications Services Gatekeeper Java API Reference
6.0

E55513-02


Copyright © 2008, 2015, Oracle and/or its affiliates. All rights reserved.