@PublicAPI(stability=VOLATILE, mayInstantiate=true, mayExtend=false, mayInvoke=true) public final class BackupConfig extends OperationConfig
Constructor and Description |
---|
BackupConfig(BackupDirectory backupDirectory,
String backupID,
boolean isIncremental)
Creates a new backup configuration that will create a full or incremental backup of a backend using the provided
information.
|
Modifier and Type | Method and Description |
---|---|
boolean |
compressData()
Indicates whether the backup process should compress the data as it is archived.
|
boolean |
encryptData()
Indicates whether the backup process should encrypt the data as it is archived.
|
BackupDirectory |
getBackupDirectory()
Retrieves the backup directory structure for this backup configuration.
|
String |
getBackupID()
Retrieves the identifier associated with this backup configuration, which can be used later to indicate which
backup should be restored if multiple backups are stored in the same location.
|
String |
getIncrementalBaseID()
Retrieves the backup ID for the backup on which this incremental backup should be based.
|
boolean |
hashData()
Indicates whether the backup process should generate a hash of the data as it is archived that may be validated
as part of the restore process.
|
boolean |
isIncremental()
Indicates whether the backend should attempt to perform an incremental backup containing only the changes since
the last incremental or full backup.
|
void |
setCompressData(boolean compressData)
Specifies whether the backup process should compress the data as it is archived.
|
void |
setEncryptData(boolean encryptData)
Specifies whether the backup process should encrypt the data as it is archived.
|
void |
setHashData(boolean hashData)
Specifies whether the backup process should generate a hash of the data as it is archived.
|
void |
setIncrementalBaseID(String incrementalBaseID)
Specifies the backup ID for the backup on which this incremental backup should be based.
|
void |
setSignHash(boolean signHash)
Specifies whether the backup process should digitally sign the hash of the data when it is archived.
|
boolean |
signHash()
Indicates whether the backup process should digitally sign the hash of the data when it is archived.
|
cancel, isCancelled
public BackupConfig(BackupDirectory backupDirectory, String backupID, boolean isIncremental)
backupDirectory
- The backup directory structure that indicates where the files should be written.backupID
- The unique identifier assigned to this backup.isIncremental
- Indicates whether this is to be an incremental or a full backup.public BackupDirectory getBackupDirectory()
public String getBackupID()
public boolean isIncremental()
true
if this should be an incremental backup, or false
if it should be a full
backup.public String getIncrementalBaseID()
null
, then the backend is free to choose the appropriate existing backup on which to base this
incremental backup.null
if
none was specified.public void setIncrementalBaseID(String incrementalBaseID)
incrementalBaseID
- The backup ID for the backup on which this incremental backup should be based.public boolean compressData()
true
if the backup process should compress the data as it is archived, or false
if not.public void setCompressData(boolean compressData)
compressData
- Specifies whether the backup process should compress the data as it is archived.public boolean encryptData()
true
if the backup process should encrypt the data as it is archived, or false
if not.public void setEncryptData(boolean encryptData)
encryptData
- Specifies whether the backup process should encrypt the data as it is archived.public boolean hashData()
true
if the backup process should generate a hash of the data as it is archived, or
false
if not.public void setHashData(boolean hashData)
hashData
- Specifies whether the backup process should generate a hash of the data as it is archived.public boolean signHash()
true
if the backup process should digitally sign the generated hash, or false
if not.public void setSignHash(boolean signHash)
signHash
- Specifies whether the backup process should digitally sign the data when it is archived.Copyright © 2010–2017 ForgeRock AS. All rights reserved.