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

Class CorrelationContext.Focus

java.lang.Object

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

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

All Implemented Interfaces:

DebugDumpable, Cloneable

Enclosing class:

CorrelationContext

public static class CorrelationContext.Focus
extends CorrelationContext

Context for correlating a focus to a set of matching focuses. TODO finish this class

Nested Class Summary

Nested classes/interfaces inherited from class com.evolveum.midpoint.model.api.correlation.CorrelationContext

CorrelationContext.Focus, CorrelationContext.Shadow

Field Summary

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

INDENT_STRING

Constructor Summary

Constructors

Constructor	Description
Focus(@NotNull FocusType preFocus, @Nullable String archetypeOid, @NotNull Set<String> candidateOids, @Nullable SystemConfigurationType systemConfiguration, @NotNull Task task)

Method Summary

Modifier and Type	Method	Description
@NotNull CorrelationContext.Shadow	asShadowCtx()
@Nullable String	getArchetypeOid()	Returns the archetype for focus objects that the candidate(s) must possess.
@NotNull Set<String>	getCandidateOids()	Returns candidate owners provided by previous correlator(s), if any.
@NotNull ObjectType	getPrimaryCorrelatedObject()	Returns the object (e.g.
String	toString()

Methods inherited from class com.evolveum.midpoint.model.api.correlation.CorrelationContext

clone, debugDump, getCorrelatorState, getFocusType, getPreFocus, getSystemConfiguration, getTask, setCorrelatorState

Methods inherited from class java.lang.Object

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

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

debugDump, debugDumpLazily, debugDumpLazily

Constructor Details

Focus

public Focus(@NotNull
 @NotNull FocusType preFocus,
 @Nullable
 @Nullable String archetypeOid,
 @NotNull
 @NotNull Set<String> candidateOids,
 @Nullable
 @Nullable SystemConfigurationType systemConfiguration,
 @NotNull
 @NotNull Task task)

Method Details

asShadowCtx

@NotNull
public @NotNull CorrelationContext.Shadow asShadowCtx()

Specified by:

asShadowCtx in class CorrelationContext

getArchetypeOid

@Nullable
public @Nullable String getArchetypeOid()

Description copied from class: CorrelationContext

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

Specified by:

getArchetypeOid in class CorrelationContext

getCandidateOids

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

Description copied from class: CorrelationContext

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.

Specified by:

getCandidateOids in class CorrelationContext

getPrimaryCorrelatedObject

@NotNull
public @NotNull ObjectType getPrimaryCorrelatedObject()

Description copied from class: CorrelationContext

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

Specified by:

getPrimaryCorrelatedObject in class CorrelationContext

toString

public String toString()

Overrides:

toString in class Object