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 Summary

Modifier and Type	Method	Description
static ConfigParameters	configParams()	Creates configuration parameters.
ConfigParameters	configResolver(PropertyResolver resolver)	Sets the PropertyResolver to use to resolve configuration properties.
ConfigParameters	configurationFile(Path filePath)	Sets the path of the configuration filePath of the directory server.
ConfigParameters	deploymentId(DeploymentId deploymentId)	Specifies the DeploymentId which should be used for securing the deployment of the directory server.
ConfigParameters	disableConnectionHandlers(boolean disable)	Sets the indicator allowing to disable the connection handlers.
PropertyResolver	getConfigPropertyResolver()	Returns the currently configured PropertyResolver or null if none has been defined.
ConfigParameters	serverId(String serverId)	Sets the server ID of the directory server.
ConfigParameters	serverInstanceDirectory(Path instanceDirPath)	Sets the instance root directory of the directory server.
ConfigParameters	serverRootDirectory(Path serverRootDir)	Sets the server root directory of the directory server.

Methods inherited from class java.lang.Object

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

Method Detail

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:

DeploymentId.generateDeploymentId(char[])

serverRootDirectory

public ConfigParameters serverRootDirectory(Path serverRootDir)

Sets the server root directory of the directory server.

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

Parameters:

serverRootDir - Path to the server root 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

serverInstanceDirectory

public ConfigParameters serverInstanceDirectory(Path instanceDirPath)

Sets the instance root directory of the directory server.

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

Parameters:

instanceDirPath - Path to the instance root 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