LDIF Connection Handler

The LDIF Connection Handler is used to process changes in the server using internal operations, where the changes to process are read from an LDIF file.

The connection handler periodically looks for the existence of a new file, processes the changes contained in that file as internal operations, and writes the result to an output file with comments indicating the result of the processing. NOTE: By default LDIF Connection Handler operations are not logged because they are internal operations. If you want to log these operations, allow internal logging in the access log publisher.

Parent

The LDIF Connection Handler object inherits from Connection Handler.

Properties

Use the --advanced option to access advanced properties.

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

ldif-directory

SynopsisSpecifies the path to the directory in which the LDIF files should be placed.
Default Valueconfig/auto-process-ldif
Allowed ValuesA string.
Multi-valuedNo
RequiredYes
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

poll-interval

SynopsisSpecifies how frequently the LDIF connection handler should check the LDIF directory to determine whether a new LDIF file has been added.
Default Value5 seconds
Allowed ValuesA duration. Lower limit: 1 milliseconds.
Multi-valuedNo
RequiredYes
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

Advanced Properties

java-class

SynopsisSpecifies the fully-qualified name of the Java class that provides the LDIF Connection Handler implementation.
Default Valueorg.opends.server.protocols.LDIFConnectionHandler
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.
AdvancedYes
Read-OnlyNo