Package com.evolveum.midpoint.model.impl.sync.tasks.imp

Class ImportActivityRun

java.lang.Object

com.evolveum.midpoint.repo.common.activity.run.AbstractActivityRun<WD,AH,BS>

com.evolveum.midpoint.repo.common.activity.run.LocalActivityRun<WD,AH,WS>

com.evolveum.midpoint.repo.common.activity.run.IterativeActivityRun<C,WD,AH,WS>

com.evolveum.midpoint.repo.common.activity.run.SearchBasedActivityRun<ShadowType,ImportWorkDefinition,ImportActivityHandler,AbstractActivityWorkStateType>

com.evolveum.midpoint.model.impl.sync.tasks.imp.ImportActivityRun

All Implemented Interfaces:

ImplicitSegmentationResolver, IterativeActivityRunSpecifics, ExecutionSupport, DebugDumpable

public final class ImportActivityRun
extends SearchBasedActivityRun<ShadowType,ImportWorkDefinition,ImportActivityHandler,AbstractActivityWorkStateType>

Nested Class Summary

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

ExecutionSupport.CountersGroup

Field Summary

Fields inherited from class com.evolveum.midpoint.repo.common.activity.run.SearchBasedActivityRun

searchSpecification

Fields inherited from class com.evolveum.midpoint.repo.common.activity.run.IterativeActivityRun

beans, bucket, coordinator, errorState, transientRunStatistics

Fields inherited from class com.evolveum.midpoint.repo.common.activity.run.AbstractActivityRun

activity, activityState, activityStateDefinition, endTimestamp, reportingCharacteristics, startTimestamp, taskRun

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

INDENT_STRING

Method Summary

Modifier and Type	Method	Description
void	beforeRun(OperationResult result)	Called before the run.
default @Nullable SearchSpecification<C>	createCustomSearchSpecification(OperationResult result)	Creates a complete search specification.
ItemDefinitionProvider	createItemDefinitionProvider()
@NotNull ActivityReportingCharacteristics	createReportingCharacteristics()	This method should be called only after the concrete instance is fully initialized.
default ObjectQuery	customizeQuery(ObjectQuery configuredQuery, OperationResult result)	Customizes a query present in the original search specification (usually derived from the task configuration).
Collection<SelectorOptions<GetOperationOptions>>	customizeSearchOptions(Collection<SelectorOptions<GetOperationOptions>> configuredOptions, OperationResult result)
default boolean	doesRequireDirectRepositoryAccess()
protected @NotNull ObjectReferenceType	getDesiredTaskObjectRef()	Returns the value that should be put into task.objectRef.
boolean	processItem(@NotNull ShadowType object, @NotNull ItemProcessingRequest<ShadowType> request, RunningTask workerTask, OperationResult result)

Methods inherited from class com.evolveum.midpoint.repo.common.activity.run.SearchBasedActivityRun

countObjects, determineCurrentBucketSize, determineOverallSize, getDefaultErrorAction, getExpressionProfile, getItemType, getQuery, getSchemaService, getSearchOptions, getSearchSpecificationRequired, getTaskManager, isInRepository, iterateOverItemsInBucket, prepareItemSourceForCurrentBucket, processError, processItem

Methods inherited from class com.evolveum.midpoint.repo.common.activity.run.IterativeActivityRun

determineActivityStateForCounters, disableGlobalConnIdOperationsListener, enableGlobalConnIdOperationsListener, ensureNoWorkerThreads, getBucket, getConnIdOperationsReport, getContextDescription, getContextDescriptionSpaced, getErrorState, getItemsReport, getRootTask, getRootTaskOid, getShortName, getShortNameUncapitalized, getStartTimeMillis, getTransientRunStatistics, handleError, isMultithreaded, runLocally, setContextDescription, shouldReportConnIdOperations, shouldReportInternalOperations, shouldReportItems, updateStatistics

Methods inherited from class com.evolveum.midpoint.repo.common.activity.run.LocalActivityRun

getCurrentResultStatus, getCurrentResultStatusBean, isExcludedFromStalenessChecking, runInternal, setCurrentResultStatus, shouldUpdateProgressInStateOverview, updateItemProgressInTreeOverviewIfTimePassed

Methods inherited from class com.evolveum.midpoint.repo.common.activity.run.AbstractActivityRun

areActionsExecutedStatisticsSupported, areRunRecordsSupported, areStatisticsSupported, areSynchronizationStatisticsSupported, autoComputeRunResult, canRun, debugDump, debugDumpExtra, determineActivityStateDefinition, getActivity, getActivityDefinition, getActivityHandler, getActivityLocalPath, getActivityPath, getActivityState, getActivityStateDefinition, getBeans, getEndTimestamp, getExecutionMode, getItemsProcessed, getLocalParentRun, getPersistenceType, getPrismContext, getReportingCharacteristics, getReportingDefinition, getRunningTask, getStartTimestamp, getStartTimestampRequired, getTaskRun, getTreeStateOverview, getWorkDefinition, getWorkStateTypeName, incrementCounters, incrementProgress, isBucketAnalysis, isDryRun, isFullExecution, isNoExecution, isNonScavengingWorker, isPreview, isProgressSupported, isWorker, recordIterativeOperationStart, run, setInstanceReady, shouldCreateWorkStateOnInitialization, standardRunResult, standardRunResult, 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

Methods inherited from interface com.evolveum.midpoint.task.api.ExecutionSupport

getActivityPath, getExecutionMode, incrementCounters, recordIterativeOperationStart

Methods inherited from interface com.evolveum.midpoint.repo.common.activity.run.IterativeActivityRunSpecifics

afterBucketProcessing, afterRun, beforeBucketProcessing, resolveImplicitSegmentation, useOtherActivityStateForCounters

Method Detail

createReportingCharacteristics

@NotNull
public @NotNull ActivityReportingCharacteristics createReportingCharacteristics()

Description copied from class: AbstractActivityRun

This method should be called only after the concrete instance is fully initialized.

Specified by:

createReportingCharacteristics in interface IterativeActivityRunSpecifics

Overrides:

createReportingCharacteristics in class LocalActivityRun<ImportWorkDefinition,ImportActivityHandler,AbstractActivityWorkStateType>

Returns:

Reporting characteristics of the activity run. They e.g. provide default values for ActivityReportingDefinition.

beforeRun

public void beforeRun(OperationResult result)
               throws ActivityRunException,
                      CommonException

Description copied from interface: IterativeActivityRunSpecifics

Called before the run. Note that e.g. for search-based activities the search specification is *not* known at this moment.

Throws:

ActivityRunException

CommonException

getDesiredTaskObjectRef

@NotNull
protected @NotNull ObjectReferenceType getDesiredTaskObjectRef()

Description copied from class: LocalActivityRun

Returns the value that should be put into task.objectRef. Should be overridden by subclasses. It should be called _after_ IterativeActivityRunSpecifics.beforeRun(OperationResult) method, in order to give the execution a chance to prepare data for this method.

Overrides:

getDesiredTaskObjectRef in class LocalActivityRun<ImportWorkDefinition,ImportActivityHandler,AbstractActivityWorkStateType>

customizeSearchOptions

public Collection<SelectorOptions<GetOperationOptions>> customizeSearchOptions(Collection<SelectorOptions<GetOperationOptions>> configuredOptions,
                                                                               OperationResult result)

createItemDefinitionProvider

public ItemDefinitionProvider createItemDefinitionProvider()

processItem

public boolean processItem(@NotNull
                           @NotNull ShadowType object,
                           @NotNull
                           @NotNull ItemProcessingRequest<ShadowType> request,
                           RunningTask workerTask,
                           OperationResult result)
                    throws CommonException,
                           ActivityRunException

Throws:

CommonException

ActivityRunException

createCustomSearchSpecification

@Nullable
public default @Nullable SearchSpecification<C> createCustomSearchSpecification(OperationResult result)

Creates a complete search specification. If the activity is not interested in this kind of customization, it should return null, and the default search specification is then produced by the SearchBasedActivityRun. Note: freely add CommonException and ActivityRunException to the signature of this method if needed.

customizeQuery

public default ObjectQuery customizeQuery(ObjectQuery configuredQuery,
                                          OperationResult result)
                                   throws CommonException

Customizes a query present in the original search specification (usually derived from the task configuration). The activity can either add specific clauses here, or rewrite the query altogether.

Throws:

CommonException

doesRequireDirectRepositoryAccess

public default boolean doesRequireDirectRepositoryAccess()

Returns:

True if the activity requires direct repository access. Note that the framework does not check the authorizations of the user running the activity in such cases. If an autz check is needed, the activity is responsible for that.