com.unboundid.ldap.sdk.unboundidds.tasks
Class RestoreTask

java.lang.Object
  extended by com.unboundid.ldap.sdk.unboundidds.tasks.Task
      extended by com.unboundid.ldap.sdk.unboundidds.tasks.RestoreTask
All Implemented Interfaces:
java.io.Serializable

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

NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.
This class defines a Directory Server task that can be used to restore a backup. The properties that are available for use with this type of task include:

See Also:
Serialized Form

Constructor Summary
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.
 
Method Summary
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 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.
 
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.tasks.Task
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
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

RestoreTask

public 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. Attempts to use a task created with this constructor for any other reason will likely fail.


RestoreTask

public RestoreTask(java.lang.String taskID,
                   java.lang.String backupDirectory,
                   java.lang.String backupID,
                   boolean verifyOnly)
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 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.

RestoreTask

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)
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 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.

RestoreTask

public RestoreTask(Entry entry)
            throws TaskException
Creates a new restore task from the provided entry.

Parameters:
entry - The entry to use to create this restore task.
Throws:
TaskException - If the provided entry cannot be parsed as a restore task entry.

RestoreTask

public RestoreTask(java.util.Map<TaskProperty,java.util.List<java.lang.Object>> properties)
            throws TaskException
Creates a new restore 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 restore task.
Method Detail

getTaskName

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

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

public java.lang.String getBackupDirectory()
Retrieves the path to the backup directory which contains the backup to restore. It may be either an absolute path or one that is relative to the server root.

Returns:
The path to the backup directory which contains the backup to restore.

getBackupID

public java.lang.String getBackupID()
Retrieves the backup ID of the backup to restore.

Returns:
The backup ID of the backup to restore, or null if the most recent backup in the backup directory should be restored.

verifyOnly

public boolean verifyOnly()
Indicates whether the backup should only be verified without actually being restored.

Returns:
true if the backup should be verified but not restored, or false if it should be restored.

getAdditionalObjectClasses

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

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

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

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.