Package com.evolveum.midpoint.model.api.correlation

Class CorrelationContext

java.lang.Object

com.evolveum.midpoint.model.api.correlation.CorrelationContext

All Implemented Interfaces:

DebugDumpable, Cloneable

Direct Known Subclasses:

CorrelationContext.Focus, CorrelationContext.Shadow

public abstract class CorrelationContext
extends Object
implements DebugDumpable, Cloneable

The context of the correlation and correlator state update operations. (Both work on an object being synchronized. The use in the latter case is experimental, though.) Created by _the caller_ of Correlator.correlate(CorrelationContext, OperationResult) method, but then updated by the method implementation(s) themselves. Not to be confused with CorrelatorContext which describes the context of the whole Correlator lifespan.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CorrelationContext.Focus	Context for correlating a focus to a set of matching focuses.
static class	CorrelationContext.Shadow	Context for correlating a shadow to a set of matching focuses.

Field Summary

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

INDENT_STRING

Constructor Summary

Constructors

Constructor	Description
CorrelationContext(@NotNull Containerable preFocus, @Nullable Collection<? extends Containerable> candidatePool, @Nullable SystemConfigurationType systemConfiguration, @NotNull com.evolveum.midpoint.task.api.Task task)

Method Summary

Modifier and Type	Method	Description
abstract @NotNull CorrelationContext.Shadow	asShadowCtx()
CorrelationContext	clone()	A simple shallow clone.
String	debugDump(int indent)
abstract @Nullable String	getArchetypeOid()	Returns the archetype for focus objects that the candidate(s) must possess.
abstract @NotNull Set<String>	getCandidateOids()	Returns candidate owners provided by previous correlator(s), if any.
@Nullable Collection<? extends Containerable>	getCandidatePool()
AbstractCorrelatorStateType	getCorrelatorState()
@NotNull Class<? extends Containerable>	getFocusContainerableType()
@NotNull Class<? extends ObjectType>	getFocusType()
@NotNull FocusType	getPreFocus()
@NotNull Containerable	getPreFocusContainerable()
abstract @NotNull Containerable	getPrimaryCorrelatedObject()	Returns the object (e.g.
@Nullable SystemConfigurationType	getSystemConfiguration()
@NotNull com.evolveum.midpoint.task.api.Task	getTask()
void	setCorrelatorState(AbstractCorrelatorStateType correlatorState)

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

debugDump, debugDumpLazily, debugDumpLazily

Constructor Details

CorrelationContext

public CorrelationContext(@NotNull
 @NotNull Containerable preFocus,
 @Nullable
 @Nullable Collection<? extends Containerable> candidatePool,
 @Nullable
 @Nullable SystemConfigurationType systemConfiguration,
 @NotNull
 @NotNull com.evolveum.midpoint.task.api.Task task)

Method Details

getPreFocus

@NotNull
public @NotNull FocusType getPreFocus()

getPreFocusContainerable

@NotNull
public @NotNull Containerable getPreFocusContainerable()

getFocusType

@NotNull
public @NotNull Class<? extends ObjectType> getFocusType()

getFocusContainerableType

@NotNull
public @NotNull Class<? extends Containerable> getFocusContainerableType()

getCandidatePool

@Nullable
public @Nullable Collection<? extends Containerable> getCandidatePool()

getArchetypeOid

@Nullable
public abstract @Nullable String getArchetypeOid()

Returns the archetype for focus objects that the candidate(s) must possess. Null means "no restrictions".

getCandidateOids

@NotNull
public abstract @NotNull Set<String> getCandidateOids()

Returns candidate owners provided by previous correlator(s), if any. Background: If more child correlators are defined to be used, they will run separately (at least under the default implementation of the composite correlator), one after another. The original implementation executed each of the correlators independently, so that (typically) each of them issued its own query over all population of focus objects. The results were then combined by the composite correlator. However, there might be situations where subsequent correlators should just _refine_ the results returned by previous one(s). For that, we want to retain the relevant candidate owner(s) OID(s) in the context, and use that to limit search within those correlators. Empty set means "no previous candidates available", i.e. no restrictions will be applied. LIMITED USE. Currently used only "identification recovery" feature - for CorrelationContext.Focus context and `items` correlator.

getSystemConfiguration

@Nullable
public @Nullable SystemConfigurationType getSystemConfiguration()

getCorrelatorState

public AbstractCorrelatorStateType getCorrelatorState()

setCorrelatorState

public void setCorrelatorState(AbstractCorrelatorStateType correlatorState)

getTask

@NotNull
public @NotNull com.evolveum.midpoint.task.api.Task getTask()

debugDump

public String debugDump(int indent)

Specified by:

debugDump in interface DebugDumpable

asShadowCtx

@NotNull
public abstract @NotNull CorrelationContext.Shadow asShadowCtx()

clone

public CorrelationContext clone()

A simple shallow clone. Use with care.

Overrides:

clone in class Object

getPrimaryCorrelatedObject

@NotNull
public abstract @NotNull Containerable getPrimaryCorrelatedObject()

Returns the object (e.g. shadow or focus or its part) that is being correlated. Currently for logging purposes.