Class ExportTaskProperties

java.lang.Object
com.unboundid.ldap.sdk.unboundidds.tasks.ExportTaskProperties

This class defines a set of properties that may be used in conjunction with an LDIF export administrative 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 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.
  • Constructor Summary

    Constructors
    Constructor
    Description
    Creates a new set of export task properties from the settings for the provided task.
    Creates a new set of export task properties as a copy of the provided set of properties.
    ExportTaskProperties(String backendID, String ldifFile)
    Creates a new set of export task properties without default values for all properties except those specified.
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    Indicates whether to append to an existing LDIF file rather than overwriting it.
    boolean
    Indicates whether the LDIF file should be compressed.
    boolean
    Indicates whether the LDIF file should be encrypted.
    Retrieves the flag that indicates whether the server should send an administrative alert notification if the task does not complete successfully.
    Retrieves the flag that indicates whether the server should send an administrative alert notification when the task starts running.
    Retrieves the flag that indicates whether the server should send an administrative alert notification if the task completes successfully.
    Retrieves the backend ID of the backend to be exported.
    Retrieves the task IDs for any tasks that must complete before the new collect support data task will be eligible to start running.
    Retrieves the path to a file containing the passphrase to use to generate the encryption key.
    Retrieves the ID of the encryption settings definition to use to generate the encryption key.
    Retrieves the names of the attributes to exclude from the exported entries.
    Retrieves the set of base DNs for the subtrees to exclude from the export.
    Retrieves a set of filter strings to use to identify entries to exclude from the export.
    Retrieves the action that the server should take if any of the tasks on which the new task depends did not complete successfully.
    Retrieves the names of the attributes to include in the exported entries.
    Retrieves the set of base DNs for the subtrees to include in the export.
    Retrieves a set of filter strings to use to identify entries to include in the export.
    Retrieves the path to the LDIF file to be written.
    Retrieves the maximum rate at which the LDIF file should be written, in megabytes per second.
    Retrieves the addresses to email whenever the task completes, regardless of its success or failure.
    Retrieves the addresses to email if the task does not complete successfully.
    Retrieves the addresses to email whenever the task starts running.
    Retrieves the addresses to email if the task completes successfully.
    Retrieves a list containing the names or DNs of any post-LDIF-export task processors that should be invoked for the export.
    Retrieves the earliest time that the task should be eligible to start running.
    Retrieves the task ID that should be used for the task.
    int
    Retrieves the column at which long lines should be wrapped.
    void
    setAlertOnError(Boolean alertOnError)
    Specifies the flag that indicates whether the server should send an administrative alert notification if the task does not complete successfully.
    void
    setAlertOnStart(Boolean alertOnStart)
    Specifies the flag that indicates whether the server should send an administrative alert notification when the task starts running.
    void
    setAlertOnSuccess(Boolean alertOnSuccess)
    Specifies the flag that indicates whether the server should send an administrative alert notification if the task completes successfully.
    void
    setAppendToLDIF(boolean appendToLDIF)
    Specifies whether to append to an existing LDIF file rather than overwriting it.
    void
    setBackendID(String backendID)
    Specifies the backend ID of the backend to be exported.
    void
    setCompress(boolean compress)
    Specifies whether the LDIF file should be compressed.
    void
    setDependencyIDs(List<String> dependencyIDs)
    Specifies the task IDs for any tasks that must complete before the new collect support data task will be eligible to start running.
    void
    setEncrypt(boolean encrypt)
    Specifies whether the LDIF file should be encrypted.
    void
    setEncryptionPassphraseFile(String encryptionPassphraseFile)
    Specifies the path to a file containing the passphrase to use to generate the encryption key.
    void
    setEncryptionSettingsDefinitionID(String encryptionSettingsDefinitionID)
    Specifies the ID of the encryption settings definition to use to generate the encryption key.
    void
    setExcludeAttributes(List<String> excludeAttributes)
    Specifies the names of the attributes to exclude from the exported entries.
    void
    setExcludeBranches(List<String> excludeBranches)
    Specifies the set of base DNs for the subtrees to exclude from the export.
    void
    setExcludeFilters(List<String> excludeFilters)
    Specifies a set of filter strings to use to identify entries to exclude from the export.
    void
    Specifies the action that the server should take if any of the tasks on which the new task depends did not complete successfully.
    void
    setIncludeAttributes(List<String> includeAttributes)
    Specifies the names of the attributes to include in the exported entries.
    void
    setIncludeBranches(List<String> includeBranches)
    Specifies the set of base DNs for the subtrees to include in the export.
    void
    setIncludeFilters(List<String> includeFilters)
    Specifies a set of filter strings to use to identify entries to include in the export.
    void
    setLDIFFile(String ldifFile)
    Specifies the path to the LDIF file to be written.
    void
    setMaxMegabytesPerSecond(Integer maxMegabytesPerSecond)
    Specifies the maximum rate at which the LDIF file should be written, in megabytes per second.
    void
    setNotifyOnCompletion(List<String> notifyOnCompletion)
    Specifies the addresses to email whenever the task completes, regardless of its success or failure.
    void
    setNotifyOnError(List<String> notifyOnError)
    Specifies the addresses to email if the task does not complete successfully.
    void
    setNotifyOnStart(List<String> notifyOnStart)
    Specifies the addresses to email whenever the task starts running.
    void
    setNotifyOnSuccess(List<String> notifyOnSuccess)
    Specifies the addresses to email if the task completes successfully.
    void
    setPostExportTaskProcessors(List<String> postExportTaskProcessors)
    Specifies a list containing the names or DNs of any post-LDIF-export task processors that should be invoked for the export.
    void
    setScheduledStartTime(Date scheduledStartTime)
    Specifies the earliest time that the task should be eligible to start running.
    void
    setSign(boolean sign)
    Specifies whether the LDIF file should be cryptographically signed.
    void
    setTaskID(String taskID)
    Specifies the task ID that should be used for the task.
    void
    setWrapColumn(int wrapColumn)
    Specifies the column at which long lines should be wrapped.
    boolean
    Indicates whether the LDIF file should be cryptographically signed.
    Retrieves a string representation of this collect support data task properties object.
    void
    Appends a string representation of this collect support data task properties object to the provided buffer.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • ExportTaskProperties

      public ExportTaskProperties(@NotNull String backendID, @NotNull String ldifFile)
      Creates a new set of export task properties without default values for all properties except those specified.
      Parameters:
      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.
    • ExportTaskProperties

      Creates a new set of export task properties as a copy of the provided set of properties.
      Parameters:
      properties - The export task properties that should be used to create the new export task properties object. It must not be null.
    • ExportTaskProperties

      Creates a new set of export task properties from the settings for the provided task.
      Parameters:
      task - The export task to use to create the task properties.
  • Method Details

    • getBackendID

      Retrieves the backend ID of the backend to be exported.
      Returns:
      The backend ID of the backend to be exported.
    • setBackendID

      public void setBackendID(@NotNull String backendID)
      Specifies the backend ID of the backend to be exported.
      Parameters:
      backendID - The backend ID of the backend to be exported. It must not be null.
    • getLDIFFile

      Retrieves the path to the LDIF file to be written.
      Returns:
      The path to the LDIF file to be written.
    • setLDIFFile

      public void setLDIFFile(@NotNull String ldifFile)
      Specifies the path to the LDIF file to be written.
      Parameters:
      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

      public boolean appendToLDIF()
      Indicates whether to append to an existing LDIF file rather than overwriting it.
      Returns:
      true if the export should append to an existing LDIF file, or false if the existing file should be overwritten.
    • setAppendToLDIF

      public void setAppendToLDIF(boolean appendToLDIF)
      Specifies whether to append to an existing LDIF file rather than overwriting it.
      Parameters:
      appendToLDIF - Indicates whether to append to an existing LDIF file rather than overwriting it.
    • getIncludeBranches

      Retrieves the set of base DNs for the subtrees to include in the export.
      Returns:
      The set of base DNs for the subtrees to include in the export, or an empty list if no include base DNs should be specified.
    • setIncludeBranches

      public void setIncludeBranches(@Nullable List<String> includeBranches)
      Specifies the set of base DNs for the subtrees to include in the export.
      Parameters:
      includeBranches - The set of base DNs for the subtrees to include in the export. It may be null or empty if no include branches should be specified.
    • getExcludeBranches

      Retrieves the set of base DNs for the subtrees to exclude from the export.
      Returns:
      The set of base DNs for the subtrees to exclude from the export, or an empty list if no exclude base DNs should be specified.
    • setExcludeBranches

      public void setExcludeBranches(@Nullable List<String> excludeBranches)
      Specifies the set of base DNs for the subtrees to exclude from the export.
      Parameters:
      excludeBranches - The set of base DNs for the subtrees to exclude from the export. It may be null or empty if no exclude branches should be specified.
    • getIncludeFilters

      Retrieves a set of filter strings to use to identify entries to include in the export.
      Returns:
      A set of filter strings to use to identify entries to include in the export, or an empty list if no include filters should be specified.
    • setIncludeFilters

      public void setIncludeFilters(@Nullable List<String> includeFilters)
      Specifies a set of filter strings to use to identify entries to include in the export.
      Parameters:
      includeFilters - A set of filter strings to use to identify entries to include in the export. It may be null or empty if no include filters should be specified.
    • getExcludeFilters

      Retrieves a set of filter strings to use to identify entries to exclude from the export.
      Returns:
      A set of filter strings to use to identify entries to exclude from the export, or an empty list if no exclude filters should be specified.
    • setExcludeFilters

      public void setExcludeFilters(@Nullable List<String> excludeFilters)
      Specifies a set of filter strings to use to identify entries to exclude from the export.
      Parameters:
      excludeFilters - A set of filter strings to use to identify entries to exclude from the export. It may be null or empty if no exclude filters should be specified.
    • getIncludeAttributes

      Retrieves the names of the attributes to include in the exported entries.
      Returns:
      The names of the attributes to include in the exported entries, or an empty list if no include attributes should be specified.
    • setIncludeAttributes

      public void setIncludeAttributes(@Nullable List<String> includeAttributes)
      Specifies the names of the attributes to include in the exported entries.
      Parameters:
      includeAttributes - The names of the attributes to include in the exported entries. It may be null or empty if no include attributes should be specified.
    • getExcludeAttributes

      Retrieves the names of the attributes to exclude from the exported entries.
      Returns:
      The names of the attributes to exclude from the exported entries, or an empty list if no exclude attributes should be specified.
    • setExcludeAttributes

      public void setExcludeAttributes(@Nullable List<String> excludeAttributes)
      Specifies the names of the attributes to exclude from the exported entries.
      Parameters:
      excludeAttributes - The names of the attributes to exclude from the exported entries. It may be null or empty if no exclude attributes should be specified.
    • getWrapColumn

      public int getWrapColumn()
      Retrieves the column at which long lines should be wrapped.
      Returns:
      The column at which long lines should be wrapped, or -1 if long lines should not be wrapped.
    • setWrapColumn

      public void setWrapColumn(int wrapColumn)
      Specifies the column at which long lines should be wrapped.
      Parameters:
      wrapColumn - The column at which long lines should be wrapped. It may be less than or equal to zero if long lines should not be wrapped.
    • compress

      public boolean compress()
      Indicates whether the LDIF file should be compressed.
      Returns:
      true if the LDIF file should be compressed, or false if not.
    • setCompress

      public void setCompress(boolean compress)
      Specifies whether the LDIF file should be compressed.
      Parameters:
      compress - Indicates whether the LDIF file should be compressed.
    • encrypt

      public boolean encrypt()
      Indicates whether the LDIF file should be encrypted.
      Returns:
      true if the LDIF file should be encrypted, or false if not.
    • setEncrypt

      public void setEncrypt(boolean encrypt)
      Specifies whether the LDIF file should be encrypted.
      Parameters:
      encrypt - Indicates whether the LDIF file should be encrypted.
    • getEncryptionPassphraseFile

      Retrieves the path to a file containing the passphrase to use to generate the encryption key.
      Returns:
      The path to a file containing the passphrase to use to generate the encryption key, or null if the LDIF file should not be encrypted or if it should be encrypted with a key obtained through some other means.
    • setEncryptionPassphraseFile

      public void setEncryptionPassphraseFile(@Nullable String encryptionPassphraseFile)
      Specifies the path to a file containing the passphrase to use to generate the encryption key.
      Parameters:
      encryptionPassphraseFile - The path to a file containing the passphrase to use to generate the encryption key. It may be null if the LDIF file should not be encrypted or if it should be encrypted with a key obtained through some other means.
    • getEncryptionSettingsDefinitionID

      Retrieves the ID of the encryption settings definition to use to generate the encryption key.
      Returns:
      The ID of the encryption settings definition to use to generate the encryption key, or null if the LDIF file should not be encrypted, if it should be encrypted with the server's preferred encryption settings definition, or if it should be encrypted with a key obtained through some other means.
    • setEncryptionSettingsDefinitionID

      public void setEncryptionSettingsDefinitionID(@Nullable String encryptionSettingsDefinitionID)
      Specifies the ID of the encryption settings definition to use to generate the encryption key.
      Parameters:
      encryptionSettingsDefinitionID - The ID of the encryption settings definition to use to generate the encryption key. It may be null if the LDIF file should not be encrypted, if it should be encrypted with the server's preferred encryption settings definition, or if it should be encrypted with a key obtained through some other means.
    • sign

      public boolean sign()
      Indicates whether the LDIF file should be cryptographically signed.
      Returns:
      true if the LDIF file should be cryptographically signed, or false if not.
    • setSign

      public void setSign(boolean sign)
      Specifies whether the LDIF file should be cryptographically signed.
      Parameters:
      sign - Indicates whether the LDIF file should be cryptographically signed.
    • getMaxMegabytesPerSecond

      Retrieves the maximum rate at which the LDIF file should be written, in megabytes per second.
      Returns:
      The maximum rate at which the LDIF file should be written, in megabytes per second, or null if no rate limiting should be used.
    • setMaxMegabytesPerSecond

      public void setMaxMegabytesPerSecond(@Nullable Integer maxMegabytesPerSecond)
      Specifies the maximum rate at which the LDIF file should be written, in megabytes per second.
      Parameters:
      maxMegabytesPerSecond - The maximum rate at which the LDIF file should be written, in megabytes per second. A value of null, or one that is less than or equal to zero, indicates that no rate limiting should be used.
    • 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.
    • setPostExportTaskProcessors

      public void setPostExportTaskProcessors(@Nullable List<String> postExportTaskProcessors)
      Specifies a list containing the names or DNs of any post-LDIF-export task processors that should be invoked for the export.
      Parameters:
      postExportTaskProcessors - A list containing the names or DNs of any post-LDIF-export task processors that should be invoked for the export. It may be null or empty if no post-LDIF-export task processors should be invoked.
    • getTaskID

      Retrieves the task ID that should be used for the task.
      Returns:
      The task ID that should be used for the task, or null if a random UUID should be generated for use as the task ID.
    • setTaskID

      public void setTaskID(@Nullable String taskID)
      Specifies the task ID that should be used for the task.
      Parameters:
      taskID - The task ID that should be used for the task. It may be null if a random UUID should be generated for use as the task ID.
    • getScheduledStartTime

      Retrieves the earliest time that the task should be eligible to start running.
      Returns:
      The earliest time that the task should be eligible to start running, or null if the task should be eligible to start immediately (or as soon as all of its dependencies have been satisfied).
    • setScheduledStartTime

      public void setScheduledStartTime(@Nullable Date scheduledStartTime)
      Specifies the earliest time that the task should be eligible to start running.
      Parameters:
      scheduledStartTime - The earliest time that the task should be eligible to start running. It may be null if the task should be eligible to start immediately (or as soon as all of its dependencies have been satisfied).
    • getDependencyIDs

      Retrieves the task IDs for any tasks that must complete before the new collect support data task will be eligible to start running.
      Returns:
      The task IDs for any tasks that must complete before the new collect support data task will be eligible to start running, or an empty list if the new task should not depend on any other tasks.
    • setDependencyIDs

      public void setDependencyIDs(@Nullable List<String> dependencyIDs)
      Specifies the task IDs for any tasks that must complete before the new collect support data task will be eligible to start running.
      Parameters:
      dependencyIDs - The task IDs for any tasks that must complete before the new collect support data task will be eligible to start running. It may be null or empty if the new task should not depend on any other tasks.
    • getFailedDependencyAction

      Retrieves the action that the server should take if any of the tasks on which the new task depends did not complete successfully.
      Returns:
      The action that the server should take if any of the tasks on which the new task depends did not complete successfully, or null if the property should not be specified when creating the task (and the server should choose an appropriate failed dependency action).
    • setFailedDependencyAction

      public void setFailedDependencyAction(@Nullable FailedDependencyAction failedDependencyAction)
      Specifies the action that the server should take if any of the tasks on which the new task depends did not complete successfully.
      Parameters:
      failedDependencyAction - The action that the server should take if any of the tasks on which the new task depends did not complete successfully. It may be null if the property should not be specified when creating the task (and the server should choose an appropriate failed dependency action).
    • getNotifyOnStart

      Retrieves the addresses to email whenever the task starts running.
      Returns:
      The addresses to email whenever the task starts running, or an empty list if no email notification should be sent when starting the task.
    • setNotifyOnStart

      public void setNotifyOnStart(@Nullable List<String> notifyOnStart)
      Specifies the addresses to email whenever the task starts running.
      Parameters:
      notifyOnStart - The addresses to email whenever the task starts running. It amy be null or empty if no email notification should be sent when starting the task.
    • getNotifyOnCompletion

      Retrieves the addresses to email whenever the task completes, regardless of its success or failure.
      Returns:
      The addresses to email whenever the task completes, or an empty list if no email notification should be sent when the task completes.
    • setNotifyOnCompletion

      public void setNotifyOnCompletion(@Nullable List<String> notifyOnCompletion)
      Specifies the addresses to email whenever the task completes, regardless of its success or failure.
      Parameters:
      notifyOnCompletion - The addresses to email whenever the task completes. It amy be null or empty if no email notification should be sent when the task completes.
    • getNotifyOnSuccess

      Retrieves the addresses to email if the task completes successfully.
      Returns:
      The addresses to email if the task completes successfully, or an empty list if no email notification should be sent on successful completion.
    • setNotifyOnSuccess

      public void setNotifyOnSuccess(@Nullable List<String> notifyOnSuccess)
      Specifies the addresses to email if the task completes successfully.
      Parameters:
      notifyOnSuccess - The addresses to email if the task completes successfully. It amy be null or empty if no email notification should be sent on successful completion.
    • getNotifyOnError

      Retrieves the addresses to email if the task does not complete successfully.
      Returns:
      The addresses to email if the task does not complete successfully, or an empty list if no email notification should be sent on an unsuccessful completion.
    • setNotifyOnError

      public void setNotifyOnError(@Nullable List<String> notifyOnError)
      Specifies the addresses to email if the task does not complete successfully.
      Parameters:
      notifyOnError - The addresses to email if the task does not complete successfully. It amy be null or empty if no email notification should be sent on an unsuccessful completion.
    • getAlertOnStart

      Retrieves the flag that indicates whether the server should send an administrative alert notification when the task starts running.
      Returns:
      The flag that indicates whether the server should send an administrative alert notification when the task starts running, or null if the property should not be specified when the task is created (and the server will default to not sending any alert).
    • setAlertOnStart

      public void setAlertOnStart(@Nullable Boolean alertOnStart)
      Specifies the flag that indicates whether the server should send an administrative alert notification when the task starts running.
      Parameters:
      alertOnStart - The flag that indicates whether the server should send an administrative alert notification when the task starts running, It may be null if the property should not be specified when the task is created (and the server will default to not sending any alert).
    • getAlertOnSuccess

      Retrieves the flag that indicates whether the server should send an administrative alert notification if the task completes successfully.
      Returns:
      The flag that indicates whether the server should send an administrative alert notification if the task completes successfully, or null if the property should not be specified when the task is created (and the server will default to not sending any alert).
    • setAlertOnSuccess

      public void setAlertOnSuccess(@Nullable Boolean alertOnSuccess)
      Specifies the flag that indicates whether the server should send an administrative alert notification if the task completes successfully.
      Parameters:
      alertOnSuccess - The flag that indicates whether the server should send an administrative alert notification if the task completes successfully, It may be null if the property should not be specified when the task is created (and the server will default to not sending any alert).
    • getAlertOnError

      Retrieves the flag that indicates whether the server should send an administrative alert notification if the task does not complete successfully.
      Returns:
      The flag that indicates whether the server should send an administrative alert notification if the task does not complete successfully, or null if the property should not be specified when the task is created (and the server will default to not sending any alert).
    • setAlertOnError

      public void setAlertOnError(@Nullable Boolean alertOnError)
      Specifies the flag that indicates whether the server should send an administrative alert notification if the task does not complete successfully.
      Parameters:
      alertOnError - The flag that indicates whether the server should send an administrative alert notification if the task does not complete successfully, It may be null if the property should not be specified when the task is created (and the server will default to not sending any alert).
    • toString

      Retrieves a string representation of this collect support data task properties object.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this collect support data task properties object.
    • toString

      public void toString(@NotNull StringBuilder buffer)
      Appends a string representation of this collect support data task properties object to the provided buffer.
      Parameters:
      buffer - The buffer to which the string representation will be appended. It must not be null.