LiveSyncTaskHandler (midPoint Aggregate JavaDoc)

java.lang.Object
- com.evolveum.midpoint.repo.common.task.AbstractTaskHandler<TH,TE>
- - com.evolveum.midpoint.model.impl.tasks.AbstractModelTaskHandler<LiveSyncTaskHandler,LiveSyncTaskHandler.TaskExecution>
  - - com.evolveum.midpoint.model.impl.sync.tasks.LiveSyncTaskHandler

All Implemented Interfaces:

TaskHandler, WorkBucketAwareTaskHandler
```
@Component
public class LiveSyncTaskHandler
extends AbstractModelTaskHandler<LiveSyncTaskHandler,LiveSyncTaskHandler.TaskExecution>
```
The task handler for a live synchronization. This handler takes care of executing live synchronization "runs". It means that the handler "run" method will be called every few seconds. The responsibility is to scan for changes that happened since the last run.

Author:

Radovan Semancik

Nested Class Summary

Nested Classes
Modifier and Type Class Description

class LiveSyncTaskHandler.PartExecution

class LiveSyncTaskHandler.TaskExecution

Field Summary

Fields
Modifier and Type	Field	Description
`static ThreadLocal<Integer>`	`CHANGE_BEING_PROCESSED`	Local sequence number of a change that is being processed in the current thread.
`static String`	`HANDLER_URI`

Fields inherited from class com.evolveum.midpoint.model.impl.tasks.AbstractModelTaskHandler
clock, clockwork, contextFactory, eventDispatcher, expressionFactory, model, modelObjectResolver, provisioningService, securityEnforcer, synchronizationService, syncTaskHelper, systemObjectCache, taskManager

Fields inherited from class com.evolveum.midpoint.repo.common.task.AbstractTaskHandler
globalReportingOptions, lightweightIdentifierGenerator, matchingRuleRegistry, operationExecutionRecorder, prismContext, repositoryService, schemaService, taskTypeName

Constructor Summary

Constructors
Modifier Constructor Description

protected LiveSyncTaskHandler()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getArchetypeOid()`
`String`	`getCategoryName(Task task)`	Returns a category name for a given task.
`String`	`getDefaultChannel()`

Methods inherited from class com.evolveum.midpoint.model.impl.tasks.AbstractModelTaskHandler
getClock, getExpressionFactory, getProvisioningService, getSynchronizationService, getSyncTaskHelper, getSystemObjectsCache

Methods inherited from class com.evolveum.midpoint.repo.common.task.AbstractTaskHandler
createTaskExecution, getCacheConfigurationManager, getGlobalReportingOptions, getLogger, getMatchingRuleRegistry, getOperationExecutionRecorder, getPrismContext, getRepositoryService, getStatisticsCollectionStrategy, getTaskManager, getTaskTypeName, getTracer, heartbeat, refreshStatus, run

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.evolveum.midpoint.task.api.TaskHandler
getCategoryNames, run

Methods inherited from interface com.evolveum.midpoint.task.api.WorkBucketAwareTaskHandler
onNoMoreBuckets, run

- Field Detail
  - HANDLER_URI
```
public static final String HANDLER_URI
```
    See Also:
    
    Constant Field Values
  - CHANGE_BEING_PROCESSED
```
public static final ThreadLocal<Integer> CHANGE_BEING_PROCESSED
```
    Local sequence number of a change that is being processed in the current thread. Actually, it is a hack to enable testing: The code in mappings can obtain this information and do some asserts on it. When the information will be propagated into e.g. lensContext, we should remove this hack.
- Constructor Detail
  - LiveSyncTaskHandler
```
protected LiveSyncTaskHandler()
```
- Method Detail
  - 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"
  - getArchetypeOid
```
public String getArchetypeOid()
```
    Returns:
    
    Archetype OID for tasks that are powered by this handler.
  - getDefaultChannel
```
public String getDefaultChannel()
```
    Returns:
    
    Channel URI for tasks managed by this handler, if applicable.