Entering content frame

Background documentation HTTP Provider Service Locate the document in its SAP Library structure

The HTTP Provider Service represents a server socket that listens for client HTTP connections on the SAP J2EE Engine. It takes care of parsing the URL of the incoming HTTP requests, dispatching them to the correct SAP J2EE Engine’s module for processing, and returning the generated responses back to the client.

HTTP Provider Service runs on both dispatchers and servers.

Dispatcher

Property

Description

Default Value

Ports

Defines a list of ports definitions. A port definition can have the following attributes: Port: that specifies the port number; Type: that specifies the type of the port (HTTP or SSL); SocketQueue: that specifies the maximum queue length for incoming connection indications; AcceptingThreadsCount: that specifies the number of threads that listen to the server socket for incoming connections; BindAddress: that specifies the address of the server to which connections can be established only. Only the Port: and the Type: attributes are mandatory.

Separate port definitions are enclosed within brackets.

(Port:50000,SocketQueue:200,

AcceptingThreadsCount:10,

BindAddress:,Type:http)

(Port:50001,SocketQueue:200,

AcceptingThreadsCount:10,

BindAddress:,Type:ssl)

ProxyMappings

Defines a comma-separated list of ports mappings. A valid mapping must contain the hostname and port, as well as the communication scheme of the host, to which the requests from the original port are to be redirected. An Override attribute is present also to force the host and port information from the request to be overridden by the relevant information from this property.

 

KeepAliveTimeout

The period (in seconds) from the last server response to the client until the server shuts the client-server connection down. The value of this property is an integer. If it is set to 0 or less, there is no timeout.

15

MaxRequestHeadersLength

Specifies the maximum length of all headers in a request.

The value is specified in bytes.

4096

HttpTrace

Specifies whether the HTTP Provider Service logs the HTTP requests and responses it served. Information about them is stored in a file called req_resp.trc. The file is located in the \dispatcher\log\services\http directory under the SAP J2EE Engine installation directory.

disable

Note

The possible values of this property are disable, enable, and enableHeaders. When enable is set, the service logs information about the full requests and responses. If enableHeaders is set, only the headers of the requests and responses are logged.

MaxRequestContentLength

Specifies the limit of length of  the request body that can be accepted (that is, the value of the Content-Length header of the request must not exceed the value of this property). The request is rejected if its body exceeds the limit.

The value of the property is specified in KB.

131072

ReadBufferSize

Specifies the size of the buffer that the HTTP Provider Service running on the Java dispatcher uses to send the request body to the HTTP Provider Service on the server processes.

The value of the property is specified in bytes.

32768

ServiceUnavailableResponse

Specifies the directory path to the page that is returned as response to the client when no server is connected to the Java dispatcher. If the value of this property is an empty string, then the “Dispatcher running but no server connected” error message is returned to the client.

 

UseServerHeader

Specifies whether the Server header is sent with the response. It contains the name of the server that responds to the request.

true

HeterogeneousLoadBalancing

Enables heterogeneous load balancing – if a server process is stopped and requests are sent, they are switched to a running server element.

true

SocketTcpNoDelay

This property is used to enable/disable the Nagle’s algorithm for communication through TCP sockets. It is equivalent to the standard TCP_NODELAY option of the java.net.Socket class.

For more information, refer to the Java 2 Standard Edition, version 1.4 API documentation at http://java.sun.com.

This property takes Boolean values. Value of true means the TCP_NODELAY option is set.

true

This graphic is explained in the accompanying text

For more information about HTTP and HTTPS ports generation and changing, see SAP J2EE Engine Ports.

Server

Property

Description

Default Value

LogCLF

Enables or disables logging in Common Log Format – standard format for logging HTTP requests and responses.

false

FileBufferSize

This is used for downloading or uploading static files using HTTP.

We recommend that you increase the file buffer size when transferring large files so that fewer sets of data are transmitted.

The value of this property is specified in bytes.

4096

ServletsLongDataTransferLimit

Specifies the limit of the length of servlet (or JSP) responses, above which the Long Data Transfer mechanism is activated to transfer the response messages.

The value of this property is specified in bytes.

131072

ServletsLongDataTransferTimeout

Specifies the period of time that the server waits for the dispatcher to send the callback to continue sending the response data (when the response is sent using the Long Data Transfer mechanism). If the timeout period is exceeded, a runtime exception is thrown to interrupt the response message transfer.

The period is specified in milliseconds.

10000

CacheControl

Sets the expiration period for static files stored by client caches. It must be specified in milliseconds.

86400

SapCacheControl

Sets timeout for storing responses from SAP J2EE Engine into the ICM’s cache. It must be specified in milliseconds.

86400

MaxFileLengthForCache

Sets a limit to the size of the file that can be written to the cache.

The value is specified in bytes.

16348

CacheSize

Sets the maximum number of files that can be kept in the cache.

1000

CacheTimeOut

The period (value range from 1 to 15 seconds) until the system checks the version of all files in the cache and updates them. If it is set to 0 or less, this option is switched off.

-1

ProxyServersCertificates

A list of certificate subject DN names against which the proxy server is authorized when forwarding a client certificate to HTTP Service.

{}

AcceptClientCertWithoutSSL

If checked, the HTTP server accepts client certificates that are forwarded to it by the proxy server over a non-secure HTTP connection. If not checked, the proxy server must use SSL connection.

false

ClientCertificateHeaderName

Specifies the name of the header that is attached to the client HTTP request. The value of this header represents the Base64 encoded public key of client certificate.

SSL_CLIENT_CERT

ProtocolHeaderName

Specifies the header name that contains the name of the communication protocol used between the client and the proxy.

ClientProtocol

ClientCertificateChainHeaderPrefix

Specifies the prefix of the name of the header that is used to forward the certificate chain that contains the client certificate.

SSL_CLIENT_CERT_CHAIN_

ClientKeySizeHeaderName

Specifies the name of the header that contains information about the size of the client key.

SSL_CIPHER_USEKEYSIZE

ClientCipherSuiteHeaderName

Specifies the name of the header that contains information about the cipher suite that is used by the client.

SSL_CIPHER_SUITE

ServletInputStreamTimeout

Specifies the time period (in milliseconds) that the server waits for the client to write data into the input stream. If nothing is written, an exception is thrown.

10000

AlwaysCompressed

Specifies a list of file extensions and HTTP messages content types that must always be compressed with gzip transfer encoding when returned as HTTP responses.

*.htm,*.html,text/html

NeverCompressed

Specifies a list of file extensions and HTTP messages content types that must never be compressed with gzip transfer encoding when returned as HTTP responses.

 

CompressedOthers

Determines whether to compress or not HTTP responses that contain files or have content types that do not appear in the AlwaysCompressed and NeverCompressed lists.

true

MinimumGZipLength

Specifies the minimum length of the HTTP response so that it is compressed using gzip transfer encoding. Response messages that are shorter than the value of this property are never compressed. The length is specified in bytes.

8192

Mime

Defines the list of supported MIME types.

 

UseServerHeader

Specifies whether the Server header is sent with the response. It contains the name of the server that responds to the request.

true

MinFileLengthForLongData

Transfer

Specifies the response file length. If it exceeds the default value, then the response is returned as Long Data Transfer.

The value of this property is specified in bytes.

204800

InputBufferMaxSize

Specifies the upper limit of the input stream read buffer used by the HTTP Provider Service on the server process. The size is specified in KB.

8192

InputBufferMinSize

Specifies the lower limit of the input stream read buffer used by the HTTP Provider Service on the server process. The size is specified in KB.

1024

ZoneSeparator

Specifies the string that is used to separate the zone identifier from the application alias. This string can be of an arbitrary length.

~

InferNames

Specifies a list of Web pages, one of which must be returned to the client if a Web directory has been requested (not a specific web resource contained in it). Use a comma to separate multiple pages in the list.

{index.html,index.htm,default.html,

default.htm}

 

Runtime

Property

Description

Default Value

Root Directory

The root directory for this host. The installation program does not create the main directory for the HTTP files automatically. It must be created additionally, or the path must be redirected to an existing directory.

../../docs

Start Page

This page is displayed when the browser establishes a connection with the host. The server searches the root directory for a file that appears in the Welcome Files list. The first match found is returned to the client browser.

 

Log Responses

Enables or disables logging responses on a particular virtual host.

By default, the indicator is checked.

 

Use Cache

If this indicator is set, cache is used for static data.

By default, the indicator is checked.

 

Keep Alive

Specifies whether a connection is “kept alive” or is closed each time.

By default, the indicator is checked.

 

Directory List

If the default Welcome file cannot be found in the current directory, the server returns a list of directories.

By default, the indicator is not checked.

 

 

See also:

 

HTTP Provider Service in the Administration Manual.

 

Leaving content frame