com.evolveum.midpoint.model.impl.util

Class AbstractScannerTaskHandler<O extends com.evolveum.midpoint.xml.ns._public.common.common_3.ObjectType,H extends AbstractScannerResultHandler<O>>

java.lang.Object

com.evolveum.midpoint.model.impl.util.AbstractSearchIterativeTaskHandler<O,H>

com.evolveum.midpoint.model.impl.util.AbstractScannerTaskHandler<O,H>

All Implemented Interfaces:

TaskHandler

Direct Known Subclasses:

FocusValidityScannerTaskHandler, TriggerScannerTaskHandler

@Component
public abstract class AbstractScannerTaskHandler<O extends com.evolveum.midpoint.xml.ns._public.common.common_3.ObjectType,H extends AbstractScannerResultHandler<O>>
extends AbstractSearchIterativeTaskHandler<O,H>

Author:

Radovan Semancik

Field Summary

Fields

Modifier and Type	Field and Description
protected Clock	clock

Fields inherited from class com.evolveum.midpoint.model.impl.util.AbstractSearchIterativeTaskHandler

modelObjectResolver, prismContext, repositoryService, securityEnforcer, taskManager

Constructor Summary

Constructors

Constructor and Description
AbstractScannerTaskHandler(Class<O> type, String taskName, String taskOperationPrefix)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	finish(H handler, TaskRunResult runResult, Task task, OperationResult opResult)
String	getCategoryName(Task task) Returns a category name for a given task.
List<String>	getCategoryNames() Returns names of task categories provided by this handler.
protected boolean	initializeRun(H handler, TaskRunResult runResult, Task task, OperationResult opResult) Used to properly initialize the "run", which is kind of task instance.

Methods inherited from class com.evolveum.midpoint.model.impl.util.AbstractSearchIterativeTaskHandler

createHandler, createQuery, createQueryFromTask, getObjectQueryTypeFromTask, getType, getTypeFromTask, heartbeat, isEnableActionsExecutedStatistics, isEnableIterationStatistics, isEnableSynchronizationStatistics, isLogFinishInfo, isPreserveStatistics, refreshStatus, resolveObjectRef, run, runInternal, setEnableActionsExecutedStatistics, setEnableIterationStatistics, setEnableSynchronizationStatistics, setLogFinishInfo, setPreserveStatistics, useRepositoryDirectly

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

clock

@Autowired(required=true)
protected Clock clock

Constructor Detail

AbstractScannerTaskHandler

public AbstractScannerTaskHandler(Class<O> type,
                          String taskName,
                          String taskOperationPrefix)

Method Detail

initializeRun

protected boolean initializeRun(H handler,
                    TaskRunResult runResult,
                    Task task,
                    OperationResult opResult)

Description copied from class: AbstractSearchIterativeTaskHandler

Used to properly initialize the "run", which is kind of task instance. The result handler is already created at this stage. Therefore this method may be used to "enrich" the result handler with some instance-specific data.

Overrides:

initializeRun in class AbstractSearchIterativeTaskHandler<O extends com.evolveum.midpoint.xml.ns._public.common.common_3.ObjectType,H extends AbstractScannerResultHandler<O>>

finish

protected void finish(H handler,
          TaskRunResult runResult,
          Task task,
          OperationResult opResult)
               throws SchemaException

Overrides:

finish in class AbstractSearchIterativeTaskHandler<O extends com.evolveum.midpoint.xml.ns._public.common.common_3.ObjectType,H extends AbstractScannerResultHandler<O>>

Throws:

SchemaException

getCategoryName

public String getCategoryName(Task task)

Description copied from interface: TaskHandler

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

public List<String> getCategoryNames()

Description copied from interface: TaskHandler

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)