@PublicAPI(stability=VOLATILE, mayInstantiate=false, mayExtend=false, mayInvoke=true) public final class BackupInfo extends Object
Modifier and Type | Field and Description |
---|---|
static String |
PROPERTY_BACKUP_DATE
The name of the property that holds the date that the backup was
created.
|
static String |
PROPERTY_BACKUP_ID
The name of the property that holds the backup ID in encoded
representations.
|
static String |
PROPERTY_CUSTOM_PREFIX
The prefix to use with custom backup properties.
|
static String |
PROPERTY_DEPENDENCY
The name of the property that holds the set of dependencies in
encoded representations (one dependency per instance).
|
static String |
PROPERTY_IS_COMPRESSED
The name of the property that holds the compressed flag in
encoded representations.
|
static String |
PROPERTY_IS_ENCRYPTED
The name of the property that holds the encrypted flag in encoded
representations.
|
static String |
PROPERTY_IS_INCREMENTAL
The name of the property that holds the incremental flag in
encoded representations.
|
static String |
PROPERTY_SIGNED_HASH
The name of the property that holds the signed hash in encoded
representations.
|
static String |
PROPERTY_UNSIGNED_HASH
The name of the property that holds the unsigned hash in encoded
representations.
|
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.
|
LinkedList<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.
|
HashMap<String,String> |
getBackupProperties()
Retrieves a set of additional properties that should be
associated with this backup.
|
String |
getBackupProperty(String name)
Retrieves the value of the backup property with the specified
name.
|
HashSet<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.
|
void |
toString(StringBuilder buffer)
Appends a multi-line string representation of this backup info
structure to the provided buffer.
|
public static final String PROPERTY_BACKUP_DATE
public static final String PROPERTY_BACKUP_ID
public static final String PROPERTY_IS_INCREMENTAL
public static final String PROPERTY_IS_COMPRESSED
public static final String PROPERTY_IS_ENCRYPTED
public static final String PROPERTY_UNSIGNED_HASH
public static final String PROPERTY_SIGNED_HASH
public static final String PROPERTY_DEPENDENCY
public static final String PROPERTY_CUSTOM_PREFIX
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 HashSet<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 HashMap<String,String> getBackupProperties()
public String getBackupProperty(String name)
name
- The name of the backup property to retrieve.null
if there is no such property.public LinkedList<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.public String toString()
public void toString(StringBuilder buffer)
buffer
- The buffer to which the information should be
written.Copyright © 2010-2015 ForgeRock AS. All Rights Reserved.