|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.api.Backend
org.opends.server.api.ConfigHandler
@PublicAPI(stability=VOLATILE, mayInstantiate=false, mayExtend=true, mayInvoke=true) public abstract class ConfigHandler
This class defines the set of methods and structures that must be implemented by a Directory Server configuration handler.
Constructor Summary | |
---|---|
ConfigHandler()
|
Method Summary | |
---|---|
abstract void |
finalizeConfigHandler()
Finalizes this configuration handler so that it will release any resources associated with it so that it will no longer be used. |
abstract ConfigEntry |
getConfigEntry(DN entryDN)
Retrieves the requested entry from the configuration. |
abstract ConfigEntry |
getConfigRootEntry()
Retrieves the entry that is at the root of the Directory Server configuration. |
abstract java.lang.String |
getServerRoot()
Retrieves the absolute path of the Directory Server instance root. |
abstract void |
initializeConfigHandler(java.lang.String configFile,
boolean checkSchema)
Bootstraps this configuration handler using the information in the provided configuration file. |
abstract void |
writeSuccessfulStartupConfig()
Indicates that the Directory Server has started successfully and that the configuration handler should save a copy of the current configuration for use as a "last known good" reference. |
abstract void |
writeUpdatedConfig()
Writes an updated version of the Directory Server configuration to the repository. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ConfigHandler()
Method Detail |
---|
public abstract void initializeConfigHandler(java.lang.String configFile, boolean checkSchema) throws InitializationException
configFile
- The path to the file to use to initialize
this configuration handler.checkSchema
- Indicates whether to perform schema checking
on the configuration data.
InitializationException
- If a problem occurs while
attempting to initialize this
configuration handler.public abstract void finalizeConfigHandler()
public abstract ConfigEntry getConfigRootEntry() throws ConfigException
ConfigException
- If a problem occurs while interacting
with the configuration.public abstract ConfigEntry getConfigEntry(DN entryDN) throws ConfigException
entryDN
- The distinguished name of the configuration
entry to retrieve.
ConfigException
- If a problem occurs while interacting
with the configuration.public abstract java.lang.String getServerRoot()
public abstract void writeUpdatedConfig() throws DirectoryException
DirectoryException
- If a problem is encountered while
writing the updated configuration.@PublicAPI(stability=VOLATILE, mayInstantiate=false, mayExtend=true, mayInvoke=false) public abstract void writeSuccessfulStartupConfig()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |