IBM Integration Bus, Version 9.0.0.8 Operating Systems: AIX, HP-Itanium, Linux, Solaris, Windows, z/OS

See information about the latest product version

Local environment overrides for the SOAPAsyncRequest node

You can dynamically override values in the local environment in the same way as setting values in other elements of a message. These local environment overrides are used only by the SOAPAsyncRequest node and not by the SOAPAsyncResponse node.

This topic contains the following sections:

Local environment overrides for the SOAPAsyncRequest node

You can set the following properties under LocalEnvironment.Destination.SOAP.Request:
Setting Description
TransportType Overrides the Transport property on the node to switch transport. For example, if the node is configured to use the JMS transport, use the following to switch to HTTP transport:
SET OutputLocalEnvironment.Destination.SOAP.Request.TransportType = 'http';
To switch to JMS transport:
SET OutputLocalEnvironment.Destination.SOAP.Request.TransportType = 'jms';
This overrides only the request transport for this message. The response transport is not changed from the property set on the SOAPAsyncResponse node.
Operation Overrides the Operation property on the node. For example: 
SET OutputLocalEnvironment.Destination.SOAP.Request.Operation = 'myOperation';
SSL authentication alias Overrides the SSL authentication alias property on the node. For example:
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.HTTP.KeyAlias = 'Key1Alias';
UserContext You can store context data in the following location in the local environment. The SOAPAsyncResponse node can later retrieve this data.
SET OutputLocalEnvironment.Destination.SOAP.Request.UserContext = 'myData';

LocalEnvironment overrides for HTTP transport

You can set the following properties under LocalEnvironment.Destination.SOAP.Request.Transport.HTTP. These properties apply only when using HTTP transport.

You can switch between HTTP and JMS transport using the TransportType override, or the WS-Addressing To field; see WS-Addressing information in the local environment.
Setting Description
WebServiceURL Overrides the Web service URL property on the node. For example:
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.HTTP.WebServiceURL = 
'http://ibm.com/abc/';
RequestURI Overrides the RequestURI, which is the path after the URL and port. For example:
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.HTTP.RequestURI = 
'/abc/def?x=y&g=h';
Timeout Overrides the Request timeout (in seconds) property on the node. For example:
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.HTTP.Timeout = 42;
This is the time that the node waits to receive the HTTP 202 acknowledgment, rather than the time to wait for the associated Web service response.
ProxyURL Overrides the HTTP(S) proxy location property on the node. For example:
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.HTTP.ProxyURL = 
'my.proxy';
SSLProtocol Overrides the SSLProtocol property on the node. For example:
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.HTTP.SSLProtocol = 
'TLS';

Valid values are: SSL, SSLv3, and TLS.
SSLCiphers Overrides the Allowed SSL Ciphers (if using SSL) property on the node. For example:
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.HTTP.SSLCiphers = 
'SSL_RSA_FIPS_WITH_3DES_EDE_CBC_SHA';
HTTPVersion Overrides the HTTPVersion. For example:
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.HTTP.HTTPVersion = 
'HTTP/1.1';
Method Overrides the Method. For example:
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.HTTP.Method = 'GET';
ProxyConnectHeaders Specifies additional headers that are used if the outbound request is an SSL connection through a proxy. These additional headers are sent with the initial CONNECT request to the proxy. For example, you can send proxy authentication information to a proxy server when you are using SSL. You can send multiple headers but each one must be separated by a carriage return and a line feed (ASCII 0x0D 0x0A), in accordance with RFC2616; for example:
DECLARE CRLF CHAR CAST(X'0D0A' AS CHAR CCSID 1208);     
SET OutputLocalEnvironment.Destination.HTTP.ProxyConnectHeaders =
'Proxy-Authorization: Basic Zm5lcmJsZTpwYXNzd29yZA==' || CRLF || 
'Proxy-Connection: Keep-Alive' || CRLF;
This setting is used only if the request is an SSL request through a proxy server. To send proxy authentication information for a non-SSL request, specify the individual headers in the HTTPRequestHeader folder, as shown in the following example:
SET OutputRoot.HTTPRequestHeader."Proxy-Authorization" = 
'Basic Zm5lcmJsZTpwYXNzd29yZA==';
SET OutputRoot.HTTPRequestHeader."Proxy-Connection" = 'Keep-Alive';
Compression Overrides the Use compression property on the node. For example: 
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.HTTP.Compression = 
'gzip';
Enable CRL checking Overrides the Enable Certificate Revocation List checking property on the node. For example:
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.HTTP.EnableCRLCheck = 'true';

Local environment overrides for JMS transport

You can set the following JMS properties in the SOAPAsyncRequest node under LocalEnvironment.Destination.SOAP.Request.Transport.JMS. These properties apply only when using JMS transport.

You can switch between HTTP and JMS transport using the TransportType override, or the WS-Addressing To field; see WS-Addressing information in the local environment.

Some JMS local environment overrides for the SOAPAsyncRequest node have equivalent properties in the JMSTransport header. If you specify a local environment override, it takes precedence over any equivalent property set in the JMSTransport header.

Setting Description
CorrelationID Sets the request message CorrelID. For example:
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.JMS.CorrelationID  = 
'myCorrelID';
DeliveryMode Overrides the DeliveryMode property on the node. For example:
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.JMS.DeliveryMode = 
'NON_PERSISTENT';
Allowed values for this property are PERSISTENT and NON_PERSISTENT. If the UriFormat is ibm, 1 and 0 are additional allowed values for DeliveryMode.
Destination Overrides the Destination property on the node. For example:
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.JMS.Destination = 
'REPLYTOQ2';
DestinationURI You can override multiple JMS properties at the same time in the local environment using the DestinationURI setting. Properties that you set in this way can be overridden by setting local environment overrides for individual JMS properties as shown in the following tables.
SET OutputLocalEnvironment.Destination.SOAP.Reply.Transport.JMS.DestinationURI = 
	'jms:jndi:INPUTQ1?jndiConnectionFactoryName=QCF&
	replyToName=REPLYTOQ2&
	jndiInitialContextFactory=com.sun.jndi.fscontext.RefFSContextFactory&
	jndiURL=file:/C:/Webservices/SOAP/JMS/JNDI&
	userParam1=value1&
	userParam2=value2&
	timeToLive=30000';
This local environment override can be set with either a W3C-style or IBM-style URI format. For more information, see WSDL URI formats for JMS.
Expiration Overrides the Expiration property on the node. This property is specified in milliseconds. For example, to set an expiration of 100 milliseconds:
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.JMS.Expiration = 
'100';
MessagePriority Overrides the MessagePriority property on the node. For example:
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.JMS.MessagePriority = 
'7';
MessageType Overrides the MessageType property on the node. For example:
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.JMS.MessageType = 
'text';
Allowed values for this property are textand bytes.
ProviderName Overrides the JMS provider name property on the node. For example:
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.JMS.ProviderName = 
'WebSphere MQ';
TargetService Overrides the TargetService property on the node. For example:
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.JMS.TargetService = 
'testService';
TransactionMode Overrides the Transaction mode property on the node. For example:
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.JMS.TransactionMode = 'Yes';
Allowable values for this property are Yes, No and ForceLocal.
  • No means that no transaction takes place, and is equivalent to None.
  • Yes means that a local transaction takes place if the flow's Coordinated Transaction is not selected, or an XA coordinated transaction takes place if the flow's Coordinated Transaction property is selected.
  • ForceLocal means that a local transaction is always used, even if the flow's Coordinated Transaction property is selected.
UriFormat Overrides the UriFormat property on the node. For example:
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.JMS.UriFormat  = 
'w3c';
Allowable values for this property are w3c and ibm.

Local environment overrides for JNDI

You can set the following JMS properties in the SOAPAsyncRequest node under LocalEnvironment.Destination.SOAP.Request.Transport.JMS.JNDI. These properties apply only when using JMS transport.

Setting Description
BindingsLocation Overrides the JNDI URL bindings location property on the node. For example:
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.JMS.JNDI.BindingsLocation = 
'file:/C:/Webservices/SOAP/JMS/JNDI';
ConnectionFactoryName Overrides the Connection factory name property on the node. For example:
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.JMS.JNDI.ConnectionFactoryName = 
'QCF';
ContextParameters Specify JNDI context parameters in addition to the JNDI context parameters defined on the node. You can define specific JNDI context parameters, for example:
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.JMS.JNDI.ContextParameters.property1 = 
'value1';
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.JMS.JNDI.ContextParameters.property2 = 
'value2';
InitialContextFactory Overrides the Initial context factory property on the node. For example:
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.JMS.JNDI.InitialContextFactory = 
'com.sun.jndi.fscontext.RefFSContextFactory';
UserProperties Specify user context parameters in addition to the user context parameters defined on the node. You can define specific user context parameters, for example:
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.JMS.JNDI.UserProperties.property1 = 
'value1';
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.JMS.JNDI.UserProperties.property2 = 
'value2';

Local environment overrides for WS-Addressing ReplyTo

You can set the following JMS WS-Addressing ReplyTo properties in the SOAPAsyncRequest node under LocalEnvironment.Destination.SOAP.Request.Transport.JMS.AsyncReply. Set these properties if you want to override how the remote server locates the JNDI definitions for the response queue.

These properties apply only when using JMS transport. You can switch between HTTP and JMS transport using the TransportType override, or the WS-Addressing To field; see WS-Addressing information in the local environment.

Setting Description
BindingsLocation Overrides the BindingsLocation property in the WS-Addressing ReplyTo.
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.JMS.AsyncReply.JNDI.BindingsLocation = 
'file:/C:/webservices/SOAP/JMS/JNDI';
ConnectionFactoryName Overrides the ConnectionFactoryName property in the WS-Addressing ReplyTo.
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.JMS.AsyncReply.JNDI.ConnectionFactoryName = 
'QCF';
ContextParameters Specify JNDI context parameters in the WS-Addressing ReplyTo. You can define specific JNDI context parameters, for example:
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.JMS.AsyncReply.JNDI.ContextParameters.property1 = 
'value1';
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.JMS.AsyncReply.JNDI.ContextParameters.property2 = 
'value2';
InitialContextFactory Overrides the InitialContextFactory property in the WS-Addressing ReplyTo.
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.JMS.AsyncReply.JNDI.InitialContextFactory = 
'com.sun.jndi.fscontext.RefFSContextFactory';
Setting Description
OneWay Instructs the node that the inbound message was a one-way message and that no reply message is needed. For example:
SET OutputLocalEnvironment.Destination.SOAP.Request.Gateway.OneWay = True
If the inbound message used HTTP transport, the node sends an acknowledgment HTTP 202 message. If the inbound message used JMS transport, no response is expected. The outbound message has no reply-to queue, and the node does not wait for a response.

For more information, see One-way messages in Gateway mode.
ac56202_.htm | Last updated Friday, 21 July 2017