HTTP Client
The HTTP Client resource template represents an outgoing HTTP connection.
HTTP Client
This section has the following fields.
Field | Literal Value/Module Property | Description |
---|---|---|
Default Host | Yes | The name of the host that accepts the incoming requests.
For machines that have only one network card, the default value localhost specifies the current machine. For machines with more than one network card, this field specifies the host name of the card used to accept the incoming HTTP requests. The default value is localhost. |
Default Port | Yes | The port number on which to invoke outgoing HTTP requests.
The default value is 80. |
HTTP Version | No |
The HTTP version to be used for communication. By default, it is HTTP 1.1. If required, you can select HTTP 2.0 as the version for the HTTP 2 communication. It is mandatory for the server to support HTTP 2 as well if HTTP 2 is selected as the client protocol. When HTTP 2 is selected as the version, the option of the client in the Implementation Library field, changes to Jetty HTTP Client, and other options do not appear, as only the Jetty client supports HTTP 2. When HTTP 1.1 is selected as the version, the previous options reappear along with the new option Jetty HTTP Client, which also supports HTTP 1 communication. When HTTP 2.0 is selected as the HTTP version in the HTTP client shared resource, enabling SSL through the Confidentiality or Default Confidentiality option is compulsory. |
Implementation Library | No |
Specifies the implementation library to be used:
The default is Apache HttpComponents(Supported by HTTP 1, SOAP and REST), when HTTP 1.1 is selected as the protocol version. When HTTP 2 is selected as the protocol version, the Jetty HTTP Client is the only Implementation option available, because currently only the Jetty Client supports HTTP 2. Note:
|
Disable Connection Pooling | Yes | Indicates whether to use the single or multi-threaded connection manager.
If you select this check box, Maximum Total Connections, Idle Connection Timeout(ms), Maximum Total Connections Per Host/Route, and Stale Check fields are disabled. The default value is False. This option is not enabled when the Jetty HTTP Client is selected as the implementation library, because connection pooling happens internally in the Jetty Client library. |
Maximum Total Connections | Yes | Specifies the maximum number of concurrent, active HTTP connections allowed by the resource instance to be opened with the target service. This property is enabled only if connection pooling is enabled (the Disable Connection Pooling parameter is deselected).
The default value is 200. For applications that create many long-lived connections, increase the value of this parameter. |
Idle Connection Timeout(ms) | Yes | Keep-alive time (in milliseconds) for idle HTTP connection in the Persistent Connection Pool. |
Maximum Total Connections Per Host/Route | Yes | Specifies the maximum number of concurrent, active HTTP connections allowed by the resource instance to the same host or route. This property is enabled only if connection pooling is enabled (the Disable Connection Pooling parameter is unchecked).
Note: This number cannot be greater than
Maximum Total Connections. Every connection created here also counts into Maximum Total Connections.
The default value is 20. |
Stale Check | Yes | Selecting this check box determines whether the stale connection check is to be used. Disabling the stale connection check can result in slight performance improvement at the risk of getting an I/O error, when executing a request over a connection that has been closed at the server side. |
Cookie Policy | No | Specifies the Cookie Policy to use:
Note: Ensure you have selected
Apache HttpComponents (Supported by HTTP and REST) as the Implementation Library when selecting a Cookie Policy.
|
Disable connection state tracking | Yes | This check box is enabled only when
Apache HttpComponents (Supported by HTTP and REST) option is selected in the
Implementation Library field.
When this check box is selected, the HTTPS connections are not reset by the Apache components client, and a single HTTPS connection can be reused. By default, the check box is clear. This option is not enabled when the Jetty HTTP Client is selected as the implementation library. |
Thread Pool | No | Specifies a queue of threads available to run a queue of tasks.
Thread pools are used to improve performance when executing large numbers of asynchronous tasks by reducing per task invocation overhead, provide a means of bounding, and managing the resources consumed when executing a collection of tasks. You can optionally create this client thread pool to route messages to the target service. The thread pool resource can be created by either selecting a thread pool resource template or creating a new one. For more information, see the Thread Pool topic. |
Advanced
This section has the following fields.
Field | Literal Value/Module Property | Description |
---|---|---|
Socket Timeout (ms) | Yes | Specifies the number of milliseconds to wait for data before the connection is severed.
The value zero (0) is interpreted as an infinite timeout and is used when no socket timeout is set in the HTTP method parameters. |
Connection Timeout (ms) | Yes | Specifies the number of milliseconds to wait while a connection is being established.
The value zero (0) is interpreted as no timeout. |
Accept Redirect | Yes | Indicates whether the HTTP method should automatically follow HTTP redirects.
This option is used when client connection receives the redirect responses from server like Moved Permanently, Moved Temporarily, Temporary Redirect and so on. The default value is False. |
Retry Count | Yes | Specifies the maximum number of retry attempts for connecting to the server if an exception occurs.
When the client library implementation is set to Apache Components, the retry count at HTTP client shared resource is accessed internally by the Apache Components Client to create a DefaultHttpRequestRetryHandler (https://hc.apache.org/httpcomponents-client-ga/httpclient/apidocs/org/apache/http/impl/client/DefaultHttpRequestRetryHandler.html), which retries to send the failed requests number of times specified in the Retry Count field. Interrupted IO Exception, Unknown Host Exception, Connect Exception, and SSL Exception are the types of exceptions for which the requests cannot be retried. The requests are retried for all other exceptions, only if the request has not been successfully sent. The default value of retry count is 3. |
Use Single Cookie Header | Yes | Select this check box if multiple name/value pairs must be sent in a single non-repeating Cookie header element for outgoing HTTP requests.
The default value is False. |
Use Non-Preemptive Authentication | Yes | Select this check box if you want to use non-preemptive authentication. |
Log Request/Response Time | Yes | Select this check box to log the time required for sending and receiving the HTTP response in the Send HTTP Request activity. |
HTTP Proxy | No | Specifies the HTTP proxy server to be used to gain access outside of a firewall. The
Proxy Configuration shared configuration resource specifies the configuration of the proxy server.
For more information, see the Proxy Configuration. |
Circuit Breaker Configuration
Field | Literal Value/Module Property | Description |
---|---|---|
Enable Circuit Breaker | Yes | Select
Enable Circuit Breaker to configure properties for Hystrix configuration.
The default value is False. |
Command Name | Yes | The specific Hystrix command.
The command name should be unique for each HTTP Connector shared resource. |
Command Properties | ||
Execution Isolation Strategy | Yes |
The isolation strategy used, THREAD, executes on a separate thread and concurrent requests are limited by the number of threads in the thread-pool. |
Metrics Rolling Window (ms) | Yes | The duration of the statistical rolling window, in milliseconds.
This is the duration for which Hystrix retains metrics for the circuit breaker to use and for publishing. The value should be such that Metrics Rolling Window (ms) % Metrics Rolling Window Buckets = 0 |
Circuit Breaker Request Volume Threshold | Yes |
The minimum number of requests in a rolling window that will enable tripping the circuit. This controls how many requests have to occur in a rolling window for the circuit to consider tripping. The default value is 20. |
Metrics Rolling Window Buckets | Yes | The number of buckets that the rolling statistical window is divided into.
The value should be such that Metrics Rolling Window (ms) % Metrics Rolling Window Buckets = 0 |
Circuit Breaker Error Threshold Percentage | Yes |
The error percentage at or above which the circuit should trip and start short-circuiting requests. The default value is 50. |
Request Log Enabled | Yes | Indicates whether the Hystrix command execution and events should be logged.
The default value is Yes. |
Circuit Breaker Sleep Window (ms) | Yes | This property sets the amount of time, after tripping the circuit, to reject requests before allowing attempts again to determine if the circuit should again be closed.
The default value is 5000. |
Execution Timeout Enabled | No | Specifies whether the Hystrix command execution should have a timeout.
The default value is Yes. |
Execution Timeout (ms) | Yes | The time, in milliseconds, after which the caller will timeout and stop the command execution.
The default value 1000. |
Thread Pool Properties | ||
Core Size | Yes | The size of the core thread pool.
The default value is 10. |
Max Queue Size | Yes | The maximum size of the queue.
The default value is -1. |
Queue Size Rejection Threshold | Yes | The queue size rejection threshold.
This property is not applicable if Max Queue Size is set to -1. The default value is 5. |
Keep Alive Time (minutes) | Yes | The keep alive time, in minutes.
The default value is 1. |
Execution Thread Interrupt on Timeout | Yes | Specifies whether the Hystrix command execution should be interrupted when a timeout occurs.
The default value is Yes. |
Security
Field | Literal Value/Module Property | Description |
---|---|---|
Authentication | None | To be included when the messages must be authenticated. Authentication can be performed with user names and passwords.
Identity Provider : Provides user name and password credentials encapsulated in an identity provider resource. Selecting this check box activates the Identity Provider field. |
Kerberos Authentication | None |
Selecting this check box enables Kerberos Authentication. Kerberos Authentication requires a few additional configurations. For more information about configurations, see the section "Kerberos Authentication Configuration". To enforce Kerberos authentication on REST binding, you must select Apache HttpComponents (Supported by HTTP and REST) library. |
Username | None | Enter the Active Directory user name to be used for the Kerberos authentication.
This field is enabled only when the Kerberos Authentication field is selected. |
Password | None | Enter the password for the specified user name.
This field is enabled only when the Kerberos Authentication field is selected. This field is mandatory. |
Default Confidentiality | Yes | Select the check box to encrypt or decrypt messages.
Select the check box to enable the SSL with default configuration. For more information about SSL Client configuration, see the SSL Client Configuration. Note: If you select
Default Confidentiality, there is no need to create a shared resource. SSL is enabled with
Default Configuration. If custom configurations for SSL are required, select
Confidentiality. When using
Default Confidentiality ensure that the correct root certificates are present at the <TIBCO_HOME>\tibcojre64\1.8.0\lib\security\cacerts trust store.
|
Confidentiality | Yes | Select the check box when encrypting or decrypting messages.
When you select a module property for this field and set it to true, or select the check box, the SSL Client Configuration field is visible. For more information about SSL Client configuration, see the SSL Client Configuration. |
Kerberos Authentication Configuration
The krb5.conf and login.conf files are present under the config folder at the location, BW Home/config. We recommend that the configurations in the login.conf file should not be changed. However, values in the krb5.conf file can be changed according to the Kerberos environment you are working in.
You can configure the following values in the krb5.conf file: