HTTP Connection Handler
HTTP Connection Handlers provide HTTP services built on top of the underlying LDAP directory.
It routes HTTP requests to HTTP endpoints registered in the configuration.
Parent
The HTTP Connection Handler object inherits from Connection Handler.
HTTP Connection Handler Properties
You can use configuration expressions to set property values at startup time. For details, see Property Value Substitution.
advertised-listen-address
Synopsis |
The advertised address(es) which clients should use for connecting to this HTTP Connection Handler. |
Description |
Multiple addresses may be provided as separate values for this attribute. The meta-address 0.0.0.0 is not permitted. |
Default Value |
None |
Allowed Values |
A hostname or an IP address. |
Multi-valued |
Yes |
Required |
Yes |
Admin Action Required |
None |
Advanced |
No |
Read-Only |
No |
allowed-client
Synopsis |
A set of clients who will be allowed to establish connections to this Connection Handler. |
Description |
Valid values include a host name, a fully qualified domain name, a domain name, an IP address, or a subnetwork with subnetwork mask. Specifying a value for this property in a connection handler will override any value set in the global configuration. |
Default Value |
All clients with addresses that do not match an address on the deny list are allowed. If there is no deny list, then all clients are allowed. |
Allowed Values |
An IP address mask. |
Multi-valued |
Yes |
Required |
No |
Admin Action Required |
None Changes to this property take effect immediately and do not interfere with established connections. |
Advanced |
No |
Read-Only |
No |
api-descriptor-enabled
Synopsis |
Indicates whether the HTTP Connection Handler should publish Swagger and CREST API descriptors. |
Description |
When enabled, API descriptors facilitate development of new client client applications. The API descriptors are not protected and are not recommended for production systems." |
Default Value |
true |
Allowed Values |
true false |
Multi-valued |
No |
Required |
No |
Admin Action Required |
The object must be disabled and re-enabled for changes to take effect. |
Advanced |
No |
Read-Only |
No |
denied-client
Synopsis |
A set of clients who are not allowed to establish connections to this Connection Handler. |
Description |
Valid values include a host name, a fully qualified domain name, a domain name, an IP address, or a subnetwork with subnetwork mask. If both allowed and denied client masks are defined and a client connection matches one or more masks in both lists, then the connection is denied. If only a denied list is specified, then any client not matching a mask in that list is allowed. Specifying a value for this property in a connection handler will override any value set in the global configuration. |
Default Value |
If an allow list is specified, then only clients with addresses on the allow list are allowed. Otherwise, all clients are allowed. |
Allowed Values |
An IP address mask. |
Multi-valued |
Yes |
Required |
No |
Admin Action Required |
None Changes to this property take effect immediately and do not interfere with established connections. |
Advanced |
No |
Read-Only |
No |
enabled
Synopsis |
Indicates whether the Connection Handler is enabled. |
Default Value |
None |
Allowed Values |
true false |
Multi-valued |
No |
Required |
Yes |
Admin Action Required |
None |
Advanced |
No |
Read-Only |
No |
keep-stats
Synopsis |
Indicates whether the HTTP Connection Handler should keep statistics. |
Description |
If enabled, the HTTP Connection Handler maintains statistics about the number and types of operations requested over HTTP and the amount of data sent and received. |
Default Value |
true |
Allowed Values |
true false |
Multi-valued |
No |
Required |
No |
Admin Action Required |
None |
Advanced |
No |
Read-Only |
No |
key-manager-provider
Synopsis |
Specifies the name of the key manager that should be used with this HTTP Connection Handler . |
Default Value |
None |
Allowed Values |
The name of an existing key-manager-provider. The referenced key manager provider must be enabled when the HTTP Connection Handler is enabled and configured to use SSL. |
Multi-valued |
No |
Required |
No |
Admin Action Required |
The object must be disabled and re-enabled for changes to take effect. |
Advanced |
No |
Read-Only |
No |
listen-address
Synopsis |
The network interface(s) on which this HTTP Connection Handler should listen for incoming client connections. |
Description |
Multiple addresses may be provided as separate values for this attribute. If no values are provided, then the directory server will listen on all interfaces. |
Default Value |
0.0.0.0 |
Allowed Values |
A hostname or an IP address. |
Multi-valued |
Yes |
Required |
No |
Admin Action Required |
The object must be disabled and re-enabled for changes to take effect. |
Advanced |
No |
Read-Only |
No |
listen-port
Synopsis |
Specifies the port number on which the HTTP Connection Handler will listen for connections from clients. |
Description |
Only a single port number may be provided. |
Default Value |
None |
Allowed Values |
An integer. Lower limit: 1. Upper limit: 65535. |
Multi-valued |
No |
Required |
Yes |
Admin Action Required |
The object must be disabled and re-enabled for changes to take effect. |
Advanced |
No |
Read-Only |
No |
max-concurrent-ops-per-connection
Synopsis |
Specifies the maximum number of internal operations that each HTTP client connection can execute concurrently. |
Description |
This property allow to limit the impact that each HTTP request can have on the whole server by limiting the number of internal operations that each HTTP request can execute concurrently. A value of 0 means that no limit is enforced. |
Default Value |
Let the server decide. |
Allowed Values |
An integer. Lower limit: 0. |
Multi-valued |
No |
Required |
No |
Admin Action Required |
The object must be disabled and re-enabled for changes to take effect. |
Advanced |
No |
Read-Only |
No |
restricted-client
Synopsis |
A set of clients who will be limited to the maximum number of connections specified by the "restricted-client-connection-limit" property. |
Description |
Valid values include a host name, a fully qualified domain name, a domain name, an IP address, or a subnetwork with subnetwork mask. Specifying a value for this property in a connection handler will override any value set in the global configuration. |
Default Value |
No restrictions are imposed on the number of connections a client can open. |
Allowed Values |
An IP address mask. |
Multi-valued |
Yes |
Required |
No |
Admin Action Required |
None Changes to this property take effect immediately and do not interfere with established connections. |
Advanced |
No |
Read-Only |
No |
restricted-client-connection-limit
Synopsis |
Specifies the maximum number of connections a restricted client can open at the same time to this Connection Handler. |
Description |
Once Directory Server accepts the specified number of connections from a client specified in restricted-client, any additional connection will be rejected. The number of connections is maintained by IP address. Specifying a value for this property in a connection handler will override any value set in the global configuration. |
Default Value |
100 |
Allowed Values |
An integer. Lower limit: 0. |
Multi-valued |
No |
Required |
No |
Admin Action Required |
None Changes to this property take effect immediately and do not interfere with established connections. |
Advanced |
No |
Read-Only |
No |
ssl-cert-nickname
Synopsis |
Specifies the nicknames (also called the aliases) of the keys or key pairs that the HTTP Connection Handler should use when performing SSL communication. |
Description |
The property can be used multiple times (referencing different nicknames) when server certificates with different public key algorithms are used in parallel (for example, RSA, DSA, and ECC-based algorithms). When a nickname refers to an asymmetric (public/private) key pair, the nickname for the public key certificate and associated private key entry must match exactly. A single nickname is used to retrieve both the public key and the private key. This is only applicable when the HTTP Connection Handler is configured to use SSL. |
Default Value |
Let the server decide. |
Allowed Values |
A string. |
Multi-valued |
Yes |
Required |
No |
Admin Action Required |
The object must be disabled and re-enabled for changes to take effect. |
Advanced |
No |
Read-Only |
No |
ssl-cipher-suite
Synopsis |
Specifies the names of the SSL cipher suites that are allowed for use in SSL communication. |
Default Value |
Uses the default set of SSL cipher suites provided by the server’s JVM. |
Allowed Values |
A string. |
Multi-valued |
Yes |
Required |
No |
Admin Action Required |
The object must be disabled and re-enabled for changes to take effect. |
Advanced |
No |
Read-Only |
No |
ssl-client-auth-policy
Synopsis |
Specifies the policy that the HTTP Connection Handler should use regarding client SSL certificates. Clients can use the SASL EXTERNAL mechanism only if the policy is set to "optional" or "required". |
Description |
This is only applicable if clients are allowed to use SSL. |
Default Value |
optional |
Allowed Values |
|
Multi-valued |
No |
Required |
No |
Admin Action Required |
The object must be disabled and re-enabled for changes to take effect. |
Advanced |
No |
Read-Only |
No |
ssl-protocol
Synopsis |
Specifies the names of the SSL protocols that are allowed for use in SSL communication. |
Default Value |
Uses the default set of SSL protocols provided by the server’s JVM. |
Allowed Values |
A string. |
Multi-valued |
Yes |
Required |
No |
Admin Action Required |
The object must be disabled and re-enabled for changes to take effect. |
Advanced |
No |
Read-Only |
No |
trust-manager-provider
Synopsis |
Specifies the name(s) of the trust manager(s) that should be used with the HTTP Connection Handler. |
Default Value |
None |
Allowed Values |
The name of an existing trust-manager-provider. The referenced trust manager provider must be enabled when the HTTP Connection Handler is enabled, is configured to use SSL and its SSL client auth policy is set to required or optional. |
Multi-valued |
Yes |
Required |
No |
Admin Action Required |
The object must be disabled and re-enabled for changes to take effect. |
Advanced |
No |
Read-Only |
No |
use-ssl
Synopsis |
Indicates whether the HTTP Connection Handler should use SSL. |
Description |
If enabled, the HTTP Connection Handler will use SSL to encrypt communication with the clients. |
Default Value |
false |
Allowed Values |
true false |
Multi-valued |
No |
Required |
No |
Admin Action Required |
The object must be disabled and re-enabled for changes to take effect. |
Advanced |
No |
Read-Only |
No |
Advanced Properties
Use the --advanced
option to access advanced properties.
accept-backlog
Synopsis |
Specifies the maximum number of pending connection attempts that are allowed to queue up in the accept backlog before the server starts rejecting new connection attempts. |
Description |
This is primarily an issue for cases in which a large number of connections are established to the server in a very short period of time (for example, a benchmark utility that creates a large number of client threads that each have their own connection to the server) and the connection handler is unable to keep up with the rate at which the new connections are established. |
Default Value |
128 |
Allowed Values |
An integer. Lower limit: 1. |
Multi-valued |
No |
Required |
No |
Admin Action Required |
The object must be disabled and re-enabled for changes to take effect. |
Advanced |
Yes |
Read-Only |
No |
allow-tcp-reuse-address
Synopsis |
Indicates whether the HTTP Connection Handler should reuse socket descriptors. |
Description |
If enabled, the SO_REUSEADDR socket option is used on the server listen socket to potentially allow the reuse of socket descriptors for clients in a TIME_WAIT state. This may help the server avoid temporarily running out of socket descriptors in cases in which a very large number of short-lived connections have been established from the same client system. |
Default Value |
true |
Allowed Values |
true false |
Multi-valued |
No |
Required |
No |
Admin Action Required |
The object must be disabled and re-enabled for changes to take effect. |
Advanced |
Yes |
Read-Only |
No |
buffer-size
Synopsis |
Specifies the size in bytes of the HTTP response message write buffer. |
Description |
This property specifies write buffer size allocated by the server for each client connection and used to buffer HTTP response messages data when writing. |
Default Value |
4096 bytes |
Allowed Values |
|
Multi-valued |
No |
Required |
No |
Admin Action Required |
The object must be disabled and re-enabled for changes to take effect. |
Advanced |
Yes |
Read-Only |
No |
java-class
Synopsis |
Specifies the fully-qualified name of the Java class that provides the HTTP Connection Handler implementation. |
Default Value |
org.opends.server.protocols.http.HTTPConnectionHandler |
Allowed Values |
A Java class that extends or implements:
|
Multi-valued |
No |
Required |
Yes |
Admin Action Required |
The object must be disabled and re-enabled for changes to take effect. |
Advanced |
Yes |
Read-Only |
No |
max-blocked-write-time-limit
Synopsis |
Specifies the maximum length of time that attempts to write data to HTTP clients should be allowed to block. |
Description |
If an attempt to write data to a client takes longer than this length of time, then the client connection is terminated. |
Default Value |
30 seconds |
Allowed Values |
Uses duration syntax. Lower limit: 0 milliseconds. |
Multi-valued |
No |
Required |
No |
Admin Action Required |
The object must be disabled and re-enabled for changes to take effect. |
Advanced |
Yes |
Read-Only |
No |
max-request-size
Synopsis |
Specifies the size in bytes of the largest HTTP request message that will be allowed by the HTTP Connection Handler. |
Description |
This can help prevent denial-of-service attacks by clients that indicate they send extremely large requests to the server causing it to attempt to allocate large amounts of memory. |
Default Value |
5 megabytes |
Allowed Values |
Uses size syntax. Upper limit: 2147483647. |
Multi-valued |
No |
Required |
No |
Admin Action Required |
The object must be disabled and re-enabled for changes to take effect. |
Advanced |
Yes |
Read-Only |
No |
num-request-handlers
Synopsis |
Specifies the number of request handlers that are used to read requests from clients. |
Description |
The HTTP Connection Handler uses one thread to accept new connections from clients, but uses one or more additional threads to read requests from existing client connections. This ensures that new requests are read efficiently and that the connection handler itself does not become a bottleneck when the server is under heavy load from many clients at the same time. |
Default Value |
Let the server decide. |
Allowed Values |
An integer. Lower limit: 1. |
Multi-valued |
No |
Required |
No |
Admin Action Required |
The object must be disabled and re-enabled for changes to take effect. |
Advanced |
Yes |
Read-Only |
No |
use-tcp-keep-alive
Synopsis |
Indicates whether the HTTP Connection Handler should use TCP keep-alive. |
Description |
If enabled, the SO_KEEPALIVE socket option is used to indicate that TCP keepalive messages should periodically be sent to the client to verify that the associated connection is still valid. This may also help prevent cases in which intermediate network hardware could silently drop an otherwise idle client connection, provided that the keepalive interval configured in the underlying operating system is smaller than the timeout enforced by the network hardware. |
Default Value |
true |
Allowed Values |
true false |
Multi-valued |
No |
Required |
No |
Admin Action Required |
None |
Advanced |
Yes |
Read-Only |
No |
use-tcp-no-delay
Synopsis |
Indicates whether the HTTP Connection Handler should use TCP no-delay. |
Description |
If enabled, the TCP_NODELAY socket option is used to ensure that response messages to the client are sent immediately rather than potentially waiting to determine whether additional response messages can be sent in the same packet. In most cases, using the TCP_NODELAY socket option provides better performance and lower response times, but disabling it may help for some cases in which the server sends a large number of entries to a client in response to a search request. |
Default Value |
true |
Allowed Values |
true false |
Multi-valued |
No |
Required |
No |
Admin Action Required |
None |
Advanced |
Yes |
Read-Only |
No |