org.opends.server.extensions

Class ConfigFileHandler

java.lang.Object

org.opends.server.api.Backend<C>

org.opends.server.api.ConfigHandler<ConfigFileHandlerBackendCfg>

org.opends.server.extensions.ConfigFileHandler

All Implemented Interfaces:

AlertGenerator, Backupable

public class ConfigFileHandler
extends ConfigHandler<ConfigFileHandlerBackendCfg>
implements AlertGenerator, Backupable

This class defines a simple configuration handler for the Directory Server that will read the server configuration from an LDIF file.

Nested Class Summary

Nested classes/interfaces inherited from class org.opends.server.api.Backend

Backend.BackendOperation

Constructor Summary

Constructors

Constructor and Description
ConfigFileHandler() Creates a new instance of this config file handler.

Method Summary

Methods

Modifier and Type	Method and Description
void	addEntry(Entry entry, AddOperation addOperation) Adds the provided entry to this backend.
void	afterRestore(Path restoreDirectory, Path saveDirectory) Called after the restore operation has finished successfully.
Path	beforeRestore() Called before the restore operation begins.
void	configureBackend(ConfigFileHandlerBackendCfg cfg, ServerContext serverContext) Configure this backend based on the information in the provided configuration.
void	createBackup(BackupConfig backupConfig) Creates a backup of the contents of this backend in a form that may be restored at a later date if necessary.
void	deleteEntry(DN entryDN, DeleteOperation deleteOperation) Removes the specified entry from this backend.
boolean	entryExists(DN entryDN) Indicates whether an entry with the specified DN exists in the backend.
void	exportLDIF(LDIFExportConfig exportConfig) Exports the contents of this backend to LDIF.
void	finalizeConfigHandler() Finalizes this configuration handler so that it will release any resources associated with it so that it will no longer be used.
Map<String,String>	getAlerts() Retrieves information about the set of alerts that this generator may produce.
DN[]	getBaseDNs() Retrieves the set of base-level DNs that may be used within this backend.
String	getClassName() Retrieves the fully-qualified name of the Java class for this alert generator implementation.
DN	getComponentEntryDN() Retrieves the DN of the configuration entry with which this alert generator is associated.
ConfigEntry	getConfigEntry(DN entryDN) Retrieves the requested entry from the configuration.
ConfigEntry	getConfigRootEntry() Retrieves the entry that is at the root of the Directory Server configuration.
File	getDirectory() Returns the directory which acts as the root of all files to backup and restore.
Entry	getEntry(DN entryDN) Retrieves the requested entry from this backend.
long	getEntryCount() Retrieves the total number of entries contained in this backend, if that information is available.
ListIterator<Path>	getFilesToBackup() Returns the files to backup.
String	getInstanceRoot() Retrieves the absolute path of the Directory Server instance root.
long	getNumberOfChildren(DN parentDN) Retrieves the number of subordinates immediately below the requested entry.
long	getNumberOfEntriesInBaseDN(DN baseDN) Retrieves the number of entries for the specified base DN including all entries from the requested entry to the lowest level in the tree.
String	getServerRoot() Retrieves the absolute path of the Directory Server install root.
Set<String>	getSupportedControls() Retrieves the OIDs of the controls that may be supported by this backend.
Set<String>	getSupportedFeatures() Retrieves the OIDs of the features that may be supported by this backend.
void	handleConfigChangeResult(org.forgerock.opendj.config.server.ConfigChangeResult result, DN entryDN, String className, String methodName) Examines the provided result and logs a message if appropriate.
org.forgerock.opendj.ldap.ConditionResult	hasSubordinates(DN entryDN) Indicates whether the requested entry has any subordinates.
LDIFImportResult	importLDIF(LDIFImportConfig importConfig, ServerContext serverContext) Imports information from an LDIF file into this backend.
void	initializeConfigHandler(String configFile, boolean checkSchema) Bootstraps this configuration handler using the information in the provided configuration file.
boolean	isDirectRestore() Indicates if restore is done directly in the restore directory.
boolean	isIndexed(AttributeType attributeType, IndexType indexType) Indicates whether search operations which target the specified attribute in the indicated manner would be considered indexed in this backend.
void	openBackend() Opens this backend based on the information provided when the backend was configured.
void	removeBackup(BackupDirectory backupDirectory, String backupID) Removes the specified backup if it is possible to do so.
void	renameEntry(DN currentDN, Entry entry, ModifyDNOperation modifyDNOperation) Moves and/or renames the provided entry in this backend, altering any subordinate entries as necessary.
void	replaceEntry(Entry oldEntry, Entry newEntry, ModifyOperation modifyOperation) Replaces the specified entry with the provided entry in this backend.
void	restoreBackup(RestoreConfig restoreConfig) Restores a backup of the contents of this backend.
void	search(SearchOperation searchOperation) Processes the specified search in this backend.
boolean	supports(Backend.BackendOperation backendOperation) Indicates whether this backend supports the provided backend operation.
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.
void	writeUpdatedConfig() Writes an updated version of the Directory Server configuration to the repository.

Methods inherited from class org.opends.server.api.Backend

addSubordinateBackend, closeBackend, finalizeBackend, getBackendID, getBackendMonitor, getParentBackend, getPersistentSearches, getSubordinateBackends, getWritabilityMode, handlesEntry, handlesEntry, isConfigurationAcceptable, isIndexed, isPrivateBackend, rebuildBackend, registerPersistentSearch, removeSubordinateBackend, setBackendID, setBackendMonitor, setParentBackend, setPrivateBackend, setWritabilityMode, supportsControl, verifyBackend

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigFileHandler

public ConfigFileHandler()

Creates a new instance of this config file handler. No initialization should be performed here, as all of that work should be done in the initializeConfigHandler method.

Method Detail

initializeConfigHandler

public void initializeConfigHandler(String configFile,
                           boolean checkSchema)
                             throws InitializationException

Bootstraps this configuration handler using the information in the provided configuration file. Depending on this configuration handler implementation, the provided file may contain either the entire server configuration or information that is needed to access the configuration in some other location or repository.

Specified by:

initializeConfigHandler in class ConfigHandler<ConfigFileHandlerBackendCfg>

Parameters:

configFile - The path to the file to use to initialize this configuration handler.

checkSchema - Indicates whether to perform schema checking on the configuration data.

Throws:

InitializationException - If a problem occurs while attempting to initialize this configuration handler.

finalizeConfigHandler

public void finalizeConfigHandler()

Finalizes this configuration handler so that it will release any resources associated with it so that it will no longer be used. This will be called when the Directory Server is shutting down, as well as in the startup process once the schema has been read so that the configuration can be re-read using the updated schema.

Specified by:

finalizeConfigHandler in class ConfigHandler<ConfigFileHandlerBackendCfg>

getConfigRootEntry

public ConfigEntry getConfigRootEntry()
                               throws org.forgerock.opendj.config.server.ConfigException

Retrieves the entry that is at the root of the Directory Server configuration.

Specified by:

getConfigRootEntry in class ConfigHandler<ConfigFileHandlerBackendCfg>

Returns:

The entry that is at the root of the Directory Server configuration.

Throws:

org.forgerock.opendj.config.server.ConfigException - If a problem occurs while interacting with the configuration.

getConfigEntry

public ConfigEntry getConfigEntry(DN entryDN)
                           throws org.forgerock.opendj.config.server.ConfigException

Retrieves the requested entry from the configuration.

Specified by:

getConfigEntry in class ConfigHandler<ConfigFileHandlerBackendCfg>

Parameters:

entryDN - The distinguished name of the configuration entry to retrieve.

Returns:

The requested configuration entry.

Throws:

org.forgerock.opendj.config.server.ConfigException - If a problem occurs while interacting with the configuration.

getServerRoot

public String getServerRoot()

Retrieves the absolute path of the Directory Server install root.

Specified by:

getServerRoot in class ConfigHandler<ConfigFileHandlerBackendCfg>

Returns:

The absolute path of the Directory Server install root.

getInstanceRoot

public String getInstanceRoot()

Retrieves the absolute path of the Directory Server instance root.

Specified by:

getInstanceRoot in class ConfigHandler<ConfigFileHandlerBackendCfg>

Returns:

The absolute path of the Directory Server instance root.

configureBackend

public void configureBackend(ConfigFileHandlerBackendCfg cfg,
                    ServerContext serverContext)
                      throws org.forgerock.opendj.config.server.ConfigException

Configure this backend based on the information in the provided configuration. When the method returns, the backend will have been configured (ready to be opened) but still unable to process operations.

Specified by:

configureBackend in class Backend<ConfigFileHandlerBackendCfg>

Parameters:

cfg - The configuration of this backend.

serverContext - The server context for this instance

Throws:

org.forgerock.opendj.config.server.ConfigException - If there is an error in the configuration.

openBackend

public void openBackend()
                 throws org.forgerock.opendj.config.server.ConfigException,
                        InitializationException

Opens this backend based on the information provided when the backend was configured. It also should open any underlying storage and register all suffixes with the server.

Specified by:

openBackend in class Backend<ConfigFileHandlerBackendCfg>

Throws:

org.forgerock.opendj.config.server.ConfigException - If an unrecoverable problem arises while opening the backend.

InitializationException - If a problem occurs during opening that is not related to the server configuration.

See Also:

Backend.configureBackend(C, org.opends.server.core.ServerContext)

getBaseDNs

public DN[] getBaseDNs()

Retrieves the set of base-level DNs that may be used within this backend.

Specified by:

getBaseDNs in class Backend<ConfigFileHandlerBackendCfg>

Returns:

The set of base-level DNs that may be used within this backend.

getEntryCount

public long getEntryCount()

Retrieves the total number of entries contained in this backend, if that information is available.

Specified by:

getEntryCount in class Backend<ConfigFileHandlerBackendCfg>

Returns:

The total number of entries contained in this backend, or -1 if that information is not available.

isIndexed

public boolean isIndexed(AttributeType attributeType,
                IndexType indexType)

Indicates whether search operations which target the specified attribute in the indicated manner would be considered indexed in this backend. The operation should be considered indexed only if the specified operation can be completed efficiently within the backend.

Note that this method should return a general result that covers all values of the specified attribute. If a the specified attribute is indexed in the indicated manner but some particular values may still be treated as unindexed (e.g., if the number of entries with that attribute value exceeds some threshold), then this method should still return true for the specified attribute and index type.

Specified by:

isIndexed in class Backend<ConfigFileHandlerBackendCfg>

Parameters:

attributeType - The attribute type for which to make the determination.

indexType - The index type for which to make the determination.

Returns:

true if search operations targeting the specified attribute in the indicated manner should be considered indexed, or false if not.

hasSubordinates

public org.forgerock.opendj.ldap.ConditionResult hasSubordinates(DN entryDN)
                                                          throws DirectoryException

Indicates whether the requested entry has any subordinates.

Specified by:

hasSubordinates in class Backend<ConfigFileHandlerBackendCfg>

Parameters:

entryDN - The distinguished name of the entry.

Returns:

ConditionResult.TRUE if the entry has one or more subordinates or ConditionResult.FALSE otherwise or ConditionResult.UNDEFINED if it can not be determined.

Throws:

DirectoryException - If a problem occurs while trying to retrieve the entry.

getNumberOfEntriesInBaseDN

public long getNumberOfEntriesInBaseDN(DN baseDN)
                                throws DirectoryException

Retrieves the number of entries for the specified base DN including all entries from the requested entry to the lowest level in the tree.

Specified by:

getNumberOfEntriesInBaseDN in class Backend<ConfigFileHandlerBackendCfg>

Parameters:

baseDN - The base distinguished name.

Returns:

The number of subordinate entries including the base dn.

Throws:

DirectoryException - If baseDN isn't a base dn managed by this backend or if a problem occurs while trying to retrieve the entry.

getNumberOfChildren

public long getNumberOfChildren(DN parentDN)
                         throws DirectoryException

Retrieves the number of subordinates immediately below the requested entry.

Specified by:

getNumberOfChildren in class Backend<ConfigFileHandlerBackendCfg>

Parameters:

parentDN - The distinguished name of the parent.

Returns:

The number of subordinate entries for the requested entry.

Throws:

DirectoryException - If baseDN isn't a base dn managed by this backend or if a problem occurs while trying to retrieve the entry.

getEntry

public Entry getEntry(DN entryDN)
               throws DirectoryException

Retrieves the requested entry from this backend. The caller is not required to hold any locks on the specified DN.

Specified by:

getEntry in class Backend<ConfigFileHandlerBackendCfg>

Parameters:

entryDN - The distinguished name of the entry to retrieve.

Returns:

The requested entry, or null if the entry does not exist.

Throws:

DirectoryException - If a problem occurs while trying to retrieve the entry.

entryExists

public boolean entryExists(DN entryDN)
                    throws DirectoryException

Indicates whether an entry with the specified DN exists in the backend. The default implementation calls getEntry, but backend implementations may override this with a more efficient version. The caller is not required to hold any locks on the specified DN.

Overrides:

entryExists in class Backend<ConfigFileHandlerBackendCfg>

Parameters:

entryDN - The DN of the entry for which to determine existence.

Returns:

true if the specified entry exists in this backend, or false if it does not.

Throws:

DirectoryException - If a problem occurs while trying to make the determination.

addEntry

public void addEntry(Entry entry,
            AddOperation addOperation)
              throws DirectoryException

Adds the provided entry to this backend. This method must ensure that the entry is appropriate for the backend and that no entry already exists with the same DN. The caller must hold a write lock on the DN of the provided entry.

Specified by:

addEntry in class Backend<ConfigFileHandlerBackendCfg>

Parameters:

entry - The entry to add to this backend.

addOperation - The add operation with which the new entry is associated. This may be null for adds performed internally.

Throws:

DirectoryException - If a problem occurs while trying to add the entry.

deleteEntry

public void deleteEntry(DN entryDN,
               DeleteOperation deleteOperation)
                 throws DirectoryException

Removes the specified entry from this backend. This method must ensure that the entry exists and that it does not have any subordinate entries (unless the backend supports a subtree delete operation and the client included the appropriate information in the request). The caller must hold a write lock on the provided entry DN.

Specified by:

deleteEntry in class Backend<ConfigFileHandlerBackendCfg>

Parameters:

entryDN - The DN of the entry to remove from this backend.

deleteOperation - The delete operation with which this action is associated. This may be null for deletes performed internally.

Throws:

DirectoryException - If a problem occurs while trying to remove the entry.

replaceEntry

public void replaceEntry(Entry oldEntry,
                Entry newEntry,
                ModifyOperation modifyOperation)
                  throws DirectoryException

Replaces the specified entry with the provided entry in this backend. The backend must ensure that an entry already exists with the same DN as the provided entry. The caller must hold a write lock on the DN of the provided entry.

Specified by:

replaceEntry in class Backend<ConfigFileHandlerBackendCfg>

Parameters:

oldEntry - The original entry that is being replaced.

newEntry - The new entry to use in place of the existing entry with the same DN.

modifyOperation - The modify operation with which this action is associated. This may be null for modifications performed internally.

Throws:

DirectoryException - If a problem occurs while trying to replace the entry.

renameEntry

public void renameEntry(DN currentDN,
               Entry entry,
               ModifyDNOperation modifyDNOperation)
                 throws DirectoryException

Moves and/or renames the provided entry in this backend, altering any subordinate entries as necessary. This must ensure that an entry already exists with the provided current DN, and that no entry exists with the target DN of the provided entry. The caller must hold write locks on both the current DN and the new DN for the entry.

Specified by:

renameEntry in class Backend<ConfigFileHandlerBackendCfg>

Parameters:

currentDN - The current DN of the entry to be moved/renamed.

entry - The new content to use for the entry.

modifyDNOperation - The modify DN operation with which this action is associated. This may be null for modify DN operations performed internally.

Throws:

DirectoryException - If a problem occurs while trying to perform the rename.

search

public void search(SearchOperation searchOperation)
            throws DirectoryException

Processes the specified search in this backend. Matching entries should be provided back to the core server using the SearchOperation.returnEntry method. The caller is not required to have any locks when calling this operation.

Specified by:

search in class Backend<ConfigFileHandlerBackendCfg>

Parameters:

searchOperation - The search operation to be processed.

Throws:

DirectoryException - If a problem occurs while processing the search.

writeUpdatedConfig

public void writeUpdatedConfig()
                        throws DirectoryException

Writes an updated version of the Directory Server configuration to the repository. This should ensure that the stored configuration matches the pending configuration.

Specified by:

writeUpdatedConfig in class ConfigHandler<ConfigFileHandlerBackendCfg>

Throws:

DirectoryException - If a problem is encountered while writing the updated configuration.

writeSuccessfulStartupConfig

public 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. Note that this may not be possible with some kinds of configuration repositories, so it should be a best effort attempt.

This method should only be called by the Directory Server itself when the server has started successfully. It should not be invoked by any other component at any other time.

Specified by:

writeSuccessfulStartupConfig in class ConfigHandler<ConfigFileHandlerBackendCfg>

getSupportedControls

public Set<String> getSupportedControls()

Retrieves the OIDs of the controls that may be supported by this backend.

Specified by:

getSupportedControls in class Backend<ConfigFileHandlerBackendCfg>

Returns:

The OIDs of the controls that may be supported by this backend.

getSupportedFeatures

public Set<String> getSupportedFeatures()

Retrieves the OIDs of the features that may be supported by this backend.

Specified by:

getSupportedFeatures in class Backend<ConfigFileHandlerBackendCfg>

Returns:

The OIDs of the features that may be supported by this backend.

supports

public boolean supports(Backend.BackendOperation backendOperation)

Indicates whether this backend supports the provided backend operation.

Specified by:

supports in class Backend<ConfigFileHandlerBackendCfg>

Parameters:

backendOperation - the backend operation

Returns:

true if this backend supports the provided backend operation, false otherwise.

exportLDIF

public void exportLDIF(LDIFExportConfig exportConfig)
                throws DirectoryException

Exports the contents of this backend to LDIF. This method should only be called if Backend.supports(BackendOperation) with Backend.BackendOperation.LDIF_EXPORT returns true.

Note that the server will not explicitly initialize this backend before calling this method.

Specified by:

exportLDIF in class Backend<ConfigFileHandlerBackendCfg>

Parameters:

exportConfig - The configuration to use when performing the export.

Throws:

DirectoryException - If a problem occurs while performing the LDIF export.

importLDIF

public LDIFImportResult importLDIF(LDIFImportConfig importConfig,
                          ServerContext serverContext)
                            throws DirectoryException

Imports information from an LDIF file into this backend. This method should only be called if Backend.supports(BackendOperation) with Backend.BackendOperation.LDIF_IMPORT returns true.

Note that the server will not explicitly initialize this backend before calling this method.

Specified by:

importLDIF in class Backend<ConfigFileHandlerBackendCfg>

Parameters:

importConfig - The configuration to use when performing the import.

serverContext - The server context

Returns:

Information about the result of the import processing.

Throws:

DirectoryException - If a problem occurs while performing the LDIF import.

createBackup

public void createBackup(BackupConfig backupConfig)
                  throws DirectoryException

Creates a backup of the contents of this backend in a form that may be restored at a later date if necessary. This method should only be called if Backend.supports(BackendOperation) with Backend.BackendOperation.BACKUP returns true.

Note that the server will not explicitly initialize this backend before calling this method.

Specified by:

createBackup in class Backend<ConfigFileHandlerBackendCfg>

Parameters:

backupConfig - The configuration to use when performing the backup.

Throws:

DirectoryException - If a problem occurs while performing the backup.

removeBackup

public void removeBackup(BackupDirectory backupDirectory,
                String backupID)
                  throws DirectoryException

Removes the specified backup if it is possible to do so.

Specified by:

removeBackup in class Backend<ConfigFileHandlerBackendCfg>

Parameters:

backupDirectory - The backup directory structure with which the specified backup is associated.

backupID - The backup ID for the backup to be removed.

Throws:

DirectoryException - If it is not possible to remove the specified backup for some reason (e.g., no such backup exists or there are other backups that are dependent upon it).

restoreBackup

public void restoreBackup(RestoreConfig restoreConfig)
                   throws DirectoryException

Restores a backup of the contents of this backend. This method should only be called if Backend.supports(BackendOperation) with Backend.BackendOperation.RESTORE returns true.

Note that the server will not explicitly initialize this backend before calling this method.

Specified by:

restoreBackup in class Backend<ConfigFileHandlerBackendCfg>

Parameters:

restoreConfig - The configuration to use when performing the restore.

Throws:

DirectoryException - If a problem occurs while performing the restore.

getComponentEntryDN

public DN getComponentEntryDN()

Retrieves the DN of the configuration entry with which this alert generator is associated.

Specified by:

getComponentEntryDN in interface AlertGenerator

Returns:

The DN of the configuration entry with which this alert generator is associated.

getClassName

public String getClassName()

Retrieves the fully-qualified name of the Java class for this alert generator implementation.

Specified by:

getClassName in interface AlertGenerator

Returns:

The fully-qualified name of the Java class for this alert generator implementation.

getAlerts

public Map<String,String> getAlerts()

Retrieves information about the set of alerts that this generator may produce. The map returned should be between the notification type for a particular notification and the human-readable description for that notification. This alert generator must not generate any alerts with types that are not contained in this list.

Specified by:

getAlerts in interface AlertGenerator

Returns:

Information about the set of alerts that this generator may produce.

handleConfigChangeResult

public void handleConfigChangeResult(org.forgerock.opendj.config.server.ConfigChangeResult result,
                            DN entryDN,
                            String className,
                            String methodName)

Examines the provided result and logs a message if appropriate. If the result code is anything other than SUCCESS, then it will log an error message. If the operation was successful but admin action is required, then it will log a warning message. If no action is required but messages were generated, then it will log an informational message.

Parameters:

result - The config change result object that

entryDN - The DN of the entry that was added, deleted, or modified.

className - The name of the class for the object that generated the provided result.

methodName - The name of the method that generated the provided result.

getDirectory

public File getDirectory()

Returns the directory which acts as the root of all files to backup and restore.

Specified by:

getDirectory in interface Backupable

Returns:

the root directory

getFilesToBackup

public ListIterator<Path> getFilesToBackup()

Returns the files to backup.

Specified by:

getFilesToBackup in interface Backupable

Returns:

an iterator of files to backup, which may be empty but never null

isDirectRestore

public boolean isDirectRestore()

Indicates if restore is done directly in the restore directory.

Specified by:

isDirectRestore in interface Backupable

Returns:

true if restore is done directly in the restore directory provided by getDirectory() method, or false if restore is done in a temporary directory.

beforeRestore

public Path beforeRestore()
                   throws DirectoryException

Called before the restore operation begins.

In case of direct restore, the backupable entity should take any action to save a copy of existing data before restore operation. Saving includes removing the existing data and copying it in a save directory.

Specified by:

beforeRestore in interface Backupable

Returns:

the directory where current files are saved. It may be null if not applicable.

Throws:

DirectoryException - If an error occurs.

afterRestore

public void afterRestore(Path restoreDirectory,
                Path saveDirectory)
                  throws DirectoryException

Called after the restore operation has finished successfully.

For direct restore, the backupable entity can safely discard the saved copy. For indirect restore, the backupable entity should switch the restored directory to the final restore directory.

Specified by:

afterRestore in interface Backupable

Parameters:

restoreDirectory - The directory in which files have actually been restored. It is never null.

saveDirectory - The directory in which current files have been saved. It may be null if beforeRestore() returned null.

Throws:

DirectoryException - If an error occurs.