Package com.evolveum.midpoint.task.api
Interface TaskHandler
-
- All Known Subinterfaces:
WorkBucketAwareTaskHandler
- All Known Implementing Classes:
AbstractScannerTaskHandler
,AbstractSearchIterativeModelTaskHandler
,AbstractSearchIterativeTaskHandler
,AsyncUpdateTaskHandler
,AuditReindexTaskHandler
,CleanUpTaskHandler
,DeleteNotUpdatedShadowTaskHandler
,DeleteTaskHandler
,ExecuteChangesTaskHandler
,ExecuteDeltasTaskHandler
,FocusValidityScannerTaskHandler
,ImportAccountsFromResourceTaskHandler
,ImportObjectsFromFileTaskHandler
,IterativeScriptExecutionTaskHandler
,LiveSyncTaskHandler
,ModelOperationTaskHandler
,ObjectIntegrityCheckTaskHandler
,RecomputeTaskHandler
,ReconciliationTaskHandler
,ReindexTaskHandler
,ScriptExecutionTaskHandler
,ShadowIntegrityCheckTaskHandler
,ShadowRefreshTaskHandler
,TriggerScannerTaskHandler
public interface TaskHandler
- Author:
- Radovan Semancik
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description String
getArchetypeOid()
String
getCategoryName(Task task)
Deprecated.default List<String>
getCategoryNames()
Deprecated.default @NotNull StatisticsCollectionStrategy
getStatisticsCollectionStrategy()
default Long
heartbeat(Task task)
default void
refreshStatus(Task task)
default TaskRunResult
run(RunningTask task)
TaskRunResult
run(RunningTask task, TaskPartitionDefinitionType partitionDefinition)
-
-
-
Method Detail
-
run
default TaskRunResult run(RunningTask task)
-
run
@Experimental TaskRunResult run(RunningTask task, TaskPartitionDefinitionType partitionDefinition)
-
refreshStatus
default void refreshStatus(Task task)
-
getCategoryName
@Deprecated String getCategoryName(Task task)
Deprecated.Returns a category name for a given task. In most cases, the name would be independent of concrete task.- Parameters:
task
- a task, whose category is to be determined; if getCategoryNames() returns null, this method has to accept null value as this parameter, and return the (one) category name that it gives to all tasks- Returns:
- a user-understandable name, like "LiveSync" or "Workflow"
-
getCategoryNames
@Deprecated default List<String> getCategoryNames()
Deprecated.Returns names of task categories provided by this handler. Usually it will be one-item list.- Returns:
- a list of category names; may be null - in that case the category info is given by getCategoryName(null)
-
getStatisticsCollectionStrategy
@NotNull default @NotNull StatisticsCollectionStrategy getStatisticsCollectionStrategy()
-
getArchetypeOid
String getArchetypeOid()
- Returns:
- Archetype OID for tasks that are powered by this handler.
-
-