com.unboundid.ldap.sdk.unboundidds.tasks

Class BackupTask

java.lang.Object

com.unboundid.ldap.sdk.unboundidds.tasks.Task

com.unboundid.ldap.sdk.unboundidds.tasks.BackupTask

All Implemented Interfaces:

java.io.Serializable

@NotMutable
 @ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class BackupTask
extends Task

This class defines a Directory Server task that can be used to back up one or more Directory Server backends.

NOTE: This class, and other classes within the com.unboundid.ldap.sdk.unboundidds package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.

The properties that are available for use with this type of task include:

• The path to the directory in which the backup should be placed. If multiple backends are to be backed up at once, then this should be the parent of the backup directories for each backend. This must be provided when scheduling this task.
• The backend IDs of the backends to archive. If this is not provided, then the server will attempt to back up all supported backends.
• The backup ID to use for the backup. If this is not provided, then the server will generate a backup ID.
• A flag that indicates whether the backup should be an incremental backup (if the backend supports that capability) or a full backup.
• The backup ID of the existing backup on which the incremental backup should be based. If this is not provided and an incremental backup is to be performed, then it will be based on the most recent backup in the backup directory.
• A flag that indicates whether to compress the contents of the backup.
• A flag that indicates whether to encrypt the contents of the backup.
• A flag that indicates whether to hash the contents of the backup to use as a checksum for verifying the integrity of the backup.
• A flag that indicates whether to sign the backup hash in order to prevent anyone from tampering with it.
• The path to a file containing a passphrase to use to generate the encryption key.
• The ID of the encryption settings definition to use to generate the encryption key.
• The maximum rate in megabytes per second at which the backup should be written.
• The minimum number of previous full backups to retain.
• The minimum age of previous full backups to retain.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BackupTask() Creates a new uninitialized backup task instance which should only be used for obtaining general information about this task, including the task name, description, and supported properties.
BackupTask(Entry entry) Creates a new backup task from the provided entry.
BackupTask(java.util.Map<TaskProperty,java.util.List<java.lang.Object>> properties) Creates a new backup task from the provided set of task properties.
BackupTask(java.lang.String taskID, java.lang.String backupDirectory, java.util.List<java.lang.String> backendIDs, java.lang.String backupID, boolean incremental, java.lang.String incrementalBaseID, boolean compress, boolean encrypt, boolean hash, boolean signHash, java.util.Date scheduledStartTime, java.util.List<java.lang.String> dependencyIDs, FailedDependencyAction failedDependencyAction, java.util.List<java.lang.String> notifyOnCompletion, java.util.List<java.lang.String> notifyOnError) Creates a new restore task with the provided information.
BackupTask(java.lang.String taskID, java.lang.String backupDirectory, java.util.List<java.lang.String> backendIDs, java.lang.String backupID, boolean incremental, java.lang.String incrementalBaseID, boolean compress, boolean encrypt, java.lang.String encryptionPassphraseFile, java.lang.String encryptionSettingsDefinitionID, boolean hash, boolean signHash, java.lang.Integer maxMegabytesPerSecond, java.lang.Integer retainPreviousFullBackupCount, java.lang.String retainPreviousFullBackupAge, java.util.Date scheduledStartTime, java.util.List<java.lang.String> dependencyIDs, FailedDependencyAction failedDependencyAction, java.util.List<java.lang.String> notifyOnCompletion, java.util.List<java.lang.String> notifyOnError) Creates a new restore task with the provided information.
BackupTask(java.lang.String taskID, java.lang.String backupDirectory, java.util.List<java.lang.String> backendIDs, java.lang.String backupID, boolean incremental, java.lang.String incrementalBaseID, boolean compress, boolean encrypt, java.lang.String encryptionPassphraseFile, java.lang.String encryptionSettingsDefinitionID, boolean hash, boolean signHash, java.lang.Integer maxMegabytesPerSecond, java.lang.Integer retainPreviousFullBackupCount, java.lang.String retainPreviousFullBackupAge, java.util.Date scheduledStartTime, java.util.List<java.lang.String> dependencyIDs, FailedDependencyAction failedDependencyAction, java.util.List<java.lang.String> notifyOnStart, java.util.List<java.lang.String> notifyOnCompletion, java.util.List<java.lang.String> notifyOnSuccess, java.util.List<java.lang.String> notifyOnError, java.lang.Boolean alertOnStart, java.lang.Boolean alertOnSuccess, java.lang.Boolean alertOnError) Creates a new restore task with the provided information.
BackupTask(java.lang.String taskID, java.lang.String backupDirectory, java.lang.String backendID) Creates a new backup task with the provided information.

Method Summary

Modifier and Type	Method and Description
boolean	backupAll() Indicates whether the server should back up all supported backends.
boolean	compress() Indicates whether the backup should be compressed.
boolean	encrypt() Indicates whether the backup should be encrypted.
protected java.util.List<Attribute>	getAdditionalAttributes() Retrieves a list of the additional attributes (other than attributes common to all task types) that should be included when creating new task entries of this type.
protected java.util.List<java.lang.String>	getAdditionalObjectClasses() Retrieves a list of the additional object classes (other than the base "top" and "ds-task" classes) that should be included when creating new task entries of this type.
java.util.List<java.lang.String>	getBackendIDs() Retrieves the set of backend IDs for the backends that should be archived.
java.lang.String	getBackupDirectory() Retrieves the path to the backup directory in which the backup files should be written.
java.lang.String	getBackupID() Retrieves the backup ID for the backup to generate.
java.lang.String	getEncryptionPassphraseFile() Retrieves the path to a file that contains the passphrase to use to generate the encryption key.
java.lang.String	getEncryptionSettingsDefinitionID() Retrieves the identifier of the encryption settings definition to use to generate the encryption key.
java.lang.String	getIncrementalBaseID() Retrieves the backup ID of the existing backup on which the incremental backup should be based.
java.lang.Integer	getMaxMegabytesPerSecond() Retrieves the maximum rate, in megabytes per second, at which the backup should be written.
java.lang.String	getRetainPreviousFullBackupAge() Retrieves a string representation of the minimum age of previous full backups that should be retained if the new backup is created successfully.
java.lang.Integer	getRetainPreviousFullBackupCount() Retrieves the minimum number of previous full backups that should be retained if the new backup is created successfully.
java.lang.String	getTaskDescription() Retrieves a human-readable description for this task.
java.lang.String	getTaskName() Retrieves a human-readable name for this task.
java.util.Map<TaskProperty,java.util.List<java.lang.Object>>	getTaskPropertyValues() Retrieves the values of the task properties for this task.
java.util.List<TaskProperty>	getTaskSpecificProperties() Retrieves a list of task-specific properties that may be provided when scheduling a task of this type.
boolean	hash() Indicates whether the server should generate a hash of the backup.
boolean	incremental() Indicates whether the server should attempt to perform an incremental backup rather than a full backup.
boolean	signHash() Indicates whether the server should sign the backup hash.

Methods inherited from class com.unboundid.ldap.sdk.unboundidds.tasks.Task

createTaskEntry, decodeTask, getActualStartTime, getAlertOnError, getAlertOnStart, getAlertOnSuccess, getAvailableTaskTypes, getCommonTaskProperties, getCompletionTime, getDependencyIDs, getFailedDependencyAction, getLogMessages, getNotifyOnCompletionAddresses, getNotifyOnErrorAddresses, getNotifyOnStartAddresses, getNotifyOnSuccessAddresses, getScheduledStartTime, getState, getTaskClassName, getTaskEntry, getTaskEntryDN, getTaskID, isCompleted, isPending, isRunning, parseBoolean, parseBooleanValue, parseDate, parseLong, parseString, parseStringList, parseStrings, toString, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BackupTask

public BackupTask()

Creates a new uninitialized backup task instance which should only be used for obtaining general information about this task, including the task name, description, and supported properties. Attempts to use a task created with this constructor for any other reason will likely fail.

BackupTask

public BackupTask(@Nullable
                  java.lang.String taskID,
                  @NotNull
                  java.lang.String backupDirectory,
                  @Nullable
                  java.lang.String backendID)

Creates a new backup task with the provided information.

Parameters:

taskID - The task ID to use for this task. If it is null then a UUID will be generated for use as the task ID.

backupDirectory - The path to the directory on the server into which the backup should be written. If a single backend is to be archived, then this should be the path to the specific backup directory for that backend. If multiple backends are to be archived, then this should be the parent of the directories for each of the backends. It must not be null.

backendID - The backend ID of the backend to back up. It may be null if all supported backends should be backed up.

BackupTask

public BackupTask(@Nullable
                  java.lang.String taskID,
                  @NotNull
                  java.lang.String backupDirectory,
                  @Nullable
                  java.util.List<java.lang.String> backendIDs,
                  @Nullable
                  java.lang.String backupID,
                  boolean incremental,
                  @Nullable
                  java.lang.String incrementalBaseID,
                  boolean compress,
                  boolean encrypt,
                  boolean hash,
                  boolean signHash,
                  @Nullable
                  java.util.Date scheduledStartTime,
                  @Nullable
                  java.util.List<java.lang.String> dependencyIDs,
                  @Nullable
                  FailedDependencyAction failedDependencyAction,
                  @Nullable
                  java.util.List<java.lang.String> notifyOnCompletion,
                  @Nullable
                  java.util.List<java.lang.String> notifyOnError)

Creates a new restore task with the provided information.

Parameters:

taskID - The task ID to use for this task. If it is null then a UUID will be generated for use as the task ID.

backupDirectory - The path to the directory on the server into which the backup should be written. If a single backend is to be archived, then this should be the path to the specific backup directory for that backend. If multiple backends are to be archived, then this should be the parent of the directories for each of the backends. It must not be null.

backendIDs - A list of the backend IDs of the backends to archive. It may be null or empty if all supported backends should be archived.

backupID - The backup ID to use for this backup. It may be null to indicate that the server should generate the backup ID.

incremental - Indicates whether to perform an incremental backup rather than a full backup.

incrementalBaseID - The backup ID of the existing backup on which to base the incremental backup. It may be null if this is not an incremental backup or if it should be based on the most recent backup.

compress - Indicates whether the backup should be compressed.

encrypt - Indicates whether the backup should be encrypted.

hash - Indicates whether to generate a hash of the backup contents.

signHash - Indicates whether to sign the hash of the backup contents.

scheduledStartTime - The time that this task should start running.

dependencyIDs - The list of task IDs that will be required to complete before this task will be eligible to start.

failedDependencyAction - Indicates what action should be taken if any of the dependencies for this task do not complete successfully.

notifyOnCompletion - The list of e-mail addresses of individuals that should be notified when this task completes.

notifyOnError - The list of e-mail addresses of individuals that should be notified if this task does not complete successfully.

BackupTask

public BackupTask(@Nullable
                  java.lang.String taskID,
                  @NotNull
                  java.lang.String backupDirectory,
                  @Nullable
                  java.util.List<java.lang.String> backendIDs,
                  @Nullable
                  java.lang.String backupID,
                  boolean incremental,
                  @Nullable
                  java.lang.String incrementalBaseID,
                  boolean compress,
                  boolean encrypt,
                  @Nullable
                  java.lang.String encryptionPassphraseFile,
                  @Nullable
                  java.lang.String encryptionSettingsDefinitionID,
                  boolean hash,
                  boolean signHash,
                  @Nullable
                  java.lang.Integer maxMegabytesPerSecond,
                  @Nullable
                  java.lang.Integer retainPreviousFullBackupCount,
                  @Nullable
                  java.lang.String retainPreviousFullBackupAge,
                  @Nullable
                  java.util.Date scheduledStartTime,
                  @Nullable
                  java.util.List<java.lang.String> dependencyIDs,
                  @Nullable
                  FailedDependencyAction failedDependencyAction,
                  @Nullable
                  java.util.List<java.lang.String> notifyOnCompletion,
                  @Nullable
                  java.util.List<java.lang.String> notifyOnError)

Creates a new restore task with the provided information.

Parameters:

taskID - The task ID to use for this task. If it is null then a UUID will be generated for use as the task ID.

backupDirectory - The path to the directory on the server into which the backup should be written. If a single backend is to be archived, then this should be the path to the specific backup directory for that backend. If multiple backends are to be archived, then this should be the parent of the directories for each of the backends. It must not be null.

backendIDs - A list of the backend IDs of the backends to archive. It may be null or empty if all supported backends should be archived.

backupID - The backup ID to use for this backup. It may be null to indicate that the server should generate the backup ID.

incremental - Indicates whether to perform an incremental backup rather than a full backup.

incrementalBaseID - The backup ID of the existing backup on which to base the incremental backup. It may be null if this is not an incremental backup or if it should be based on the most recent backup.

compress - Indicates whether the backup should be compressed.

encrypt - Indicates whether the backup should be encrypted.

encryptionPassphraseFile - The path to a file containing the passphrase to use to generate the encryption key. It amy be null if the backup is not to be encrypted, or if the key should be obtained in some other way.

encryptionSettingsDefinitionID - The ID of the encryption settings definition use to generate the encryption key. It may be null if the backup is not to be encrypted, or if the key should be obtained in some other way.

hash - Indicates whether to generate a hash of the backup contents.

signHash - Indicates whether to sign the hash of the backup contents.

maxMegabytesPerSecond - The maximum rate in megabytes per second at which the backup should be written.

retainPreviousFullBackupCount - The minimum number of previous backups to retain.

retainPreviousFullBackupAge - A string representation of the minimum age of previous backups to retain. The age should be formatted in the same way as values for the DurationArgument class.

scheduledStartTime - The time that this task should start running.

dependencyIDs - The list of task IDs that will be required to complete before this task will be eligible to start.

failedDependencyAction - Indicates what action should be taken if any of the dependencies for this task do not complete successfully.

notifyOnCompletion - The list of e-mail addresses of individuals that should be notified when this task completes.

notifyOnError - The list of e-mail addresses of individuals that should be notified if this task does not complete successfully.

BackupTask

public BackupTask(@Nullable
                  java.lang.String taskID,
                  @NotNull
                  java.lang.String backupDirectory,
                  @Nullable
                  java.util.List<java.lang.String> backendIDs,
                  @Nullable
                  java.lang.String backupID,
                  boolean incremental,
                  @Nullable
                  java.lang.String incrementalBaseID,
                  boolean compress,
                  boolean encrypt,
                  @Nullable
                  java.lang.String encryptionPassphraseFile,
                  @Nullable
                  java.lang.String encryptionSettingsDefinitionID,
                  boolean hash,
                  boolean signHash,
                  @Nullable
                  java.lang.Integer maxMegabytesPerSecond,
                  @Nullable
                  java.lang.Integer retainPreviousFullBackupCount,
                  @Nullable
                  java.lang.String retainPreviousFullBackupAge,
                  @Nullable
                  java.util.Date scheduledStartTime,
                  @Nullable
                  java.util.List<java.lang.String> dependencyIDs,
                  @Nullable
                  FailedDependencyAction failedDependencyAction,
                  @Nullable
                  java.util.List<java.lang.String> notifyOnStart,
                  @Nullable
                  java.util.List<java.lang.String> notifyOnCompletion,
                  @Nullable
                  java.util.List<java.lang.String> notifyOnSuccess,
                  @Nullable
                  java.util.List<java.lang.String> notifyOnError,
                  @Nullable
                  java.lang.Boolean alertOnStart,
                  @Nullable
                  java.lang.Boolean alertOnSuccess,
                  @Nullable
                  java.lang.Boolean alertOnError)

Creates a new restore task with the provided information.

Parameters:

taskID - The task ID to use for this task. If it is null then a UUID will be generated for use as the task ID.

backupDirectory - The path to the directory on the server into which the backup should be written. If a single backend is to be archived, then this should be the path to the specific backup directory for that backend. If multiple backends are to be archived, then this should be the parent of the directories for each of the backends. It must not be null.

backendIDs - A list of the backend IDs of the backends to archive. It may be null or empty if all supported backends should be archived.

backupID - The backup ID to use for this backup. It may be null to indicate that the server should generate the backup ID.

incremental - Indicates whether to perform an incremental backup rather than a full backup.

incrementalBaseID - The backup ID of the existing backup on which to base the incremental backup. It may be null if this is not an incremental backup or if it should be based on the most recent backup.

compress - Indicates whether the backup should be compressed.

encrypt - Indicates whether the backup should be encrypted.

encryptionPassphraseFile - The path to a file containing the passphrase to use to generate the encryption key. It amy be null if the backup is not to be encrypted, or if the key should be obtained in some other way.

encryptionSettingsDefinitionID - The ID of the encryption settings definition use to generate the encryption key. It may be null if the backup is not to be encrypted, or if the key should be obtained in some other way.

hash - Indicates whether to generate a hash of the backup contents.

signHash - Indicates whether to sign the hash of the backup contents.

maxMegabytesPerSecond - The maximum rate in megabytes per second at which the backup should be written.

retainPreviousFullBackupCount - The minimum number of previous backups to retain.

retainPreviousFullBackupAge - A string representation of the minimum age of previous backups to retain. The age should be formatted in the same way as values for the DurationArgument class.

scheduledStartTime - The time that this task should start running.

dependencyIDs - The list of task IDs that will be required to complete before this task will be eligible to start.

failedDependencyAction - Indicates what action should be taken if any of the dependencies for this task do not complete successfully.

notifyOnStart - The list of e-mail addresses of individuals that should be notified when this task starts running.

notifyOnCompletion - The list of e-mail addresses of individuals that should be notified when this task completes.

notifyOnSuccess - The list of e-mail addresses of individuals that should be notified if this task completes successfully.

notifyOnError - The list of e-mail addresses of individuals that should be notified if this task does not complete successfully.

alertOnStart - Indicates whether the server should send an alert notification when this task starts.

alertOnSuccess - Indicates whether the server should send an alert notification if this task completes successfully.

alertOnError - Indicates whether the server should send an alert notification if this task fails to complete successfully.

BackupTask

public BackupTask(@NotNull
                  Entry entry)
           throws TaskException

Creates a new backup task from the provided entry.

Parameters:

entry - The entry to use to create this backup task.

Throws:

TaskException - If the provided entry cannot be parsed as a backup task entry.

BackupTask

public BackupTask(@NotNull
                  java.util.Map<TaskProperty,java.util.List<java.lang.Object>> properties)
           throws TaskException

Creates a new backup task from the provided set of task properties.

Parameters:

properties - The set of task properties and their corresponding values to use for the task. It must not be null.

Throws:

TaskException - If the provided set of properties cannot be used to create a valid backup task.

Method Detail

getTaskName

@NotNull
public java.lang.String getTaskName()

Retrieves a human-readable name for this task.

Overrides:

getTaskName in class Task

Returns:

A human-readable name for this task.

getTaskDescription

@NotNull
public java.lang.String getTaskDescription()

Retrieves a human-readable description for this task.

Overrides:

getTaskDescription in class Task

Returns:

A human-readable description for this task.

getBackupDirectory

@NotNull
public java.lang.String getBackupDirectory()

Retrieves the path to the backup directory in which the backup files should be written. If a single backend is to be archived, then this will be the directory in which the backup files are written. If multiple backends are to be archived, then this will be the parent of the directories containing the backups for each backend.

Returns:

The path to the backup directory in which the backup files should be written.

backupAll

public boolean backupAll()

Indicates whether the server should back up all supported backends.

Returns:

true if the server should back up all supported backends, or false if it should back up a specified backend or set of backends.

getBackendIDs

@NotNull
public java.util.List<java.lang.String> getBackendIDs()

Retrieves the set of backend IDs for the backends that should be archived.

Returns:

The set of backend IDs for the backends that should be archived, or an empty list if the server should back up all supported backends.

getBackupID

@Nullable
public java.lang.String getBackupID()

Retrieves the backup ID for the backup to generate.

Returns:

The backup ID for the backup to generate, or null if the server should generate a backup ID.

incremental

public boolean incremental()

Indicates whether the server should attempt to perform an incremental backup rather than a full backup.

Returns:

true if the server should attempt to perform an incremental backup, or false for a full backup.

getIncrementalBaseID

@Nullable
public java.lang.String getIncrementalBaseID()

Retrieves the backup ID of the existing backup on which the incremental backup should be based.

Returns:

The backup ID of the existing backup on which the incremental backup should be based, or null if it is not an incremental backup or the server should use the most recent backup available as the base for the new incremental backup.

compress

public boolean compress()

Indicates whether the backup should be compressed.

Returns:

true if the backup should be compressed, or false if not.

encrypt

public boolean encrypt()

Indicates whether the backup should be encrypted.

Returns:

true if the backup should be encrypted, or false if not.

getEncryptionPassphraseFile

@Nullable
public java.lang.String getEncryptionPassphraseFile()

Retrieves the path to a file that contains the passphrase to use to generate the encryption key.

Returns:

The path to a file that contains the passphrase to use to generate the encryption key, or null if the backup should not be encrypted or if the encryption key should be obtained through some other means.

getEncryptionSettingsDefinitionID

@Nullable
public java.lang.String getEncryptionSettingsDefinitionID()

Retrieves the identifier of the encryption settings definition to use to generate the encryption key.

Returns:

The identifier of the encryption settings definition to use to generate the encryption key, or null if the backup should not be encrypted or if the encryption key should be obtained through some other means.

hash

public boolean hash()

Indicates whether the server should generate a hash of the backup.

Returns:

true if the server should generate a hash of the backup, or false if not.

signHash

public boolean signHash()

Indicates whether the server should sign the backup hash.

Returns:

true if the server should sign the backup hash, or false if not.

getMaxMegabytesPerSecond

@Nullable
public java.lang.Integer getMaxMegabytesPerSecond()

Retrieves the maximum rate, in megabytes per second, at which the backup should be written.

Returns:

The maximum rate, in megabytes per second, at which the backup should be written, or null if the writing should not be rate limited.

getRetainPreviousFullBackupCount

@Nullable
public java.lang.Integer getRetainPreviousFullBackupCount()

Retrieves the minimum number of previous full backups that should be retained if the new backup is created successfully.

Returns:

The minimum number of previous full backups that should be retained if the new backup is created successfully, or null if no backups should be removed or if the backup age should be the only retention criteria.

getRetainPreviousFullBackupAge

@Nullable
public java.lang.String getRetainPreviousFullBackupAge()

Retrieves a string representation of the minimum age of previous full backups that should be retained if the new backup is created successfully.

Returns:

A string representation fo the minimum age of previous full backups that should be retained if the new backup is created successfully, or null if no backups should be removed or if the backup count should be the only retention criteria.

getAdditionalObjectClasses

@NotNull
protected java.util.List<java.lang.String> getAdditionalObjectClasses()

Retrieves a list of the additional object classes (other than the base "top" and "ds-task" classes) that should be included when creating new task entries of this type.

Overrides:

getAdditionalObjectClasses in class Task

Returns:

A list of the additional object classes that should be included in new task entries of this type, or an empty list if there do not need to be any additional classes.

getAdditionalAttributes

@NotNull
protected java.util.List<Attribute> getAdditionalAttributes()

Retrieves a list of the additional attributes (other than attributes common to all task types) that should be included when creating new task entries of this type.

Overrides:

getAdditionalAttributes in class Task

Returns:

A list of the additional attributes that should be included in new task entries of this type, or an empty list if there do not need to be any additional attributes.

getTaskSpecificProperties

@NotNull
public java.util.List<TaskProperty> getTaskSpecificProperties()

Retrieves a list of task-specific properties that may be provided when scheduling a task of this type. This method should be overridden by subclasses in order to provide an appropriate set of properties.

Overrides:

getTaskSpecificProperties in class Task

Returns:

A list of task-specific properties that may be provided when scheduling a task of this type.

getTaskPropertyValues

@NotNull
public java.util.Map<TaskProperty,java.util.List<java.lang.Object>> getTaskPropertyValues()

Retrieves the values of the task properties for this task. The data type of the values will vary based on the data type of the corresponding task property and may be one of the following types: Boolean, Date, Long, or String. Task properties which do not have any values will be included in the map with an empty value list.

Note that subclasses which have additional task properties should override this method and return a map which contains both the property values from this class (obtained from super.getTaskPropertyValues() and the values of their own task-specific properties.

Overrides:

getTaskPropertyValues in class Task

Returns:

A map of the task property values for this task.