Package com.nimbusds.common.ldap

Class SampleDirectory.Configuration

java.lang.Object
com.nimbusds.common.ldap.SampleDirectory.Configuration
Enclosing class:
SampleDirectory
public static class SampleDirectory.Configuration extends Object
The sample directory server configuration.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    final String
    baseDN
    The base distinguished name (DN) of the directory information tree.
    final String
    content
    The initial directory information tree, supplied in a single LDIF file.
    static final boolean
    DEFAULT_ENABLE
    The default enable policy.
    static final Set<com.unboundid.ldap.sdk.OperationType>
    DEFAULT_OPERATIONS
    The default permitted LDAP operations.
    static final int
    DEFAULT_PORT
    The default port number.
    final boolean
    enable
    If true the sample directory server must be enabled.
    final Set<com.unboundid.ldap.sdk.OperationType>
    operations
    Specifies the permitted LDAP operations.
    final int
    port
    The port number on which the sample directory server must accept LDAP client connections.
    final String
    schema
    Specifies an alternative schema for the sample directory + server, supplied in a single LDIF file.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Configuration(Properties props)
    Creates a new sample directory server configuration from the specified properties.

  • Method Summary

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • enable

      public final boolean enable
      If true the sample directory server must be enabled.

      Property key: sampleDirectoryServer.enable

    • DEFAULT_ENABLE

      public static final boolean DEFAULT_ENABLE
      The default enable policy.
      See Also:

    • port

      public final int port
      The port number on which the sample directory server must accept LDAP client connections.

      Property key: sampleDirectoryServer.port

    • DEFAULT_PORT

      public static final int DEFAULT_PORT
      The default port number.
      See Also:

    • operations

      public final Set<com.unboundid.ldap.sdk.OperationType> operations
      Specifies the permitted LDAP operations.

      Property key: sampleDirectoryServer.operations

    • DEFAULT_OPERATIONS

      public static final Set<com.unboundid.ldap.sdk.OperationType> DEFAULT_OPERATIONS
      The default permitted LDAP operations.

    • schema

      public final String schema
      Specifies an alternative schema for the sample directory + server, supplied in a single LDIF file. If null the default built-in server schema must be used.

      Property key: sampleDirectoryServer.schema

    • baseDN

      public final String baseDN
      The base distinguished name (DN) of the directory information tree.

      Property key: sampleDirectoryServer.baseDN

    • content

      public final String content
      The initial directory information tree, supplied in a single LDIF file. If null the directory will be left empty.

      Property key: sampleDirectoryServer.content

  • Constructor Details

    • Configuration

      public Configuration(Properties props) throws com.thetransactioncompany.util.PropertyParseException
      Creates a new sample directory server configuration from the specified properties.
      Parameters:
      props - The configuration properties. Must not be null.
      Throws:
      com.thetransactioncompany.util.PropertyParseException - On a missing or invalid property.