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

Class PopulateComposedAttributeValuesTask

java.lang.Object
com.unboundid.ldap.sdk.unboundidds.tasks.Task
com.unboundid.ldap.sdk.unboundidds.tasks.PopulateComposedAttributeValuesTask
All Implemented Interfaces:
Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class PopulateComposedAttributeValuesTask extends Task
This class defines a Directory Server task that can be used to populate the values of a composed attribute in existing entries without the need to export the data to LDIF and re-import it.
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 names or DNs of the configuration entries for the composed attribute plugin instances for which to generate values.
  • The backend IDs of the backends in which the values are to be composed.
  • The maximum number of entries to update per second.
See Also:

  • Constructor Details

    • PopulateComposedAttributeValuesTask

      public PopulateComposedAttributeValuesTask()
      Creates a new uninitialized populate composed attribute values task instance that 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.

    • PopulateComposedAttributeValuesTask

      public PopulateComposedAttributeValuesTask(@Nullable String taskID, @Nullable List<String> pluginConfigs, @Nullable List<String> backendIDs, @Nullable Integer maxRatePerSecond)
      Creates a new populate composed attribute values 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.
      pluginConfigs - The names or DNs of the configuration entries for the composed attribute plugin instances to use to generate values. If this is not specified, then values will be generated for all enabled composed attribute plugin instances defined in the configuration.
      backendIDs - The backend IDs for the backends in which composed values will be generated. If this is not specified, then an appropriate set of backends will be determined from the configurations of the selected plugin instances.
      maxRatePerSecond - The maximum number of entries to update per second. If this is not specified, then no rate limit will be imposed.

    • PopulateComposedAttributeValuesTask

      public PopulateComposedAttributeValuesTask(@Nullable String taskID, @Nullable List<String> pluginConfigs, @Nullable List<String> backendIDs, @Nullable Integer maxRatePerSecond, @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 populate composed attribute values 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.
      pluginConfigs - The names or DNs of the configuration entries for the composed attribute plugin instances to use to generate values. If this is not specified, then values will be generated for all enabled composed attribute plugin instances defined in the configuration.
      backendIDs - The backend IDs for the backends in which composed values will be generated. If this is not specified, then an appropriate set of backends will be determined from the configurations of the selected plugin instances.
      maxRatePerSecond - The maximum number of entries to update per second. If this is not specified, then no rate limit will be imposed.
      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.

    • PopulateComposedAttributeValuesTask

      public PopulateComposedAttributeValuesTask(@NotNull Entry entry) throws TaskException
      Creates a new populate composed attribute values task from the provided entry.
      Parameters:
      entry - The entry to use to create this populate composed attribute values task.
      Throws:
      TaskException - If the provided entry cannot be parsed as a populate composed attribute values task entry.

    • PopulateComposedAttributeValuesTask

      public PopulateComposedAttributeValuesTask(@NotNull Map<TaskProperty,List<Object>> properties) throws TaskException
      Creates a populate composed attribute values 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 populate composed attribute values 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.

    • getPluginConfigs

      @NotNull public List<String> getPluginConfigs()
      Retrieves a list of the names or DNs of the configuration entries for the composed attribute plugin instances for which to generate values.
      Returns:
      A list of the names or DNs of the configuration entries for the composed attribute plugin instances for which to generate values, or an empty list if the server should generate composed values for all enabled composed attribute plugin instances defined in the configuration.

    • getBackendIDs

      @NotNull public List<String> getBackendIDs()
      Retrieves a list of the backend IDs for the backends in which to generate composed values.
      Returns:
      A list of the backend IDs for the backends in which to generate composed values, or an empty list if the server should determine an appropriate set of backends from the configurations of the selected plugin instances.

    • getMaxRatePerSecond

      @Nullable public Integer getMaxRatePerSecond()
      Retrieves the maximum number of entries per second for which composed values should be generated.
      Returns:
      The maximum number of entries per second for which composed values should be generated, or null if no rate limit should be imposed.

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