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

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

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class ExportTask
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 export the contents of a backend to LDIF. The properties that are available for use with this type of task include:

See Also:
Serialized Form

Constructor Summary
ExportTask()
          Creates a new uninitialized export task instance which should only be used for obtaining general information about this task, including the task name, description, and supported properties.
ExportTask(Entry entry)
          Creates a new export task from the provided entry.
ExportTask(java.util.Map<TaskProperty,java.util.List<java.lang.Object>> properties)
          Creates a new export task from the provided set of task properties.
ExportTask(java.lang.String taskID, java.lang.String backendID, java.lang.String ldifFile)
          Creates a new export task with the provided information.
ExportTask(java.lang.String taskID, java.lang.String backendID, java.lang.String ldifFile, boolean appendToLDIF, java.util.List<java.lang.String> includeBranches, java.util.List<java.lang.String> excludeBranches, java.util.List<java.lang.String> includeFilters, java.util.List<java.lang.String> excludeFilters, java.util.List<java.lang.String> includeAttributes, java.util.List<java.lang.String> excludeAttributes, int wrapColumn, boolean compress, boolean encrypt, boolean sign, 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 export task with the provided information.
 
Method Summary
 boolean appendToLDIF()
          Indicates whether to append to the LDIF file rather than overwriting it if it already exists.
 boolean compress()
          Indicates whether the LDIF data should be compressed as it is exported.
 boolean encrypt()
          Indicates whether the LDIF data should be encrypted as it is exported.
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 getBackendID()
          Retrieves the backend ID of the backend from which the data is to be exported.
 java.util.List<java.lang.String> getExcludeAttributes()
          Retrieves a list of the attributes that should be excluded from exported entries.
 java.util.List<java.lang.String> getExcludeBranches()
          Retrieves a list of base DNs of branches that should be excluded from the export.
 java.util.List<java.lang.String> getExcludeFilters()
          Retrieves a list of search filters that should be used to determine which entries should be excluded from the export.
 java.util.List<java.lang.String> getIncludeAttributes()
          Retrieves a list of the attributes that should be included in exported entries.
 java.util.List<java.lang.String> getIncludeBranches()
          Retrieves a list of base DNs of branches that should be included in the export.
 java.util.List<java.lang.String> getIncludeFilters()
          Retrieves a list of search filters that should be used to determine which entries should be included in the export.
 java.lang.String getLDIFFile()
          Retrieves the path to the LDIF file to which the exported data should be written.
 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.
 int getWrapColumn()
          Retrieves the column number at which long lines should be wrapped.
 boolean sign()
          Indicates whether the exported LDIF data should include a signed hash.
 
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

ExportTask

public ExportTask()
Creates a new uninitialized export 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.


ExportTask

public ExportTask(java.lang.String taskID,
                  java.lang.String backendID,
                  java.lang.String ldifFile)
Creates a new export 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.
backendID - The backend ID of the backend containing the data to export. It must not be null.
ldifFile - The path to the LDIF file to create. It may be an absolute path or a path relative to the server install root. It must not be null.

ExportTask

public ExportTask(java.lang.String taskID,
                  java.lang.String backendID,
                  java.lang.String ldifFile,
                  boolean appendToLDIF,
                  java.util.List<java.lang.String> includeBranches,
                  java.util.List<java.lang.String> excludeBranches,
                  java.util.List<java.lang.String> includeFilters,
                  java.util.List<java.lang.String> excludeFilters,
                  java.util.List<java.lang.String> includeAttributes,
                  java.util.List<java.lang.String> excludeAttributes,
                  int wrapColumn,
                  boolean compress,
                  boolean encrypt,
                  boolean sign,
                  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 export 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.
backendID - The backend ID of the backend to be exported. It must not be null.
ldifFile - The path to the LDIF file to be written. It may be an absolute path or one that is relative to the server root. It must not be null.
appendToLDIF - Indicates whether to an append to any existing file rather than overwriting it.
includeBranches - The set of base DNs of entries to include in the export. It may be null or empty if no entries should be excluded based on their location.
excludeBranches - The set of base DNs of entries to exclude from the export. It may be null or empty if no entries should be excluded based on their location.
includeFilters - The set of filters to use to match entries that should be included in the export. It may be null or empty if no entries should be excluded based on their content.
excludeFilters - The set of filters to use to match entries that should be excluded from the export. It may be null or empty if no entries should be excluded based on their content.
includeAttributes - The set of attributes that should be included in exported entries. It may be null or empty if all attributes should be included.
excludeAttributes - The set of attributes that should be excluded from exported entries. It may be null or empty if no attributes should be excluded.
wrapColumn - The column at which long lines should be wrapped. It may be less than or equal to zero to indicate that long lines should not be wrapped.
compress - Indicates whether the LDIF data should be compressed as it is written.
encrypt - Indicates whether the LDIF data should be encrypted as it is written.
sign - Indicates whether to include a signed hash of the content in the exported data.
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.

ExportTask

public ExportTask(Entry entry)
           throws TaskException
Creates a new export task from the provided entry.

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

ExportTask

public ExportTask(java.util.Map<TaskProperty,java.util.List<java.lang.Object>> properties)
           throws TaskException
Creates a new export 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 export 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.

getBackendID

public java.lang.String getBackendID()
Retrieves the backend ID of the backend from which the data is to be exported.

Returns:
The backend ID of the backend from which the data is to be exported.

getLDIFFile

public java.lang.String getLDIFFile()
Retrieves the path to the LDIF file to which the exported data should be written. It may be either an absolute path or one that is relative to the server root.

Returns:
The path to the LDIF file to which the exported data should be written.

appendToLDIF

public boolean appendToLDIF()
Indicates whether to append to the LDIF file rather than overwriting it if it already exists.

Returns:
true if the server should append to an existing LDIF file, or false if the server should overwrite it.

getIncludeBranches

public java.util.List<java.lang.String> getIncludeBranches()
Retrieves a list of base DNs of branches that should be included in the export.

Returns:
A list of base DNs of branches that should be included in the export, or an empty list if no entries should be excluded based on their location.

getExcludeBranches

public java.util.List<java.lang.String> getExcludeBranches()
Retrieves a list of base DNs of branches that should be excluded from the export.

Returns:
A list of base DNs of branches that should be excluded from the export, or an empty list if no entries should be excluded based on their location.

getIncludeFilters

public java.util.List<java.lang.String> getIncludeFilters()
Retrieves a list of search filters that should be used to determine which entries should be included in the export.

Returns:
A list of search filters that should be used to determine which entries should be included in the export, or an empty list if no entries should be excluded based on their content.

getExcludeFilters

public java.util.List<java.lang.String> getExcludeFilters()
Retrieves a list of search filters that should be used to determine which entries should be excluded from the export.

Returns:
A list of search filters that should be used to determine which entries should be excluded from the export, or an empty list if no entries should be excluded based on their content.

getIncludeAttributes

public java.util.List<java.lang.String> getIncludeAttributes()
Retrieves a list of the attributes that should be included in exported entries.

Returns:
A list of the attributes that should be included in exported entries, or an empty list if no attributes should be excluded.

getExcludeAttributes

public java.util.List<java.lang.String> getExcludeAttributes()
Retrieves a list of the attributes that should be excluded from exported entries.

Returns:
A list of the attributes that should be excluded from exported entries, or an empty list if no attributes should be excluded.

getWrapColumn

public int getWrapColumn()
Retrieves the column number at which long lines should be wrapped.

Returns:
The column number at which long lines should be wrapped, or a value less than or equal to zero to indicate that no wrapping should be performed.

compress

public boolean compress()
Indicates whether the LDIF data should be compressed as it is exported.

Returns:
true if the LDIF data should be compressed as it is exported, or false if not.

encrypt

public boolean encrypt()
Indicates whether the LDIF data should be encrypted as it is exported.

Returns:
true if the LDIF data should be encrypted as it is exported, or false if not.

sign

public boolean sign()
Indicates whether the exported LDIF data should include a signed hash.

Returns:
true if the exported LDIF data should include a signed hash, or false if not.

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.