@PublicAPI(stability=VOLATILE, mayInstantiate=false, mayExtend=false, mayInvoke=true) public final class BackupInfo extends Object
Constructor and Description |
---|
BackupInfo(BackupDirectory backupDirectory,
String backupID,
Date backupDate,
boolean isIncremental,
boolean isCompressed,
boolean isEncrypted,
byte[] unsignedHash,
byte[] signedHash,
HashSet<String> dependencies,
HashMap<String,String> backupProperties)
Creates a new backup info structure with the provided information.
|
Modifier and Type | Method and Description |
---|---|
static BackupInfo |
decode(BackupDirectory backupDirectory,
List<String> encodedInfo)
Decodes the provided list of strings as the representation of a backup info structure.
|
boolean |
dependsOn(String backupID)
Indicates whether this backup has a dependency on the backup with the provided ID.
|
List<String> |
encode()
Encodes this backup info structure to a multi-line string representation.
|
Date |
getBackupDate()
Retrieves the date that this backup was created.
|
BackupDirectory |
getBackupDirectory()
Retrieves the reference to the backup directory in which this backup is stored.
|
String |
getBackupID()
Retrieves the unique ID for this backup.
|
Map<String,String> |
getBackupProperties()
Retrieves a set of additional properties that should be associated with this backup.
|
Set<String> |
getDependencies()
Retrieves the set of the backup IDs for the backups on which this backup is dependent.
|
byte[] |
getSignedHash()
Retrieves the data for the signed hash for this backup, if appropriate.
|
byte[] |
getUnsignedHash()
Retrieves the data for the unsigned hash for this backup, if appropriate.
|
boolean |
isCompressed()
Indicates whether this backup is compressed.
|
boolean |
isEncrypted()
Indicates whether this backup is encrypted.
|
boolean |
isIncremental()
Indicates whether this is an incremental or a full backup.
|
String |
toString()
Retrieves a multi-line string representation of this backup info structure.
|
public BackupInfo(BackupDirectory backupDirectory, String backupID, Date backupDate, boolean isIncremental, boolean isCompressed, boolean isEncrypted, byte[] unsignedHash, byte[] signedHash, HashSet<String> dependencies, HashMap<String,String> backupProperties)
backupDirectory
- A reference to the backup directory in which this backup is stored.backupID
- The unique ID for this backup.backupDate
- The time that this backup was created.isIncremental
- Indicates whether this is an incremental or a full backup.isCompressed
- Indicates whether the backup is compressed.isEncrypted
- Indicates whether the backup is encrypted.unsignedHash
- The unsigned hash for this backup, if appropriate.signedHash
- The signed hash for this backup, if appropriate.dependencies
- The backup IDs of the previous backups on which this backup is dependent.backupProperties
- The set of additional backend-specific properties that should be stored with this backup information.
It should be a mapping between property names and values, where the names do not contain any equal
signs and neither the names nor the values contain line breaks.public BackupDirectory getBackupDirectory()
public String getBackupID()
public Date getBackupDate()
public boolean isIncremental()
true
if this is an incremental backup, or false
if it is a full backup.public boolean isCompressed()
true
if this backup is compressed, or false
if it is not.public boolean isEncrypted()
true
if this backup is encrypted, or false
if it is not.public byte[] getUnsignedHash()
null
if there is none.public byte[] getSignedHash()
null
if there is none.public Set<String> getDependencies()
public boolean dependsOn(String backupID)
backupID
- The backup ID for which to make the determination.true
if this backup has a dependency on the backup with the provided ID, or
false
if not.public Map<String,String> getBackupProperties()
public List<String> encode()
decode
method to reconstruct the structure.public static BackupInfo decode(BackupDirectory backupDirectory, List<String> encodedInfo) throws ConfigException
backupDirectory
- The reference to the backup directory with which the backup info is associated.encodedInfo
- The list of strings that comprise the string representation of the backup info structure.ConfigException
- If a problem occurs while attempting to decode the backup info data.Copyright 2010-2020 ForgeRock AS.