Package com.evolveum.midpoint.schema.util.task

Class TaskInformation

java.lang.Object
com.evolveum.midpoint.schema.util.task.TaskInformation
All Implemented Interfaces:
DebugDumpable, Serializable
Direct Known Subclasses:
ActivityBasedTaskInformation, LegacyTaskInformation
public abstract class TaskInformation extends Object implements DebugDumpable, Serializable
Contains all non-trivial task information (progress, workers, overall status, and so on) needed for the use of GUI and reporting. This is a kind of middle layer (or "API") that isolates higher layers (GUI, reporting) from the details of data representation at the level of tasks and activities. It also hides the complexities induced by the transition from tasks-based approach to activities-based one, namely the existence of legacy tasks that live outside of the new activity framework. Instances of this class can be created in one of two ways: 1. For a root task (either activity-based or not), 2. For any subtask in hierarchy (either persistent or not, activity-based or not). The task(s) provided here may have subtasks resolved or not. If possible, we try to do our best to extract as much information as possible. But currently we are quite limited. E.g. we ignore the subtasks that were loaded.
See Also:

  • Field Details

    • task

      @NotNull protected final @NotNull TaskType task
      The original task.

    • workersInformation

      @NotNull protected final @NotNull ActivityWorkersInformation workersInformation
      Workers information covering this task and its subtasks.

    • overallStatus

      @NotNull protected final @NotNull OperationResultStatusType overallStatus
      Result status covering this task and its subtasks.

  • Constructor Details

  • Method Details

    • createForTask

      @NotNull public static @NotNull TaskInformation createForTask(@NotNull @NotNull TaskType task, @Nullable @Nullable TaskType rootTask)

    • debugDump

      public String debugDump(int indent)
      Specified by:
      debugDump in interface DebugDumpable

    • getTask

      @NotNull public @NotNull TaskType getTask()

    • getProgressDescriptionShort

      public String getProgressDescriptionShort()
      Returns short description of progress of the task and its children.

    • getProgressDescription

      public abstract String getProgressDescription(boolean longForm)

    • getProgress

      public abstract double getProgress()
      Returns the progress of the task based on activity tree state. Progress (%) is based on the number of completed activities to all activities. Each activity represents the same amount of work.
      Returns:
      The progress is a number between 0 and 1. If the progress is unknown, the method returns -1.

    • isComplete

      public abstract boolean isComplete()

    • getAllErrors

      public abstract Integer getAllErrors()
      Returns number of items failed to be processed by the task and its children, if known. BEWARE: Fatal errors (e.g. resource not found for import task) are not counted here.

    • getNodesDescription

      public String getNodesDescription()
      Returns textual form of information about nodes on which the task and its children execute.

    • getCompletelyStalledSince

      @Nullable public @Nullable XMLGregorianCalendar getCompletelyStalledSince()
      Returns the "stalled since" information for the task and its children.

    • getResultStatus

      @NotNull public @NotNull OperationResultStatusType getResultStatus()
      Returns the overall status of the task with its children that is displayable to the user.

    • getStartTimestamp

      public abstract XMLGregorianCalendar getStartTimestamp()
      Returns the "start timestamp", whatever that means. Currently, it is the execution start for trivial tasks (a single non-bucketed activity, or a legacy task); and realization start otherwise.

    • getEndTimestamp

      public abstract XMLGregorianCalendar getEndTimestamp()
      Returns the "end timestamp" with the analogous semantics to getStartTimestamp().

    • getLiveSyncToken

      public abstract Object getLiveSyncToken()

    • getTaskHealthStatus

      public abstract OperationResultStatusType getTaskHealthStatus()
      Overall health status of the task and it's subtasks. Not related to items/objects processing, rather just task execution (e.g. failed/stalled workers).

    • getTaskHealthDescription

      public abstract LocalizableMessage getTaskHealthDescription()
      Returns the message that describes primarily the overall status (health) of the task and it's subtasks. Description should not be based on errors created as a result of items/objects processing, just state of tasks/subtasks and their execution. This should be a short message that is suitable for displaying to the user/table.

    • getTaskHealthUserFriendlyMessages

      public abstract List<LocalizableMessage> getTaskHealthUserFriendlyMessages()
      Return list of localizable messages that contains concrete errors/warnings that are related to the task health (plus it's subtasks). Collected messages might repeat, therefore might not be unique. It's up to client to decide whether to filter them. E.g. Policy violation error localizable messages.

    • getTaskHealthMessages

      public abstract List<String> getTaskHealthMessages()
      Return list of technical messages that contains concrete errors/warnings that are related to the task health (plus it's subtasks). Collected messages might repeat, therefore might not be unique. It's up to client to decide whether to filter them. E.g. Policy violation error messages.

    • getRootActivityStatePersistence

      @Nullable public abstract @Nullable ActivityStatePersistenceType getRootActivityStatePersistence()

    • getTaskUserFriendlyStatus

      public abstract TaskResultStatus getTaskUserFriendlyStatus()