HTTP Client

The HTTP Client resource template represents an outgoing HTTP connection. HTTP clients are used by a reference's SOAP binding.

General

Property Required? Editable? Accepts SVars? Description
Machine Name Y Y Y 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 that have more than one network card, this field specifies the host name of the card that used to accept incoming HTTP requests.

Default: localhost.

Port Y Y Y The port number on which to invoke outgoing HTTP requests.

Default: 80.

Idle Timeout (s) N Y Y The length of time to wait before closing an inactive connection. If more than zero, and data transmission has not finished, a call to close the connection blocks the calling program until the data is transmitted or until the specified timeout occurs. If 0, a call to close the connection returns without blocking the caller and an attempt is made to send the data. Normally this transfer is successful, but it cannot be guaranteed. This value should be changed only on the advise of TIBCO Support.

Default: 0 s.

Socket Timeout (ms) N Y Y Defines the socket timeout (SO_TIMEOUT), which is the timeout for waiting for data or a maximum period inactivity between consecutive data packets. This should be changed when connecting to very slow external services. A timeout value of zero is interpreted as an infinite timeout.

Default: 0 ms.

Connection Timeout (ms) N Y Y Determines the timeout until a connection is established. This should be changed when connecting to very slow external services. A timeout value of zero is interpreted as an infinite timeout.
Note: The timeout is influenced by operating system specific behavior at the TCP socket layer. On Windows 2008, Windows 7 and Windows XP the timeout value configured in this field is not honored, and instead it uses an internal timeout of around 21 seconds. Some versions of Linux, such as Ubuntu, also do not honor this timeout.

Default: 0 ms.

SSL

Property Required? Editable? Accepts SVars? Description
Enable SSL

Y Y N Enable SSL connections. When checked, the SSL properties display.

Default: Unchecked.

SSL Client Provider

Y Y Y The name of an SSL Client Provider resource.
Configure SSL N N N (Not applicable to some resource templates) Invokes a wizard to import certificates from an SSL-enabled server, optionally create an SSL Client Provider resource, and configure the trust store of the newly created or an existing SSL Client Provider with the imported certificates. When you complete the wizard, the SSL Client Provider field is filled in.

Advanced Configuration

Property Required? Editable? Accepts SVars? Description
Accept Redirect N N N 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.

Default: Unchecked.

Reuse Address N N N When a TCP connection is closed, the connection might remain in a timeout state for a period of time after the connection is closed (typically known as the TIME_WAIT state or 2MSL wait state).

For applications using a well-known socket address or port, it might not be possible to bind a socket to the required SocketAddress if there is a connection in the timeout state involving the socket address or port.

Default: Unchecked.

Disable Connection Pooling N N N Indicate whether to use the single or multi-threaded connection manager.

Default: Unchecked.

Suppress TCP Delay N N N Determines whether the Nagle algorithm is used.

The Nagle algorithm tries to conserve bandwidth by minimizing the number of segments that are sent. When applications wish to decrease network latency and increase performance, they can disable Nagle's algorithm by enabling Suppress TCP Delay.

Data will be sent earlier at the cost of an increase in bandwidth consumption and the number of packets.

Default: Checked.

Stale Check N N N 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.

Default: Unchecked.

Buffer Size (B)

N Y Y Socket buffer size in bytes.

A suggestion to the kernel from the application about the size of the buffers to use for the data transferred over the socket.

Default: -1. Allow the runtime to determine the buffer size.

Connection Retrieval Timeout (ms) N Y Y The timeout, in milliseconds, until a connection is established.

Default: 0.

Local Socket Address N Y Y Local host address to be used for creating the socket.

Default: None.

Maximum Total Connections N Y Y Controls the maximum number of simultaneous active connection that this resource instance allows. The value should be increased for application that creates a lot of long-lived connections.

Default: 20.

Maximum Total Connections per Host N Y Y Controls the maximum number of simultaneous active connection to a same host that this resource instance allows. This number cannot be greater than Maximum Total Connections.

Default: 2.

HTTP Proxy

Property Required? Editable? Accepts SVars? Description
Configure Proxy N N N Check the check box to configure the HTTP Proxy options described in this table.

Default: Unchecked

Proxy Type Y N N Type of proxy server. You can select HTTP or SOCKS V4 / V5.

Default: HTTP

Proxy Host Y Y Y Address of the proxy host.

Default: localhost

Proxy Port Y Y Y

Port of the proxy host.

Default: 8080

Configure BASIC authentication N Y N Check the box to configure access to proxy server with a username and password.

Default: Unchecked

When you check this check box, the fields for specifying the username and password are enabled.

Default username: username

Default password: None