Web services gateway - The gateway message context values

The gateway message context holds the contextual information for each incoming message.

In WebSphere Application Server Enterprise Version 5 or WebSphere Business Integration Server Foundation Version 5.1 you can use the Context Field Constant values if you import the com.ibm.wsgw.GatewayContextNames class.

For basic information on the fields that are available in the context, see the Javadoc for the GatewayContextNames class. Additional information on all of these fields except AUTH_SUBJECT and copyright is provided in the following table.

Treat all of the context fields as Read only. If your filter attempts to write to a context field, you do not get an error message (because the write does not actually fail) but subsequent system behavior is not readily predictable.

If you want to change the target service location and port name fields, then you can use the Routing interface to get the list of valid target service locations and to select the target service location. For more information see Using a filter to select a target service and port.

Context Field Constant Description
AUTH_PASSWORD Read the password from the incoming HTTP request (where available)
AUTH_USER_NAME Read the user name from the incoming HTTP request (where available).
GATEWAY_SERVICE_NAME Name of the gateway service for which the request was received.
MESSAGE_ID A server-unique ID that is set by the channel and used to correlate messages, for example in trace. You can make this ID globally unique by using the host name as a prefix.
RECEIVING_CHANNEL_NAME Name of the channel on which the request was received.
REQUEST_SOAP_HEADERS Retrieve the SOAP headers for an inbound SOAP request. SOAP Headers are returned as a vector of nodes.
RESPONSE_SOAP_HEADERS Retrieve the SOAP headers for an outbound SOAP response. SOAP Headers are returned as an array of nodes.
RETRY_COUNT Number of retries for the request. This constant is NOT CURRENTLY USED.
SOAP_HEADERS Retrieve the SOAP headers for an inbound SOAP request. SOAP Headers are returned as a vector of nodes. This constant is deprecated (use the REQUEST_SOAP_HEADERS constant).
TARGET_PORT_NAME Currently selected port name. This constant is set after service invocation, therefore the constant can only be got by response filters. See also Using a filter to select a target service and port.
TARGET_SERVICE_LOCATION Gives the location of the currently selected target service WSDL, name and namespace.
TIMEOUT_TIME Time-out value for the response. This constant is NOT CURRENTLY USED.



Related tasks
Writing a filter for the Web services gateway
Creating and returning a SOAP fault message from a filterResponse method
Related reference
Web services gateway - The Filter interface



Searchable topic ID:   rwsg_pme_context
Last updated: Jun 21, 2007 8:07:48 PM CDT    WebSphere Business Integration Server Foundation, Version 5.0.2
http://publib.boulder.ibm.com/infocenter/wasinfo/index.jsp?topic=/com.ibm.wasee.doc/info/ee/wsg/ref/rwsg_pme_context.html

Library | Support | Terms of Use | Feedback