HTTP(S) input connector

These connectors enable the StreamServer to function as an HTTP server.

Comments

• Use the HTTPS connector if you want the StreamServer to function as an SSL server that communicates over an encrypted HTTPS channel. • An HTTP(S) connector must be connected to an input queue. • You can use the custom startup argument -startallinconnectors to start connectors that are not connected to any Event. • To use several threads on the input queue you must add the custom command UseResponseTimeouts to the Logical platform access point . See Using custom commands and keywords in the Design Center documentation for more information.

The connector settings are described below.

Security configuration

The security configuration to add to the HTTPS connector. See the Encryption and authentication documentation for more information about security configurations. The security configuration must be included in a resource set connected to the Platform.

Version

The HTTP version to use. Auto means the version is determined by the client.

SSL version

The SSL version to use with the HTTPS connector. The server and the clients must use the same SSL version.

Expose in Collector

Select to expose the connector as a reprocess service in the Collector web application.

Description

The description of the connector shown in the Collector web application.

Example 21

Description

Fax invoices

 

Reprocess type

The output channel for the reprocess service.

Address

An alternative network address for the StreamServer, for example the IP address to a specific network card. You can leave this empty if you want to use the default network address for the workstation.

Port

The port the connector listens to for HTTP requests. If the Project contains several HTTP(S) connectors, you must select a unique port for each connector. Instead of using several HTTP(S) connectors, you can use one HTTP(S) input connector and different URIs to other types of input connectors. See HTTP Realms tab.

Input threads

The maximum number of concurrent connections. When all connections are busy, and a new client tries to connect to the StreamServer, the connection may fail. Increasing the number can decrease performance.

Idle time-out

A time-out (milliseconds) applied when the StreamServer has finished processing a request, and no more data related to the request will be received or sent. This time-out sets the maximum time the connection will remain open, and enables the client to send a new request without having to set up a new connection.

Time-out

A time-out (milliseconds) applied when the StreamServer sends or receives data. If no data is sent or received during the time specified (dead connection), the connection will be closed.

Response time-out

The maximum time (milliseconds) the client is expected to wait for a response.

Note:

Response time-out is disabled by default, and the client receives the response when StreamServer has finished processing the job. To enable Response time-out, you must add the custom command UseResponseTimeouts to the Logical platform access point.

This time-out starts ticking as soon as StreamServer has received all data from the client. The size of the time-out depends on whether the client needs to wait for StreamServer to process the job:

•	If the client expects StreamServer output in the response, this time-out must be large enough to cover the processing by, and delivery from, StreamServer. You can also remove UseResponseTimeouts to disable the time-out.

•	If the client does not expect any StreamServer output in the response, you can set this time-out to 0 to immediately return 200 OK after all data is received from the client.

The response-timeout can also be set by the client using an HTTP header field. To enable this, you must add the custom command UseResponseTimeouts to the Logical platform access point and the custom command HTTPResponseTimeOut (see Custom HTTP(S) connector settings) to the Logical connector access point. For example, if the client uses the header field x-timeout to set the response time-out, you can use the following HTTPResponseTimeOut command to enable the client to set the time-out:

HTTPResponseTimeOut "x-timeout" "" "" END;

Note:

This will override the Response time-out set on the HTTP(S) input connector.

When processing a job, StreamServer will not check if the connection to the client is still open. A response time-out triggered by the client or StreamServer is not regarded as an error and will not stop StreamServer from processing the job.

Authentication

The type of authentication scheme (RFC 2617) to use for password authentication. The authentication scheme you specify here applies to all HTTP realms you specify for the HTTP(S) connector. See HTTP Realms tab.

•	None - Do not use authentication.

•	Basic - Send authentication parameters as clear text. This is the only scheme supported in HTTP/1.0.

•	Digest - Send authentication parameters as a checksum over the network. Requires HTTP/1.1.

Publish directory

The root directory for stored files. If you want to enable clients to access stored files via HTTP(S), you must specify a publish directory.

Publish extension file

A file that associates file formats and content-types (RFC 2045). Applies to files in the Publish directory. The StreamServer accepts html, htm, gif, jpg, txt, zip by default. To use other formats, you must specify a publish extension file.

File syntax:

Target ContentType CustomHeader

Where Target is the format to associate with a content type, ContentType is the content type, and CustomHeader is an optional custom header (Name:Value).

Example 22

Publish extension file

.pdf application/pdf

/qwerty.tbl text/plain

Line 1 associates all *.pdf files with content type application/pdf.

Line 2 associates the file qwerty.tbl with content type text/plain.

 

Job resource URI

Identifies output files stored via a Job Resource output connector. Used if the client expects a response to be presented in a web browser via an ActiveX plug-in. In such a case, the response must be temporarily stored using a Job Resource output connector. See Responding with processed data via a Job Resource connector.

Example 23

Job resource URI

/jr