|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.types.DirectoryEnvironmentConfig
@PublicAPI(stability=VOLATILE, mayInstantiate=true, mayExtend=false, mayInvoke=true) public final class DirectoryEnvironmentConfig
This class provides a set of properties that may control various aspects of the server environment. Note that these properties may only be altered before the Directory Server is started. Any attempt to change an environment configuration property while the server is running will be rejected.
Constructor Summary | |
---|---|
DirectoryEnvironmentConfig()
Creates a new directory environment configuration initialized from the system properties defined in the JVM. |
|
DirectoryEnvironmentConfig(java.util.Map<java.lang.String,java.lang.String> properties)
Creates a new directory environment configuration initialized with a copy of the provided set of properties. |
|
DirectoryEnvironmentConfig(java.util.Properties properties)
Creates a new directory environment configuration initialized with a copy of the provided set of properties. |
Method Summary | |
---|---|
boolean |
disableConnectionHandlers()
Indicates whether the Directory Server startup process should skip the connection handler creation and initialization phases. |
boolean |
disableExec()
Indicates whether the Directory Server should be allowed to use the Runtime.exec() method to be able to launch external
commands on the underlying system. |
boolean |
forceDaemonThreads()
Indicates whether all threads created by the Directory Server should be created as daemon threads. |
java.lang.Class |
getConfigClass()
Retrieves the class that provides the Directory Server configuration handler implementation. |
java.io.File |
getConfigFile()
Retrieves the configuration file that should be used to initialize the Directory Server config handler. |
java.io.File |
getLockDirectory()
Retrieves the directory that should be used to hold the server lock files. |
int |
getLockManagerConcurrencyLevel()
Retrieves the concurrency level for the Directory Server lock table. |
boolean |
getLockManagerFairOrdering()
Retrieves whether a fair ordering should be used for the lock manager. |
int |
getLockManagerTableSize()
Retrieves the initial table size for the server lock table. |
int |
getMaxConfigArchiveSize()
Retrieves the maximum number of archived configurations that the Directory Server should maintain. |
java.lang.String |
getProperty(java.lang.String name)
Retrieves the property with the specified name. |
java.io.File |
getSchemaDirectory()
Retrieves the directory that contains the server schema configuration files. |
java.io.File |
getServerRoot()
Retrieves the directory that should be considered the server root. |
boolean |
maintainConfigArchive()
Indicates whether the Directory Server should maintain an archive of previous configurations. |
java.lang.Class |
setConfigClass(java.lang.Class configClass)
Specifies the class that provides the Directory Server configuration handler implementation. |
java.io.File |
setConfigFile(java.io.File configFile)
Specifies the configuration file that should be used to initialize the Directory Server config handler. |
boolean |
setDisableConnectionHandlers(boolean disableConnectionHandlers)
Specifies whether the Directory Server startup process should skip the connection handler creation and initialization phases. |
boolean |
setDisableExec(boolean disableExec)
Specifies whether the Directory Server should be allowed to use the Runtime.exec() method to be able to launch external
commands on the underlying system. |
boolean |
setForceDaemonThreads(boolean forceDaemonThreads)
Specifies whether all threads created by the Directory Server should be created as daemon threads. |
java.io.File |
setLockDirectory(java.io.File lockDirectory)
Specifies the directory that should be used to hold the server lock files. |
int |
setLockManagerConcurrencyLevel(int concurrencyLevel)
Specifies the concurrency level for the Directory Server lock table. |
boolean |
setLockManagerFairOrdering(boolean fairOrdering)
Specifies whether a fair ordering should be used for the lock manager. |
int |
setLockManagerTableSize(int lockTableSize)
Specifies the initial table size for the server lock table. |
boolean |
setMaintainConfigArchive(boolean maintainConfigArchive)
Specifies whether the Directory Server should maintain an archive of previous configurations. |
int |
setMaxConfigArchiveSize(int maxConfigArchiveSize)
Specifies the maximum number of archived configurations that the Directory Server should maintain. |
java.lang.String |
setProperty(java.lang.String name,
java.lang.String value)
Specifies a property with the given name and value. |
java.io.File |
setSchemaDirectory(java.io.File schemaDirectory)
Specifies the directory that should contain the server schema configuration files. |
java.io.File |
setServerRoot(java.io.File serverRoot)
Specifies the directory that should be considered the server root. |
boolean |
setUseLastKnownGoodConfiguration(boolean useLastKnownGoodConfiguration)
Specifies whether the Directory Server should attempt to start using the last known good configuration rather than the current active configuration. |
boolean |
useLastKnownGoodConfiguration()
Indicates whether the Directory Server should attempt to start with the "last known good" configuration rather than the current active configuration file. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DirectoryEnvironmentConfig()
public DirectoryEnvironmentConfig(java.util.Properties properties)
properties
- The properties to use when initializing this
environment configuration, or null
to use an empty set of properties.public DirectoryEnvironmentConfig(java.util.Map<java.lang.String,java.lang.String> properties)
properties
- The properties to use when initializing this
environment configuration, or null
to use an empty set of properties.Method Detail |
---|
public java.lang.String getProperty(java.lang.String name)
name
- The name of the property to retrieve.
null
if
no such property is defined.public java.lang.String setProperty(java.lang.String name, java.lang.String value) throws InitializationException
null
.
name
- The name of the property to set.value
- The value of the property to set, or null
if the property is to be removed.
null
if it was not previously set.
InitializationException
- If the Directory Server is
already running.public java.io.File getServerRoot()
null
if it is not defined.public java.io.File setServerRoot(java.io.File serverRoot) throws InitializationException
serverRoot
- The directory that should be considered the
server root.
null
if there was
none.
InitializationException
- If the Directory Server is
already running or there is a
problem with the provided
server root.public java.io.File getConfigFile()
null
if
no configuration file is defined.public java.io.File setConfigFile(java.io.File configFile) throws InitializationException
configFile
- The configuration file that should be used to
initialize the Directory Server config
handler.
null
if none was defined.
InitializationException
- If the Directory Server is
already running or there is a
problem with the provided
configuration file.public java.lang.Class getConfigClass()
public java.lang.Class setConfigClass(java.lang.Class configClass) throws InitializationException
configClass
- The class that proviedes the Directory
Server configuration handler implementation.
null
if none was defined.
InitializationException
- If the Directory Server is
already running or there is a
problem with the provided
config handler class.public boolean useLastKnownGoodConfiguration()
false
will be returned.
true
if the Directory Server should attempt to
start using the "last known good" configuration, or
false
if it should try to start using the
active configuration.public boolean setUseLastKnownGoodConfiguration(boolean useLastKnownGoodConfiguration) throws InitializationException
useLastKnownGoodConfiguration
- Indicates whether the
Directory Server should
attempt to start using the
last known good
configuration.
false
will
be returned.
InitializationException
- If the Directory Server is
already running.public boolean maintainConfigArchive()
true
will be returned.
true
if the Directory Server should maintain an
archive of previous configurations, or false
if
not.public boolean setMaintainConfigArchive(boolean maintainConfigArchive) throws InitializationException
maintainConfigArchive
- Indicates whether the Directory
Server should maintain an archive
of previous configurations.
true
will
be returned.
InitializationException
- If the Directory Server is
already running.public int getMaxConfigArchiveSize()
public int setMaxConfigArchiveSize(int maxConfigArchiveSize) throws InitializationException
maxConfigArchiveSize
- The maximum number of archived
configurations that the Directory
Server should maintain.
InitializationException
- If the Directory Server is
already running.public java.io.File getSchemaDirectory()
null
if none is defined.public java.io.File setSchemaDirectory(java.io.File schemaDirectory) throws InitializationException
schemaDirectory
- The directory that should contain the
server schema configuration files.
null
if none was defined.
InitializationException
- If the Directory Server is
already running or there is a
problem with the provided
schema directory.public java.io.File getLockDirectory()
null
if it cannot be determined.public java.io.File setLockDirectory(java.io.File lockDirectory) throws InitializationException
lockDirectory
- The directory that should be used to hold
the server lock files.
null
if none was defined.
InitializationException
- If the Directory Server is
already running or there is a
problem with the provided lock
directory.public boolean disableConnectionHandlers()
true
if the Directory Server should not start
its connection handlers, or false
if the
connection handlers should be enabled.public boolean setDisableConnectionHandlers(boolean disableConnectionHandlers) throws InitializationException
disableConnectionHandlers
- Indicates whether the
Directory Server should skip
the connection handler
creation and initialization
phases.
false
will
be returned.
InitializationException
- If the Directory Server is
already running.public boolean forceDaemonThreads()
true
if all threads created by the Directory
Server should be created as daemon threads, or
false
if not.public boolean setForceDaemonThreads(boolean forceDaemonThreads) throws InitializationException
forceDaemonThreads
- Indicates whether all threads created
by the Directory Server should be
created as daemon threads.
false
will
be returned.
InitializationException
- If the Directory Server is
already running.public boolean disableExec()
Runtime.exec()
method to be able to launch external
commands on the underlying system.
true
if the Directory Server should be allowed
to use Runtime.exec()
, or false
if not.public boolean setDisableExec(boolean disableExec) throws InitializationException
Runtime.exec()
method to be able to launch external
commands on the underlying system.
disableExec
- Indicates whether the Directory Server
should be allowed to launch external
commands on the underlying system.
false
will
be returned.
InitializationException
- If the Directory Server is
already running.public int getLockManagerConcurrencyLevel()
public int setLockManagerConcurrencyLevel(int concurrencyLevel) throws InitializationException
concurrencyLevel
- The concurrency level for the Directory
Server lock manager.
InitializationException
- If the Directory Server is
already running or there is a
problem with the provided
concurrency level value.public boolean getLockManagerFairOrdering()
public boolean setLockManagerFairOrdering(boolean fairOrdering) throws InitializationException
fairOrdering
- true
if fair ordering should be
used, or false
if not.
InitializationException
- If the Directory Server is
already running.public int getLockManagerTableSize()
public int setLockManagerTableSize(int lockTableSize) throws InitializationException
lockTableSize
- The initial table size for the server lock
table.
InitializationException
- If the Directory Server is
already running or there is a
problem with the provided
initial table size.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |