Class ShutdownTask

  • All Implemented Interfaces:
    Comparable<Task>

    public final class ShutdownTask
    extends Task
    This class provides an implementation of a Directory Server task that can be used to stop the server.
    • Constructor Detail

      • ShutdownTask

        public ShutdownTask()
    • Method Detail

      • getDisplayName

        public LocalizableMessage getDisplayName()
        Description copied from class: Task
        Gets a message that identifies this type of task suitable for presentation to humans in monitoring tools.
        Overrides:
        getDisplayName in class Task
        Returns:
        name of task
      • initializeTask

        public void initializeTask​(Entry taskEntry)
                            throws LdapException
        Performs any task-specific initialization that may be required before processing can start. This default implementation does not do anything, but subclasses may override it as necessary. This method will be called at the time the task is scheduled, and therefore any failure in this method will be returned to the client.
        Overrides:
        initializeTask in class Task
        Parameters:
        taskEntry - the task entry
        Throws:
        LdapException - If a problem occurs during initialization that should be returned to the client.
      • runTask

        public TaskState runTask()
        Performs the actual core processing for this task. This method should not return until all processing associated with this task has completed.
        Specified by:
        runTask in class Task
        Returns:
        The final state to use for the task.