Interface TaskManager
Task Manager Interface.
Status: public Stability: DRAFT
- Version:
- 0.1
- Author:
- Radovan Semancik
Task manager provides controls task execution, coordination, distribution and failover between nodes, etc.
This interface is just a basic framework for task management now. Although we hope that this is roughly almost final shape of the interface, the implementation is not complete and some changes may happen.
This definition specifies interface of Task Manager - a component that controls (asynchronous) task execution.
The task manager can store the task for later execution, switch them to background resume execution of a task from a different node, etc. Generally speaking, task manager provides operation to manage tasks in the whole midPoint cluster of IDM nodes.
This interface partially adheres to [Common Interface Concepts], but the goals are slightly different. This interface should be conveniently used also for tasks that are not persistent (synchronous short tasks). Therefore some methods are made much more user-friendly while tolerating some redundancy in the interface.
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic interface
Provides an information whether we can allow to run the system in clustered mode. -
Field Summary
Modifier and TypeFieldDescriptionstatic final long
static final long
static final long
-
Method Summary
Modifier and TypeMethodDescriptionaddTask
(PrismObject<TaskType> taskPrism, RepoAddOptions options, OperationResult parentResult) default String
addTask
(PrismObject<TaskType> taskPrism, OperationResult parentResult) Add new task.void
cleanupNodes
(@NotNull DeadNodeCleanupPolicyType deadNodesPolicy, @NotNull Predicate<NodeType> selector, @NotNull RunningTask task, @NotNull OperationResult opResult) Deletes dead nodes, i.e.void
cleanupTasks
(@NotNull CleanupPolicyType closedTasksPolicy, @NotNull Predicate<TaskType> selector, @NotNull RunningTask task, @NotNull OperationResult opResult) Deletes obsolete tasks, as specified in the policy.void
closeTask
(String taskOid, OperationResult parentResult) <T extends ObjectType>
intcountObjects
(Class<T> type, ObjectQuery query, OperationResult parentResult) Counts the number of objects.createFakeRunningTask
(Task task) Use only for tests.default Task
Creates new transient, running task instance.@NotNull Task
createTaskInstance
(PrismObject<TaskType> taskPrism, OperationResult parentResult) Creates task instance from the XML task representation.@NotNull Task
createTaskInstance
(PrismObject<TaskType> taskPrism, String operationName, OperationResult parentResult) Creates task instance from the XML task representation.createTaskInstance
(String operationName) Creates new transient, running task instance.boolean
deactivateServiceThreads
(long timeToWait, OperationResult parentResult) Deactivates service threads (temporarily).void
deleteNode
(String nodeOid, OperationResult result) Deletes a node from the repository.void
deleteTask
(String oid, OperationResult parentResult) Deletes task with provided OID.void
deleteTaskTree
(String rootTaskOid, OperationResult parentResult) TODO@NotNull ClusterStateType
determineClusterState
(OperationResult result) Retrieves the cluster state needed e.g.Number[]
Returns hikari pool statistics (active, idle, waiting, total, max number of DB connections) Return null if pool is unavailable.@NotNull Collection<TracingRootType>
getHandler
(String handlerUri) getLocallyRunningTaskByIdentifier
(String lightweightIdentifier) Returns locally-run task by identifier.@NotNull NodeType
Returns the local node object (immutable).@NotNull String
Returns the local node object OID.getLocalSchedulerInformation
(OperationResult parentResult) Returns the local scheduler information.getNextRunStartTime
(String oid, OperationResult result) Gets next scheduled execution time for a given task.@NotNull String
Returns identifier for current node.<T extends ObjectType>
@NotNull PrismObject<T>getObject
(Class<T> clazz, String oid, Collection<SelectorOptions<GetOperationOptions>> options, OperationResult result) TODOgetRunningTasksThreadsDump
(OperationResult parentResult) boolean
Returns true if the service threads are running.@NotNull Task
getTask
(String taskOid, Collection<SelectorOptions<GetOperationOptions>> options, OperationResult parentResult) TODO@NotNull Task
getTaskByIdentifier
(String identifier, OperationResult parentResult) Returns a task with a given identifier.@NotNull Task
getTaskPlain
(String taskOid, OperationResult parentResult) Returns a task with specified OID.@NotNull Task
getTaskPlain
(String taskOid, Collection<SelectorOptions<GetOperationOptions>> options, OperationResult parentResult) Gets the task simply by fetching it from repository.getTaskThreadsDump
(String taskOid, OperationResult parentResult) default Task
getTaskTree
(String rootTaskOid, OperationResult parentResult) @NotNull PrismObject<TaskType>
getTaskTypeByIdentifier
(String identifier, Collection<SelectorOptions<GetOperationOptions>> options, OperationResult parentResult) TODO@NotNull Task
getTaskWithResult
(String taskOid, OperationResult parentResult) Gets the task (as in getTaskPlain) but with its operation result.boolean
isCheckingIn
(NodeType node) boolean
boolean
Is clustering available (via subscription)? SeeTaskManager.ClusteringAvailabilityProvider
.boolean
isCurrentNode
(PrismObject<NodeType> node) Checks whether supplied node is the current node.boolean
boolean
EXPERIMENTAL.boolean
isOrphaned
(PrismObject<TaskType> task, OperationResult parentResult) boolean
boolean
isUpAndAlive
(NodeType node) void
markClosedTaskSuspended
(String oid, OperationResult result) Brings a closed task to suspended state.void
modifyTask
(String oid, Collection<? extends ItemDelta<?, ?>> modifications, OperationResult parentResult) Modifies task using relative change description.void
reactivateServiceThreads
(OperationResult parentResult) Re-activates the service threads after they have been deactivated.recordRunningTasksThreadsDump
(String cause, OperationResult parentResult) void
registerClusteringAvailabilityProvider
(@NotNull TaskManager.ClusteringAvailabilityProvider provider) Registers a provider forisClusteringAvailable()
information.void
registerHandler
(@NotNull String uri, @NotNull TaskHandler handler) Registers a handler for a specified handler URI.void
registerNodeUp
(OperationResult result) Registers current node as "up".void
void
registerTaskListener
(TaskListener taskListener) Registers a task listener that will be notified on task-related events.void
registerTaskUpdatedListener
(TaskUpdatedListener taskListener) void
resumeTask
(Task task, OperationResult parentResult) Resume suspended task.void
resumeTask
(String taskOid, OperationResult parentResult) void
resumeTasks
(Collection<String> taskOids, OperationResult parentResult) Resume suspended tasks.void
resumeTaskTree
(String coordinatorOid, OperationResult parentResult) void
scheduleTaskNow
(Task task, OperationResult parentResult) Schedules a RUNNABLE task or CLOSED single-run task to be run immediately.void
scheduleTaskNow
(String taskOid, OperationResult parentResult) The same as above.void
scheduleTasksNow
(Collection<String> taskOids, OperationResult parentResult) Schedules RUNNABLE/CLOSED tasks to be run immediately.<T extends ObjectType>
@NotNull SearchResultList<PrismObject<T>>searchObjects
(Class<T> type, ObjectQuery query, Collection<SelectorOptions<GetOperationOptions>> options, OperationResult parentResult) Notes: Implemented options are: - noFetch: it causes task manager NOT to ask remote nodes about node/task status.<T extends ObjectType>
SearchResultMetadatasearchObjectsIterative
(Class<T> type, ObjectQuery query, Collection<SelectorOptions<GetOperationOptions>> options, ResultHandler<T> handler, OperationResult parentResult) void
void
setGlobalTracingOverride
(@NotNull Collection<TracingRootType> roots, @NotNull TracingProfileType profile) void
setWebContextPath
(String path) EXPERIMENTAL.void
startLocalScheduler
(OperationResult parentResult) Starts the local scheduler.void
startScheduler
(String nodeIdentifier, OperationResult parentResult) Starts the scheduler on a given node.void
startSchedulers
(Collection<String> nodeIdentifiers, OperationResult parentResult) void
stopLocalScheduler
(OperationResult parentResult) Stops the local scheduler.void
stopLocalTaskRunInStandardWay
(String oid, OperationResult result) Stops the local task.void
stopScheduler
(String nodeIdentifier, OperationResult parentResult) Stops the scheduler on a given node.void
stopSchedulers
(Collection<String> nodeIdentifiers, OperationResult parentResult) 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
suspendAndCloseTaskNoException
(Task task, long suspendTimeout, OperationResult parentResult) TODOvoid
suspendAndDeleteTask
(String taskOid, long suspendTimeout, boolean alsoSubtasks, OperationResult parentResult) The same as above, but limited to a single task and throws the first exception encountered.void
suspendAndDeleteTasks
(Collection<String> taskOidList, long suspendTimeout, boolean alsoSubtasks, OperationResult parentResult) Suspends tasks and deletes them.boolean
suspendTask
(Task task, long waitTime, OperationResult parentResult) Suspends a task.boolean
suspendTask
(String taskOid, long waitTime, OperationResult parentResult) Suspends a task.boolean
suspendTasks
(Collection<String> taskOids, long waitForStop, OperationResult parentResult) Suspends a set of tasks.boolean
suspendTaskTree
(String coordinatorOid, long waitTime, OperationResult parentResult) void
switchToBackground
(Task task, OperationResult parentResult) Switches the provided task to background, making it asynchronous.void
synchronizeTasks
(OperationResult parentResult) Synchronizes information in midPoint repository and task scheduling database.void
unpauseTask
(Task task, OperationResult parentResult) Puts a WAITING task back into RUNNABLE state.void
unregisterClusteringAvailabilityProvider
(@NotNull TaskManager.ClusteringAvailabilityProvider provider) Unregisters a provider forisClusteringAvailable()
information.void
unregisterHandler
(String uri) Unregisters a handler URI (registered either as "standard", additional or deprecated handler URI).void
unregisterTaskListener
(TaskListener taskListener) Unregisters a task listener.void
unregisterTaskUpdatedListener
(TaskUpdatedListener taskListener) void
void
waitForTransientChildrenAndCloseThem
(RunningTask task, OperationResult result) Should be called only from the thread that created the children - to avoid race conditions.
-
Field Details
-
WAIT_INDEFINITELY
static final long WAIT_INDEFINITELY- See Also:
-
DO_NOT_WAIT
static final long DO_NOT_WAIT- See Also:
-
DO_NOT_STOP
static final long DO_NOT_STOP- See Also:
-
-
Method Details
-
searchObjects
@NotNull <T extends ObjectType> @NotNull SearchResultList<PrismObject<T>> searchObjects(Class<T> type, ObjectQuery query, Collection<SelectorOptions<GetOperationOptions>> options, OperationResult parentResult) throws SchemaException Notes: Implemented options are: - noFetch: it causes task manager NOT to ask remote nodes about node/task status. - (for tasks) TaskType.F_NEXT_RUN_START_TIMESTAMP: it can be used to disable asking Quartz for next run start time - other options that are passed down to repository- Throws:
SchemaException
-
searchObjectsIterative
<T extends ObjectType> SearchResultMetadata searchObjectsIterative(Class<T> type, ObjectQuery query, Collection<SelectorOptions<GetOperationOptions>> options, ResultHandler<T> handler, OperationResult parentResult) throws SchemaException - Throws:
SchemaException
-
countObjects
<T extends ObjectType> int countObjects(Class<T> type, ObjectQuery query, OperationResult parentResult) throws SchemaException Counts the number of objects.- Throws:
SchemaException
-
getObject
@NotNull <T extends ObjectType> @NotNull PrismObject<T> getObject(Class<T> clazz, String oid, Collection<SelectorOptions<GetOperationOptions>> options, OperationResult result) throws ObjectNotFoundException, SchemaException TODO -
addTask
default String addTask(PrismObject<TaskType> taskPrism, OperationResult parentResult) throws ObjectAlreadyExistsException, SchemaException Add new task. The OID provided in the task may be empty. In that case the OID will be assigned by the implementation of this method and it will be provided as return value. This operation should fail if such object already exists (if object with the provided OID already exists). The operation may fail if provided OID is in an unusable format for the storage. Generating own OIDs and providing them to this method is not recommended for normal operation. Should be atomic. Should not allow creation of two objects with the same OID (even if created in parallel). The operation may fail if the object to be created does not conform to the underlying schema of the storage system or the schema enforced by the implementation.- Parameters:
taskPrism
- object to createparentResult
- parent OperationResult (in/out)- Returns:
- OID assigned to the created object
- Throws:
ObjectAlreadyExistsException
- object with specified identifiers already exists, cannot addSchemaException
- error dealing with storage schema, e.g. schema violationIllegalArgumentException
- wrong OID format, etc.
-
addTask
String addTask(PrismObject<TaskType> taskPrism, RepoAddOptions options, OperationResult parentResult) throws ObjectAlreadyExistsException, SchemaException -
modifyTask
void modifyTask(String oid, Collection<? extends ItemDelta<?, ?>> modifications, OperationResult parentResult) throws ObjectNotFoundException, SchemaException, ObjectAlreadyExistsExceptionModifies task using relative change description. Must fail if object with provided OID does not exist. Must fail if any of the described changes cannot be applied. Should be atomic. If two or more modify operations are executed in parallel, the operations should be merged. In case that the operations are in conflict (e.g. one operation adding a value and the other removing the same value), the result is not deterministic. The operation may fail if the modified object does not conform to the underlying schema of the storage system or the schema enforced by the implementation. HOWEVER, the preferred way of modifying tasks is to use methods in Task interface.- Parameters:
oid
- OID of the task to be changedmodifications
- specification of object changesparentResult
- parent OperationResult (in/out)- Throws:
ObjectNotFoundException
- specified object does not existSchemaException
- resulting object would violate the schemaIllegalArgumentException
- wrong OID format, described change is not applicableObjectAlreadyExistsException
-
deleteTask
void deleteTask(String oid, OperationResult parentResult) throws ObjectNotFoundException, SchemaException Deletes task with provided OID. Must fail if object with specified OID does not exist. Should be atomic. BEWARE: call this method only if you are pretty sure the task is not running. Otherwise the running thread will complain when it will try to store task result into repo. (I.e. it is a good practice to suspend the task before deleting.)- Parameters:
oid
- OID of object to deleteparentResult
- parent OperationResult (in/out)- Throws:
ObjectNotFoundException
- specified object does not existIllegalArgumentException
- wrong OID format, described change is not applicableSchemaException
-
deleteTaskTree
void deleteTaskTree(String rootTaskOid, OperationResult parentResult) throws SchemaException, ObjectNotFoundException TODO -
createTaskInstance
Creates new transient, running task instance. This is fact creates usual "synchronous" task. This is useful for normal day-to-day tasks that are either synchronous or start as a synchronous and are switched to asynchronous task later.- Returns:
- transient, running task instance
-
createTaskInstance
@NotNull @NotNull Task createTaskInstance(PrismObject<TaskType> taskPrism, OperationResult parentResult) throws SchemaException Creates task instance from the XML task representation.- Parameters:
taskPrism
- JAXB (XML) representation of the task- Returns:
- new Java representation of the task
- Throws:
SchemaException
- The provided taskType is not compliant to schema
-
createTaskInstance
Creates new transient, running task instance. This in fact creates usual "synchronous" task. This is useful for normal day-to-day tasks that are either synchronous or start as a synchronous and are switched to asynchronous task later. The result inside the task will be initialized with specified operation name.- Parameters:
operationName
- operation name to use as a root for new result in task- Returns:
- new Java representation of the task
-
createTaskInstance
@NotNull @NotNull Task createTaskInstance(PrismObject<TaskType> taskPrism, @Deprecated String operationName, OperationResult parentResult) throws SchemaException Creates task instance from the XML task representation. If there is not a result inside the task, it will create the result with specified operation name.- Parameters:
taskPrism
- Prism representation of the taskoperationName
- operation name to use as a root for new result in task -- IGNORED- Returns:
- new Java representation of the task
- Throws:
SchemaException
- The provided taskType is not compliant to schema
-
getTaskPlain
@NotNull @NotNull Task getTaskPlain(String taskOid, OperationResult parentResult) throws ObjectNotFoundException, SchemaException Returns a task with specified OID. This operation will look up a task instance in the repository and return it in a form of Task object. Works only on persistent tasks. Gets the task simply by fetching it from repository. No attempts to augment it with the live data nor Quartz scheduling information nor subtasks is done. TODO can we use options (noFetch? raw?) to achieve this?- Parameters:
taskOid
- OID of the persistent task.- Returns:
- Task instance
- Throws:
SchemaException
- error dealing with resource schemaObjectNotFoundException
- wrong OID format, etc.
-
getTaskPlain
@NotNull @NotNull Task getTaskPlain(String taskOid, Collection<SelectorOptions<GetOperationOptions>> options, OperationResult parentResult) throws ObjectNotFoundException, SchemaException Gets the task simply by fetching it from repository. No attempts to augment it with the live data nor Quartz scheduling information nor subtasks is done. TODO can we use options (noFetch? raw?) to achieve this? -
getTask
@NotNull @NotNull Task getTask(String taskOid, Collection<SelectorOptions<GetOperationOptions>> options, OperationResult parentResult) throws ObjectNotFoundException, SchemaException TODO -
getTaskTree
default Task getTaskTree(String rootTaskOid, OperationResult parentResult) throws SchemaException, ObjectNotFoundException -
getTaskWithResult
@NotNull @NotNull Task getTaskWithResult(String taskOid, OperationResult parentResult) throws ObjectNotFoundException, SchemaException Gets the task (as in getTaskPlain) but with its operation result. -
closeTask
void closeTask(String taskOid, OperationResult parentResult) throws ObjectNotFoundException, SchemaException -
getTaskByIdentifier
@NotNull @NotNull Task getTaskByIdentifier(String identifier, OperationResult parentResult) throws SchemaException, ObjectNotFoundException Returns a task with a given identifier. (NOTE: Currently finds only persistent tasks. In the future, we plan to support searching for transient tasks as well.)- Parameters:
identifier
- task identifier to search for- Throws:
SchemaException
ObjectNotFoundException
-
getTaskTypeByIdentifier
@NotNull @NotNull PrismObject<TaskType> getTaskTypeByIdentifier(String identifier, Collection<SelectorOptions<GetOperationOptions>> options, OperationResult parentResult) throws SchemaException, ObjectNotFoundException TODO -
isOrphaned
- Returns:
- true if the task is orphaned i.e. it has a parent declared but not existing
- Throws:
SchemaException
-
cleanupTasks
void cleanupTasks(@NotNull @NotNull CleanupPolicyType closedTasksPolicy, @NotNull @NotNull Predicate<TaskType> selector, @NotNull @NotNull RunningTask task, @NotNull @NotNull OperationResult opResult) throws SchemaException, ObjectNotFoundException Deletes obsolete tasks, as specified in the policy. This method removes whole task trees, i.e. not single tasks. A task tree is deleted if the root task is closed (assuming all tasks in the tree are closed) and was closed before at least specified time.- Parameters:
closedTasksPolicy
- specifies which tasks are to be deleted, e.g. how old they have to beselector
- If returns false, the respective task will not be removed. In a task tree, the selector must return true for every task for the tree to be deleted.task
- task, within which context the cleanup executes (used to test for interruptions)- Throws:
SchemaException
ObjectNotFoundException
-
cleanupNodes
void cleanupNodes(@NotNull @NotNull DeadNodeCleanupPolicyType deadNodesPolicy, @NotNull @NotNull Predicate<NodeType> selector, @NotNull @NotNull RunningTask task, @NotNull @NotNull OperationResult opResult) throws SchemaException, ObjectNotFoundException Deletes dead nodes, i.e. ones that are not checking-in, and the last checkin time is older than specified time period.- Parameters:
selector
- If returns false, the respective node will not be removed.- Throws:
SchemaException
ObjectNotFoundException
-
getLocalSchedulerInformation
Returns the local scheduler information. To be called from the task manager on other nodes. -
stopLocalScheduler
Stops the local scheduler. To be called from the task manager on other nodes. -
startLocalScheduler
Starts the local scheduler. To be called from the task manager on other nodes. -
stopLocalTaskRunInStandardWay
Stops the local task. To be called from the task manager on other nodes. -
suspendTasks
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 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.- 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) On error conditions does NOT throw an exception.
-
suspendTask
boolean suspendTask(Task task, long waitTime, OperationResult parentResult) throws ObjectNotFoundException, SchemaException Suspends a task. The same as above except that on error condition it DOES throw appropriate exception. -
suspendTask
boolean suspendTask(String taskOid, long waitTime, OperationResult parentResult) throws SchemaException, ObjectNotFoundException Suspends a task. The same as above except that on error condition it DOES throw appropriate exception. -
markClosedTaskSuspended
@Experimental void markClosedTaskSuspended(String oid, OperationResult result) throws SchemaException, ObjectNotFoundException Brings a closed task to suspended state. This is to allow later resumption of the task. Not very clean solution, so don't use unless really needed. -
suspendAndDeleteTasks
void suspendAndDeleteTasks(Collection<String> taskOidList, long suspendTimeout, boolean alsoSubtasks, OperationResult parentResult) Suspends tasks and deletes them.- Parameters:
taskOidList
- List of task OIDs to be suspended and deleted.suspendTimeout
- How long (in milliseconds) to wait for task suspension before proceeding with deletion.alsoSubtasks
- Should also subtasks be deleted?
-
suspendAndDeleteTask
void suspendAndDeleteTask(String taskOid, long suspendTimeout, boolean alsoSubtasks, OperationResult parentResult) throws SchemaException, ObjectNotFoundException The same as above, but limited to a single task and throws the first exception encountered. -
suspendAndCloseTaskNoException
TODO -
resumeTask
void resumeTask(Task task, OperationResult parentResult) throws ObjectNotFoundException, SchemaException Resume suspended task.- Parameters:
task
- task instance to be resumed.- Throws:
ObjectNotFoundException
SchemaException
-
resumeTask
void resumeTask(String taskOid, OperationResult parentResult) throws ObjectNotFoundException, SchemaException -
resumeTasks
Resume suspended tasks.- Parameters:
taskOids
- a collection of OIDs of tasks that have to be resumed
-
suspendTaskTree
boolean suspendTaskTree(String coordinatorOid, long waitTime, OperationResult parentResult) throws SchemaException, ObjectNotFoundException -
resumeTaskTree
void resumeTaskTree(String coordinatorOid, OperationResult parentResult) throws SchemaException, ObjectNotFoundException -
unpauseTask
void unpauseTask(Task task, OperationResult parentResult) throws ObjectNotFoundException, SchemaException, PreconditionViolationException Puts a WAITING task back into RUNNABLE state.- Throws:
PreconditionViolationException
- If there is a conflict during unpausing, i.e. the task is originally in the waiting state, but (independently) changes the state during execution of the method.ObjectNotFoundException
SchemaException
-
switchToBackground
Switches the provided task to background, making it asynchronous. The provided task will be "released" to other nodes to execute. There is no guarantee that the task will execute on the same node that called the switchToBackground() method.- Parameters:
task
- task to switch to background.
-
scheduleTasksNow
Schedules 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 Proceeds quietly - i.e. on exception it simply logs it.
-
scheduleTaskNow
void scheduleTaskNow(Task task, OperationResult parentResult) throws SchemaException, ObjectNotFoundException Schedules a RUNNABLE task or CLOSED single-run task to be run immediately. (If the task will really start immediately, depends e.g. on whether a scheduler is started, whether there are available threads, and so on.) Throws appropriate exceptions. -
scheduleTaskNow
void scheduleTaskNow(String taskOid, OperationResult parentResult) throws SchemaException, ObjectNotFoundException The same as above. -
getNodeId
Returns identifier for current node. -
isCurrentNode
Checks whether supplied node is the current node.- Returns:
- true if node is the current node
-
deleteNode
void deleteNode(String nodeOid, OperationResult result) throws SchemaException, ObjectNotFoundException Deletes a node from the repository. (Checks whether the node is not up before deleting it.) -
registerNodeUp
Registers current node as "up". Normally this is done after midPoint starting up; but should be done explicitly in tests. -
determineClusterState
@Experimental @NotNull @NotNull ClusterStateType determineClusterState(OperationResult result) throws SchemaException Retrieves the cluster state needed e.g. for workers reconciliation.- Throws:
SchemaException
-
deactivateServiceThreads
boolean deactivateServiceThreads(long timeToWait, OperationResult parentResult) throws SchemaException 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)- Throws:
SchemaException
-
reactivateServiceThreads
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.
-
stopScheduler
Stops the scheduler on a given node. This means that at that node no tasks will be started.- Parameters:
nodeIdentifier
- Node on which the scheduler should be stopped. Null means current node.
-
stopSchedulers
-
stopSchedulersAndTasks
boolean stopSchedulersAndTasks(Collection<String> nodeIdentifiers, long waitTime, OperationResult parentResult) throws SchemaException Stops a set of schedulers (on their nodes) and tasks that are executing on these nodes.- Parameters:
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 execution.- Throws:
SchemaException
-
startScheduler
Starts the scheduler on a given node. A prerequisite is that the node is running and its TaskManager is not in an error state.- Parameters:
nodeIdentifier
- Node on which the scheduler should be started. Null means current node.
-
startSchedulers
-
registerTaskListener
Registers a task listener that will be notified on task-related events.- Parameters:
taskListener
- listener to be registered
-
unregisterTaskListener
Unregisters a task listener.- Parameters:
taskListener
- listener to be unregistered
-
registerTaskUpdatedListener
-
unregisterTaskUpdatedListener
-
synchronizeTasks
Synchronizes information in midPoint repository and task scheduling database. -
getNextRunStartTime
Gets next scheduled execution time for a given task.- Parameters:
oid
- OID of the task- Returns:
- null if there's no next scheduled execution for a given task or if a task with given OID does not exist
-
registerHandler
Registers a handler for a specified handler URI.- Parameters:
uri
- URI of the handler, e.g. http://midpoint.evolveum.com/xml/ns/public/model/cleanup/handler-3handler
- instance of the handler
-
unregisterHandler
Unregisters a handler URI (registered either as "standard", additional or deprecated handler URI). -
registerTaskDeletionListener
-
setDefaultHandlerUri
-
registerClusteringAvailabilityProvider
void registerClusteringAvailabilityProvider(@NotNull @NotNull TaskManager.ClusteringAvailabilityProvider provider) Registers a provider forisClusteringAvailable()
information. -
unregisterClusteringAvailabilityProvider
void unregisterClusteringAvailabilityProvider(@NotNull @NotNull TaskManager.ClusteringAvailabilityProvider provider) Unregisters a provider forisClusteringAvailable()
information. -
isClusteringAvailable
boolean isClusteringAvailable()Is clustering available (via subscription)? SeeTaskManager.ClusteringAvailabilityProvider
. -
isLocalNodeClusteringEnabled
boolean isLocalNodeClusteringEnabled()EXPERIMENTAL. Relaxes some assumptions on cluster structure e.g. that IP addresses of cluster members must be different. To be used for demonstration/testing only. Avoid using in production environments. -
setWebContextPath
EXPERIMENTAL. Used to provide midPoint URL path (typically "/midpoint") when determined by the web layer. -
getRunningTasksThreadsDump
-
recordRunningTasksThreadsDump
String recordRunningTasksThreadsDump(String cause, OperationResult parentResult) throws ObjectAlreadyExistsException - Throws:
ObjectAlreadyExistsException
-
getTaskThreadsDump
String getTaskThreadsDump(String taskOid, OperationResult parentResult) throws SchemaException, ObjectNotFoundException -
createFakeRunningTask
Use only for tests. (Even in that case it is an ugly hack.) -
getHandler
-
getLocalNode
Returns the local node object (immutable). -
getLocalNodeOid
Returns the local node object OID. -
getCacheConfigurationManager
CacheConfigurationManager getCacheConfigurationManager() -
isDynamicProfilingEnabled
boolean isDynamicProfilingEnabled() -
isClustered
boolean isClustered() -
isTracingOverridden
boolean isTracingOverridden() -
getGlobalTracingRequestedFor
-
getGlobalTracingProfile
TracingProfileType getGlobalTracingProfile() -
setGlobalTracingOverride
void setGlobalTracingOverride(@NotNull @NotNull Collection<TracingRootType> roots, @NotNull @NotNull TracingProfileType profile) -
unsetGlobalTracingOverride
void unsetGlobalTracingOverride() -
isUpAndAlive
- Returns:
- true if we consider this node to be "up" (alive). This is determined by looking at operational state (should be UP) and last check-in information (should not be more than nodeTimeout ago).
-
isCheckingIn
- Returns:
- true if this node has recently checked in. It might be starting or up.
-
getLocalNodeGroups
Collection<ObjectReferenceType> getLocalNodeGroups()- Returns:
- Collection of node groups that the current cluster node belongs to. The collection is unmodifiable. Groups are represented by abstract roles. (Current implementation uses node archetypes to keep this information.)
-
getLocallyRunningTaskByIdentifier
Returns locally-run task by identifier. Returned instance is the same as is being used to carrying out operations. SO USE WITH CARE. EXPERIMENTAL. Should be replaced by something like "get operational information". -
waitForTransientChildrenAndCloseThem
Should be called only from the thread that created the children - to avoid race conditions. -
getDBPoolStats
Number[] getDBPoolStats()Returns hikari pool statistics (active, idle, waiting, total, max number of DB connections) Return null if pool is unavailable. TODO move to more appropriate place
-