Uses of Class
org.opends.server.backends.task.TaskState
-
Packages that use TaskState Package Description org.opends.server.backends.task Contains the code for the Directory Server backend that provides an interface for executing administrative tasks.org.opends.server.tasks Contains implementations for various Directory Server tasks.org.opends.server.tools.tasks This package contains classes that support client tool interaction with the tasks backend. -
-
Uses of TaskState in org.opends.server.backends.task
Methods in org.opends.server.backends.task that return TaskState Modifier and Type Method Description TaskStateTask. execute()Begins execution for this task.static TaskStateTaskState. fromString(String s)Retrieves the task state that corresponds to the provided string value.protected TaskStateTask. getFinalTaskState()Returns a state for this task after processing has completed.protected TaskStateTask. getTaskInterruptState()Gets the interrupt state for this task that was set as a result of a call toTask.interruptTask(TaskState, LocalizableMessage).TaskStateTask. getTaskState()Retrieves the current state for this task.protected abstract TaskStateTask. runTask()Performs the actual core processing for this task.static TaskStateTaskState. valueOf(String name)Returns the enum constant of this type with the specified name.static TaskState[]TaskState. values()Returns an array containing the constants of this enum type, in the order they are declared.Methods in org.opends.server.backends.task with parameters of type TaskState Modifier and Type Method Description voidTaskScheduler. interruptRunningTasks(TaskState interruptState, org.forgerock.i18n.LocalizableMessage interruptReason, boolean waitForStop)Attempts to interrupt any tasks that are actively running.voidTask. interruptTask(TaskState interruptState, org.forgerock.i18n.LocalizableMessage interruptReason)Performs any necessary processing to prematurely interrupt the execution of this task.voidTaskThread. interruptTask(TaskState interruptState, org.forgerock.i18n.LocalizableMessage interruptReason, boolean exitThread)Attempts to interrupt processing on the task in progress.static booleanTaskState. isCancelled(TaskState taskState)Indicates whether this task has been cancelled.static booleanTaskState. isDone(TaskState taskState)Indicates whether a task with the specified state has completed all the processing that it will do, regardless of whether it completed its intended goal.static booleanTaskState. isPending(TaskState taskState)Indicates whether a task with the specified state is currently pending execution.static booleanTaskState. isRecurring(TaskState taskState)Indicates whether a task with the specified state is recurring.static booleanTaskState. isRunning(TaskState taskState)Indicates whether a task with the specified state is currently running.static booleanTaskState. isSuccessful(TaskState taskState)Indicates whether a task with the specified state has been able to complete its intended goal.protected voidTask. setTaskInterruptState(TaskState state)Sets a state for this task that is the result of a call toTask.interruptTask(TaskState, LocalizableMessage).booleanTaskScheduler. threadDone(TaskThread taskThread, Task completedTask, TaskState taskState)Indicates that processing has completed on the provided task thread and that it is now available for processing other tasks. -
Uses of TaskState in org.opends.server.tasks
Methods in org.opends.server.tasks that return TaskState Modifier and Type Method Description protected TaskStateAddSchemaFileTask. runTask()protected TaskStateBackupTask. runTask()Performs the actual core processing for this task.protected TaskStateDisconnectClientTask. runTask()protected TaskStateEnterLockdownModeTask. runTask()protected TaskStateExportTask. runTask()protected TaskStateImportTask. runTask()protected TaskStateInitializeTargetTask. runTask()protected TaskStateInitializeTask. runTask()protected TaskStateLeaveLockdownModeTask. runTask()protected TaskStatePurgeConflictsHistoricalTask. runTask()Performs the actual core processing for this task.protected TaskStateRebuildTask. runTask()protected TaskStateResetChangeNumberTask. runTask()protected TaskStateRestoreTask. runTask()Performs the actual core processing for this task.protected TaskStateSetGenerationIdTask. runTask()TaskStateShutdownTask. runTask()Performs the actual core processing for this task.Methods in org.opends.server.tasks with parameters of type TaskState Modifier and Type Method Description voidBackupTask. interruptTask(TaskState interruptState, org.forgerock.i18n.LocalizableMessage interruptReason)Performs any necessary processing to prematurely interrupt the execution of this task.voidExportTask. interruptTask(TaskState interruptState, org.forgerock.i18n.LocalizableMessage interruptReason)voidImportTask. interruptTask(TaskState interruptState, org.forgerock.i18n.LocalizableMessage interruptReason)voidRestoreTask. interruptTask(TaskState interruptState, org.forgerock.i18n.LocalizableMessage interruptReason)Performs any necessary processing to prematurely interrupt the execution of this task. -
Uses of TaskState in org.opends.server.tools.tasks
Methods in org.opends.server.tools.tasks that return TaskState Modifier and Type Method Description TaskStateTaskEntry. getTaskState()Gets the task state.
-