public interface ArchivableDataProvider
TODO: do we need supportsRestore?
TODO: do we need removeBackup?
TODO: is there any boiler plate code that abstracted in order to make implementation simpler? E.g. initialization, crypto.
FIXME: the async APIs used below are a bad fit. We do not want to return an
LdapException
. We really need a more generic promises API.
Modifier and Type | Method and Description |
---|---|
LdapPromise<Void> |
createBackup(BackupConfig backupConfig,
LdapResultHandler<Void> handler)
Creates a backup of the contents of this data provider in a form that may
be restored at a later date if necessary.
|
DataProviderID |
getDataProviderID()
Returns the ID of this data provider.
|
LdapPromise<Void> |
restoreBackup(RestoreConfig restoreConfig,
LdapResultHandler<Void> handler)
Restores a backup of the contents of this data provider.
|
boolean |
supportsBackup(BackupConfig backupConfig,
StringBuilder unsupportedReason)
Indicates whether this data provider provides a mechanism to perform a
backup of its contents in a form that can be restored later, based on the
provided configuration.
|
LdapPromise<Void> createBackup(BackupConfig backupConfig, LdapResultHandler<Void> handler)
supportsBackup
returns true
.
Note that the server will not explicitly initialize this data provider before calling this method.
backupConfig
- The configuration to use when performing the backup.handler
- A handler which will be notified when the backup completes.DataProviderID getDataProviderID()
LdapPromise<Void> restoreBackup(RestoreConfig restoreConfig, LdapResultHandler<Void> handler)
Note that the server will not explicitly initialize this data provider before calling this method.
restoreConfig
- The configuration to use when performing the restore.handler
- A handler which will be notified when the restore completes.boolean supportsBackup(BackupConfig backupConfig, StringBuilder unsupportedReason)
backupConfig
- The configuration of the backup for which to make the
determination.unsupportedReason
- A buffer to which a message can be appended explaining why the
requested backup is not supported.true
if this data provider provides a mechanism for
performing backups with the provided configuration, or
false
if not.Copyright 2010-2017 ForgeRock AS.