java.lang.Object
- com.evolveum.midpoint.repo.common.activity.run.AbstractActivityRun<WD,AH,WS>

Type Parameters:

WD - Definition of the work that this activity has to do.

AH - Type of the activity handler.

WS - Type of the activity work (business) state.

All Implemented Interfaces:

ExecutionSupport, DebugDumpable

Direct Known Subclasses:

DelegatingActivityRun, DistributingActivityRun, LocalActivityRun
```
public abstract class AbstractActivityRun<WD extends WorkDefinition,AH extends ActivityHandler<WD,AH>,WS extends AbstractActivityWorkStateType>
extends Object
implements ExecutionSupport, DebugDumpable
```
Implements (represents) a run of an activity. Responsibilities _at this [highest] level of abstraction_: 1. During execution - see run(OperationResult): a. initializes activity state (if needed), b. skips run of the activity if the activity realization is complete, c. executes "before run" and the real code, d. handles exceptions thrown by the execution code, converting them into ActivityRunResult (such conversion is done at various other levels, btw), e. logs the start/end, f. updates execution and result (op) status in the repository, 2. Maintains links to other activity framework objects: task run, activity, activity state (and its definition), activity state for counters. 3. Provides methods for navigation to more distant objects of the framework and other auxiliary objects (beans).

Nested Class Summary
- Nested classes/interfaces inherited from interface com.evolveum.midpoint.task.api.ExecutionSupport
  ExecutionSupport.CountersGroup

Field Summary

Fields
Modifier and Type	Field	Description
`protected @NotNull Activity<WD,AH>`	`activity`	Definition of the activity.
`protected @NotNull CurrentActivityState<WS>`	`activityState`	The "live" version of the activity state.
`protected @NotNull ActivityStateDefinition<WS>`	`activityStateDefinition`	Captures traits of the activity state (e.g.
`protected Long`	`endTimestamp`	When did this run end?
`protected @NotNull Lazy<ActivityReportingCharacteristics>`	`reportingCharacteristics`	Reporting characteristics of this kind of activity run.
`protected Long`	`startTimestamp`	When did this run start?
`protected @NotNull ActivityBasedTaskRun`	`taskRun`	The task run in context of which this activity run takes place.

Fields inherited from interface com.evolveum.midpoint.util.DebugDumpable
INDENT_STRING

Constructor Summary

Constructors
Modifier Constructor Description

protected AbstractActivityRun(@NotNull ActivityRunInstantiationContext<WD,AH> context)

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`areActionsExecutedStatisticsSupported()`
`boolean`	`areRunRecordsSupported()`
`boolean`	`areStatisticsSupported()`
`boolean`	`areSynchronizationStatisticsSupported()`
`protected ActivityRunResult`	`autoComputeRunResult()`	The status will be computed based on current operation result.
`boolean`	`canRun()`
`@NotNull ActivityReportingCharacteristics`	`createReportingCharacteristics()`	This method should be called only after the concrete instance is fully initialized.
`String`	`debugDump(int indent)`
`protected void`	`debugDumpExtra(StringBuilder sb, int indent)`
`protected ActivityStateDefinition<WS>`	`determineActivityStateDefinition()`	Called during initialization.
`protected @NotNull ActivityState`	`determineActivityStateForCounters(@NotNull OperationResult result)`
`@NotNull Activity<WD,AH>`	`getActivity()`
`@NotNull ActivityDefinition<WD>`	`getActivityDefinition()`
`AH`	`getActivityHandler()`
`@Nullable ActivityPath`	`getActivityLocalPath()`
`@NotNull ActivityPath`	`getActivityPath()`	Returns the path of the activity we are executing.
`@NotNull CurrentActivityState<WS>`	`getActivityState()`
`@NotNull ActivityStateDefinition<WS>`	`getActivityStateDefinition()`
`CommonTaskBeans`	`getBeans()`
`@NotNull String`	`getDiagName()`	Returns the name for diagnostic purposes, e.g.
`Long`	`getEndTimestamp()`
`@NotNull ExecutionModeType`	`getExecutionMode()`	Returns the mode in which the activity executes (normal, dry run, simulate, ...).
`int`	`getItemsProcessed()`
`AbstractActivityRun<?,?,?>`	`getLocalParentRun()`
`@NotNull ActivityStatePersistenceType`	`getPersistenceType()`
`@NotNull PrismContext`	`getPrismContext()`
`@NotNull ActivityReportingCharacteristics`	`getReportingCharacteristics()`
`@NotNull ActivityReportingDefinition`	`getReportingDefinition()`
`@NotNull RunningTask`	`getRunningTask()`
`Long`	`getStartTimestamp()`
`long`	`getStartTimestampRequired()`
`@NotNull ActivityBasedTaskRun`	`getTaskRun()`	Returns task run that contains this activity run.
`protected @NotNull ActivityTreeStateOverview`	`getTreeStateOverview()`
`WD`	`getWorkDefinition()`
`@NotNull QName`	`getWorkStateTypeName()`
`Map<String,Integer>`	`incrementCounters(@NotNull ExecutionSupport.CountersGroup counterGroup, @NotNull Collection<String> countersIdentifiers, @NotNull OperationResult result)`	Increments given counters related to the activity execution.
`void`	`incrementProgress(@NotNull QualifiedItemProcessingOutcomeType outcome)`
`boolean`	`isBucketAnalysis()`
`boolean`	`isDryRun()`
`boolean`	`isFullExecution()`
`boolean`	`isNoExecution()`
`boolean`	`isNonScavengingWorker()`
`boolean`	`isPreview()`
`boolean`	`isProgressSupported()`
`boolean`	`isWorker()`
`Operation`	`recordIterativeOperationStart(@NotNull IterativeOperationStartInfo info)`
`@NotNull ActivityRunResult`	`run(OperationResult result)`	Runs the activity.
`protected abstract @NotNull ActivityRunResult`	`runInternal(OperationResult result)`	Carries out the actual run of this activity.
`protected void`	`setInstanceReady()`
`boolean`	`shouldCreateWorkStateOnInitialization()`
`protected ActivityRunResult`	`standardRunResult()`
`protected ActivityRunResult`	`standardRunResult(@Nullable OperationResultStatus status)`	Finished (with specified status), or interrupted.
`String`	`toString()`

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

Methods inherited from interface com.evolveum.midpoint.util.DebugDumpable
debugDump, debugDumpLazily, debugDumpLazily

Field Detail

taskRun
```
@NotNull
protected final @NotNull ActivityBasedTaskRun taskRun
```
The task run in context of which this activity run takes place.

activity

@NotNull
protected final @NotNull Activity<WD extends WorkDefinition,AH extends ActivityHandler<WD,AH>> activity

Definition of the activity. Contains the definition of the work.

activityStateDefinition

@NotNull
protected final @NotNull ActivityStateDefinition<WS extends AbstractActivityWorkStateType> activityStateDefinition

Captures traits of the activity state (e.g. if it has to be created).

activityState

@NotNull
protected final @NotNull CurrentActivityState<WS extends AbstractActivityWorkStateType> activityState

The "live" version of the activity state.

startTimestamp
```
protected Long startTimestamp
```
When did this run start?

endTimestamp
```
protected Long endTimestamp
```
When did this run end?

reportingCharacteristics
```
@NotNull
protected final @NotNull Lazy<ActivityReportingCharacteristics> reportingCharacteristics
```
Reporting characteristics of this kind of activity run. Can be used only after the concrete instance is ready (i.e. fully initialized)!

Constructor Detail

AbstractActivityRun

protected AbstractActivityRun(@NotNull
                              @NotNull ActivityRunInstantiationContext<WD,AH> context)

Method Detail

createReportingCharacteristics
```
@NotNull
public @NotNull ActivityReportingCharacteristics createReportingCharacteristics()
```
This method should be called only after the concrete instance is fully initialized.

setInstanceReady
```
protected void setInstanceReady()
```

determineActivityStateDefinition
```
protected ActivityStateDefinition<WS> determineActivityStateDefinition()
```
Called during initialization. Should not access reporting characteristics.

getTaskRun

@NotNull
public @NotNull ActivityBasedTaskRun getTaskRun()

Returns task run that contains this activity run.

getActivity

@NotNull
public @NotNull Activity<WD,AH> getActivity()

getBeans
```
public CommonTaskBeans getBeans()
```

run
```
@NotNull
public @NotNull ActivityRunResult run(OperationResult result)
                               throws ActivityRunException
```
Runs the activity. This method is responsible for carrying out the work, e.g. recomputing all the users. For pure- or semi-composite activities it is also responsible for creating the children runs. Note that the work can be delegated to other (asynchronous) tasks. This is the case of worker tasks in multi-node task run, or of activities executed as separate subtasks.

Throws:

ActivityRunException

runInternal

@NotNull
protected abstract @NotNull ActivityRunResult runInternal(OperationResult result)
                                                   throws ActivityRunException,
                                                          CommonException

Carries out the actual run of this activity.

Throws:: ActivityRunException; CommonException

toString
```
public String toString()
```
Overrides:

toString in class Object

debugDump
```
public String debugDump(int indent)
```
Specified by:

debugDump in interface DebugDumpable

debugDumpExtra

protected void debugDumpExtra(StringBuilder sb,
                              int indent)

getActivityLocalPath

@Nullable
public @Nullable ActivityPath getActivityLocalPath()

getActivityPath
```
@NotNull
public @NotNull ActivityPath getActivityPath()
```
Description copied from interface: ExecutionSupport

Returns the path of the activity we are executing.

Specified by:

getActivityPath in interface ExecutionSupport

getLocalParentRun

public AbstractActivityRun<?,?,?> getLocalParentRun()

getActivityHandler

@NotNull
public AH getActivityHandler()

getActivityState

@NotNull
public @NotNull CurrentActivityState<WS> getActivityState()

getRunningTask

@NotNull
public @NotNull RunningTask getRunningTask()

getWorkStateTypeName

@NotNull
public @NotNull QName getWorkStateTypeName()

getTreeStateOverview

@NotNull
protected @NotNull ActivityTreeStateOverview getTreeStateOverview()

standardRunResult

protected ActivityRunResult standardRunResult()

standardRunResult

protected ActivityRunResult standardRunResult(@Nullable
                                              @Nullable OperationResultStatus status)

Finished (with specified status), or interrupted.

autoComputeRunResult
```
protected ActivityRunResult autoComputeRunResult()
```
The status will be computed based on current operation result. (This is ensured by setting the status to `null`.)

canRun
```
public boolean canRun()
```

shouldCreateWorkStateOnInitialization
```
public boolean shouldCreateWorkStateOnInitialization()
```
Returns:

true if the work (business) state should be created right on activity run initialization, along with the rest of the state Maybe we should provide this customization in the "specifics" interface for iterative activities.

getPersistenceType

@NotNull
public @NotNull ActivityStatePersistenceType getPersistenceType()

getPrismContext

@NotNull
public @NotNull PrismContext getPrismContext()

areStatisticsSupported

public boolean areStatisticsSupported()

isProgressSupported
```
public boolean isProgressSupported()
```

areSynchronizationStatisticsSupported

public boolean areSynchronizationStatisticsSupported()

areActionsExecutedStatisticsSupported

public boolean areActionsExecutedStatisticsSupported()

areRunRecordsSupported

public boolean areRunRecordsSupported()

incrementProgress

public void incrementProgress(@NotNull
                              @NotNull QualifiedItemProcessingOutcomeType outcome)

getActivityStateDefinition

@NotNull
public @NotNull ActivityStateDefinition<WS> getActivityStateDefinition()

incrementCounters

public Map<String,Integer> incrementCounters(@NotNull
                                                   @NotNull ExecutionSupport.CountersGroup counterGroup,
                                                   @NotNull
                                                   @NotNull Collection<String> countersIdentifiers,
                                                   @NotNull
                                                   @NotNull OperationResult result)
                                            throws SchemaException,
                                                   ObjectNotFoundException,
                                                   ObjectAlreadyExistsException

Description copied from interface: ExecutionSupport

Increments given counters related to the activity execution.

Specified by:: incrementCounters in interface ExecutionSupport
Returns:: Current values of the counters (after the update).
Throws:: SchemaException; ObjectNotFoundException; ObjectAlreadyExistsException

determineActivityStateForCounters

@NotNull
protected @NotNull ActivityState determineActivityStateForCounters(@NotNull
                                                                   @NotNull OperationResult result)
                                                            throws SchemaException,
                                                                   ObjectNotFoundException

Throws:: SchemaException; ObjectNotFoundException

getExecutionMode
```
@NotNull
public @NotNull ExecutionModeType getExecutionMode()
```
Description copied from interface: ExecutionSupport

Returns the mode in which the activity executes (normal, dry run, simulate, ...).

Specified by:

getExecutionMode in interface ExecutionSupport

isPreview
```
public boolean isPreview()
```

isDryRun
```
public boolean isDryRun()
```

isFullExecution
```
public boolean isFullExecution()
```

isNoExecution
```
public boolean isNoExecution()
```

isBucketAnalysis
```
public boolean isBucketAnalysis()
```

getItemsProcessed
```
public int getItemsProcessed()
```

isNonScavengingWorker

public boolean isNonScavengingWorker()

isWorker
```
public boolean isWorker()
```

getWorkDefinition

@NotNull
public WD getWorkDefinition()

getActivityDefinition

@NotNull
public @NotNull ActivityDefinition<WD> getActivityDefinition()

getReportingDefinition

@NotNull
public @NotNull ActivityReportingDefinition getReportingDefinition()

getReportingCharacteristics

@NotNull
public @NotNull ActivityReportingCharacteristics getReportingCharacteristics()

getStartTimestamp
```
public Long getStartTimestamp()
```

getStartTimestampRequired

public long getStartTimestampRequired()

getEndTimestamp
```
public Long getEndTimestamp()
```

recordIterativeOperationStart

public Operation recordIterativeOperationStart(@NotNull
                                               @NotNull IterativeOperationStartInfo info)

Specified by:: recordIterativeOperationStart in interface ExecutionSupport

getDiagName
```
@NotNull
public @NotNull String getDiagName()
```
Returns the name for diagnostic purposes, e.g. when logging an error.

Class AbstractActivityRun<WD extends WorkDefinition,​AH extends ActivityHandler<WD,​AH>,​WS extends AbstractActivityWorkStateType>

Nested Class Summary

Nested classes/interfaces inherited from interface com.evolveum.midpoint.task.api.ExecutionSupport

Field Summary

Fields inherited from interface com.evolveum.midpoint.util.DebugDumpable

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.evolveum.midpoint.util.DebugDumpable

Field Detail

taskRun

activity

activityStateDefinition

activityState

startTimestamp

endTimestamp

reportingCharacteristics

Constructor Detail

AbstractActivityRun

Method Detail

createReportingCharacteristics

setInstanceReady

determineActivityStateDefinition

getTaskRun

getActivity

getBeans

run

runInternal

toString

debugDump

debugDumpExtra

getActivityLocalPath

getActivityPath

getLocalParentRun

getActivityHandler

getActivityState

getRunningTask

getWorkStateTypeName

getTreeStateOverview

standardRunResult

standardRunResult

autoComputeRunResult

canRun

shouldCreateWorkStateOnInitialization

getPersistenceType

getPrismContext

areStatisticsSupported

isProgressSupported

areSynchronizationStatisticsSupported

areActionsExecutedStatisticsSupported

areRunRecordsSupported

incrementProgress

getActivityStateDefinition

incrementCounters

determineActivityStateForCounters

getExecutionMode

isPreview

isDryRun

isFullExecution

isNoExecution

isBucketAnalysis

getItemsProcessed

isNonScavengingWorker

isWorker

getWorkDefinition

getActivityDefinition

getReportingDefinition

getReportingCharacteristics

getStartTimestamp

getStartTimestampRequired

getEndTimestamp

recordIterativeOperationStart

getDiagName

Class AbstractActivityRun<WD extends WorkDefinition,AH extends ActivityHandler<WD,AH>,WS extends AbstractActivityWorkStateType>