HTTP Connector

HTTP Connector resource describes the characteristics of the connection used to receive incoming HTTP requests. This resource is used when the process requires an HTTP request on a specific port where the HTTP server is running. For example, the process starter HTTP Receiver and the signal-in Wait for HTTP Request activity receiving HTTP requests.

General

There can be only one process with an HTTP Receiver or Wait for HTTP Request activity that uses the same HTTP Connection resource. With this restriction the HTTP server listening for the incoming requests dispatches the request to the correct process.

The General section has the following fields.

Field Module Property Description
Package No The name to be displayed as the label of the resource package.
Name No The name to be displayed as the label for the resource.
Description No A short description of the activity.

Basic Configuration

The Basic Configuration section has the following fields.

Field Module Property Description
Host Yes

By default, the HTTP Connector shared resource uses the module property BW.HOST.NAME for binding and listening on HTTP ports. This module property is set to the machine hostname based on your deployment scenario. You must change the Host field value in the HTTP Connector properties from BW.HOST.NAME to a literal value of 0.0.0.0 to be able to access application endpoints that are residing on TIBCO® Cloud Integration. If you do not do so, the application endpoints will not be reachable.

To change the Host value to a literal value, click Literal Value. Enter 0.0.0.0 in the Host text box and save your configuration.
Important: Do not enter 'localhost' as the literal value as the application will fail when pushed to the cloud.
Port Yes Specifies the port number on which to listen for incoming HTTP requests.
Note: Do not use port 7777. It is reserved for internal use.
Accept Queue Size Yes Specifies the number of connection requests to be queued before the operating system starts sending rejections. The default values are: -1 and 0.

These default values signify that the queue size is 50 or OS-specific.

Acceptor Threads Yes Specifies the number of acceptor threads. Acceptor threads are HTTP socket threads for an HTTP connector resource that accept the incoming HTTP requests.

The default value is 1.

Advanced Configuration

The Advanced Configuration section has the following fields.

Field Module Property Description
Header Buffer Size (B) Yes Specify to set the size of the buffer for request headers. An idle connection at most has one buffer of this size allocated. The default is 4K.
Use Non-Blocking IO Sockets Yes Select this check box to use non-blocking threading model for NIO buffers.

Use this connector when there are many connections with idle periods. The default is true.

Request Buffer Size (B) Yes Specify to set the size of the content buffer for receiving requests. These buffers are used only for active connections that have requests with bodies that do not fit within the header buffer. The default is 8K.
Use Direct Buffers Yes Specify to determine whether direct byte buffers are used or not. The default is True.
Response Buffer Size (B) Yes Specify to set the size of the content buffer for sending responses. These buffers are used only for active connections that are sending responses with bodies that will not fit within the header buffer. The default is 24K.
URI Encoding Yes Specifies the character encoding used to decode the URI bytes.

If you do not set any value for uriEncoding, the default UTF-8 is used.

Max Idle Time (ms) Yes Specify to set the maximum idle time for a connection. The Max Idle Time is applied in the following cases:
  • When waiting for a new request to be received on a connection; when reading the headers and content of a request
  • When writing the headers and content of a response

Jetty interprets this value as the maximum time between the progress made on the connection. The timeout is reset if implemented by jetty if a single byte is read or written.

Enable DNS Lookups Yes Selecting this check box enables a domain name system (DNS) lookup for HTTP clients so that the IP address is resolved to a DNS name. This can adversely affect the throughput. This check box is not selected as default. Select this check box only when required.

The default is False.

Low Resource Max Idle Time (ms) Yes Specifies to set the period in ms for the connection to be idle.

This results in the server rapidly closing idle connections to gracefully handle high load situations.

Compression Yes Specifies if the output of the HTTP Connection is compressed using the HTTP/1.1 GZIP compression.

The acceptable values for this field are: True or False

The default is False.

Linger Time (ms) Yes Specifes to set the LINGER_TIME on the connection socket. This setting affects only the close connection socket.
Compressible Mime Types Yes Specifies the list of MIME types for which HTTP compression may be used. The default value for this comma separated list istext/html, text/xml, text/plain.
Session Timeout (s) Yes The timeout (in seconds) for the HTTP session to expire after inactivity.
Max Post Size Yes Specifies the maximum size in bytes of the POST that the container FORM URL parameter parsing can handle.

By default, the value of this field is set to 2M or 2097152 bytes. Setting the value less than or equal to zero disables the limit for maxPostSize.

Reverse Proxy Host Yes Specifies the name of the reverse proxy host that accepts the incoming requests.
Max Save Post Size Yes Specifies the maximum size in bytes of the POST that the container can save/buffer during FORM or CLIENT-CERT authentication.
  • FORM authentication: the request message is saved while the user is redirected to the login page. It is retained until the user authentication succeeds or the session associated with the authentication request expires.
  • CLIENT-CERT authentication: the request message is buffered for the entire duration of the SSL handshake. After processing the request, the buffer is emptied.

However, in both the cases the buffering happens before the user authentication. By default, the value of this field is set to 4K or 4096 bytes. Setting the value to -1 disables the limit for this field.

Reverse Proxy Port Yes The reverse proxy port number on which to listen for the incoming HTTP requests.
Minimum QTP Threads Yes

The Queued Thread Pool (QTP) uses the default job queue configuration to The QTP threads accept the requests from the acceptor threads.

This field specifies the minimum number of QTP threads available for the incoming HTTP requests. The HTTP server creates the number of threads specified by this parameter when it starts up. The default value is 10.

Maximum QTP Threads Yes

This field specifies the maximum number of threads available for the incoming HTTP requests. The HTTP server does not create more than the number of threads specified by this parameter. The default value is 75.

Enable Access Logs Yes Select the Enable Access Logs check box to print the HTTP access logs.
Disable HTTP Methods Yes Disable specific HTTP methods by adding the required methods to the field list.

To add a method to the list, click the Add icon . To remove a method from the list, select the required method and click the delete icon .

Note: The first time you click the Add icon , by default the TRACE method is selected and added to the list of methods to be disabled.
Share Across Applications Yes
Select the Share Across Applications check box to share the same HTTP Connector shared resource across several application modules.
Note: This check box is applicable if the HTTP Connector shared resource is present in the shared module. It will not be applicable if the HTTP Connector shared resource is present in the application module.

Security

Security can include any combination of the following characteristics:
Field Description
Confidentiality To be included when encrypting or decrypting the messages.

Selecting this check box displays the SSL Server Configuration field. Use this field to specify the SSL parameters for the HTTP Connector shared resource.