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

Class SynchronizationContext<F extends FocusType>

java.lang.Object

com.evolveum.midpoint.model.impl.sync.SynchronizationContext<F>

Type Parameters:

F - Type of the matching focus object

All Implemented Interfaces:

SingleShadowInboundsProcessingContext<F>, ResourceObjectProcessingContext, DebugDumpable

Direct Known Subclasses:

SynchronizationContext.Complete

public abstract class SynchronizationContext<F extends FocusType>
extends Object
implements SingleShadowInboundsProcessingContext<F>, ResourceObjectProcessingContext

Context of the synchronization operation. It is created in the early stages of ResourceObjectShadowChangeDescription progressing in SynchronizationServiceImpl.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SynchronizationContext.Complete<F extends FocusType>	Synchronization context ready for the synchronization, i.e. it has type identification and synchronization policy present.

Field Summary

Fields

Modifier and Type	Field	Description
protected final @Nullable ResourceObjectDefinition	resourceObjectDefinition	Definition of corresponding object (currently found by kind+intent).

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

INDENT_STRING

Constructor Summary

Constructors

Constructor	Description
SynchronizationContext(@NotNull ResourceObjectShadowChangeDescription change, @NotNull ResourceObjectProcessingContextImpl processingContext, @Nullable ResourceObjectTypeIdentification typeIdentification, @Nullable ResourceObjectDefinition objectDefinition, @Nullable SynchronizationPolicy synchronizationPolicy, @Nullable ObjectSynchronizationDiscriminatorType sorterResult, @Nullable String tag)

Method Summary

Modifier and Type	Method	Description
@NotNull VariablesMap	createVariablesMap()	Returns VariablesMap relevant for the current context.
String	debugDump(int indent)
@Nullable String	getArchetypeOid()	Returns the archetype OID bound to the object type.
@NotNull ResourceObjectShadowChangeDescription	getChange()
String	getChannel()	Returns the channel relevant to the current operation.
F	getCorrelatedOwner()
CorrelationContext	getCorrelationContext()
@NotNull ExecutionModeType	getExecutionMode()
ExpressionProfile	getExpressionProfile()
@NotNull Class<F>	getFocusClass()
String	getItemProcessingIdentifier()
F	getLinkedOwner()
@NotNull InboundMappingContextSpecification	getMappingContextSpecification()	Background information for value provenance metadata for inbound mappings related to this shadow.
@NotNull ResourceObjectDefinition	getObjectDefinitionRequired()	Relates to ResourceObjectProcessingContext.getShadowLikeValue().
F	getPreFocus()
@NotNull ResourceType	getResource()
@Nullable ObjectDelta<ShadowType>	getResourceObjectDelta()
@NotNull String	getResourceOid()
@NotNull ShadowType	getShadowedResourceObject()
@NotNull ShadowLikeValue	getShadowLikeValue()	Returns shadowed resource object, or - at least - so-called "combined object" in the sense used in ResourceObjectClassifier FIXME
String	getShadowOid()	Normally should be non-null, but we are not sure enough to mark as NotNull.
SynchronizationSituationType	getSituation()
@NotNull SynchronizationPolicy	getSynchronizationPolicyRequired()
@Nullable SystemConfigurationType	getSystemConfiguration()
String	getTag()
@NotNull Task	getTask()
@Nullable ResourceObjectTypeIdentification	getTypeIdentification()	Returns the identification of the (determined) type definition - or null if the type is not known.
abstract boolean	isComplete()
boolean	isDryRun()
boolean	isFullMode()
boolean	isProtected()
boolean	isShadowExistsInRepo()
boolean	isVisible()
void	setCorrelationContext(CorrelationContext correlationContext)
void	setShadowExistsInRepo(boolean shadowExistsInRepo)
static void	setSkipMaintenanceCheck(boolean skipMaintenanceCheck)
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

Methods inherited from interface com.evolveum.midpoint.model.impl.ResourceObjectProcessingContext

createDefaultVariablesMap, getShadowIfPresent, getShadowRequired

Methods inherited from interface com.evolveum.midpoint.model.impl.lens.projector.focus.inbounds.SingleShadowInboundsProcessingContext

getInboundDefinition, getPreFocusAsPcv, isBeforeCorrelation

Field Details

resourceObjectDefinition

@Nullable
protected final @Nullable ResourceObjectDefinition resourceObjectDefinition

Definition of corresponding object (currently found by kind+intent).

Constructor Details

SynchronizationContext

public SynchronizationContext(@NotNull
 @NotNull ResourceObjectShadowChangeDescription change,
 @NotNull
 @NotNull ResourceObjectProcessingContextImpl processingContext,
 @Nullable
 @Nullable ResourceObjectTypeIdentification typeIdentification,
 @Nullable
 @Nullable ResourceObjectDefinition objectDefinition,
 @Nullable
 @Nullable SynchronizationPolicy synchronizationPolicy,
 @Nullable
 @Nullable ObjectSynchronizationDiscriminatorType sorterResult,
 @Nullable
 @Nullable String tag)

Method Details

getMappingContextSpecification

@NotNull
public @NotNull InboundMappingContextSpecification getMappingContextSpecification()

Description copied from interface: SingleShadowInboundsProcessingContext

Background information for value provenance metadata for inbound mappings related to this shadow.

Specified by:

getMappingContextSpecification in interface SingleShadowInboundsProcessingContext<F extends FocusType>

isProtected

public boolean isProtected()

getTypeIdentification

@Nullable
public @Nullable ResourceObjectTypeIdentification getTypeIdentification()

Returns the identification of the (determined) type definition - or null if the type is not known. Note that it's not necessary to look at the shadow kind/intent if this method returns `null`, because this type is derived directly from the values in the shadow. It can be even more precise, because the shadow may be unclassified when this context is created.

getCorrelationContext

public CorrelationContext getCorrelationContext()

setCorrelationContext

public void setCorrelationContext(CorrelationContext correlationContext)

getObjectDefinitionRequired

@NotNull
public @NotNull ResourceObjectDefinition getObjectDefinitionRequired()

Description copied from interface: SingleShadowInboundsProcessingContext

Relates to ResourceObjectProcessingContext.getShadowLikeValue(). See the docs for InboundSourceData.getShadowObjectDefinition().

Specified by:

getObjectDefinitionRequired in interface SingleShadowInboundsProcessingContext<F extends FocusType>

getTag

public String getTag()

createVariablesMap

@NotNull
public @NotNull VariablesMap createVariablesMap()

Description copied from interface: ResourceObjectProcessingContext

Returns VariablesMap relevant for the current context.

Specified by:

createVariablesMap in interface ResourceObjectProcessingContext

getSynchronizationPolicyRequired

@NotNull
public @NotNull SynchronizationPolicy getSynchronizationPolicyRequired()

getShadowLikeValue

@NotNull
public @NotNull ShadowLikeValue getShadowLikeValue()

Description copied from interface: ResourceObjectProcessingContext

Returns shadowed resource object, or - at least - so-called "combined object" in the sense used in ResourceObjectClassifier FIXME

Specified by:

getShadowLikeValue in interface ResourceObjectProcessingContext

getShadowOid

public String getShadowOid()

Normally should be non-null, but we are not sure enough to mark as NotNull.

getResourceObjectDelta

@Nullable
public @Nullable ObjectDelta<ShadowType> getResourceObjectDelta()

Specified by:

getResourceObjectDelta in interface ResourceObjectProcessingContext

getResource

@NotNull
public @NotNull ResourceType getResource()

Specified by:

getResource in interface ResourceObjectProcessingContext

getResourceOid

@NotNull
public @NotNull String getResourceOid()

getFocusClass

@NotNull
public @NotNull Class<F> getFocusClass()
                                throws SchemaException

Throws:

SchemaException

getArchetypeOid

@Nullable
public @Nullable String getArchetypeOid()

Description copied from interface: SingleShadowInboundsProcessingContext

Returns the archetype OID bound to the object type. Archetypes determined from the focus itself are not returned here.

Specified by:

getArchetypeOid in interface SingleShadowInboundsProcessingContext<F extends FocusType>

getPreFocus

@NotNull
public F getPreFocus()

Specified by:

getPreFocus in interface SingleShadowInboundsProcessingContext<F extends FocusType>

getLinkedOwner

public F getLinkedOwner()

getCorrelatedOwner

public F getCorrelatedOwner()

getSituation

public SynchronizationSituationType getSituation()

getSystemConfiguration

@Nullable
public @Nullable SystemConfigurationType getSystemConfiguration()

Specified by:

getSystemConfiguration in interface ResourceObjectProcessingContext

getChannel

public String getChannel()

Description copied from interface: ResourceObjectProcessingContext

Returns the channel relevant to the current operation. It may be a channel from ResourceObjectShadowChangeDescription or from a task.

Specified by:

getChannel in interface ResourceObjectProcessingContext

getExpressionProfile

public ExpressionProfile getExpressionProfile()

getTask

@NotNull
public @NotNull Task getTask()

Specified by:

getTask in interface ResourceObjectProcessingContext

isShadowExistsInRepo

public boolean isShadowExistsInRepo()

setShadowExistsInRepo

public void setShadowExistsInRepo(boolean shadowExistsInRepo)

getItemProcessingIdentifier

public String getItemProcessingIdentifier()

toString

public String toString()

Overrides:

toString in class Object

debugDump

public String debugDump(int indent)

Specified by:

debugDump in interface DebugDumpable

setSkipMaintenanceCheck

public static void setSkipMaintenanceCheck(boolean skipMaintenanceCheck)

getExecutionMode

@NotNull
public @NotNull ExecutionModeType getExecutionMode()

isDryRun

public boolean isDryRun()

isFullMode

public boolean isFullMode()

getChange

@NotNull
public @NotNull ResourceObjectShadowChangeDescription getChange()

isComplete

public abstract boolean isComplete()

isVisible

public boolean isVisible()

getShadowedResourceObject

@NotNull
public @NotNull ShadowType getShadowedResourceObject()