Package org.opends.server.tools.tasks

Class TaskEntry

  • public class TaskEntry
extends Object
    Processes information from a task entry from the directory and provides accessors for attribute information. In some cases the data is formatted into more human-friendly formats.

    • Constructor Detail

      • TaskEntry

        public TaskEntry​(Entry entry)
        Creates a parameterized instance.
        Parameters:
        entry - to wrap

    • Method Detail

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • getDN

        public DN getDN()
        Gets the DN of the wrapped entry.
        Returns:
        DN of entry

      • getId

        public String getId()
        Gets the ID of the task.
        Returns:
        String ID of the task

      • getClassName

        public String getClassName()
        Gets the name of the class implementing the task represented here.
        Returns:
        String name of class

      • getState

        public org.forgerock.i18n.LocalizableMessage getState()
        Gets the state of the task.
        Returns:
        LocalizableMessage representing state

      • getScheduledStartTime

        public org.forgerock.i18n.LocalizableMessage getScheduledStartTime()
        Gets the human-friendly scheduled time.
        Returns:
        String time

      • getActualStartTime

        public org.forgerock.i18n.LocalizableMessage getActualStartTime()
        Gets the human-friendly start time.
        Returns:
        String time

      • getCompletionTime

        public org.forgerock.i18n.LocalizableMessage getCompletionTime()
        Gets the human-friendly completion time.
        Returns:
        String time

      • getScheduleTab

        public org.forgerock.i18n.LocalizableMessage getScheduleTab()
        Gets recurring schedule tab.
        Returns:
        LocalizableMessage tab string

      • getDependencyIds

        public List<String> getDependencyIds()
        Gets the IDs of tasks upon which this task depends.
        Returns:
        array of IDs

      • getFailedDependencyAction

        public org.forgerock.i18n.LocalizableMessage getFailedDependencyAction()
        Gets the action to take if this task fails.
        Returns:
        String action

      • getLogMessages

        public List<org.forgerock.i18n.LocalizableMessage> getLogMessages()
        Gets the logs associated with this task's execution.
        Returns:
        array of log messages

      • getCompletionNotificationEmailAddresses

        public List<String> getCompletionNotificationEmailAddresses()
        Gets the email messages that will be used for notifications when the task completes.
        Returns:
        array of email addresses

      • getErrorNotificationEmailAddresses

        public List<String> getErrorNotificationEmailAddresses()
        Gets the email messages that will be used for notifications when the task encounters an error.
        Returns:
        array of email addresses

      • getType

        public org.forgerock.i18n.LocalizableMessage getType()
        Gets a user presentable string indicating the type of this task.
        Returns:
        LocalizableMessage type

      • isCancelable

        public boolean isCancelable()
        Indicates whether this task supports a cancel operation.
        Returns:
        boolean where true means this task supports being canceled.

      • getTaskSpecificAttributeValuePairs

        public Map<org.forgerock.i18n.LocalizableMessage,​List<String>> getTaskSpecificAttributeValuePairs()
        Gets a mapping of attributes that are specific to the implementing task as opposed to the superior, or base, task.
        Returns:
        mapping of attribute field labels to lists of string values for each field.

      • getTaskState

        public TaskState getTaskState()
        Gets the task state.
        Returns:
        TaskState of task

      • isDone

        public boolean isDone()
        Indicates whether this task is done.
        Returns:
        boolean where true means this task is done