Package com.evolveum.midpoint.task.api

Interface ExecutionSupport

All Known Implementing Classes:

AbstractActivityRun, AbstractCompositeActivityRun, AsyncUpdateActivityRun, AutoScalingActivityRun, CleanupPartialActivityRun, CompositeActivityRun, DelegatingActivityRun, DistributingActivityRun, FocusValidityScanPartialRun, ImportActivityRun, IterativeActivityRun, LiveSyncActivityRun, LocalActivityRun, PartialReconciliationActivityRun, PlainIterativeActivityRun, ResourceObjectsReconciliationActivityRun, ScanActivityRun, SearchBasedActivityRun, ShadowCleanupActivityHandler.MyRun, ShadowIntegrityCheckActivityRun, ShadowRefreshActivityHandler.MyActivityRun

public interface ExecutionSupport

Functionality that supports the activity execution that is going on within this task. This interface is used in those places in code that need to interact with the activity run but have no direct access to an object of type `AbstractActivityRun`. The only thing they have is a Task that can provide instance of this interface to them (see Task.getExecutionSupport()).

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ExecutionSupport.CountersGroup	Group of counters.

Method Summary

Modifier and Type	Method	Description
@NotNull ActivityPath	getActivityPath()	Returns the path of the activity we are executing.
@NotNull ExecutionModeType	getExecutionMode()	Returns the mode in which the activity executes (normal, dry run, simulate, ...).
Map<String,Integer>	incrementCounters(@NotNull ExecutionSupport.CountersGroup counterGroup, @NotNull Collection<String> countersIdentifiers, @NotNull OperationResult result)	Increments given counters related to the activity execution.
Operation	recordIterativeOperationStart(@NotNull IterativeOperationStartInfo info)

Method Detail

getExecutionMode

@NotNull
@NotNull ExecutionModeType getExecutionMode()

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

getActivityPath

@NotNull
@NotNull ActivityPath getActivityPath()

Returns the path of the activity we are executing.

recordIterativeOperationStart

Operation recordIterativeOperationStart(@NotNull
                                        @NotNull IterativeOperationStartInfo info)

incrementCounters

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

Increments given counters related to the activity execution.

Returns:

Current values of the counters (after the update).

Throws:

SchemaException

ObjectNotFoundException

ObjectAlreadyExistsException