public class SchemaBackend extends Backend<SchemaBackendCfg> implements ConfigurationChangeListener<SchemaBackendCfg>, AlertGenerator, Backupable
Backend.BackendOperation| Constructor and Description |
|---|
SchemaBackend()
Creates a new backend with the provided information.
|
| 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.
|
ConfigChangeResult |
applyConfigurationChange(SchemaBackendCfg backendCfg)
Applies the configuration changes to this change listener.
|
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(SchemaBackendCfg 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.
|
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.
|
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.
|
Entry |
getSchemaEntry(DN entryDN,
boolean includeSchemaFile)
Generates and returns a schema entry for the Directory Server.
|
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(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(SchemaBackendCfg configEntry,
List<LocalizableMessage> unacceptableReasons)
Indicates whether the proposed change to the configuration is
acceptable to this change listener.
|
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.
|
addSubordinateBackend, finalizeBackend, getBackendID, getBackendMonitor, getParentBackend, getPersistentSearches, getSubordinateBackends, getWritabilityMode, handlesEntry, handlesEntry, isConfigurationAcceptable, isIndexed, isPrivateBackend, rebuildBackend, registerPersistentSearch, removeSubordinateBackend, setBackendID, setBackendMonitor, setParentBackend, setPrivateBackend, setWritabilityMode, supportsControl, verifyBackendpublic SchemaBackend()
super() to invoke this constructor.public void configureBackend(SchemaBackendCfg cfg, ServerContext serverContext) throws ConfigException
BackendconfigureBackend in class Backend<SchemaBackendCfg>cfg - The configuration of this backend.serverContext - The server context for this instanceConfigException - If there is an error in the configuration.public void openBackend() throws ConfigException, InitializationException
BackendopenBackend in class Backend<SchemaBackendCfg>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.Backend.configureBackend(C, org.opends.server.core.ServerContext)public void closeBackend()
Backend
It will be called as final step of finalizeBackend(),
so subclasses might override it.
closeBackend in class Backend<SchemaBackendCfg>public DN[] getBaseDNs()
BackendgetBaseDNs in class Backend<SchemaBackendCfg>public long getEntryCount()
BackendgetEntryCount in class Backend<SchemaBackendCfg>public boolean isIndexed(AttributeType attributeType, IndexType indexType)
Backendtrue for the specified
attribute and index type.isIndexed in class Backend<SchemaBackendCfg>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 org.forgerock.opendj.ldap.ConditionResult hasSubordinates(DN entryDN) throws DirectoryException
BackendhasSubordinates in class Backend<SchemaBackendCfg>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.DirectoryException - If a problem occurs while trying to
retrieve the entry.public long getNumberOfEntriesInBaseDN(DN baseDN) throws DirectoryException
BackendgetNumberOfEntriesInBaseDN in class Backend<SchemaBackendCfg>baseDN - The base distinguished name.DirectoryException - If baseDN isn't a base dn managed by this backend or if a problem occurs while trying to retrieve the
entry.public long getNumberOfChildren(DN parentDN) throws DirectoryException
BackendgetNumberOfChildren in class Backend<SchemaBackendCfg>parentDN - The distinguished name of the parent.DirectoryException - If baseDN isn't a base dn managed by this backend or if a problem occurs while trying to retrieve the
entry.public Entry getEntry(DN entryDN) throws DirectoryException
BackendgetEntry in class Backend<SchemaBackendCfg>entryDN - The distinguished name of the entry to retrieve.null if the entry does not exist.DirectoryException - If a problem occurs while trying to retrieve the entry.public Entry getSchemaEntry(DN entryDN, boolean includeSchemaFile)
entryDN - The DN to use for the generated entry.includeSchemaFile - A boolean indicating if the X-SCHEMA-FILE
extension should be used when generating
the entry.public boolean entryExists(DN entryDN) throws DirectoryException
BackendgetEntry, 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 Backend<SchemaBackendCfg>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.DirectoryException - If a problem occurs while trying to make the determination.public void addEntry(Entry entry, AddOperation addOperation) throws DirectoryException
BackendaddEntry in class Backend<SchemaBackendCfg>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.DirectoryException - If a problem occurs while trying to
add the entry.public void deleteEntry(DN entryDN, DeleteOperation deleteOperation) throws DirectoryException
BackenddeleteEntry in class Backend<SchemaBackendCfg>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.DirectoryException - If a problem occurs while trying to
remove the entry.public void replaceEntry(Entry oldEntry, Entry newEntry, ModifyOperation modifyOperation) throws DirectoryException
BackendreplaceEntry in class Backend<SchemaBackendCfg>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.DirectoryException - If a problem occurs while trying to replace the entry.public void renameEntry(DN currentDN, Entry entry, ModifyDNOperation modifyDNOperation) throws DirectoryException
BackendrenameEntry in class Backend<SchemaBackendCfg>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.DirectoryException - If a problem occurs while trying to perform the rename.public void search(SearchOperation searchOperation) throws DirectoryException
BackendSearchOperation.returnEntry method. The caller is not
required to have any locks when calling this operation.search in class Backend<SchemaBackendCfg>searchOperation - The search operation to be processed.DirectoryException - If a problem occurs while processing
the search.public Set<String> getSupportedControls()
BackendgetSupportedControls in class Backend<SchemaBackendCfg>public Set<String> getSupportedFeatures()
BackendgetSupportedFeatures in class Backend<SchemaBackendCfg>public void exportLDIF(LDIFExportConfig exportConfig) throws DirectoryException
BackendBackend.supports(BackendOperation) with Backend.BackendOperation.LDIF_EXPORT returns
true.
Note that the server will not explicitly initialize this backend before calling this method.
exportLDIF in class Backend<SchemaBackendCfg>exportConfig - The configuration to use when performing the export.DirectoryException - If a problem occurs while performing the LDIF export.public boolean supports(Backend.BackendOperation backendOperation)
Backendsupports in class Backend<SchemaBackendCfg>backendOperation - the backend operationtrue if this backend supports the provided backend operation, false
otherwise.public LDIFImportResult importLDIF(LDIFImportConfig importConfig, ServerContext serverContext) throws DirectoryException
BackendBackend.supports(BackendOperation) with Backend.BackendOperation.LDIF_IMPORT returns
true.
Note that the server will not explicitly initialize this backend before calling this method.
importLDIF in class Backend<SchemaBackendCfg>importConfig - The configuration to use when performing the import.serverContext - The server contextDirectoryException - If a problem occurs while performing the LDIF import.public void createBackup(BackupConfig backupConfig) throws DirectoryException
BackendBackend.supports(BackendOperation) with
Backend.BackendOperation.BACKUP returns true.
Note that the server will not explicitly initialize this backend before calling this method.
createBackup in class Backend<SchemaBackendCfg>backupConfig - The configuration to use when performing the backup.DirectoryException - If a problem occurs while performing the backup.public void removeBackup(BackupDirectory backupDirectory, String backupID) throws DirectoryException
BackendremoveBackup in class Backend<SchemaBackendCfg>backupDirectory - The backup directory structure with
which the specified backup is
associated.backupID - The backup ID for the backup to be
removed.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).public void restoreBackup(RestoreConfig restoreConfig) throws DirectoryException
BackendBackend.supports(BackendOperation) with Backend.BackendOperation.RESTORE returns true.
Note that the server will not explicitly initialize this backend before calling this method.
restoreBackup in class Backend<SchemaBackendCfg>restoreConfig - The configuration to use when performing the restore.DirectoryException - If a problem occurs while performing the restore.public boolean isConfigurationChangeAcceptable(SchemaBackendCfg configEntry, List<LocalizableMessage> unacceptableReasons)
ConfigurationChangeListenerisConfigurationChangeAcceptable in interface ConfigurationChangeListener<SchemaBackendCfg>configEntry - The new configuration containing the changes.unacceptableReasons - A list that can be used to hold messages about why the
provided configuration is not acceptable.true if the proposed change is
acceptable, or false if it is not.public ConfigChangeResult applyConfigurationChange(SchemaBackendCfg backendCfg)
ConfigurationChangeListenerapplyConfigurationChange in interface ConfigurationChangeListener<SchemaBackendCfg>backendCfg - The new configuration containing the changes.public DN getComponentEntryDN()
AlertGeneratorgetComponentEntryDN in interface AlertGeneratorpublic String getClassName()
AlertGeneratorgetClassName in interface AlertGeneratorpublic Map<String,String> getAlerts()
AlertGeneratorgetAlerts in interface AlertGeneratorpublic File getDirectory()
BackupablegetDirectory in interface Backupablepublic ListIterator<Path> getFilesToBackup() throws DirectoryException
BackupablegetFilesToBackup in interface BackupablenullDirectoryException - If an error occurs.public boolean isDirectRestore()
BackupableisDirectRestore in interface Backupabletrue 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 DirectoryException
BackupableIn 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 Backupablenull
if not applicable.DirectoryException - If an error occurs.public void afterRestore(Path restoreDirectory, Path saveDirectory) throws DirectoryException
BackupableFor 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 BackupablerestoreDirectory - 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.DirectoryException - If an error occurs.Copyright © 2010-2015 ForgeRock AS. All Rights Reserved.