Package org.opends.server.backends.task

Enum Class TaskState

java.lang.Object
java.lang.Enum<TaskState>
org.opends.server.backends.task.TaskState
All Implemented Interfaces:
Serializable, Comparable<TaskState>, java.lang.constant.Constable
public enum TaskState extends Enum<TaskState>
This enumeration defines the various states that a task can have during its lifetime.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    CANCELED_BEFORE_STARTING
    The task state that indicates that the task was canceled by an administrator before it started running.
    COMPLETED_SUCCESSFULLY
    The task state that indicates that the task has completed without any errors.
    COMPLETED_WITH_ERRORS
    The task state that indicates that the task was able to complete its intended goal, but that one or more errors were encountered during the process.
    DISABLED
    The task state that indicates that the task has been disabled by an administrator.
    RECURRING
    The task state that indicates that the task is recurring.
    RUNNING
    The task state that indicates that the task is currently running.
    STOPPED_BY_ADMINISTRATOR
    The task state that indicates that the task was stopped by an administrator after it had already started but before it was able to complete.
    STOPPED_BY_ERROR
    The task state that indicates that one or more errors prevented the task from completing.
    STOPPED_BY_SHUTDOWN
    The task state that indicates that the task was unable to complete because it was interrupted by the shutdown of the task backend.
    UNSCHEDULED
    The task state that indicates that the task has not yet been scheduled, or possibly that the scheduler is currently not running.
    WAITING_ON_DEPENDENCY
    The task state that indicates that at least one of the task's defined dependencies has not yet completed.
    WAITING_ON_START_TIME
    The task state that indicates that the task's scheduled start time has not yet arrived.
    WILL_RETRY
    The task state that indicates that the task will be retried again.

  • Method Summary

    Modifier and Type
    Method
    Description
    static TaskState
    fromString(String s)
    Retrieves the task state that corresponds to the provided string value.
    LocalizableMessage
    getDisplayName()
    Gets a locale sensitive representation of this state.
    boolean
    isCancelled()
    Indicates whether this task has been cancelled.
    boolean
    isDone()
    Indicates whether a task with the specified state has completed all the processing that it will do, regardless of whether it completed its intended goal.
    boolean
    isPending()
    Indicates whether a task with the specified state is currently pending execution.
    boolean
    isRecurring()
    Indicates whether a task with the specified state is recurring.
    boolean
    isRunning()
    Indicates whether a task with the specified state is currently running.
    boolean
    isSuccessful()
    Indicates whether a task with the specified state has been able to complete its intended goal.
    static TaskState
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static TaskState[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • UNSCHEDULED

      public static final TaskState UNSCHEDULED
      The task state that indicates that the task has not yet been scheduled, or possibly that the scheduler is currently not running.

    • DISABLED

      public static final TaskState DISABLED
      The task state that indicates that the task has been disabled by an administrator.

    • WAITING_ON_START_TIME

      public static final TaskState WAITING_ON_START_TIME
      The task state that indicates that the task's scheduled start time has not yet arrived.

    • WAITING_ON_DEPENDENCY

      public static final TaskState WAITING_ON_DEPENDENCY
      The task state that indicates that at least one of the task's defined dependencies has not yet completed.

    • RUNNING

      public static final TaskState RUNNING
      The task state that indicates that the task is currently running.

    • RECURRING

      public static final TaskState RECURRING
      The task state that indicates that the task is recurring.

    • COMPLETED_SUCCESSFULLY

      public static final TaskState COMPLETED_SUCCESSFULLY
      The task state that indicates that the task has completed without any errors.

    • COMPLETED_WITH_ERRORS

      public static final TaskState COMPLETED_WITH_ERRORS
      The task state that indicates that the task was able to complete its intended goal, but that one or more errors were encountered during the process.

    • STOPPED_BY_SHUTDOWN

      public static final TaskState STOPPED_BY_SHUTDOWN
      The task state that indicates that the task was unable to complete because it was interrupted by the shutdown of the task backend.

    • STOPPED_BY_ERROR

      public static final TaskState STOPPED_BY_ERROR
      The task state that indicates that one or more errors prevented the task from completing.

    • STOPPED_BY_ADMINISTRATOR

      public static final TaskState STOPPED_BY_ADMINISTRATOR
      The task state that indicates that the task was stopped by an administrator after it had already started but before it was able to complete.

    • CANCELED_BEFORE_STARTING

      public static final TaskState CANCELED_BEFORE_STARTING
      The task state that indicates that the task was canceled by an administrator before it started running.

    • WILL_RETRY

      public static final TaskState WILL_RETRY
      The task state that indicates that the task will be retried again. Used by InitializeTask as internal state.

  • Method Details

    • values

      public static TaskState[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static TaskState valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • isPending

      public boolean isPending()
      Indicates whether a task with the specified state is currently pending execution.
      Returns:
      true if the task state indicates that the task is currently pending, or false otherwise.

    • isRunning

      public boolean isRunning()
      Indicates whether a task with the specified state is currently running.
      Returns:
      true if the task state indicates that the task is currently running, or false otherwise.

    • isRecurring

      public boolean isRecurring()
      Indicates whether a task with the specified state is recurring.
      Returns:
      true if the task state indicates that the task is recurring, or false otherwise.

    • isDone

      public boolean isDone()
      Indicates whether a task with the specified state has completed all the processing that it will do, regardless of whether it completed its intended goal.
      Returns:
      false if the task state indicates that the task has not yet started or is currently running, or true otherwise

    • isSuccessful

      public boolean isSuccessful()
      Indicates whether a task with the specified state has been able to complete its intended goal.
      Returns:
      true if the task state indicates that the task completed successfully or with minor errors that still allowed it to achieve its goal, or false otherwise.

    • isCancelled

      public boolean isCancelled()
      Indicates whether this task has been cancelled.
      Returns:
      true if the task state indicates that the task was cancelled either before or during execution, or false otherwise.

    • fromString

      public static TaskState fromString(String s)
      Retrieves the task state that corresponds to the provided string value.
      Parameters:
      s - The string value for which to retrieve the corresponding task state.
      Returns:
      The corresponding task state, or null if none could be associated with the provided string.

    • getDisplayName

      public LocalizableMessage getDisplayName()
      Gets a locale sensitive representation of this state.
      Returns:
      LocalizableMessage describing state