public class ConfigurationBackend extends LocalBackend<ConfigurationBackend.ConfigurationBackendCfg> implements Backupable
Modifier and Type | Class and Description |
---|---|
class |
ConfigurationBackend.ConfigurationBackendCfg
Dummy
BackendCfg implementation for the ConfigurationBackend . |
LocalBackend.BackendOperation
Modifier and Type | Field and Description |
---|---|
static String |
CONFIG_BACKEND_ID
The backend ID for the configuration backend.
|
Constructor and Description |
---|
ConfigurationBackend(ServerContext serverContext)
Creates and initializes a new instance of this backend.
|
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 |
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(ConfigurationBackend.ConfigurationBackendCfg 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.
|
ConfigurationBackend.ConfigurationBackendCfg |
getBackendCfg()
Returns a new
ConfigurationBackend.ConfigurationBackendCfg for this ConfigurationBackend . |
Set<Dn> |
getBaseDNs()
Retrieves the set of base-level DNs that may be used within this backend.
|
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.
|
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.
|
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.
|
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.
|
boolean |
isPublicBackend()
Indicates whether the base DNs of this backend should be considered public or private.
|
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(LocalBackend.BackendOperation backendOperation)
Indicates whether this backend supports the provided backend operation.
|
deregisterBackendMonitor, finalizeBackend, getLocalBackendMonitor, getPersistentSearches, getWritabilityMode, handle, handlesEntry, handlesEntry, isIndexed, rebuildBackend, registerBackendMonitor, registerPersistentSearch, setWritabilityMode, supportsControl, verifyBackend
getBackendID, getHealthStatus, getSupportedControls, getSupportedFeatures, isConfigurationAcceptable, setBackendID, toString
public static final String CONFIG_BACKEND_ID
Try to avoid potential conflict with user backend identifiers.
public ConfigurationBackend(ServerContext serverContext)
serverContext
- The server context.public ConfigurationBackend.ConfigurationBackendCfg getBackendCfg()
ConfigurationBackend.ConfigurationBackendCfg
for this ConfigurationBackend
.ConfigurationBackend.ConfigurationBackendCfg
for this ConfigurationBackend
public void closeBackend()
LocalBackend
It will be called as final step of finalizeBackend()
, so subclasses might override it.
closeBackend
in class LocalBackend<ConfigurationBackend.ConfigurationBackendCfg>
public void configureBackend(ConfigurationBackend.ConfigurationBackendCfg cfg, ServerContext serverContext)
Backend
configureBackend
in class Backend<ConfigurationBackend.ConfigurationBackendCfg>
cfg
- The configuration of this backend.serverContext
- The server context for this instancepublic void openBackend() throws InitializationException
LocalBackend
openBackend
in class LocalBackend<ConfigurationBackend.ConfigurationBackendCfg>
InitializationException
- If a problem occurs during opening that is not related to the server configuration.Backend.configureBackend(C, org.opends.server.core.ServerContext)
public boolean isPublicBackend()
Backend
This method also controls the visibility of the associated naming contexts. i.e. if any base DN of this backend is a naming context, then it will be public or private, based on the value returned by this method.
Reminder: Public naming contexts are returned when querying the root DSE entry.
isPublicBackend
in class Backend<ConfigurationBackend.ConfigurationBackendCfg>
true
if this backend's baseDNs could be exposed as a public naming context, false
if they
must remain private naming contexts.public Set<Dn> getBaseDNs()
Backend
getBaseDNs
in class Backend<ConfigurationBackend.ConfigurationBackendCfg>
public Entry getEntry(Dn entryDN)
LocalBackend
getEntry
in class LocalBackend<ConfigurationBackend.ConfigurationBackendCfg>
entryDN
- The distinguished name of the entry to retrieve.null
if the entry does not exist.public long getEntryCount()
LocalBackend
getEntryCount
in class LocalBackend<ConfigurationBackend.ConfigurationBackendCfg>
public File getDirectory()
Backupable
getDirectory
in interface Backupable
public long getNumberOfChildren(Dn parentDN) throws LdapException
LocalBackend
getNumberOfChildren
in class LocalBackend<ConfigurationBackend.ConfigurationBackendCfg>
parentDN
- The distinguished name of the parent.LdapException
- If baseDN isn't a base dn managed by this backend or if a problem occurs while trying to retrieve the
entry.public long getNumberOfEntriesInBaseDN(Dn baseDN) throws LdapException
LocalBackend
getNumberOfEntriesInBaseDN
in class LocalBackend<ConfigurationBackend.ConfigurationBackendCfg>
baseDN
- The base distinguished name.LdapException
- If baseDN isn't a base dn managed by this backend or if a problem occurs while trying to retrieve the
entry.public ConditionResult hasSubordinates(Dn entryDN) throws LdapException
LocalBackend
hasSubordinates
in class LocalBackend<ConfigurationBackend.ConfigurationBackendCfg>
entryDN
- The distinguished name of the entry.ConditionResult.TRUE
if the entry has one or more subordinates or ConditionResult.FALSE
otherwise or ConditionResult.UNDEFINED
if it can not be determined.LdapException
- If a problem occurs while trying to retrieve the entry.public boolean isIndexed(AttributeType attributeType, IndexType indexType)
LocalBackend
true
for the specified attribute and index type.isIndexed
in class LocalBackend<ConfigurationBackend.ConfigurationBackendCfg>
attributeType
- The attribute type for which to make the determination.indexType
- The index type for which to make the determination.true
if search operations targeting the specified attribute in the indicated manner should be
considered indexed, or false
if not.public boolean entryExists(Dn entryDN)
LocalBackend
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.entryExists
in class LocalBackend<ConfigurationBackend.ConfigurationBackendCfg>
entryDN
- The DN of the entry for which to determine existence.true
if the specified entry exists in this backend, or false
if it does not.public boolean supports(LocalBackend.BackendOperation backendOperation)
LocalBackend
supports
in class LocalBackend<ConfigurationBackend.ConfigurationBackendCfg>
backendOperation
- the backend operationtrue
if this backend supports the provided backend operation, false
otherwise.public void search(SearchOperation searchOperation) throws LdapException
LocalBackend
SearchOperation.returnEntry
method. The caller is not required to have any locks when calling this
operation.search
in class LocalBackend<ConfigurationBackend.ConfigurationBackendCfg>
searchOperation
- The search operation to be processed.LdapException
- If a problem occurs while processing the search.CancelledResultException
- If this backend noticed and reacted to a request to cancel or abandon the search operation.public void addEntry(Entry entry, AddOperation addOperation) throws LdapException
LocalBackend
addEntry
in class LocalBackend<ConfigurationBackend.ConfigurationBackendCfg>
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.LdapException
- If a problem occurs while trying to add the entry.CancelledResultException
- If this backend noticed and reacted to a request to cancel or abandon the add operation.public void deleteEntry(Dn entryDN, DeleteOperation deleteOperation) throws LdapException
LocalBackend
deleteEntry
in class LocalBackend<ConfigurationBackend.ConfigurationBackendCfg>
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.LdapException
- If a problem occurs while trying to remove the entry.CancelledResultException
- If this backend noticed and reacted to a request to cancel or abandon the delete operation.public void replaceEntry(Entry oldEntry, Entry newEntry, ModifyOperation modifyOperation) throws LdapException
LocalBackend
replaceEntry
in class LocalBackend<ConfigurationBackend.ConfigurationBackendCfg>
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.LdapException
- If a problem occurs while trying to replace the entry.CancelledResultException
- If this backend noticed and reacted to a request to cancel or abandon the modify operation.public void renameEntry(Dn currentDN, Entry entry, ModifyDnOperation modifyDNOperation) throws LdapException
LocalBackend
renameEntry
in class LocalBackend<ConfigurationBackend.ConfigurationBackendCfg>
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.LdapException
- If a problem occurs while trying to perform the rename.CancelledResultException
- If this backend noticed and reacted to a request to cancel or abandon the modify DN operation.public void exportLDIF(LDIFExportConfig exportConfig) throws LdapException
LocalBackend
LocalBackend.supports(BackendOperation)
with LocalBackend.BackendOperation.LDIF_EXPORT
returns true
.
Note that the server will not explicitly initialize this backend before calling this method.
exportLDIF
in class LocalBackend<ConfigurationBackend.ConfigurationBackendCfg>
exportConfig
- The configuration to use when performing the export.LdapException
- If a problem occurs while performing the LDIF export.public LDIFImportResult importLDIF(LDIFImportConfig importConfig, ServerContext serverContext) throws LdapException
LocalBackend
LocalBackend.supports(BackendOperation)
with LocalBackend.BackendOperation.LDIF_IMPORT
returns true
.
Note that the server will not explicitly initialize this backend before calling this method.
importLDIF
in class LocalBackend<ConfigurationBackend.ConfigurationBackendCfg>
importConfig
- The configuration to use when performing the import.serverContext
- The server contextLdapException
- If a problem occurs while performing the LDIF import.public void createBackup(BackupConfig backupConfig) throws LdapException
LocalBackend
LocalBackend.supports(BackendOperation)
with LocalBackend.BackendOperation.BACKUP
returns true
.
Note that the server will not explicitly initialize this backend before calling this method.
createBackup
in class LocalBackend<ConfigurationBackend.ConfigurationBackendCfg>
backupConfig
- The configuration to use when performing the backup.LdapException
- If a problem occurs while performing the backup.public void removeBackup(BackupDirectory backupDirectory, String backupID) throws LdapException
LocalBackend
removeBackup
in class LocalBackend<ConfigurationBackend.ConfigurationBackendCfg>
backupDirectory
- The backup directory structure with which the specified backup is associated.backupID
- The backup ID for the backup to be removed.LdapException
- 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).public void restoreBackup(RestoreConfig restoreConfig) throws LdapException
LocalBackend
LocalBackend.supports(BackendOperation)
with BackendOperation#RESTORE
returns true
.
Note that the server will not explicitly initialize this backend before calling this method.
restoreBackup
in class LocalBackend<ConfigurationBackend.ConfigurationBackendCfg>
restoreConfig
- The configuration to use when performing the restore.LdapException
- If a problem occurs while performing the restore.public ListIterator<Path> getFilesToBackup()
Backupable
getFilesToBackup
in interface Backupable
null
public boolean isDirectRestore()
Backupable
isDirectRestore
in interface Backupable
true
if restore is done directly in the restore directory provided by getDirectory()
method, or false
if restore is done in a temporary directory.public Path beforeRestore() throws LdapException
Backupable
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.
beforeRestore
in interface Backupable
null
if not applicable.LdapException
- If an error occurs.public void afterRestore(Path restoreDirectory, Path saveDirectory)
Backupable
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.
afterRestore
in interface Backupable
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
.Copyright 2010-2022 ForgeRock AS.