Using HTTP Adapters with Ensemble
Settings for the HTTP Outbound Adapter
[Back] 
   
Server:docs1
Instance:LATEST
User:UnknownUser
 
-
Go to:
Search:    

Provides reference information for settings of the HTTP outbound adapter, EnsLib.HTTP.OutboundAdapter.
Summary
The outbound HTTP adapter has the following settings:
Group Settings
Basic Settings HTTP Server, HTTP Port, URL, Credentials
Connection Settings SSL Configuration, SSL Check Server Identity, Proxy Server, Proxy Port, Proxy HTTPS, Response Timeout, ConnectTimeout
Additional Settings Use Cookies, SendSuperSession
The remaining settings are common to all business operations. For information, see Settings for All Business Operations in Configuring Ensemble Productions.
Connect Timeout
Specifies the number of seconds to wait for the connection to the server to open. The default value is 5.
If the connection is not opened in this time period, the adapter retries repeatedly, up to the number of times given by Failure Timeout divided by Retry Interval.
Credentials
ID of the Ensemble credentials that can authorize a connection to the given destination URL. For information on creating Ensemble credentials, see Configuring Ensemble Productions.
HTTP Port
TCP port on the server to send HTTP requests to (will use 80 by default, or 443 if SSLConfig is specified). If this is not standard (that is, not equal to 80), it is included in the Host: header of the HTTP request that you are sending. Also see Specifying the Destination Server and URL Path,” earlier in this book.
HTTP Server
IP address of the server to send HTTP requests to. This is used in the Host: header of the HTTP request that you are sending. Also see Specifying the Destination Server and URL Path,” earlier in this book.
Proxy HTTPS
Specifies whether the proxy (if any) uses HTTPS to communicate with the real HTTP/HTTPS server.
Proxy Port
Specifies the proxy server port on which to send HTTP requests, if using a proxy server (will use 8080 by default).
Proxy Server
Specifies the proxy server through which to send HTTP requests, if any.
Response Timeout
Specifies the timeout for getting a response from the server (the timeout for opening the connection to the server is set by ConnectTimeout). The default value is 30.
If no response is received, the adapter retries repeatedly, up to the number of times given by Failure Timeout divided by Retry Interval.
SSL Check Server Identity
Specifies that when making an SSL connection, the adapter should check that the server identity in the certificate matches the name of the system being connecting to. This defaults to specifying that the check should be made. Uncheck this for test and development systems where the name specified in the SSL certificate does not match the DNS name.
SSL Configuration
The name of an existing SSL/TLS configuration to use to authenticate this connection. Choose a client SSL/TLS configuration, because the adapter initiates the communication.
To create and manage SSL/TLS configurations, use the Management Portal. See the chapter Using SSL/TLS with Caché in the Caché Security Administration Guide. The first field on the Edit SSL/TLS Configuration form is Configuration Name. Use this string as the value for the SSL Configuration setting.
If your SSL configuration requires a private key password, include that in the SSL Configuration setting. To do so, add a vertical bar character | after the configuration name, followed by the password. For example: MySSLItem|mypassword.
SendSuperSession
The SendSuperSession is a Boolean setting that controls whether the outbound adapter creates a SuperSession header in the HTTP header and assigns an identifier to it. When finding a message, you can use the SuperSession value to match a message in one production with the related message in another production. Within a production, it is easy to track a message as it travels between business services, processes, and operations using the SessionId. But once a message leaves a business operation via an HTTP message and enters a different production, the production receiving the message assigns a new SessionId.
If SendSuperSession is selected, the HTTP outbound adapter does the following:
  1. Check if the message has an empty value in Ens.MessageHeaderBase.SuperSession property. If it does have an empty value, the adapter generates a new value and stores it in the SuperSession property.
  2. Stores the value of the SuperSession property in the private InterSystems.Ensemble.SuperSession HTTP header of the outgoing message.
When an HTTP incoming adapter receives a message, it checks for the SuperSession value in the incoming HTTP message header. If the value is present, it sets the Ens.MessageHeaderBase.SuperSession property. This property is preserved as the message passes from one production component to another.
Note:
There are no tools to automate tracking messages between productions using SuperSession.
URL
URL path to request from the server (not including http:// or the server address).
Also see Specifying the Destination Server and URL Path,” earlier in this book.
Use Cookies
Specifies whether to save cookies received in HTTP responses while this adapter is instantiated, and insert them in each subsequent HTTP request.