Class Configuration.TargetDirectory

  • Enclosing class:
    Configuration

    public static class Configuration.TargetDirectory
    extends Object
    The target directory details. Requires an LDAP v3 - compatible directory server.

    Property keys: targetDirectory.*

    • Field Detail

      • useDefault

        public final boolean useDefault
        Determines whether to use the default LDAP server configured with the Json2Ldap web service.

        If false the LDAP server details must be specified explicitly below.

        Note: Development only property.

        Property key: targetDirectory.useDefault

      • DEFAULT_DIRECTORY_USE

        public static final boolean DEFAULT_DIRECTORY_USE
        The default target directory use.
        See Also:
        Constant Field Values
      • host

        public final String host
        The host name or IP address of the target directory server.

        Note: Development only property.

        Property key: targetDirectory.host

      • port

        public final int port
        The port number on which the server accepts connections.

        Note: Development only property.

        Property key: targetDirectory.port

      • timeout

        public final int timeout
        The timeout in milliseconds for LDAP connect requests. If zero the underlying LDAP client library will handle this value.

        Note: Development only property.

        Property key: targetDirectory.timeout

      • security

        public final LdapConnectionSecurity security
        The LDAP connection security (NONE, STARTTLS or SSL).

        Note: Development only property.

        Property key: targetDirectory.security

      • trustSelfSignedCerts

        public final boolean trustSelfSignedCerts
        Determines whether to accept self-signed certificates from the LDAP server (for secure StartTLS or SSL connections).

        Note: Development only property.

        Property key: targetDirectory.trustSelfSignedCerts

      • baseDn

        public final com.unboundid.ldap.sdk.DN baseDn
        The base DN under which the exported entries must be stored. The target directory user must have the required access permissions to it.

        Property key: targetDirectory.baseDN

      • entryObjectClasses

        public final String[] entryObjectClasses
        The required object classes for each target directory entry. These must be supported by the directory schema.

        Property key: targetDirectory.entryObjectClasses

      • rdnAttribute

        public final String rdnAttribute
        The attribute to use as relative distinct name (RDN) for the entries exported to the target directory. This attribute must exist in the target entryObjectClasses and the expected values must be unique for every entry under the specified baseDn.

        Property key: targetDirectory.rdnAttribute

    • Constructor Detail

      • TargetDirectory

        public TargetDirectory​(Properties props)
                        throws com.thetransactioncompany.util.PropertyParseException
        Creates a new target directory details instance from the specified properties.
        Parameters:
        props - The properties.
        Throws:
        com.thetransactioncompany.util.PropertyParseException - On a missing or invalid property.