Interface TaskSynchronizationStatisticsCollector
- All Known Subinterfaces:
RunningLightweightTask
,RunningTask
,StatisticsCollector
,Task
- All Known Implementing Classes:
NullTaskImpl
public interface TaskSynchronizationStatisticsCollector
Collects synchronization statistics related to processing of an activity within a task.
-
Method Summary
Modifier and TypeMethodDescriptionvoid
onSynchronizationExclusion
(@Nullable String processingIdentifier, @NotNull SynchronizationExclusionReasonType exclusionReason) Informs the task that no synchronization will take place.void
onSynchronizationSituationChange
(@Nullable String processingIdentifier, @Nullable String shadowOid, @Nullable SynchronizationSituationType situation) Informs the task that sync situation has changed for given shadow OID.void
onSynchronizationStart
(@Nullable String processingIdentifier, @Nullable String shadowOid, @Nullable SynchronizationSituationType situation) Called when a situation was determined right before a synchronization takes place.void
Starts collecting synchronization statistics within the task.void
stopCollectingSynchronizationStatistics
(@NotNull QualifiedItemProcessingOutcomeType outcome)
-
Method Details
-
onSynchronizationStart
void onSynchronizationStart(@Nullable @Nullable String processingIdentifier, @Nullable @Nullable String shadowOid, @Nullable @Nullable SynchronizationSituationType situation) Called when a situation was determined right before a synchronization takes place. We assume that we have a shadow with OID by that time. (If the OID is null we ignore further synchronization situation updates.) -
onSynchronizationExclusion
void onSynchronizationExclusion(@Nullable @Nullable String processingIdentifier, @NotNull @NotNull SynchronizationExclusionReasonType exclusionReason) Informs the task that no synchronization will take place. Note that in theory it is possible thatonSynchronizationStart(String, String, SynchronizationSituationType)
is called first. -
onSynchronizationSituationChange
void onSynchronizationSituationChange(@Nullable @Nullable String processingIdentifier, @Nullable @Nullable String shadowOid, @Nullable @Nullable SynchronizationSituationType situation) Informs the task that sync situation has changed for given shadow OID. There could be more such changes. But we are interested in the last one. If the shadow OID is null, we ignore such updates. -
startCollectingSynchronizationStatistics
Starts collecting synchronization statistics within the task. Must be accompanied by correspondingstopCollectingSynchronizationStatistics(QualifiedItemProcessingOutcomeType)
call. (Related to the same item!) -
stopCollectingSynchronizationStatistics
void stopCollectingSynchronizationStatistics(@NotNull @NotNull QualifiedItemProcessingOutcomeType outcome)
-