public interface TaskService
Modifier and Type | Field and Description |
---|---|
static long |
DO_NOT_STOP |
static long |
DO_NOT_WAIT |
static long |
WAIT_INDEFINITELY |
Modifier and Type | Method and Description |
---|---|
boolean |
deactivateServiceThreads(long timeToWait,
com.evolveum.midpoint.task.api.Task operationTask,
OperationResult parentResult)
Deactivates service threads (temporarily).
|
void |
deleteWorkersAndWorkState(String rootTaskOid,
boolean deleteWorkers,
long subtasksWaitTime,
com.evolveum.midpoint.task.api.Task operationTask,
OperationResult parentResult) |
List<String> |
getAllTaskCategories()
Gets a list of all task categories.
|
String |
getHandlerUriForCategory(String category)
Returns a default handler URI for a given task category.
|
String |
getRunningTasksThreadsDump(com.evolveum.midpoint.task.api.Task task,
OperationResult parentResult) |
boolean |
getServiceThreadsActivationState()
Returns true if the service threads are running.
|
PrismObject<TaskType> |
getTaskByIdentifier(String identifier,
Collection<SelectorOptions<GetOperationOptions>> options,
com.evolveum.midpoint.task.api.Task operationTask,
OperationResult parentResult)
Returns information about task, given its identifier.
|
String |
getTaskThreadsDump(String taskOid,
com.evolveum.midpoint.task.api.Task task,
OperationResult parentResult) |
String |
getThreadsDump(com.evolveum.midpoint.task.api.Task task,
OperationResult parentResult) |
void |
reactivateServiceThreads(com.evolveum.midpoint.task.api.Task operationTask,
OperationResult parentResult)
Re-activates the service threads after they have been deactivated.
|
void |
reconcileWorkers(String oid,
com.evolveum.midpoint.task.api.Task opTask,
OperationResult result) |
String |
recordRunningTasksThreadsDump(String cause,
com.evolveum.midpoint.task.api.Task task,
OperationResult parentResult) |
void |
resumeTask(String taskOid,
com.evolveum.midpoint.task.api.Task operationTask,
OperationResult parentResult) |
void |
resumeTasks(Collection<String> taskOids,
com.evolveum.midpoint.task.api.Task operationTask,
OperationResult parentResult)
Resume suspended tasks.
|
void |
resumeTaskTree(String coordinatorOid,
com.evolveum.midpoint.task.api.Task operationTask,
OperationResult parentResult) |
void |
scheduleTaskNow(String taskOid,
com.evolveum.midpoint.task.api.Task operationTask,
OperationResult parentResult) |
void |
scheduleTasksNow(Collection<String> taskOids,
com.evolveum.midpoint.task.api.Task operationTask,
OperationResult parentResult)
Schedules a RUNNABLE/CLOSED tasks to be run immediately.
|
void |
startSchedulers(Collection<String> nodeIdentifiers,
com.evolveum.midpoint.task.api.Task operationTask,
OperationResult result)
Starts the scheduler on a given nodes.
|
void |
stopSchedulers(Collection<String> nodeIdentifiers,
com.evolveum.midpoint.task.api.Task operationTask,
OperationResult parentResult)
Stops the schedulers on a given nodes.
|
boolean |
stopSchedulersAndTasks(Collection<String> nodeIdentifiers,
long waitTime,
com.evolveum.midpoint.task.api.Task operationTask,
OperationResult parentResult)
Stops a set of schedulers (on their nodes) and tasks that are executing on these nodes.
|
void |
suspendAndDeleteTask(String taskOid,
long waitForStop,
boolean alsoSubtasks,
com.evolveum.midpoint.task.api.Task operationTask,
OperationResult parentResult) |
void |
suspendAndDeleteTasks(Collection<String> taskOids,
long waitForStop,
boolean alsoSubtasks,
com.evolveum.midpoint.task.api.Task operationTask,
OperationResult parentResult)
Suspends tasks and deletes them.
|
boolean |
suspendTask(String taskOid,
long waitForStop,
com.evolveum.midpoint.task.api.Task operationTask,
OperationResult parentResult) |
boolean |
suspendTasks(Collection<String> taskOids,
long waitForStop,
com.evolveum.midpoint.task.api.Task operationTask,
OperationResult parentResult)
Suspends a set of tasks.
|
boolean |
suspendTaskTree(String taskOid,
long waitForStop,
com.evolveum.midpoint.task.api.Task operationTask,
OperationResult parentResult) |
void |
synchronizeTasks(com.evolveum.midpoint.task.api.Task operationTask,
OperationResult parentResult)
Synchronizes information in midPoint repository and task scheduling database.
|
static final long WAIT_INDEFINITELY
static final long DO_NOT_WAIT
static final long DO_NOT_STOP
boolean suspendTasks(Collection<String> taskOids, long waitForStop, com.evolveum.midpoint.task.api.Task operationTask, OperationResult parentResult) throws SecurityViolationException, ObjectNotFoundException, SchemaException, ExpressionEvaluationException, CommunicationException, ConfigurationException
taskOids
- a collection of OIDs of tasks that have to be suspendedwaitForStop
- 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.operationTask
- Task in which the operation is executed. NOT the task that be being operated on.parentResult
- SecurityViolationException
ObjectNotFoundException
SchemaException
ExpressionEvaluationException
CommunicationException
ConfigurationException
boolean suspendTask(String taskOid, long waitForStop, com.evolveum.midpoint.task.api.Task operationTask, OperationResult parentResult) throws SecurityViolationException, ObjectNotFoundException, SchemaException, ExpressionEvaluationException, CommunicationException, ConfigurationException
boolean suspendTaskTree(String taskOid, long waitForStop, com.evolveum.midpoint.task.api.Task operationTask, OperationResult parentResult) throws SecurityViolationException, ObjectNotFoundException, SchemaException, ExpressionEvaluationException, CommunicationException, ConfigurationException
void suspendAndDeleteTasks(Collection<String> taskOids, long waitForStop, boolean alsoSubtasks, com.evolveum.midpoint.task.api.Task operationTask, OperationResult parentResult) throws SecurityViolationException, ObjectNotFoundException, SchemaException, ExpressionEvaluationException, CommunicationException, ConfigurationException
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
their executions (if any) will be left as they are. Use this option only when you know what you're doing.alsoSubtasks
- Should also subtasks be deleted?parentResult
- SecurityViolationException
ObjectNotFoundException
SchemaException
ExpressionEvaluationException
CommunicationException
ConfigurationException
void suspendAndDeleteTask(String taskOid, long waitForStop, boolean alsoSubtasks, com.evolveum.midpoint.task.api.Task operationTask, OperationResult parentResult) throws SecurityViolationException, ObjectNotFoundException, SchemaException, ExpressionEvaluationException, CommunicationException, ConfigurationException
void resumeTasks(Collection<String> taskOids, com.evolveum.midpoint.task.api.Task operationTask, OperationResult parentResult) throws SecurityViolationException, ObjectNotFoundException, SchemaException, ExpressionEvaluationException, CommunicationException, ConfigurationException
taskOids
- a collection of OIDs of tasks that have to be resumedSchemaException
ObjectNotFoundException
SecurityViolationException
ExpressionEvaluationException
CommunicationException
ConfigurationException
void resumeTask(String taskOid, com.evolveum.midpoint.task.api.Task operationTask, OperationResult parentResult) throws SecurityViolationException, ObjectNotFoundException, SchemaException, ExpressionEvaluationException, CommunicationException, ConfigurationException
void resumeTaskTree(String coordinatorOid, com.evolveum.midpoint.task.api.Task operationTask, OperationResult parentResult) throws SecurityViolationException, ObjectNotFoundException, SchemaException, ExpressionEvaluationException, CommunicationException, ConfigurationException
void scheduleTasksNow(Collection<String> taskOids, com.evolveum.midpoint.task.api.Task operationTask, OperationResult parentResult) throws SecurityViolationException, ObjectNotFoundException, SchemaException, ExpressionEvaluationException, CommunicationException, ConfigurationException
taskOids
- a collection of OIDs of tasks that have to be scheduledparentResult
- SecurityViolationException
ObjectNotFoundException
SchemaException
ExpressionEvaluationException
CommunicationException
ConfigurationException
void scheduleTaskNow(String taskOid, com.evolveum.midpoint.task.api.Task operationTask, OperationResult parentResult) throws SecurityViolationException, ObjectNotFoundException, SchemaException, ExpressionEvaluationException, CommunicationException, ConfigurationException
PrismObject<TaskType> getTaskByIdentifier(String identifier, Collection<SelectorOptions<GetOperationOptions>> options, com.evolveum.midpoint.task.api.Task operationTask, OperationResult parentResult) throws SchemaException, ObjectNotFoundException, ConfigurationException, SecurityViolationException, ExpressionEvaluationException, CommunicationException
identifier
- options
- parentResult
- SchemaException
ObjectNotFoundException
ConfigurationException
SecurityViolationException
ExpressionEvaluationException
CommunicationException
boolean deactivateServiceThreads(long timeToWait, com.evolveum.midpoint.task.api.Task operationTask, OperationResult parentResult) throws SchemaException, SecurityViolationException, ObjectNotFoundException, ExpressionEvaluationException, CommunicationException, ConfigurationException
void reactivateServiceThreads(com.evolveum.midpoint.task.api.Task operationTask, OperationResult parentResult) throws SchemaException, SecurityViolationException, ObjectNotFoundException, ExpressionEvaluationException, CommunicationException, ConfigurationException
boolean getServiceThreadsActivationState()
void stopSchedulers(Collection<String> nodeIdentifiers, com.evolveum.midpoint.task.api.Task operationTask, OperationResult parentResult) throws SecurityViolationException, ObjectNotFoundException, SchemaException, ExpressionEvaluationException, CommunicationException, ConfigurationException
nodeIdentifiers
- Nodes on which the schedulers should be stopped.SecurityViolationException
ObjectNotFoundException
SchemaException
ExpressionEvaluationException
CommunicationException
ConfigurationException
boolean stopSchedulersAndTasks(Collection<String> nodeIdentifiers, long waitTime, com.evolveum.midpoint.task.api.Task operationTask, OperationResult parentResult) throws SecurityViolationException, ObjectNotFoundException, SchemaException, ExpressionEvaluationException, CommunicationException, ConfigurationException
nodeIdentifiers
- collection of node identifierswaitTime
- 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 executionparentResult
- ExpressionEvaluationException
SecurityViolationException
ObjectNotFoundException
SchemaException
CommunicationException
ConfigurationException
void startSchedulers(Collection<String> nodeIdentifiers, com.evolveum.midpoint.task.api.Task operationTask, OperationResult result) throws SecurityViolationException, ObjectNotFoundException, SchemaException, ExpressionEvaluationException, CommunicationException, ConfigurationException
nodeIdentifiers
- Nodes on which the scheduler should be started.SecurityViolationException
ObjectNotFoundException
SchemaException
ExpressionEvaluationException
CommunicationException
ConfigurationException
void synchronizeTasks(com.evolveum.midpoint.task.api.Task operationTask, OperationResult parentResult) throws SchemaException, SecurityViolationException, ObjectNotFoundException, ExpressionEvaluationException, CommunicationException, ConfigurationException
parentResult
- SchemaException
SecurityViolationException
ObjectNotFoundException
ExpressionEvaluationException
CommunicationException
ConfigurationException
List<String> getAllTaskCategories()
String getHandlerUriForCategory(String category)
category
- void reconcileWorkers(String oid, com.evolveum.midpoint.task.api.Task opTask, OperationResult result) throws CommunicationException, ObjectNotFoundException, SchemaException, SecurityViolationException, ConfigurationException, ExpressionEvaluationException, ObjectAlreadyExistsException
void deleteWorkersAndWorkState(String rootTaskOid, boolean deleteWorkers, long subtasksWaitTime, com.evolveum.midpoint.task.api.Task operationTask, OperationResult parentResult) throws SecurityViolationException, ObjectNotFoundException, SchemaException, ExpressionEvaluationException, CommunicationException, ConfigurationException
String getThreadsDump(@NotNull com.evolveum.midpoint.task.api.Task task, @NotNull OperationResult parentResult) throws CommunicationException, ObjectNotFoundException, SchemaException, SecurityViolationException, ConfigurationException, ExpressionEvaluationException
String getRunningTasksThreadsDump(@NotNull com.evolveum.midpoint.task.api.Task task, @NotNull OperationResult parentResult) throws CommunicationException, ObjectNotFoundException, SchemaException, SecurityViolationException, ConfigurationException, ExpressionEvaluationException
String recordRunningTasksThreadsDump(String cause, @NotNull com.evolveum.midpoint.task.api.Task task, @NotNull OperationResult parentResult) throws CommunicationException, ObjectNotFoundException, SchemaException, SecurityViolationException, ConfigurationException, ExpressionEvaluationException, ObjectAlreadyExistsException
String getTaskThreadsDump(@NotNull String taskOid, @NotNull com.evolveum.midpoint.task.api.Task task, @NotNull OperationResult parentResult) throws CommunicationException, ObjectNotFoundException, SchemaException, SecurityViolationException, ConfigurationException, ExpressionEvaluationException
Copyright © 2021 Evolveum. All rights reserved.