Package org.opends.server.tasks

Class EnterLockdownModeTask

java.lang.Object

org.opends.server.backends.task.Task

org.opends.server.tasks.EnterLockdownModeTask

All Implemented Interfaces:

Comparable<Task>

public class EnterLockdownModeTask
extends Task

This class provides an implementation of a Directory Server task that can be used to place the server in lockdown mode.

Constructor Summary

Constructors

Constructor	Description
EnterLockdownModeTask()

Method Summary

Modifier and Type	Method	Description
org.forgerock.i18n.LocalizableMessage	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, addLogMessage, compareTo, execute, getActualStartTime, getAttributeDisplayName, getCompletionTime, getDependencyIDs, getFailedDependencyAction, getFinalTaskState, getLogMessages, getNotifyOnCompletionAddresses, getNotifyOnErrorAddresses, getOperation, getRecurringTaskID, getScheduledStartTime, getServerContext, getTaskEntry, getTaskEntryDN, getTaskID, getTaskInterruptState, getTaskState, initializeTaskInternal, interruptTask, isCancelled, isInterruptable, isRecurring, replaceAttributeValue, sendNotificationEMailMessage, setCompletionTime, setOperation, setTaskInterruptState

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EnterLockdownModeTask

public EnterLockdownModeTask()

Method Detail

getDisplayName

public org.forgerock.i18n.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()
                    throws DirectoryException

Description copied from class: Task

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()

Description copied from class: Task

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.