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.

Properties

Use the --advanced option to access advanced properties.

Basic Properties

Advanced Properties

  • None

Basic Properties

allowed-client

SynopsisSpecifies a set of host names or address masks that determine the clients that are allowed to establish connections to this Connection Handler.
DescriptionValid values include a host name, a fully qualified domain name, a domain name, an IP address, or a subnetwork with subnetwork mask.
Default ValueAll 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 ValuesAn IP address mask.
Multi-valuedYes
RequiredNo
Admin Action RequiredNone
Changes to this property take effect immediately and do not interfere with connections that may have already been established.
AdvancedNo
Read-OnlyNo

denied-client

SynopsisSpecifies a set of host names or address masks that determine the clients that are not allowed to establish connections to this Connection Handler.
DescriptionValid 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.
Default ValueIf an allow list is specified, then only clients with addresses on the allow list are allowed. Otherwise, all clients are allowed.
Allowed ValuesAn IP address mask.
Multi-valuedYes
RequiredNo
Admin Action RequiredNone
Changes to this property take effect immediately and do not interfere with connections that may have already been established.
AdvancedNo
Read-OnlyNo

enabled

SynopsisIndicates whether the Connection Handler is enabled.
Default ValueNone
Allowed Valuestrue
false
Multi-valuedNo
RequiredYes
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

java-class

SynopsisSpecifies the fully-qualified name of the Java class that provides the Connection Handler implementation.
Default ValueNone
Allowed ValuesA Java class that extends or implements:
org.opends.server.api.ConnectionHandler
Multi-valuedNo
RequiredYes
Admin Action RequiredThe object must be disabled and re-enabled for changes to take effect.
AdvancedNo
Read-OnlyNo