Package org.forgerock.opendj.server.embedded

Class ConfigParameters

java.lang.Object
org.forgerock.opendj.server.embedded.ConfigParameters
public final class ConfigParameters extends Object
Parameters to configure a directory server.

  • Method Details

    • configParams

      public static ConfigParameters configParams()
      Creates configuration parameters.
      Returns:
      the parameters

    • getConfigPropertyResolver

      public PropertyResolver getConfigPropertyResolver()
      Returns the currently configured PropertyResolver or null if none has been defined.
      Returns:
      the currently configured PropertyResolver or null.

    • deploymentId

      public ConfigParameters deploymentId(DeploymentId deploymentId)
      Specifies the DeploymentId which should be used for securing the deployment of the directory server. The deployment ID MUST be the same for all servers in the deployment. Create a new deployment ID for the first server, then re-use it for subsequent servers.

      Deployment ID is mandatory in a directory server setup hence this method must be called before EmbeddedDirectoryServer.initializeConfiguration() is called on the embedded DS associated to this object.

      Parameters:
      deploymentId - DeploymentId to use in the directory server.
      Returns:
      this builder
      See Also:

    • serverInstallPath

      public ConfigParameters serverInstallPath(Path serverInstallPath)
      Sets the server installation path of the directory server.

      The server installation path is the location where the binaries and default configuration is stored.

      Parameters:
      serverInstallPath - Path to the server installation directory
      Returns:
      this builder

    • serverId

      public ConfigParameters serverId(String serverId)
      Sets the server ID of the directory server.
      Parameters:
      serverId - the server ID
      Returns:
      this builder

    • serverInstancePath

      public ConfigParameters serverInstancePath(Path serverInstancePath)
      Sets the instance path of the directory server.

      The instance path is the location where the data and live configuration is stored.

      Parameters:
      serverInstancePath - Path to the instance directory
      Returns:
      this builder

    • configurationFile

      public ConfigParameters configurationFile(Path filePath)
      Sets the path of the configuration filePath of the directory server.
      Parameters:
      filePath - Path to the configuration file
      Returns:
      this builder

    • disableConnectionHandlers

      public ConfigParameters disableConnectionHandlers(boolean disable)
      Sets the indicator allowing to disable the connection handlers.
      Parameters:
      disable - true to disable the connection handlers
      Returns:
      this builder

    • configResolver

      public ConfigParameters configResolver(PropertyResolver resolver)
      Sets the PropertyResolver to use to resolve configuration properties.
      Parameters:
      resolver - the property resolver to use
      Returns:
      this builder