server.xml elements beginning with F and H
The following elements are discussed below:
file-cache
The file-cache element configures the file cache. This element may appear zero or one time within the server element. For more information, see server.
Subelements
The file-cache element can contain the following subelements:
Table 3-21 List of file-cache Subelements
| Element | Occurrences | Description |
|---|---|---|
| enabled | 0 or 1 | Determines whether the server cache is enabled. The default value is true. Whether file content is cached in addition to meta information is controlled by the cache-content subelement. |
| max-age | 0 or 1 | The maximum amount of time (in seconds) to cache file content and meta information. The value can be from –1 to3600. The value -1 indicates that the file cache entries do not expire. |
| max-entries | 0 or 1 | The maximum number of paths to cache content and/or meta information. The value can be from 1 to 1048576. |
| max-open-files | 0 or 1 | The maximum number of file descriptors the file cache will keep open. The value can be from 1 to 1048576. |
| sendfile | 0 or 1 | Determines whether the server will attempt to use the operating system's sendfile, sendfilev, send_file, or TransmitFile system call. The default value is true on Windows and false on other platforms. |
| copy-files | 0 or 1 | Determines whether the server copies cached files to a temporary directory. The default value is true on Windows and false on other platforms. |
| copy-path | 0 or 1 | The temporary directory that is used when copy-files is true. If a relative path is used, it is relative to the server's config directory. |
| replacement | 0 or 1 | The cache entry replacement algorithm. The value can be false, lru, or lfu. |
| cache-content | 0 or 1 | Determines whether the server caches file content in addition to the meta information. The default value is true. |
| max-heap-file-size | 0 or 1 | The maximum size (in bytes) of files to cache on the heap. The value can be from 0 to 2147483647. |
| max-heap-space | 0 or 1 | The maximum amount (in bytes) of heap to use for caching files. The value can be from 0 to 1099511627776 . |
| max-mmap-file-size | 0 or 1 | The maximum size (in bytes) of files to mmap. The value can be from 0 to 2147483647. |
| max-mmap-space | 0 or 1 | The maximum amount (in bytes) of mmap address space to use for caching files. The value can be from 0 to 1099511627776 . |
| sendfile-size | 0 | Web Server uses sendfile-size only when the file size is greater than max-heap-file-size. When sendfile-size is set to non-zero value and file-cache and sendfile are enabled, it hints the file-cache subsystem to send the file in chunks. The chunk size can be at the most the size of sendfile-size. When sendfile-size is set to default value, that is, zero and sendfile is enabled, the entire file is attempted to be sent out. In either case, the left over file is sent in subsequent transfers. |
See Also
http
The http element configures miscellaneous HTTP protocol options. This element may appear zero or one time within the server element. For more information, see server.
Subelements
The http element can contain the following subelements:
Table 3-22 List of http Subelements
| Element | Occurrences | Description |
|---|---|---|
| version | 0 or 1 | The highest HTTP protocol version the server supports. The default HTTP version string is HTTP/1.1. |
| server-header | 0 or 1 | The server header information, such as the name of the server software and version. The default server header is Sun-Java-System-Web-Server/7.0. |
| request-header-buffer-size | 0 or 1 | The size (in bytes) of the buffer used to read HTTP request headers. The value can be from 0 to 2147483647. |
| strict-request-headers | 0 or 1 | Determines whether the server rejects certain malformed HTTP request headers. The default value is false. |
| max-request-headers | 0 or 1 | The maximum number of header fields to allow in an HTTP request header. The value can be from 1 to 512. |
| output-buffer-size | 0 or 1 | The size (in bytes) of buffer used to buffer HTTP responses. The value can be from 0 to 2147483647. |
| max-unchunk-size | 0 or 1 | The maximum size (in bytes) of a chunked HTTP request body that the server will unchunk. The value can be from 0 to 2147483647. |
| unchunk-timeout | 0 or 1 | The maximum time (in seconds) that the server waits for a chunked HTTP request body to arrive. The value can be from 0 to 3600, or -1 for no timeout. |
| io-timeout | 0 or 1 | The maximum time (in seconds) that the server waits for an individual packet. The value can be from 0 to 3600, or -1 for no timeout. |
| request-header-timeout | 0 or 1 | The maximum time (in seconds) that the server waits for a complete HTTP request header. The value can be from 0 to 604800, or -1 for no timeout. |
| request-body-timeout | 0 or 1 | The maximum time (in seconds) that the server waits for a complete HTTP request body. The value can be from 0 to 604800, or -1 for no timeout. |
| favicon | 0 or 1 | Determines whether the server replies to requests for favicon.ico with its own built-in icon file. The default value is true. |
| etag | 0 or 1 | Controls whether the server includes an Etag header field in its responses. The default value is true. |
See Also
http-listener
The http-listener element configures an HTTP listener. This element may appear zero or more times within the server element. For more information, see server.
Subelements
The http-listener element can contain the following subelements:
Table 3-23 List of http-listener Subelements
| Element | Occurrences | Description |
|---|---|---|
| enabled | 0 or 1 | Determines whether the HTTP listener is enabled at runtime. The default value is true. |
| name | 1 | The name that uniquely identifies the HTTP listener. |
| ip | 0 or 1 | The IP address on which to listen. The value of this element is a specific IP address, or * to listen on all IP addresses. |
| port | 1 | The port on which to listen. The value of this element is the port number. |
| acceptor-threads | 0 or 1 | The number of threads dedicated to accept connections received by this listener. The value can be from 1 to 128. |
| server-name | 1 | The default server name. The value can include a scheme prefix (for example, http://) and port suffix (for example, :80). |
| blocking-io | 0 or 1 | Determines whether the server uses blocking IO. The default value is false. |
| family | 0 or 1 | The name of the protocol family. |
| handle-protocol-mismatch | 0 or 1 | Controls the server's response to SSL or non-SSL protocol mismatches in client requests. A mismatch occurs when a client uses SSL to send a request to a non-SSL listener, or when a client sends a request to an SSL listener without using SSL. The default is true, which means that the server attempts to detect SSL or non-SSL protocol mismatches and sends an HTTP redirect or SSL alert when a mismatch is detected. |
| listen-queue-size | 0 or 1 | The maximum size (in bytes) of the operating system listen queue backlog. The value of this element can be from 1 to 1048576. |
| receive-buffer-size | 0 or 1 | The size (in bytes) of the operating system socket receive buffer. The value of this element can be from 1 to 1048576. |
| send-buffer-size | 0 or 1 | The size (in bytes) of the operating system socket send buffer. The value of this element can be from 1 to 1048576. |
| default-virtual-server-name | 1 | The name of the virtual server that processes requests that do not match a host. The value of this element is the name value from a virtual-server element. For more details, see virtual-server. |
| ssl | 0 or 1 | Configures SSL/TLS. For more details, see ssl. |
| description | 0 or 1 | The description of the HTTP listener. The value of this element should be in a text format. |
Sign up or Log in to add a comment or watch this page.