Note: this component is designated "advanced", which means that objects of this type are not expected to be created or altered in most environments. If you believe that such a change is necessary, you may want to contact UnboundID support in order to understand the potential impact of that change.
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 Component
↓Properties
↓dsconfig Usage
The LDIF Connection Handler component inherits from the Connection Handler
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ description | ↓ allowed-client |
| ↓ enabled | ↓ denied-client |
| ↓ ldif-directory | |
| ↓ poll-interval |
| Description | A description for this Connection Handler |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Indicates whether the Connection Handler is enabled. |
| Default Value | None |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the path to the directory in which the LDIF files should be placed. |
| Default Value | config/auto-process-ldif |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies how frequently the LDIF connection handler should check the LDIF directory to determine whether a new LDIF file has been added. |
| Default Value | 5 seconds |
| Allowed Values | A duration. Lower limit is 1 milliseconds. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
allowed-client (Advanced Property)
| Description | Specifies a set of address masks that determines the addresses of the clients that are allowed to establish connections to this connection handler. |
| 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 configuration attribute take effect immediately and do not interfere with connections that may have already been established. |
denied-client (Advanced Property)
| Description | Specifies a set of address masks that determines the addresses of the clients that are not allowed to establish connections to this connection handler. 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 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 configuration attribute take effect immediately and do not interfere with connections that may have already been established. |
To list the configured Connection Handlers:
dsconfig list-connection-handlers
[--property {propertyName}] ...
To view the configuration for an existing Connection Handler:
dsconfig get-connection-handler-prop
--handler-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing Connection Handler:
dsconfig set-connection-handler-prop
--handler-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new LDIF Connection Handler:
dsconfig create-connection-handler
--handler-name {name}
--type ldif
--set enabled:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing Connection Handler:
dsconfig delete-connection-handler
--handler-name {name}