Package com.unboundid.ldap.sdk.unboundidds.tasks

Class ReEncodeEntriesTask

java.lang.Object
com.unboundid.ldap.sdk.unboundidds.tasks.Task
com.unboundid.ldap.sdk.unboundidds.tasks.ReEncodeEntriesTask
All Implemented Interfaces:
Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class ReEncodeEntriesTask extends Task
This class defines a Directory Server task that can be used to cause entries contained in a local DB backend to be re-encoded, which may be used to apply any configuration changes that affect the encoding of that entry (e.g., if the entry should be encrypted, hashed, compressed, or fully or partially uncached; or if these settings should be reverted).
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 of the backend in which entries should be re-encoded. This must be provided.
  • The base DN of a branch of entries to include in the re-encode processing.
  • The base DN of a branch of entries to exclude from the re-encode processing.
  • A filter to use to identify entries to include in the re-encode processing.
  • A filter to use to identify entries to exclude from the re-encode processing.
  • The maximum rate at which to re-encode entries, in number of entries per second.
  • An indication as to whether to skip entries that are fully uncached.
  • An indication as to whether to skip entries that are partially uncached.
See Also:

  • Constructor Details

    • ReEncodeEntriesTask

      public ReEncodeEntriesTask()
      Creates a new uninitialized re-encode entries 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.

    • ReEncodeEntriesTask

      public ReEncodeEntriesTask(@Nullable String taskID, @NotNull String backendID, @Nullable List<String> includeBranches, @Nullable List<String> excludeBranches, @Nullable List<String> includeFilters, @Nullable List<String> excludeFilters, @Nullable Long maxEntriesPerSecond, boolean skipFullyUncachedEntries, boolean skipPartiallyUncachedEntries)
      Creates a new re-encode entries 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 entries to re-encode. It must not be null.
      includeBranches - A list containing the base DNs of branches to include in re-encode processing. It may be null or empty if there should not be any include branches.
      excludeBranches - A list containing the base DNs of branches to exclude from re-encode processing. It may be null or empty if there should not be any exclude branches.
      includeFilters - A list containing filters to use to identify entries to include in re-encode processing. It may be null or empty if there should not be any include filters.
      excludeFilters - A list containing filters to use to identify entries to exclude from re-encode processing. It may be null or empty if there should not be any exclude filters.
      maxEntriesPerSecond - The maximum number of entries to re-encode per second. It may be null to indicate that no limit should be imposed.
      skipFullyUncachedEntries - Indicates whether to skip re-encode processing for entries that are fully uncached.
      skipPartiallyUncachedEntries - Indicates whether to skip re-encode processing for entries that contain a mix of cached and uncached attributes.

    • ReEncodeEntriesTask

      public ReEncodeEntriesTask(@Nullable String taskID, @NotNull String backendID, @Nullable List<String> includeBranches, @Nullable List<String> excludeBranches, @Nullable List<String> includeFilters, @Nullable List<String> excludeFilters, @Nullable Long maxEntriesPerSecond, boolean skipFullyUncachedEntries, boolean skipPartiallyUncachedEntries, @Nullable Date scheduledStartTime, @Nullable List<String> dependencyIDs, @Nullable FailedDependencyAction failedDependencyAction, @Nullable List<String> notifyOnCompletion, @Nullable List<String> notifyOnError)
      Creates a new re-encode entries 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 entries to re-encode. It must not be null.
      includeBranches - A list containing the base DNs of branches to include in re-encode processing. It may be null or empty if there should not be any include branches.
      excludeBranches - A list containing the base DNs of branches to exclude from re-encode processing. It may be null or empty if there should not be any exclude branches.
      includeFilters - A list containing filters to use to identify entries to include in re-encode processing. It may be null or empty if there should not be any include filters.
      excludeFilters - A list containing filters to use to identify entries to exclude from re-encode processing. It may be null or empty if there should not be any exclude filters.
      maxEntriesPerSecond - The maximum number of entries to re-encode per second. It may be null to indicate that no limit should be imposed.
      skipFullyUncachedEntries - Indicates whether to skip re-encode processing for entries that are fully uncached.
      skipPartiallyUncachedEntries - Indicates whether to skip re-encode processing for entries that contain a mix of cached and uncached attributes.
      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.

    • ReEncodeEntriesTask

      public ReEncodeEntriesTask(@Nullable String taskID, @NotNull String backendID, @Nullable List<String> includeBranches, @Nullable List<String> excludeBranches, @Nullable List<String> includeFilters, @Nullable List<String> excludeFilters, @Nullable Long maxEntriesPerSecond, boolean skipFullyUncachedEntries, boolean skipPartiallyUncachedEntries, @Nullable Date scheduledStartTime, @Nullable List<String> dependencyIDs, @Nullable FailedDependencyAction failedDependencyAction, @Nullable List<String> notifyOnStart, @Nullable List<String> notifyOnCompletion, @Nullable List<String> notifyOnSuccess, @Nullable List<String> notifyOnError, @Nullable Boolean alertOnStart, @Nullable Boolean alertOnSuccess, @Nullable Boolean alertOnError)
      Creates a new re-encode entries 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 entries to re-encode. It must not be null.
      includeBranches - A list containing the base DNs of branches to include in re-encode processing. It may be null or empty if there should not be any include branches.
      excludeBranches - A list containing the base DNs of branches to exclude from re-encode processing. It may be null or empty if there should not be any exclude branches.
      includeFilters - A list containing filters to use to identify entries to include in re-encode processing. It may be null or empty if there should not be any include filters.
      excludeFilters - A list containing filters to use to identify entries to exclude from re-encode processing. It may be null or empty if there should not be any exclude filters.
      maxEntriesPerSecond - The maximum number of entries to re-encode per second. It may be null to indicate that no limit should be imposed.
      skipFullyUncachedEntries - Indicates whether to skip re-encode processing for entries that are fully uncached.
      skipPartiallyUncachedEntries - Indicates whether to skip re-encode processing for entries that contain a mix of cached and uncached attributes.
      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.

    • ReEncodeEntriesTask

      public ReEncodeEntriesTask(@NotNull Entry entry) throws TaskException
      Creates a new re-encode entries task from the provided entry.
      Parameters:
      entry - The entry to use to create this re-encode entries task.
      Throws:
      TaskException - If the provided entry cannot be parsed as a re-encode entries task entry.

    • ReEncodeEntriesTask

      public ReEncodeEntriesTask(@NotNull Map<TaskProperty,List<Object>> properties) throws TaskException
      Creates a new re-encode entries 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 re-encode entries task.

  • Method Details

    • getTaskName

      @NotNull public 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 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 String getBackendID()
      Retrieves the backend ID for the backend containing the entries to re-encode.
      Returns:
      The backend ID for the backend containing the entries to re-encode.

    • getIncludeBranches

      @NotNull public List<String> getIncludeBranches()
      Retrieves the base DNs of the branches to include in re-encode processing, if defined.
      Returns:
      The base DNs of the branches to include in re-encode processing, or an empty list if there should not be any include branches.

    • getExcludeBranches

      @NotNull public List<String> getExcludeBranches()
      Retrieves the base DNs of the branches to exclude from re-encode processing, if defined.
      Returns:
      The base DNs of the branches to exclude from re-encode processing, or an empty list if there should not be any exclude branches.

    • getIncludeFilters

      @NotNull public List<String> getIncludeFilters()
      Retrieves a set of filters to use to identify entries to include in re-encode processing, if defined.
      Returns:
      A set of filters to use to identify entries to include in re-encode processing, or an empty list if there should not be any include filters.

    • getExcludeFilters

      @NotNull public List<String> getExcludeFilters()
      Retrieves a set of filters to use to identify entries to exclude from re-encode processing, if defined.
      Returns:
      A set of filters to use to identify entries to exclude from re-encode processing, or an empty list if there should not be any exclude filters.

    • getMaxEntriesPerSecond

      @Nullable public Long getMaxEntriesPerSecond()
      Retrieves the maximum number of entries that should be re-encoded per second, if defined.
      Returns:
      The maximum number of entries that should be re-encoded per second, or null if no rate limit should be imposed.

    • skipFullyUncachedEntries

      public boolean skipFullyUncachedEntries()
      Indicates whether to skip re-encode processing for entries that are stored as fully uncached.
      Returns:
      true if fully uncached entries should be skipped, or false if not.

    • skipPartiallyUncachedEntries

      public boolean skipPartiallyUncachedEntries()
      Indicates whether to skip re-encode processing for entries that have a mix of cached and uncached attributes.
      Returns:
      true if partially uncached entries should be skipped, or false if not.

    • getAdditionalObjectClasses

      @NotNull protected List<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 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 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 Map<TaskProperty,List<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.