Connection Handler
This is an abstract object type that cannot be instantiated.
Connection Handlers are responsible for handling all interaction with the clients, including accepting the connections, reading requests, and sending responses.
Connection Handlers
The following Connection Handlers are available:
These Connection Handlers inherit the properties described below.
Connection Handler Properties
You can use configuration expressions to set property values at startup time. For details, see Property Value Substitution.
Basic Properties
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 |
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 |
java-class
Synopsis | Specifies the fully-qualified name of the Java class that provides the Connection Handler implementation. |
Default Value | None |
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 | 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 |