Package org.forgerock.opendj.config

Interface ConfigurationFramework.InitParameters

Enclosing class:

ConfigurationFramework

public static interface ConfigurationFramework.InitParameters

Represents parameters used for initializing a ConfigurationFramework.

Method Summary

Modifier and Type	Method	Description
static ConfigurationFramework.InitParameters	copyInitParameters(ConfigurationFramework configurationFramework)	Copies initialization parameters from the provided configuration framework, suitable for later reinitiaization with ConfigurationFramework.forceInitialize(org.forgerock.opendj.config.ConfigurationFramework.InitParameters).
static ConfigurationFramework.InitParameters	initParameters(Path installPath, Path instancePath, boolean isClient)	Creates initialization parameters for the configuration framework using the provided parameters.
default Path	installPath()	Returns the path where application binaries are located.
default Path	instancePath()	Returns the path where data binaries are located.
default boolean	isClient()	Returns whether the associated configuration framework is being used within a client application.
default com.forgerock.opendj.util.Version	version()	Returns the running binaries version.

Method Detail

installPath

default Path installPath()

Returns the path where application binaries are located.

Returns:

a string representing the path where application binaries are located

instancePath

default Path instancePath()

Returns the path where data binaries are located.

Returns:

a string representing the path where data binaries are located

version

default com.forgerock.opendj.util.Version version()

Returns the running binaries version.

Returns:

the running binaries version

isClient

default boolean isClient()

Returns whether the associated configuration framework is being used within a client application.

Returns:

true if the associated configuration framework is being used within a client application, false if used within a server application

See Also:

ConfigurationFramework.isClient()

initParameters

static ConfigurationFramework.InitParameters initParameters(Path installPath,
                                                            Path instancePath,
                                                            boolean isClient)

Creates initialization parameters for the configuration framework using the provided parameters.

Parameters:

installPath - the installation path to use

instancePath - the instance path to use

isClient - whether the associated configuration framework will be used within a client application.

Returns:

the new initialization parameters

copyInitParameters

static ConfigurationFramework.InitParameters copyInitParameters(ConfigurationFramework configurationFramework)

Copies initialization parameters from the provided configuration framework, suitable for later reinitiaization with ConfigurationFramework.forceInitialize(org.forgerock.opendj.config.ConfigurationFramework.InitParameters).

Parameters:

configurationFramework - the configuration framework to reinitialize

Returns:

the copied initialization parameters