com.unboundid.ldap.sdk.unboundidds.tasks

Class ExportTask

java.lang.Object

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

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

All Implemented Interfaces:

java.io.Serializable

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

This class defines a Directory Server task that can be used to export the contents of a backend to LDIF.

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 backend ID for the backend from which the data is to be exported. It must be provided when scheduling a task of this type.
• The path (on the server system) and name of the LDIF file to be written. It must be provided when scheduling a task of this type.
• A flag that indicates whether to append to any existing file or to overwrite it.
• An optional list of base DNs for branches that should be included in the export.
• An optional list of base DNs for branches that should be excluded from the export.
• An optional list of filters that may be used to determine whether an entry should be included in the export.
• An optional list of filters that may be used to determine whether an entry should be excluded from the export.
• An optional list of attributes that should be included in entries that are exported.
• An optional list of attributes that should be excluded form entries that are exported.
• An integer value that specifies the column at which long lines should be wrapped. A value less than or equal to zero indicates that no wrapping should be performed.
• A flag that indicates whether to compress the LDIF data as it is written.
• A flag that indicates whether to encrypt the LDIF data as it is written.
• A flag that indicates whether to generate a signature for the LDIF data as it is written.
• 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 LDIF file should be written.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
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(ExportTaskProperties properties) Creates a new export task with the provided set of properties.
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.
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, java.lang.String encryptionPassphraseFile, java.lang.String encryptionSettingsDefinitionID, boolean sign, java.lang.Integer maxMegabytesPerSecond, 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.
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, java.lang.String encryptionPassphraseFile, java.lang.String encryptionSettingsDefinitionID, boolean sign, java.lang.Integer maxMegabytesPerSecond, 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 export task with the provided information.

Method Summary

Modifier and Type	Method and Description
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.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.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.Integer	getMaxMegabytesPerSecond() Retrieves the maximum rate, in megabytes per second, at which the LDIF file should be written.
java.util.List<java.lang.String>	getPostExportTaskProcessors() Retrieves a list containing the names or DNs of any post-LDIF-export task processors that should be invoked for the export.
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, 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

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(@Nullable
                  java.lang.String taskID,
                  @NotNull
                  java.lang.String backendID,
                  @NotNull
                  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(@Nullable
                  java.lang.String taskID,
                  @NotNull
                  java.lang.String backendID,
                  @NotNull
                  java.lang.String ldifFile,
                  boolean appendToLDIF,
                  @Nullable
                  java.util.List<java.lang.String> includeBranches,
                  @Nullable
                  java.util.List<java.lang.String> excludeBranches,
                  @Nullable
                  java.util.List<java.lang.String> includeFilters,
                  @Nullable
                  java.util.List<java.lang.String> excludeFilters,
                  @Nullable
                  java.util.List<java.lang.String> includeAttributes,
                  @Nullable
                  java.util.List<java.lang.String> excludeAttributes,
                  int wrapColumn,
                  boolean compress,
                  boolean encrypt,
                  boolean sign,
                  @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 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(@Nullable
                  java.lang.String taskID,
                  @NotNull
                  java.lang.String backendID,
                  @NotNull
                  java.lang.String ldifFile,
                  boolean appendToLDIF,
                  @Nullable
                  java.util.List<java.lang.String> includeBranches,
                  @Nullable
                  java.util.List<java.lang.String> excludeBranches,
                  @Nullable
                  java.util.List<java.lang.String> includeFilters,
                  @Nullable
                  java.util.List<java.lang.String> excludeFilters,
                  @Nullable
                  java.util.List<java.lang.String> includeAttributes,
                  @Nullable
                  java.util.List<java.lang.String> excludeAttributes,
                  int wrapColumn,
                  boolean compress,
                  boolean encrypt,
                  @Nullable
                  java.lang.String encryptionPassphraseFile,
                  @Nullable
                  java.lang.String encryptionSettingsDefinitionID,
                  boolean sign,
                  @Nullable
                  java.lang.Integer maxMegabytesPerSecond,
                  @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 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.

encryptionPassphraseFile - The path to a file containing the passphrase to use to generate the encryption key. It amy be null if the LDIF file 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 LDIF file is not to be encrypted, or if the key should be obtained in some other way.

sign - Indicates whether to include a signed hash of the content in the exported data.

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

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(@Nullable
                  java.lang.String taskID,
                  @NotNull
                  java.lang.String backendID,
                  @NotNull
                  java.lang.String ldifFile,
                  boolean appendToLDIF,
                  @Nullable
                  java.util.List<java.lang.String> includeBranches,
                  @Nullable
                  java.util.List<java.lang.String> excludeBranches,
                  @Nullable
                  java.util.List<java.lang.String> includeFilters,
                  @Nullable
                  java.util.List<java.lang.String> excludeFilters,
                  @Nullable
                  java.util.List<java.lang.String> includeAttributes,
                  @Nullable
                  java.util.List<java.lang.String> excludeAttributes,
                  int wrapColumn,
                  boolean compress,
                  boolean encrypt,
                  @Nullable
                  java.lang.String encryptionPassphraseFile,
                  @Nullable
                  java.lang.String encryptionSettingsDefinitionID,
                  boolean sign,
                  @Nullable
                  java.lang.Integer maxMegabytesPerSecond,
                  @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 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.

encryptionPassphraseFile - The path to a file containing the passphrase to use to generate the encryption key. It amy be null if the LDIF file 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 LDIF file is not to be encrypted, or if the key should be obtained in some other way.

sign - Indicates whether to include a signed hash of the content in the exported data.

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

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.

ExportTask

public ExportTask(@NotNull
                  ExportTaskProperties properties)

Creates a new export task with the provided set of properties.

Parameters:

properties - The properties to use to create this LDIF export task.

ExportTask

public ExportTask(@NotNull
                  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(@NotNull
                  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

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

getBackendID

@NotNull
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

@NotNull
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

@NotNull
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

@NotNull
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

@NotNull
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

@NotNull
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

@NotNull
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

@NotNull
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.

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 LDIF file 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 LDIF file should not be encrypted or if the encryption key should be obtained through some other means.

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.

getMaxMegabytesPerSecond

@Nullable
public java.lang.Integer getMaxMegabytesPerSecond()

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

Returns:

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

getPostExportTaskProcessors

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

Retrieves a list containing the names or DNs of any post-LDIF-export task processors that should be invoked for the export.

Returns:

A list containing the names or DNs of any post-LDIF-export task processors that should be invoked for the export, or an empty list if no post-LDIF-export task processors should be invoked.

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.