com.evolveum.midpoint.task.api

Interface TaskHandler

All Known Implementing Classes:

AbstractScannerTaskHandler, AbstractSearchIterativeTaskHandler, AccessCertificationCampaignCreationTaskHandler, AccessCertificationRemediationTaskHandler, CleanUpTaskHandler, DeleteTaskHandler, ExecuteChangesTaskHandler, FocusValidityScannerTaskHandler, ImportAccountsFromResourceTaskHandler, ImportObjectsFromFileTaskHandler, LiveSyncTaskHandler, ModelOperationTaskHandler, NoOpTaskHandler, RecomputeTaskHandler, ReconciliationTaskHandler, ReindexTaskHandler, ReportCreateTaskHandler, ScriptExecutionTaskHandler, ShadowIntegrityCheckTaskHandler, TriggerScannerTaskHandler, WaitForSubtasksByPollingTaskHandler, WaitForTasksTaskHandler, WfPrepareChildOperationTaskHandler, WfPrepareRootOperationTaskHandler, WfProcessInstanceShadowTaskHandler, WfPropagateTaskObjectReferenceTaskHandler

public interface TaskHandler

Author:

Radovan Semancik

Method Summary

Methods

Modifier and Type	Method and Description
String	getCategoryName(Task task) Returns a category name for a given task.
List<String>	getCategoryNames() Returns names of task categories provided by this handler.
Long	heartbeat(Task task)
void	refreshStatus(Task task)
TaskRunResult	run(Task task)

Method Detail

run

TaskRunResult run(Task task)

heartbeat

Long heartbeat(Task task)

refreshStatus

void refreshStatus(Task task)

getCategoryName

String getCategoryName(Task task)

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

List<String> getCategoryNames()

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)