Package org.opends.server.tools.tasks

Interface TaskScheduleInformation

  • public interface TaskScheduleInformation
    Interface for tools that are capable of scheduling a task remotely through the task backend.
    See Also:
    TaskClient

    • Method Detail

      • addTaskAttributes

        void addTaskAttributes​(Entry taskEntry)
        Adds utility specific attributes to the provided task entry that is added to the task backend.
        Parameters:
        taskEntry - The task Entry to update.

      • getTaskObjectclass

        String getTaskObjectclass()
        Gets the objectclass used to represent scheduled instances of this utility in the task backend.
        Returns:
        String representation of this utilities objectclass

      • getTaskClass

        Class<?> getTaskClass()
        Gets the Class that implements the utility to execute.
        Returns:
        class of the tasks implementation

      • getStartDateTime

        Instant getStartDateTime()
        Gets the date at which this task should be scheduled to start.
        Returns:
        date/time at which the task should be scheduled

      • getTaskId

        String getTaskId()
        Gets an arbitrary task id assigned to this task.
        Returns:
        assigned task id if any or null otherwise.

      • getRecurringDateTime

        String getRecurringDateTime()
        Gets the date/time pattern for recurring task schedule.
        Returns:
        recurring date/time pattern at which the task should be scheduled.

      • getDependencyIds

        Collection<String> getDependencyIds()
        Gets a list of task IDs upon which this task is dependent.
        Returns:
        list of task IDs

      • getFailedDependencyAction

        FailedDependencyAction getFailedDependencyAction()
        Gets the action to take should one of the dependent task fail.
        Returns:
        action to take

      • getNotifyUponCompletionEmailAddresses

        Collection<String> getNotifyUponCompletionEmailAddresses()
        Gets a list of email address to which an email will be sent when this task completes.
        Returns:
        list of email addresses

      • getNotifyUponErrorEmailAddresses

        Collection<String> getNotifyUponErrorEmailAddresses()
        Gets a list of email address to which an email will be sent if this task encounters an error during execution.
        Returns:
        list of email addresses

      • getDescription

        default String getDescription()
        Gets the description of this task or null if there is none.
        Returns:
        The description of this task or null if there is none.