com.unboundid.ldap.sdk.unboundidds.tasks
Class ShutdownTask

java.lang.Object
  extended by com.unboundid.ldap.sdk.unboundidds.tasks.Task
      extended by com.unboundid.ldap.sdk.unboundidds.tasks.ShutdownTask
All Implemented Interfaces:
java.io.Serializable

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class ShutdownTask
extends Task

NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.
This class defines a Directory Server task that can be used to shut down or restart the server. The properties that are available for use with this type of task include:

See Also:
Serialized Form

Constructor Summary
ShutdownTask()
          Creates a new uninitialized shutdown task instance which should only be used for obtaining general information about this task, including the task name, description, and supported properties.
ShutdownTask(Entry entry)
          Creates a new shutdown task from the provided entry.
ShutdownTask(java.util.Map<TaskProperty,java.util.List<java.lang.Object>> properties)
          Creates a new shutdown task from the provided set of task properties.
ShutdownTask(java.lang.String taskID, java.lang.String shutdownMessage, boolean restartServer)
          Creates a new shutdown task with the provided information.
ShutdownTask(java.lang.String taskID, java.lang.String shutdownMessage, boolean restartServer, java.util.Date scheduledStartTime, java.util.List<java.lang.String> dependencyIDs, FailedDependencyAction failedDependencyAction, java.util.List<java.lang.String> notifyOnCompletion, java.util.List<java.lang.String> notifyOnError)
          Creates a new shutdown task with the provided information.
 
Method Summary
protected  java.util.List<Attribute> getAdditionalAttributes()
          Retrieves a list of the additional attributes (other than attributes common to all task types) that should be included when creating new task entries of this type.
protected  java.util.List<java.lang.String> getAdditionalObjectClasses()
          Retrieves a list of the additional object classes (other than the base "top" and "ds-task" classes) that should be included when creating new task entries of this type.
 java.lang.String getShutdownMessage()
          Retrieves the shutdown message that may provide a reason for or additional information about the shutdown or restart.
 java.lang.String getTaskDescription()
          Retrieves a human-readable description for this task.
 java.lang.String getTaskName()
          Retrieves a human-readable name for this task.
 java.util.Map<TaskProperty,java.util.List<java.lang.Object>> getTaskPropertyValues()
          Retrieves the values of the task properties for this task.
 java.util.List<TaskProperty> getTaskSpecificProperties()
          Retrieves a list of task-specific properties that may be provided when scheduling a task of this type.
 boolean restartServer()
          Indicates whether to attempt to restart the server rather than shut it down.
 
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.tasks.Task
createTaskEntry, decodeTask, getActualStartTime, getAvailableTaskTypes, getCommonTaskProperties, getCompletionTime, getDependencyIDs, getFailedDependencyAction, getLogMessages, getNotifyOnCompletionAddresses, getNotifyOnErrorAddresses, getScheduledStartTime, getState, getTaskClassName, getTaskEntry, getTaskEntryDN, getTaskID, isCompleted, isPending, isRunning, parseBoolean, parseBooleanValue, parseDate, parseLong, parseString, parseStringList, parseStrings, toString, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ShutdownTask

public ShutdownTask()
Creates a new uninitialized shutdown task instance which should only be used for obtaining general information about this task, including the task name, description, and supported properties. Attempts to use a task created with this constructor for any other reason will likely fail.


ShutdownTask

public ShutdownTask(java.lang.String taskID,
                    java.lang.String shutdownMessage,
                    boolean restartServer)
Creates a new shutdown task with the provided information.

Parameters:
taskID - The task ID to use for this task. If it is null then a UUID will be generated for use as the task ID.
shutdownMessage - A message that describes the reason for the shutdown. It may be null.
restartServer - Indicates whether to restart the server rather than shut it down.

ShutdownTask

public ShutdownTask(java.lang.String taskID,
                    java.lang.String shutdownMessage,
                    boolean restartServer,
                    java.util.Date scheduledStartTime,
                    java.util.List<java.lang.String> dependencyIDs,
                    FailedDependencyAction failedDependencyAction,
                    java.util.List<java.lang.String> notifyOnCompletion,
                    java.util.List<java.lang.String> notifyOnError)
Creates a new shutdown task with the provided information.

Parameters:
taskID - The task ID to use for this task. If it is null then a UUID will be generated for use as the task ID.
shutdownMessage - A message that describes the reason for the shutdown. It may be null.
restartServer - Indicates whether to restart the server rather than shut it down.
scheduledStartTime - The time that this task should start running.
dependencyIDs - The list of task IDs that will be required to complete before this task will be eligible to start.
failedDependencyAction - Indicates what action should be taken if any of the dependencies for this task do not complete successfully.
notifyOnCompletion - The list of e-mail addresses of individuals that should be notified when this task completes.
notifyOnError - The list of e-mail addresses of individuals that should be notified if this task does not complete successfully.

ShutdownTask

public ShutdownTask(Entry entry)
             throws TaskException
Creates a new shutdown task from the provided entry.

Parameters:
entry - The entry to use to create this shutdown task.
Throws:
TaskException - If the provided entry cannot be parsed as a shutdown task entry.

ShutdownTask

public ShutdownTask(java.util.Map<TaskProperty,java.util.List<java.lang.Object>> properties)
             throws TaskException
Creates a new shutdown task from the provided set of task properties.

Parameters:
properties - The set of task properties and their corresponding values to use for the task. It must not be null.
Throws:
TaskException - If the provided set of properties cannot be used to create a valid shutdown task.
Method Detail

getTaskName

public java.lang.String getTaskName()
Retrieves a human-readable name for this task.

Overrides:
getTaskName in class Task
Returns:
A human-readable name for this task.

getTaskDescription

public java.lang.String getTaskDescription()
Retrieves a human-readable description for this task.

Overrides:
getTaskDescription in class Task
Returns:
A human-readable description for this task.

getShutdownMessage

public java.lang.String getShutdownMessage()
Retrieves the shutdown message that may provide a reason for or additional information about the shutdown or restart.

Returns:
The shutdown message, or null if there is none.

restartServer

public boolean restartServer()
Indicates whether to attempt to restart the server rather than shut it down.

Returns:
true if the task should attempt to restart the server, or false if it should shut it down.

getAdditionalObjectClasses

protected java.util.List<java.lang.String> getAdditionalObjectClasses()
Retrieves a list of the additional object classes (other than the base "top" and "ds-task" classes) that should be included when creating new task entries of this type.

Overrides:
getAdditionalObjectClasses in class Task
Returns:
A list of the additional object classes that should be included in new task entries of this type, or an empty list if there do not need to be any additional classes.

getAdditionalAttributes

protected java.util.List<Attribute> getAdditionalAttributes()
Retrieves a list of the additional attributes (other than attributes common to all task types) that should be included when creating new task entries of this type.

Overrides:
getAdditionalAttributes in class Task
Returns:
A list of the additional attributes that should be included in new task entries of this type, or an empty list if there do not need to be any additional attributes.

getTaskSpecificProperties

public java.util.List<TaskProperty> getTaskSpecificProperties()
Retrieves a list of task-specific properties that may be provided when scheduling a task of this type. This method should be overridden by subclasses in order to provide an appropriate set of properties.

Overrides:
getTaskSpecificProperties in class Task
Returns:
A list of task-specific properties that may be provided when scheduling a task of this type.

getTaskPropertyValues

public java.util.Map<TaskProperty,java.util.List<java.lang.Object>> getTaskPropertyValues()
Retrieves the values of the task properties for this task. The data type of the values will vary based on the data type of the corresponding task property and may be one of the following types: Boolean, Date, Long, or String. Task properties which do not have any values will be included in the map with an empty value list.

Note that subclasses which have additional task properties should override this method and return a map which contains both the property values from this class (obtained from super.getTaskPropertyValues() and the values of their own task-specific properties.

Overrides:
getTaskPropertyValues in class Task
Returns:
A map of the task property values for this task.