com.evolveum.midpoint.model.api

Interface TaskService

public interface TaskService

Interface of the Model subsystem that provides task-specific operations.

Author:

mederly

Field Summary

Fields

Modifier and Type	Field and Description
static long	DO_NOT_STOP
static long	DO_NOT_WAIT
static long	WAIT_INDEFINITELY

Method Summary

Methods

Modifier and Type	Method and Description
boolean	deactivateServiceThreads(long timeToWait, OperationResult parentResult) Deactivates service threads (temporarily).
List<String>	getAllTaskCategories() Gets a list of all task categories.
String	getHandlerUriForCategory(String category) Returns a default handler URI for a given task category.
boolean	getServiceThreadsActivationState() Returns true if the service threads are running.
com.evolveum.midpoint.prism.PrismObject<TaskType>	getTaskByIdentifier(String identifier, Collection<SelectorOptions<GetOperationOptions>> options, OperationResult parentResult) Returns information about task, given its identifier.
void	reactivateServiceThreads(OperationResult parentResult) Re-activates the service threads after they have been deactivated.
void	resumeTasks(Collection<String> taskOids, OperationResult parentResult) Resume suspended tasks.
void	scheduleTasksNow(Collection<String> taskOids, OperationResult parentResult) Schedules a RUNNABLE/CLOSED tasks to be run immediately.
void	startSchedulers(Collection<String> nodeIdentifiers, OperationResult result) Starts the scheduler on a given nodes.
void	stopSchedulers(Collection<String> nodeIdentifiers, OperationResult parentResult) Stops the schedulers on a given nodes.
boolean	stopSchedulersAndTasks(Collection<String> nodeIdentifiers, long waitTime, OperationResult parentResult) Stops a set of schedulers (on their nodes) and tasks that are executing on these nodes.
void	suspendAndDeleteTasks(Collection<String> taskOids, long waitForStop, boolean alsoSubtasks, OperationResult parentResult) Suspends tasks and deletes them.
boolean	suspendTasks(Collection<String> taskOids, long waitForStop, OperationResult parentResult) Suspends a set of tasks.
void	synchronizeTasks(OperationResult parentResult) Synchronizes information in midPoint repository and task scheduling database.

Field Detail

WAIT_INDEFINITELY

static final long WAIT_INDEFINITELY

See Also:

Constant Field Values

DO_NOT_WAIT

static final long DO_NOT_WAIT

See Also:

Constant Field Values

DO_NOT_STOP

static final long DO_NOT_STOP

See Also:

Constant Field Values

Method Detail

suspendTasks

boolean suspendTasks(Collection<String> taskOids,
                   long waitForStop,
                   OperationResult parentResult)

Suspends a set of tasks. Sets their execution status to SUSPENDED. Stops their execution (unless doNotStop is set).

Parameters:

taskOids - a collection of OIDs of tasks that have to be suspended

waitTime - how long (in milliseconds) to wait for stopping the execution of tasks; WAIT_INDEFINITELY means wait indefinitely :) DO_NOT_WAIT means stop the tasks, but do not wait for finishing their execution DO_NOT_STOP means do not try to stop the task execution. Tasks will only be put into SUSPENDED state, and their executions (if any) will be left as they are. Use this option only when you know what you're doing.

parentResult -

Returns:

true if all the tasks were stopped, false if some tasks continue to run or if stopping was not requested (DO_NOT_STOP option)

suspendAndDeleteTasks

void suspendAndDeleteTasks(Collection<String> taskOids,
                         long waitForStop,
                         boolean alsoSubtasks,
                         OperationResult parentResult)

Suspends tasks and deletes them.

Parameters:

taskOids - Collection of task OIDs to be suspended and deleted.

waitForStop - How long (in milliseconds) to wait for task stop before proceeding with deletion. WAIT_INDEFINITELY means wait indefinitely :) DO_NOT_WAIT means stop the tasks, but do not wait for finishing their execution DO_NOT_STOP means do not try to stop the task execution. Tasks will only be put into SUSPENDED state, and

alsoSubtasks - Should also subtasks be deleted?

parentResult -

resumeTasks

void resumeTasks(Collection<String> taskOids,
               OperationResult parentResult)

Resume suspended tasks.

Parameters:

taskOids - a collection of OIDs of tasks that have to be resumed

Throws:

SchemaException

ObjectNotFoundException

scheduleTasksNow

void scheduleTasksNow(Collection<String> taskOids,
                    OperationResult parentResult)

Schedules a RUNNABLE/CLOSED tasks to be run immediately. (If a task will really start immediately, depends e.g. on whether a scheduler is started, whether there are available threads, and so on.)

Parameters:

taskOids - a collection of OIDs of tasks that have to be scheduled

parentResult -

getTaskByIdentifier

com.evolveum.midpoint.prism.PrismObject<TaskType> getTaskByIdentifier(String identifier,
                                                                    Collection<SelectorOptions<GetOperationOptions>> options,
                                                                    OperationResult parentResult)
                                                                      throws SchemaException,
                                                                             ObjectNotFoundException

Returns information about task, given its identifier.

Parameters:

identifier -

options -

parentResult -

Returns:

Throws:

SchemaException

ObjectNotFoundException

deactivateServiceThreads

boolean deactivateServiceThreads(long timeToWait,
                               OperationResult parentResult)

Deactivates service threads (temporarily). This will suspend all background activity such as scanning threads, heartbeats and similar mechanisms. Note: The threads are normally activated after task manager implementation starts. This methods should not be used in a normal case. WARNING: this feature is intended for development-time diagnostics and should not be used on production environments. Suspending the threads may affect correct behavior of the system (such as timeouts on heartbeats). Use this feature only if you really know what you are doing. timeToWait is only for orientation = it may be so that the implementation would wait 2 or 3 times this value (if it waits separately for several threads completion)

reactivateServiceThreads

void reactivateServiceThreads(OperationResult parentResult)

Re-activates the service threads after they have been deactivated.

getServiceThreadsActivationState

boolean getServiceThreadsActivationState()

Returns true if the service threads are running. This method returns true in a normal case. It returns false is the threads were temporarily suspended.

Returns:

true if the service threads are running.

stopSchedulers

void stopSchedulers(Collection<String> nodeIdentifiers,
                  OperationResult parentResult)

Stops the schedulers on a given nodes. This means that at that nodes no tasks will be started.

Parameters:

nodeIdentifiers - Nodes on which the schedulers should be stopped.

stopSchedulersAndTasks

boolean stopSchedulersAndTasks(Collection<String> nodeIdentifiers,
                             long waitTime,
                             OperationResult parentResult)

Stops a set of schedulers (on their nodes) and tasks that are executing on these nodes.

Parameters:

nodeIdentifiers - collection of node identifiers

waitTime - how long to wait for task shutdown, in milliseconds WAIT_INDEFINITELY means wait indefinitely DO_NOT_WAIT means stop the tasks, but do not wait for finishing their execution

parentResult -

Returns:

startSchedulers

void startSchedulers(Collection<String> nodeIdentifiers,
                   OperationResult result)

Starts the scheduler on a given nodes. A prerequisite is that nodes are running and their TaskManagers are not in an error state.

Parameters:

nodeIdentifiers - Nodes on which the scheduler should be started.

synchronizeTasks

void synchronizeTasks(OperationResult parentResult)

Synchronizes information in midPoint repository and task scheduling database. Not needed to use during normal operation (only when problems occur).

Parameters:

parentResult -

getAllTaskCategories

List<String> getAllTaskCategories()

Gets a list of all task categories. TODO consider removing this method

Returns:

getHandlerUriForCategory

String getHandlerUriForCategory(String category)

Returns a default handler URI for a given task category. TODO consider removing this method (currently used for task creation via GUI)

Parameters:

category -

Returns: