org.opends.server.backends

Class BackupBackend

java.lang.Object

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

org.opends.server.api.LocalBackend<org.forgerock.opendj.server.config.server.BackupBackendCfg>

org.opends.server.backends.BackupBackend

All Implemented Interfaces:

org.forgerock.opendj.config.server.ConfigurationChangeListener<org.forgerock.opendj.server.config.server.BackupBackendCfg>

public class BackupBackend
extends LocalBackend<org.forgerock.opendj.server.config.server.BackupBackendCfg>
implements org.forgerock.opendj.config.server.ConfigurationChangeListener<org.forgerock.opendj.server.config.server.BackupBackendCfg>

This class defines a backend used to present information about Directory Server backups. It will not actually store anything, but upon request will retrieve information about the backups that it knows about. The backups will be arranged in a hierarchy based on the directory that contains them, and it may be possible to dynamically discover new backups if a previously unknown backup directory is included in the base DN.

Nested Class Summary

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

LocalBackend.BackendOperation

Constructor Summary

Constructors

Constructor and Description
BackupBackend() Creates a new backend with the provided information.

Method Summary

Modifier and Type	Method and Description
void	addEntry(Entry entry, AddOperation addOperation) Adds the provided entry to this backend.
org.forgerock.opendj.config.server.ConfigChangeResult	applyConfigurationChange(org.forgerock.opendj.server.config.server.BackupBackendCfg cfg)
void	closeBackend() Performs any necessary work to finally close this backend, particularly closing any underlying databases or connections and deregistering any suffixes that it manages with the Directory Server.
void	configureBackend(org.forgerock.opendj.server.config.server.BackupBackendCfg config, 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(org.forgerock.opendj.ldap.DN entryDN, DeleteOperation deleteOperation) Removes the specified entry from this backend.
void	exportLDIF(LDIFExportConfig exportConfig) Exports the contents of this backend to LDIF.
Set<org.forgerock.opendj.ldap.DN>	getBaseDNs() Retrieves the set of base-level DNs that may be used within this backend.
Entry	getEntry(org.forgerock.opendj.ldap.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.
long	getNumberOfChildren(org.forgerock.opendj.ldap.DN parentDN) Retrieves the number of subordinates immediately below the requested entry.
long	getNumberOfEntriesInBaseDN(org.forgerock.opendj.ldap.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.
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.
org.forgerock.opendj.ldap.ConditionResult	hasSubordinates(org.forgerock.opendj.ldap.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.
boolean	isConfigurationChangeAcceptable(org.forgerock.opendj.server.config.server.BackupBackendCfg cfg, List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)
boolean	isIndexed(org.forgerock.opendj.ldap.schema.AttributeType attributeType, IndexType indexType) Indicates whether search operations which target the specified attribute in the indicated manner would be considered indexed in this backend.
static org.forgerock.opendj.ldap.DN	makeChildDN(org.forgerock.opendj.ldap.DN parentDN, org.forgerock.opendj.ldap.schema.AttributeType rdnAttrType, String rdnStringValue) Create a new child DN from a given parent DN.
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(org.forgerock.opendj.ldap.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(LocalBackend.BackendOperation backendOperation) Indicates whether this backend supports the provided backend operation.

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

entryExists, finalizeBackend, getBackendMonitor, getPersistentSearches, getWritabilityMode, handlesEntry, handlesEntry, isDefaultRoute, isIndexed, isPrivateBackend, rebuildBackend, registerPersistentSearch, setBackendMonitor, setPrivateBackend, setWritabilityMode, supportsControl, verifyBackend

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

getBackendID, isConfigurationAcceptable, setBackendID

Methods inherited from class java.lang.Object

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

Constructor Detail

BackupBackend

public BackupBackend()

Creates a new backend with the provided information. All backend implementations must implement a default constructor that use super() to invoke this constructor.

Method Detail

configureBackend

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

Description copied from class: Backend

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<org.forgerock.opendj.server.config.server.BackupBackendCfg>

Parameters:

config - 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

Description copied from class: LocalBackend

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 LocalBackend<org.forgerock.opendj.server.config.server.BackupBackendCfg>

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)

closeBackend

public void closeBackend()

Description copied from class: LocalBackend

Performs any necessary work to finally close this backend, particularly closing any underlying databases or connections and deregistering any suffixes that it manages with the Directory Server.

It will be called as final step of finalizeBackend(), so subclasses might override it.

Overrides:

closeBackend in class LocalBackend<org.forgerock.opendj.server.config.server.BackupBackendCfg>

getBaseDNs

public Set<org.forgerock.opendj.ldap.DN> getBaseDNs()

Description copied from class: Backend

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

Specified by:

getBaseDNs in class Backend<org.forgerock.opendj.server.config.server.BackupBackendCfg>

Returns:

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

getEntryCount

public long getEntryCount()

Description copied from class: LocalBackend

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

Specified by:

getEntryCount in class LocalBackend<org.forgerock.opendj.server.config.server.BackupBackendCfg>

Returns:

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

isIndexed

public boolean isIndexed(org.forgerock.opendj.ldap.schema.AttributeType attributeType,
                         IndexType indexType)

Description copied from class: LocalBackend

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 LocalBackend<org.forgerock.opendj.server.config.server.BackupBackendCfg>

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(org.forgerock.opendj.ldap.DN entryDN)
                                                          throws DirectoryException

Description copied from class: LocalBackend

Indicates whether the requested entry has any subordinates.

Specified by:

hasSubordinates in class LocalBackend<org.forgerock.opendj.server.config.server.BackupBackendCfg>

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(org.forgerock.opendj.ldap.DN baseDN)
                                throws DirectoryException

Description copied from class: LocalBackend

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 LocalBackend<org.forgerock.opendj.server.config.server.BackupBackendCfg>

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(org.forgerock.opendj.ldap.DN parentDN)
                         throws DirectoryException

Description copied from class: LocalBackend

Retrieves the number of subordinates immediately below the requested entry.

Specified by:

getNumberOfChildren in class LocalBackend<org.forgerock.opendj.server.config.server.BackupBackendCfg>

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(org.forgerock.opendj.ldap.DN entryDN)
               throws DirectoryException

Description copied from class: LocalBackend

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 LocalBackend<org.forgerock.opendj.server.config.server.BackupBackendCfg>

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.

addEntry

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

Description copied from class: LocalBackend

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 LocalBackend<org.forgerock.opendj.server.config.server.BackupBackendCfg>

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(org.forgerock.opendj.ldap.DN entryDN,
                        DeleteOperation deleteOperation)
                 throws DirectoryException

Description copied from class: LocalBackend

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 LocalBackend<org.forgerock.opendj.server.config.server.BackupBackendCfg>

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

Description copied from class: LocalBackend

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 LocalBackend<org.forgerock.opendj.server.config.server.BackupBackendCfg>

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(org.forgerock.opendj.ldap.DN currentDN,
                        Entry entry,
                        ModifyDNOperation modifyDNOperation)
                 throws DirectoryException

Description copied from class: LocalBackend

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 LocalBackend<org.forgerock.opendj.server.config.server.BackupBackendCfg>

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

Description copied from class: LocalBackend

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 LocalBackend<org.forgerock.opendj.server.config.server.BackupBackendCfg>

Parameters:

searchOperation - The search operation to be processed.

Throws:

DirectoryException - If a problem occurs while processing the search.

getSupportedControls

public Set<String> getSupportedControls()

Description copied from class: Backend

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

Specified by:

getSupportedControls in class Backend<org.forgerock.opendj.server.config.server.BackupBackendCfg>

Returns:

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

getSupportedFeatures

public Set<String> getSupportedFeatures()

Description copied from class: Backend

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

Specified by:

getSupportedFeatures in class Backend<org.forgerock.opendj.server.config.server.BackupBackendCfg>

Returns:

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

supports

public boolean supports(LocalBackend.BackendOperation backendOperation)

Description copied from class: LocalBackend

Indicates whether this backend supports the provided backend operation.

Specified by:

supports in class LocalBackend<org.forgerock.opendj.server.config.server.BackupBackendCfg>

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

Description copied from class: LocalBackend

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

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

Specified by:

exportLDIF in class LocalBackend<org.forgerock.opendj.server.config.server.BackupBackendCfg>

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

Description copied from class: LocalBackend

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

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

Specified by:

importLDIF in class LocalBackend<org.forgerock.opendj.server.config.server.BackupBackendCfg>

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

Description copied from class: LocalBackend

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 LocalBackend.supports(BackendOperation) with LocalBackend.BackendOperation.BACKUP returns true.

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

Specified by:

createBackup in class LocalBackend<org.forgerock.opendj.server.config.server.BackupBackendCfg>

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

Description copied from class: LocalBackend

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

Specified by:

removeBackup in class LocalBackend<org.forgerock.opendj.server.config.server.BackupBackendCfg>

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

Description copied from class: LocalBackend

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

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

Specified by:

restoreBackup in class LocalBackend<org.forgerock.opendj.server.config.server.BackupBackendCfg>

Parameters:

restoreConfig - The configuration to use when performing the restore.

Throws:

DirectoryException - If a problem occurs while performing the restore.

isConfigurationChangeAcceptable

public boolean isConfigurationChangeAcceptable(org.forgerock.opendj.server.config.server.BackupBackendCfg cfg,
                                               List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)

Specified by:

isConfigurationChangeAcceptable in interface org.forgerock.opendj.config.server.ConfigurationChangeListener<org.forgerock.opendj.server.config.server.BackupBackendCfg>

applyConfigurationChange

public org.forgerock.opendj.config.server.ConfigChangeResult applyConfigurationChange(org.forgerock.opendj.server.config.server.BackupBackendCfg cfg)

Specified by:

applyConfigurationChange in interface org.forgerock.opendj.config.server.ConfigurationChangeListener<org.forgerock.opendj.server.config.server.BackupBackendCfg>

makeChildDN

public static org.forgerock.opendj.ldap.DN makeChildDN(org.forgerock.opendj.ldap.DN parentDN,
                                                       org.forgerock.opendj.ldap.schema.AttributeType rdnAttrType,
                                                       String rdnStringValue)

Create a new child DN from a given parent DN. The child RDN is formed from a given attribute type and string value.

Parameters:

parentDN - The DN of the parent.

rdnAttrType - The attribute type of the RDN.

rdnStringValue - The string value of the RDN.

Returns:

A new child DN.