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

Interface CorrelationService

@Experimental
public interface CorrelationService

Supports correlation.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	CorrelationService.CaseCloser

Method Summary

Modifier and Type	Method	Description
void	clearCorrelationState(@NotNull String shadowOid, @NotNull OperationResult result)	Clears the correlation state of a shadow.
void	completeCorrelationCase(@NotNull CaseType currentCase, @NotNull CorrelationService.CaseCloser closeCaseInRepository, @NotNull com.evolveum.midpoint.task.api.Task task, @NotNull OperationResult result)	Completes given correlation case.
CorrelationResult	correlate(@NotNull ShadowType shadow, @NotNull com.evolveum.midpoint.task.api.Task task, @NotNull OperationResult result)	Executes the correlation for a given shadow.
@NotNull CorrelatorContext<?>	createRootCorrelatorContext(@NotNull CompositeCorrelatorType correlators, @Nullable CorrelationDefinitionType correlationDefinitionBean, @Nullable SystemConfigurationType systemConfiguration)	Creates the root correlator context for given configuration.
Collection<CorrelationProperty>	getCorrelationProperties(@NotNull CaseType aCase, @NotNull com.evolveum.midpoint.task.api.Task task, @NotNull OperationResult result)	Returns properties relevant for the correlation, e.g.
Correlator	instantiateCorrelator(@NotNull CaseType aCase, @NotNull com.evolveum.midpoint.task.api.Task task, @NotNull OperationResult result)	Instantiates the correlator for given correlation case.
@NotNull Correlator	instantiateCorrelator(@NotNull ShadowType shadow, @NotNull com.evolveum.midpoint.task.api.Task task, @NotNull OperationResult result)	Instantiates the correlator for given shadow.

Method Detail

instantiateCorrelator

Correlator instantiateCorrelator(@NotNull
                                 @NotNull CaseType aCase,
                                 @NotNull
                                 @NotNull com.evolveum.midpoint.task.api.Task task,
                                 @NotNull
                                 @NotNull OperationResult result)
                          throws SchemaException,
                                 ConfigurationException,
                                 ExpressionEvaluationException,
                                 CommunicationException,
                                 SecurityViolationException,
                                 ObjectNotFoundException

Instantiates the correlator for given correlation case.

Throws:

SchemaException

ConfigurationException

ExpressionEvaluationException

CommunicationException

SecurityViolationException

ObjectNotFoundException

instantiateCorrelator

@NotNull
@NotNull Correlator instantiateCorrelator(@NotNull
                                          @NotNull ShadowType shadow,
                                          @NotNull
                                          @NotNull com.evolveum.midpoint.task.api.Task task,
                                          @NotNull
                                          @NotNull OperationResult result)
                                   throws SchemaException,
                                          ExpressionEvaluationException,
                                          CommunicationException,
                                          SecurityViolationException,
                                          ConfigurationException,
                                          ObjectNotFoundException

Instantiates the correlator for given shadow. TODO consider removal (seems to be unused)

Throws:

SchemaException

ExpressionEvaluationException

CommunicationException

SecurityViolationException

ConfigurationException

ObjectNotFoundException

completeCorrelationCase

void completeCorrelationCase(@NotNull
                             @NotNull CaseType currentCase,
                             @NotNull
                             @NotNull CorrelationService.CaseCloser closeCaseInRepository,
                             @NotNull
                             @NotNull com.evolveum.midpoint.task.api.Task task,
                             @NotNull
                             @NotNull OperationResult result)
                      throws SchemaException,
                             ExpressionEvaluationException,
                             CommunicationException,
                             SecurityViolationException,
                             ConfigurationException,
                             ObjectNotFoundException

Completes given correlation case. Preconditions: - case is freshly fetched, - case is a correlation one

Throws:

SchemaException

ExpressionEvaluationException

CommunicationException

SecurityViolationException

ConfigurationException

ObjectNotFoundException

getCorrelationProperties

Collection<CorrelationProperty> getCorrelationProperties(@NotNull
                                                         @NotNull CaseType aCase,
                                                         @NotNull
                                                         @NotNull com.evolveum.midpoint.task.api.Task task,
                                                         @NotNull
                                                         @NotNull OperationResult result)
                                                  throws SchemaException,
                                                         ConfigurationException,
                                                         ExpressionEvaluationException,
                                                         CommunicationException,
                                                         SecurityViolationException,
                                                         ObjectNotFoundException

Returns properties relevant for the correlation, e.g. to be shown in GUI.

Throws:

SchemaException

ConfigurationException

ExpressionEvaluationException

CommunicationException

SecurityViolationException

ObjectNotFoundException

createRootCorrelatorContext

@NotNull
@NotNull CorrelatorContext<?> createRootCorrelatorContext(@NotNull
                                                          @NotNull CompositeCorrelatorType correlators,
                                                          @Nullable
                                                          @Nullable CorrelationDefinitionType correlationDefinitionBean,
                                                          @Nullable
                                                          @Nullable SystemConfigurationType systemConfiguration)
                                                   throws ConfigurationException,
                                                          SchemaException

Creates the root correlator context for given configuration.

Throws:

ConfigurationException

SchemaException

clearCorrelationState

void clearCorrelationState(@NotNull
                           @NotNull String shadowOid,
                           @NotNull
                           @NotNull OperationResult result)
                    throws ObjectNotFoundException

Clears the correlation state of a shadow. Does not do unlinking (if the shadow is linked)!

Throws:

ObjectNotFoundException

correlate

CorrelationResult correlate(@NotNull
                            @NotNull ShadowType shadow,
                            @NotNull
                            @NotNull com.evolveum.midpoint.task.api.Task task,
                            @NotNull
                            @NotNull OperationResult result)
                     throws SchemaException,
                            ExpressionEvaluationException,
                            CommunicationException,
                            SecurityViolationException,
                            ConfigurationException,
                            ObjectNotFoundException

Executes the correlation for a given shadow.

Throws:

SchemaException

ExpressionEvaluationException

CommunicationException

SecurityViolationException

ConfigurationException

ObjectNotFoundException