CloudStreams 10.5 | webMethods CloudStreams | Administering webMethods CloudStreams | Virtual Services | Creating a New Virtual Service (SOAP) | IS Service Constructs | Using Context Variables in IS Services | The Predefined Context Variables
 
The Predefined Context Variables
You can use the predefined context variables listed below. Any context variable state defined during the inbound request processing steps will still be available during the outbound response processing steps.
Note:
To set, get or remove the predefined context variables, use the API for context variables provided by CloudStreams (see The API for Context Variables).
Note:
You do not need to declare the predefined context variables. If you attempt to declare an existing predefined context variable, an error will occur.
Context Variable Display Name
Context Variable Name
Description
Average Response
AVG_SUCCESS_TIME
The average amount of time it took the service to complete all invocations in the current interval. Response time is measured from the moment CloudStreams receives the request until the moment it returns the response to the caller.
Client IP Address
INBOUND_IP
The IP address used to send the request to CloudStreams.
CloudStreams Host Name
HOSTNAME
CloudStreams host name.
CloudStreams IP Address
SERVER_IP
CloudStreams IP address.
CloudStreams Target Name
TARGET_NAME
CloudStreams target name.
Consumer
CONSUMER_APPLICATION
The name of the consumer application accessing the service, if known.
Fault Count
INTERVAL_FAULT_COUNT
The number of invocations of the service resulting in a fault in the current interval.
Inbound Content Type
MESSAGE_TYPE
A Content-Type defined in axis2.xml for a message formatter. This value must be a key in the axis2 message formatters list, since it is used to control message serialization. (The valid choices are defined as attributes of <messageFormatters/> group in Integration Server's axis2.xml configuration.)
Inbound HTTP Method
INBOUND_HTTP_METHOD
The HTTP method used by the client to send the request (GET, POST, PUT, DELETE, CUSTOM).
Inbound Protocol
INBOUND_PROTOCOL
The protocol (HTTP or HTTPS) of the request.
Maximum Response
SLOWEST_SUCCESS_INVOKE
The maximum amount of time it should take for the service to complete an invocation. Response time is measured from the moment CloudStreams receives the request until the moment it returns the response to the caller.
Minimum Response
FASTEST_SUCCESS_INVOKE
The minimum amount of time it should take for the service to complete an invocation.
Outbound HTTP Method
ROUTING_METHOD
The HTTP method to be sent to the native service if the inbound HTTP method is custom. Otherwise, this value will be null. For more information, see Changing the HTTP Method of a REST Virtual Service.
Success Count
INTERVAL_SUCCESS_COUNT
The number of successful invocations of the service in the current interval.
Total Count
INTERVAL_TOTAL_COUNT
The total number of invocations (successful or unsuccessful) of the service in the current interval.
Virtual Service Name
SERVICE_NAME
Virtual service name.
(not displayed)
BUILDER_TYPE
A Content Type defined in axis2.xml for a message builder. This value must be a key in the axis2 message builders list, since it is used to control building of native service response messages. (The valid choices are defined as attributes of <messageBuilders/> group in Integration Server's axis2.xml configuration.)
(not displayed)
INBOUND_REQUEST_URI
A partial reference to a virtual service (for HTTP/HTTPS only). The protocol, host and port are not part of the value. For example, if the following virtual service is invoked:
http://user:5555/ws/TC1
then the expected value of this variable would be /ws/TC1.
For a REST or XML service, the URL might also include query string parameters. For example, if the following virtual service is invoked:
http://user:5555/ws/cars?vin=1234
then the expected value of this variable would be /ws/cars?vin1234.
This is useful to know because by the time you are able to access the request inside of CloudStreams, the REST request would contain a top-level element that looks like this:
<vin>1234</vin>
So it is not obvious from an XSLT expression or an IS service callout what part of a REST request came in as a query parameter. Therefore, using this variable along with INBOUND_HTTP_METHOD and INBOUND_PROTOCOL, you can determine the exact entry point URI that was used when a CloudStreams virtual service was invoked.
(not displayed)
NATIVE_PROVIDER_ERROR
The reason returned by the native service provider in the case where it produced a SOAP fault. This variable will not contain CloudStreams-hosted errors such as policy violation errors; it will only contain the reason text wrapped in a SOAP fault.
(not displayed)
OPERATION
The service operation selected to execute a request.
(not displayed)
PROTOCOL_HEADERS
Contains a map of key-value pairs in the request, where the values are typed as strings. To get/set this variable, use pub.cloudstreams.ctxvar:getContextVariable (see The API for Context Variables).
(not displayed)
SOAP_HEADERS
(For use in IS services only.) Contains an array of the SOAP header elements in the request. To get/set this variable, use pub.cloudstreams.ctxvar:getContextVariable (see The API for Context Variables).
(not displayed)
USER
The value defined for the Integration Server session executing the request message. If the request is not authenticated, it will use a default unprivileged account. Otherwise, it will set the Integration Server session to the user credentials used for transport security. In the case where a consumer is sending a request with both transport credentials (HTTP Basic authentication) and message credentials (WSS Username or X.509 token), the message credentials take precedence over the transport credentials.