Package org.opends.server.backup

Class Backup

java.lang.Object

org.opends.server.backup.Backup

All Implemented Interfaces:

Comparable<Backup>

public final class Backup
extends Object
implements Comparable<Backup>

This class contains all the metadata associated with a backup. This includes various properties like the timestamp or backend name as well as the set of backend file IDs associated with this backup. This class implements Comparable, allowing to compare backups based on their timestamps. Backup objects map the content of <backupId>.idx files and have additional fields like verified and errors.

Constructor Summary

Constructors

Constructor	Description
Backup(Instant timestamp, String backendId, String serverId, Set<org.opends.server.backup.BackendFileId> backendFileIds)	Creates a new backup with the provided properties.

Method Summary

Modifier and Type	Method	Description
int	compareTo(Backup o)	Compares this backup to the provided one based on their timestamps.
boolean	equals(Object o)
String	getBackendName()	Returns the name of the backend that was backed up.
Set<LocalizableMessage>	getErrors()	Return all the errors found after verifying this backup.
BackupId	getId()	Returns the backup ID.
String	getServerId()	Returns the ID of the DS instance that created this backup.
Instant	getTimestamp()	Return the backup creation timestamp.
String	getTimestampString()	Returns a string version of this backup timestamp in the format yyyyMMddHHmmssSSS.
boolean	hasErrors()	Returns whether this backup cannot be restored because it has errors.
int	hashCode()
boolean	isVerified()	Returns whether this backup has been verified.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Backup

public Backup(Instant timestamp,
              String backendId,
              String serverId,
              Set<org.opends.server.backup.BackendFileId> backendFileIds)

Creates a new backup with the provided properties.

Parameters:

timestamp - The timestamp.

backendId - The backend ID.

serverId - The server ID.

backendFileIds - the set of backend file IDs.

Method Detail

compareTo

public int compareTo(Backup o)

Compares this backup to the provided one based on their timestamps.

Specified by:

compareTo in interface Comparable<Backup>

Parameters:

o - The other backup.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getServerId

public String getServerId()

Returns the ID of the DS instance that created this backup.

Returns:

the ID of the DS instance that created this backup.

getTimestamp

public Instant getTimestamp()

Return the backup creation timestamp.

Returns:

the backup creation timestamp.

getTimestampString

public String getTimestampString()

Returns a string version of this backup timestamp in the format yyyyMMddHHmmssSSS.

Returns:

a string version of this backup timestamp in the format yyyyMMddHHmmssSSS.

getBackendName

public String getBackendName()

Returns the name of the backend that was backed up.

Returns:

the name of the backend that was backed up.

isVerified

public boolean isVerified()

Returns whether this backup has been verified.

Returns:

whether this backup has been verified.

hasErrors

public boolean hasErrors()

Returns whether this backup cannot be restored because it has errors.

Returns:

wether this backup has errors.

getErrors

public Set<LocalizableMessage> getErrors()

Return all the errors found after verifying this backup.

Returns:

all the errors found after verifying this backup.

getId

public BackupId getId()

Returns the backup ID.

Returns:

the backup ID.

toString

public String toString()

Overrides:

toString in class Object