1. Babelway
  2. Babelway User Guide
  3. Chapter 4. Manage & Build

4.2.5.16. Http Client Gateway Out (Deprecated)

With an HttpClientOut Gateway, outgoing messages are sent using a Http connection.

All the user defined metadatas defined in the messages are passed in the context of the new message.

The specific settings are:

 Url 

 External service address. 

 Support HTTP and HTTPS protocols. 

 Username 

 Login or username to access the service. 

 Password 

 Password associated with the username. 

 Connected gateway 

 Select zero, one or several gateways to receive the response from the http server. 

 Valid HTTP return code 

 Comma separated list of expected return Http code which evaluates the response HTTP code in the header. If the return code is not in the list, the message is set in error. The default is '200,201,202,204,205'. 

 Success expression 

 The success expression is a regex that evaluates the HTTP response body. If the response doesn't match the success expression, the message is flagged with 'error' status. 

 Response filename 

 You can specify a filename that will be associated with the server response. Default is 'attachment'. 

 User Metadata Transfer Strategy 

 The strategy that will be used to transfer the user metadata to the response message created in the connected gateways. 

 Retry strategy 

 Allows you to determine what to do if call to remote server fails. If 'No retry' is chosen, the message will be put immediately in error. Other values allow to make some retries before setting the message in error. 

  • No retry
  • aggressive
  • Keep trying for 15 minutes
    • Will retries after 2, 4, 7, 10 and 15 minutes.
  • Keep trying for 1 hour 
    • Will retries after 2, 4, 8, 15, 30 and 60 minutes.
  • Keep trying for 3 hours 
    • Will do 6 retries in the first hour, then every hour.
  • Keep trying for 8 hours 
    • Will do 6 retries in the first hour, then every hour.
  • Keep trying for 1 day 
    • Will do 4 retries in the first hour, then every hour.
  • Keep trying for 3 days 
    • Will do 5 retries in the first 2 hours, then every 3 hours.
  • Keep trying for 5 days, once a day 
    • Will do One retry every day for 5 days at the same time as the first try.
  • Keep trying for 7 days 
    • Will do 5 retries in the first hour, then every 3 hours for 3 days, then every 6 hours.

 Filename 

 Filename of the outgoing message [with extension if applicable]. If empty, we will apply the default settings. 

Timeout 

 Timeout for connection in milliseconds. Must be between 10000 and 240000. 

 Http Method 

 You can specify the http method to call. 'Form Posting' is emulating a browser Form Post using mime multipart. The default is POST. 

 TLS version 

 You can specify the version of the TLS protocol. TLS is the replacement of SSL. The default is TLSv1.2. 

 Message parameter name 

 Name given to the parameter containing the actual message. This is also equivalent to the FORM parameter when a POST if done from a web browser. 

 Extra parameters 

 Extra parameters to inlude in the message. Name is the parameter name (FORM parameter) and the value is the name of a metadata containg the parameter content. In case of a binary content, the name of the metadata will also be used as the 'filename' of the parameter. 

 Http headers 

 You can add specific http header. This accepts metadata. 

 Trust level 

 The trust level defines the level of security used in the SSL handshake. Relax = No certificate verification, Standard = trusting certificates in environment certificates as well as known CA's, Paranoiac = only trusts certificates defined in the environmnent certificates. Mutual = requires 2-way authentication. 

 Authentication method 

 You can select from FORM, BASIC, DIGEST, NTLM, CERT, OAUTH1, OAUTH2, ANY or OAuth 2.0 with Credentials. CERT is 2-way SSL authentication. ANY is BASIC, DIGEST or NTLM depending on the server response. 

 Preemptive authentication 

 Allows to send authentication information with the first http request (to avoid making a second request). Only for BASIC or DIGEST authentication. 

 Login url 

 If authentication method is FORM. 

 Authentication form fields 

When using FORM authentication, you can add specific authentication form fields to the authentication call. This accepts metadata. 

 Metadata from response  

 You can use data receive by the login request as metadata, which can be used in the data sending after login. 

 2-way auth. certificate 

 If CERT authentication is used (2-way SSL authentication), this allows to select the key pair to use from the environment certificate. 

 Oauth bearer 

 If OAUTH2 authentication is used, this allows select the OAUTH bearer token to use. 

 Oauth signature method 

 If OAUTH1 authentication is used, this allows select the signature algorithm to use. Note that if SHA1withRSA is used, a Key alias must be selected. 

 Oauth consumer key 

 If OAUTH1 authentication is used, this allows defined the consumer key. This is mandatory. 

 Oauth consumer secret 

 If OAUTH1 authentication is used, this allows defined the consumer secret. This is optional. 

 Oauth token 

If OAUTH1 authentication is used, this allows defined the token. At this version of Babelway this is mandatory, please contact support if you need to retreive the token from an OAUth handsake. 

 Oauth token secret  

 If OAUTH1 authentication is used, this allows defined the token secret. This is optional. 

 Oauth RSA key 

 If OAUTH1 authentication is used with SHA1withRSA, this allows to select the key signing the OAUTH authentication. 

After channel deployment, your connection will be available to send messages.

 

When using the Authentication method of type OAuth 2.0 with Credentials we will do two calls, The first call will be through the URL provided in the "Login url" field then when we receive the response we can use regex to extract the data received in the response body and save them in a user defined metadata in the "Metadata from response" section then this created user defined metadata can be used in the second call in the "HTTP headers" section, as shown below.

mceclip2.png

Note: The sent HTTP request has a default content type of "text/html" and if you need to change it based in the output message, you can add the desired Content-Type in the headers section under the properties of the HTTP Client Gateway OUT as seen below:

1- Click on the properties of the HTTP Client Gateway OUT as seen below:

mceclip0.png
mceclip1.png

Go to the Properties of the HTTP Client Gateway OUT

 

2- Add the desired Content-Type in the headers section (fo example "application/json") as seen below:

mceclip2.png

Add the desired Content-Type

Note:

  • In Babelway, we're using the standard Java version of REGEX, and it's the same used all over the system.
  • If there is a file name provided in the "Message In" or "Message Out" which contain ~ tilde character, All browser based on Chromium will replace the ~ tilde character by the _ underscore character when you try to download the file from the Babelway interface, For more details you can check this link https://bugs.chromium.org/p/chromium/issues/detail?id=479419
  • The maximum file size accepted by this gateway is 100/250 MB.