org.opends.server.tasks
Class DisconnectClientTask

java.lang.Object
  extended by org.opends.server.backends.task.Task
      extended by org.opends.server.tasks.DisconnectClientTask
All Implemented Interfaces:
java.lang.Comparable<Task>

public class DisconnectClientTask
extends Task

This class provides an implementation of a Directory Server task that can be used to terminate a client connection.


Constructor Summary
DisconnectClientTask()
           
 
Method Summary
 Message getDisplayName()
          Gets a message that identifies this type of task suitable for presentation to humans in monitoring tools.
 void initializeTask()
          Performs any task-specific initialization that may be required before processing can start.
protected  TaskState runTask()
          Performs the actual core processing for this task.
 
Methods inherited from class org.opends.server.backends.task.Task
addLogMessage, compareTo, execute, getActualStartTime, getAttributeDisplayName, getCompletionTime, getDependencyIDs, getFailedDependencyAction, getFinalTaskState, getLogMessages, getNotifyOnCompletionAddresses, getNotifyOnErrorAddresses, getOperation, getRecurringTaskID, getScheduledStartTime, getTaskEntry, getTaskEntryDN, getTaskID, getTaskInterruptState, getTaskState, initializeTaskInternal, interruptTask, isCancelled, isInterruptable, logError, replaceAttributeValue, setOperation, setTaskInterruptState
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DisconnectClientTask

public DisconnectClientTask()
Method Detail

getDisplayName

public Message getDisplayName()
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()
                    throws DirectoryException
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
Throws:
DirectoryException - If a problem occurs during initialization that should be returned to the client.

runTask

protected 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.