@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class RestoreTask extends Task
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 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.
Constructor and Description |
---|
RestoreTask()
Creates a new uninitialized restore task instance which should only be used
for obtaining general information about this task, including the task name,
description, and supported properties.
|
RestoreTask(Entry entry)
Creates a new restore task from the provided entry.
|
RestoreTask(java.util.Map<TaskProperty,java.util.List<java.lang.Object>> properties)
Creates a new restore task from the provided set of task properties.
|
RestoreTask(java.lang.String taskID,
java.lang.String backupDirectory,
java.lang.String backupID,
boolean verifyOnly)
Creates a new restore task with the provided information.
|
RestoreTask(java.lang.String taskID,
java.lang.String backupDirectory,
java.lang.String backupID,
boolean verifyOnly,
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.
|
RestoreTask(java.lang.String taskID,
java.lang.String backupDirectory,
java.lang.String backupID,
boolean verifyOnly,
java.lang.String encryptionPassphraseFile,
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.
|
Modifier and Type | Method and Description |
---|---|
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.lang.String |
getBackupDirectory()
Retrieves the path to the backup directory which contains the backup to
restore.
|
java.lang.String |
getBackupID()
Retrieves the backup ID of the backup to restore.
|
java.lang.String |
getEncryptionPassphraseFile()
Retrieves the path to a file that contains the passphrase to use to
generate the encryption key.
|
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 |
verifyOnly()
Indicates whether the backup should only be verified without actually being
restored.
|
createTaskEntry, decodeTask, getActualStartTime, getAvailableTaskTypes, getCommonTaskProperties, getCompletionTime, getDependencyIDs, getFailedDependencyAction, getLogMessages, getNotifyOnCompletionAddresses, getNotifyOnErrorAddresses, getScheduledStartTime, getState, getTaskClassName, getTaskEntry, getTaskEntryDN, getTaskID, isCompleted, isPending, isRunning, parseBoolean, parseBooleanValue, parseDate, parseLong, parseString, parseStringList, parseStrings, toString, toString
public RestoreTask()
public RestoreTask(java.lang.String taskID, java.lang.String backupDirectory, java.lang.String backupID, boolean verifyOnly)
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 containing
the backup to restore. It may be an absolute path
or relative to the server root directory. It must
not be null
.backupID
- The backup ID of the backup to restore. If this
is null
then the most recent backup in the
specified backup directory will be restored.verifyOnly
- Indicates whether to only verify the backup
without restoring it.public RestoreTask(java.lang.String taskID, java.lang.String backupDirectory, java.lang.String backupID, boolean verifyOnly, 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)
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
containing the backup to restore. It may
be an absolute path or relative to the
server root directory. It must not be
null
.backupID
- The backup ID of the backup to restore. If
this is null
then the most recent
backup in the specified backup directory
will be restored.verifyOnly
- Indicates whether to only verify the backup
without restoring it.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.public RestoreTask(java.lang.String taskID, java.lang.String backupDirectory, java.lang.String backupID, boolean verifyOnly, java.lang.String encryptionPassphraseFile, 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)
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
containing the backup to restore. It may
be an absolute path or relative to the
server root directory. It must not be
null
.backupID
- The backup ID of the backup to restore.
If this is null
then the most
recent backup in the specified backup
directory will be restored.verifyOnly
- Indicates whether to only verify the
backup without restoring it.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.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.public RestoreTask(Entry entry) throws TaskException
entry
- The entry to use to create this restore task.TaskException
- If the provided entry cannot be parsed as a restore
task entry.public RestoreTask(java.util.Map<TaskProperty,java.util.List<java.lang.Object>> properties) throws TaskException
properties
- The set of task properties and their corresponding
values to use for the task. It must not be
null
.TaskException
- If the provided set of properties cannot be used to
create a valid restore task.public java.lang.String getTaskName()
getTaskName
in class Task
public java.lang.String getTaskDescription()
getTaskDescription
in class Task
public java.lang.String getBackupDirectory()
public java.lang.String getBackupID()
null
if the
most recent backup in the backup directory should be restored.public boolean verifyOnly()
true
if the backup should be verified but not restored, or
false
if it should be restored.public java.lang.String getEncryptionPassphraseFile()
null
if the backup is
not encrypted or if the encryption key should be obtained through
some other means.protected java.util.List<java.lang.String> getAdditionalObjectClasses()
getAdditionalObjectClasses
in class Task
protected java.util.List<Attribute> getAdditionalAttributes()
getAdditionalAttributes
in class Task
public java.util.List<TaskProperty> getTaskSpecificProperties()
getTaskSpecificProperties
in class Task
public java.util.Map<TaskProperty,java.util.List<java.lang.Object>> getTaskPropertyValues()
Boolean
,
Date
, Long
, or String
. Task properties which do
not have any values will be included in the map with an empty value list.
super.getTaskPropertyValues()
and the
values of their own task-specific properties.getTaskPropertyValues
in class Task