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

Class DelayTask

java.lang.Object
com.unboundid.ldap.sdk.unboundidds.tasks.Task
com.unboundid.ldap.sdk.unboundidds.tasks.DelayTask
All Implemented Interfaces:
Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class DelayTask extends Task
This class defines a Directory Server task that simply sleeps for a specified length of time or until a given condition occurs. It is primarily intended to act as a separator between other tasks in a dependency chain.
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.
See Also:

  • Constructor Details

    • DelayTask

      public DelayTask()
      Creates a new, uninitialized delay 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.

    • DelayTask

      public DelayTask(@Nullable Long sleepDurationMillis, @Nullable Long millisToWaitForWorkQueueToBecomeIdle, @Nullable Collection<LDAPURL> ldapURLsForSearchesExpectedToReturnEntries, @Nullable Long millisBetweenSearches, @Nullable Long searchTimeLimitMillis, @Nullable Long totalDurationMillisForEachLDAPURL, @Nullable TaskState taskStateIfTimeoutIsEncountered) throws TaskException
      Creates a new delay task with the provided information.
      Parameters:
      sleepDurationMillis - The length of time, in milliseconds, that the task should sleep. This may be null if the task is intended to wait for the work queue to become idle or searches to return entries and no additional sleep is required. If it is not null, then it must be greater than zero. If a sleep duration is provided and the task should also wait for the work queue to become idle or wait for search results, then the sleep for this duration will occur after waiting for those other conditions to be satisfied (or for a timeout to occur).
      millisToWaitForWorkQueueToBecomeIdle - The length of time, in milliseconds, that the task should wait for the server work queue to report that there are no pending requests and all worker threads are idle. This may be null if the task should not wait for the work queue to become idle. If it is not null, then it must be greater than zero.
      ldapURLsForSearchesExpectedToReturnEntries - A list of LDAP URLs that provide criteria for search requests that are eventually expected to return one or more entries. This may be null or empty if the task should not perform any such searches. If this is non-empty, then the millisBetweenSearches, searchTimeLimitMillis, and totalDurationMillisForEachLDAPURL arguments must be non-null.
      millisBetweenSearches - The length of time, in milliseconds, between the individual searches created from each of the provided LDAP URLs. Each search created from an LDAP URL will be repeated until it returns at least one entry, or until the total length of time processing that search meets or exceeds the value of the totalDurationMillisForEachSearch argument. If the ldapURLsForSearchesExpectedToReturnEntries list is not empty, then this must not be null. If it is not null, then it must be greater than zero.
      searchTimeLimitMillis - The maximum length of time, in milliseconds, to wait for a response to each individual search created from one of the provided LDAP URLs. If the ldapURLsForSearchesExpectedToReturnEntries list is not empty, then this must not be null. If it is not null, then it must be greater than zero.
      totalDurationMillisForEachLDAPURL - The maximum length of time, in milliseconds, to wait for the search criteria created from each of the provided LDAP URLs to match at least one entry. If the ldapURLsForSearchesExpectedToReturnEntries list is not empty, then this must not be null. If it is not null, then it must be greater than zero.
      taskStateIfTimeoutIsEncountered - The task state that should be used if a timeout is encountered while waiting for the work queue to become idle or while waiting for search criteria created from an LDAP URL to match at least one entry. This may be null to indicate that the server should determine the appropriate task state. If it is non-null, then the value must be one of TaskState.STOPPED_BY_ERROR, TaskState.COMPLETED_WITH_ERRORS, or TaskState.COMPLETED_SUCCESSFULLY.
      Throws:
      TaskException - If there is a problem with any of the provided arguments.

    • DelayTask

      public DelayTask(@Nullable String taskID, @Nullable Long sleepDurationMillis, @Nullable Long millisToWaitForWorkQueueToBecomeIdle, @Nullable Collection<LDAPURL> ldapURLsForSearchesExpectedToReturnEntries, @Nullable Long millisBetweenSearches, @Nullable Long searchTimeLimitMillis, @Nullable Long totalDurationMillisForEachLDAPURL, @Nullable TaskState taskStateIfTimeoutIsEncountered, @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) throws TaskException
      Creates a new delay 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.
      sleepDurationMillis - The length of time, in milliseconds, that the task should sleep. This may be null if the task is intended to wait for the work queue to become idle or searches to return entries and no additional sleep is required. If it is not null, then it must be greater than zero. If a sleep duration is provided and the task should also wait for the work queue to become idle or wait for search results, then the sleep for this duration will occur after waiting for those other conditions to be satisfied (or for a timeout to occur).
      millisToWaitForWorkQueueToBecomeIdle - The length of time, in milliseconds, that the task should wait for the server work queue to report that there are no pending requests and all worker threads are idle. This may be null if the task should not wait for the work queue to become idle. If it is not null, then it must be greater than zero.
      ldapURLsForSearchesExpectedToReturnEntries - A list of LDAP URLs that provide criteria for search requests that are eventually expected to return one or more entries. This may be null or empty if the task should not perform any such searches. If this is non-empty, then the millisBetweenSearches, searchTimeLimitMillis, and totalDurationMillisForEachLDAPURL arguments must be non-null.
      millisBetweenSearches - The length of time, in milliseconds, between the individual searches created from each of the provided LDAP URLs. Each search created from an LDAP URL will be repeated until it returns at least one entry, or until the total length of time processing that search meets or exceeds the value of the totalDurationMillisForEachSearch argument. If the ldapURLsForSearchesExpectedToReturnEntries list is not empty, then this must not be null. If it is not null, then it must be greater than zero.
      searchTimeLimitMillis - The maximum length of time, in milliseconds, to wait for a response to each individual search created from one of the provided LDAP URLs. If the ldapURLsForSearchesExpectedToReturnEntries list is not empty, then this must not be null. If it is not null, then it must be greater than zero.
      totalDurationMillisForEachLDAPURL - The maximum length of time, in milliseconds, to wait for the search criteria created from each of the provided LDAP URLs to match at least one entry. If the ldapURLsForSearchesExpectedToReturnEntries list is not empty, then this must not be null. If it is not null, then it must be greater than zero.
      taskStateIfTimeoutIsEncountered - The task state that should be used if a timeout is encountered while waiting for the work queue to become idle or while waiting for search criteria created from an LDAP URL to match at least one entry. This may be null to indicate that the server should determine the appropriate task state. If it is non-null, then the value must be one of TaskState.STOPPED_BY_ERROR, TaskState.COMPLETED_WITH_ERRORS, or TaskState.COMPLETED_SUCCESSFULLY.
      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.
      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.
      Throws:
      TaskException - If there is a problem with any of the provided arguments.

    • DelayTask

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

    • DelayTask

      public DelayTask(@NotNull Map<TaskProperty,List<Object>> properties) throws TaskException
      Creates a new delay 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 delay 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.

    • getSleepDurationMillis

      @Nullable public Long getSleepDurationMillis()
      Retrieves the length of time, in milliseconds, that the task should sleep.
      Returns:
      The length of time, in milliseconds, that the task should sleep, or null if the task should not sleep for a specified period of time.

    • getMillisToWaitForWorkQueueToBecomeIdle

      @Nullable public Long getMillisToWaitForWorkQueueToBecomeIdle()
      Retrieves the length of time, in milliseconds, that the task should wait for the server work queue to report that there are no pending requests and all worker threads are idle.
      Returns:
      The length of time, in milliseconds, that the task should wait for the server work queue to report that it is idle, or null if the task should not wait for the work queue to be idle

    • getLDAPURLsForSearchesExpectedToReturnEntries

      @NotNull public List<LDAPURL> getLDAPURLsForSearchesExpectedToReturnEntries()
      Retrieves a list of LDAP URLs that provide criteria for search requests that are eventually expected to return one or more entries.
      Returns:
      A list of LDAP URLs that provide criteria for search requests that are eventually expected to return one or more entries, or an empty list if no searches are to be performed.

    • getMillisBetweenSearches

      @Nullable public Long getMillisBetweenSearches()
      Retrieves the length of time, in milliseconds, between the individual searches created from each of the provided LDAP URLs. Each search created from an LDAP URL will be repeated until it returns at least one entry, or until the total length of processing that search meets or exceeds the value returned by the getTotalDurationMillisForEachLDAPURL() method.
      Returns:
      The length of time, in milliseconds, between the individual searches created from each of the provided LDAP URLs, or null if no searches are to be performed.

    • getSearchTimeLimitMillis

      @Nullable public Long getSearchTimeLimitMillis()
      Retrieves the maximum length of time, in milliseconds, to wait for a response to each individual search created from one of the provided LDAP URLs.
      Returns:
      The maximum length of time, in milliseconds, to wait for a response to each individual search created from one of the provided LDAP URLs, or null if no searches are to be performed.

    • getTotalDurationMillisForEachLDAPURL

      @Nullable public Long getTotalDurationMillisForEachLDAPURL()
      Retrieves the maximum length of time, in milliseconds, to wait for the search criteria created from each of the provided LDAP URLs to match at least one entry.
      Returns:
      The maximum length of time, in milliseconds, to wait for the search criteria created from each of the provided LDAP URLs to match at least one entry, or null if no searches are to be performed.

    • getTaskStateIfTimeoutIsEncountered

      @Nullable public String getTaskStateIfTimeoutIsEncountered()
      Retrieves the name of the task state that should be used if a timeout is encountered while waiting for the work queue to become idle or while waiting for search criteria created from an LDAP URL to match at least one entry.
      Returns:
      The name of the task state that should be used if a timeout is encountered, or null if the server should determine the appropriate task state.

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