Package com.evolveum.midpoint.model.api.correlator

Class CorrelationContext

java.lang.Object

com.evolveum.midpoint.model.api.correlator.CorrelationContext

All Implemented Interfaces:

DebugDumpable, Cloneable

public 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.

Field Summary

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

INDENT_STRING

Constructor Summary

Constructors

Constructor	Description
CorrelationContext(@NotNull ShadowType resourceObject, @NotNull FocusType preFocus, @NotNull ResourceType resource, @NotNull ResourceObjectTypeDefinition objectTypeDefinition, @Nullable SystemConfigurationType systemConfiguration, @NotNull com.evolveum.midpoint.task.api.Task task)

Method Summary

Modifier and Type	Method	Description
CorrelationContext	clone()	A simple shallow clone.
String	debugDump(int indent)
AbstractCorrelatorStateType	getCorrelatorState()
@NotNull Class<? extends ObjectType>	getFocusType()
@NotNull ManualCorrelationContext	getManualCorrelationContext()
@NotNull ResourceObjectTypeDefinition	getObjectTypeDefinition()
@NotNull FocusType	getPreFocus()
@NotNull ResourceType	getResource()
@NotNull ShadowType	getResourceObject()
@Nullable SystemConfigurationType	getSystemConfiguration()
@NotNull com.evolveum.midpoint.task.api.Task	getTask()
void	requestManualCorrelation()	Instructs the correlator that the manual correlation should be carried out.
void	requestManualCorrelation(List<ResourceObjectOwnerOptionType> potentialMatches)	Instructs the correlator that the manual correlation should be carried out.
void	setCorrelatorState(AbstractCorrelatorStateType correlatorState)
String	toString()

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 Detail

CorrelationContext

public CorrelationContext(@NotNull
                          @NotNull ShadowType resourceObject,
                          @NotNull
                          @NotNull FocusType preFocus,
                          @NotNull
                          @NotNull ResourceType resource,
                          @NotNull
                          @NotNull ResourceObjectTypeDefinition objectTypeDefinition,
                          @Nullable
                          @Nullable SystemConfigurationType systemConfiguration,
                          @NotNull
                          @NotNull com.evolveum.midpoint.task.api.Task task)

Method Detail

getResourceObject

@NotNull
public @NotNull ShadowType getResourceObject()

getPreFocus

@NotNull
public @NotNull FocusType getPreFocus()

getFocusType

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

getResource

@NotNull
public @NotNull ResourceType getResource()

getObjectTypeDefinition

@NotNull
public @NotNull ResourceObjectTypeDefinition getObjectTypeDefinition()

getSystemConfiguration

@Nullable
public @Nullable SystemConfigurationType getSystemConfiguration()

getCorrelatorState

public AbstractCorrelatorStateType getCorrelatorState()

setCorrelatorState

public void setCorrelatorState(AbstractCorrelatorStateType correlatorState)

getManualCorrelationContext

@NotNull
public @NotNull ManualCorrelationContext getManualCorrelationContext()

requestManualCorrelation

public void requestManualCorrelation()

Instructs the correlator that the manual correlation should be carried out. If there's only one option, an error should be signalled.

requestManualCorrelation

public void requestManualCorrelation(List<ResourceObjectOwnerOptionType> potentialMatches)

Instructs the correlator that the manual correlation should be carried out. Provides explicit list of potential matches to display. If there's only one option, an error should be signalled.

getTask

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

toString

public String toString()

Overrides:

toString in class Object

debugDump

public String debugDump(int indent)

Specified by:

debugDump in interface DebugDumpable

clone

public CorrelationContext clone()

A simple shallow clone. Use with care.

Overrides:

clone in class Object