Package com.evolveum.midpoint.model.impl.correlator.idmatch

Class IdMatchCorrelator

java.lang.Object

com.evolveum.midpoint.model.impl.correlator.BaseCorrelator<IdMatchCorrelatorType>

com.evolveum.midpoint.model.impl.correlator.idmatch.IdMatchCorrelator

All Implemented Interfaces:

Correlator

public class IdMatchCorrelator
extends BaseCorrelator<IdMatchCorrelatorType>

A correlator based on an external service providing ID Match API. (https://spaces.at.internet2.edu/display/cifer/SOR-Registry+Strawman+ID+Match+API) Limitations: . This correlator is not to be used as a child of the composite correlator. . Currently supports only shadow-based correlations.

Nested Class Summary

Nested classes/interfaces inherited from class com.evolveum.midpoint.model.impl.correlator.BaseCorrelator

BaseCorrelator.ConfidenceValueProvider

Field Summary

Fields inherited from class com.evolveum.midpoint.model.impl.correlator.BaseCorrelator

beans, configurationBean, correlatorContext, MAX_CANDIDATES, typeName

Method Summary

Modifier and Type	Method	Description
protected @NotNull Confidence	checkCandidateOwnerInternal(@NotNull CorrelationContext correlationContext, @NotNull FocusType candidateOwner, @NotNull OperationResult result)
@NotNull CorrelationResult	correlateInternal(@NotNull CorrelationContext correlationContext, @NotNull OperationResult result)
@NotNull Collection<CorrelationPropertyDefinition>	getCorrelationPropertiesDefinitions(PrismObjectDefinition<? extends FocusType> focusDefinition, @NotNull Task task, @NotNull OperationResult result)	Returns the correlation properties this correlator uses to do the correlation.
void	resolve(@NotNull CaseType aCase, @NotNull String outcomeUri, @NotNull Task task, @NotNull OperationResult result)	Resolves a correlation case using provided work item output.
void	update(@NotNull CorrelationContext correlationContext, @NotNull OperationResult result)	Updates the internal state of the correlator with the "fresh" data from the resource.

Methods inherited from class com.evolveum.midpoint.model.impl.correlator.BaseCorrelator

checkCandidateOwner, correlate, createResult, determineConfidence, explain, explainInternal, getDefaultContextDescription, instantiateChild

Methods inherited from class java.lang.Object

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

Method Details

correlateInternal

@NotNull
public @NotNull CorrelationResult correlateInternal(@NotNull
 @NotNull CorrelationContext correlationContext,
 @NotNull
 @NotNull OperationResult result)
                                             throws ConfigurationException,
SchemaException,
CommunicationException,
SecurityViolationException

Specified by:

correlateInternal in class BaseCorrelator<IdMatchCorrelatorType>

Throws:

ConfigurationException

SchemaException

CommunicationException

SecurityViolationException

checkCandidateOwnerInternal

@NotNull
protected @NotNull Confidence checkCandidateOwnerInternal(@NotNull
 @NotNull CorrelationContext correlationContext,
 @NotNull
 @NotNull FocusType candidateOwner,
 @NotNull
 @NotNull OperationResult result)
                                                   throws ConfigurationException,
SchemaException,
CommunicationException,
SecurityViolationException

Specified by:

checkCandidateOwnerInternal in class BaseCorrelator<IdMatchCorrelatorType>

Throws:

ConfigurationException

SchemaException

CommunicationException

SecurityViolationException

update

public void update(@NotNull
 @NotNull CorrelationContext correlationContext,
 @NotNull
 @NotNull OperationResult result)
            throws SchemaException,
CommunicationException,
SecurityViolationException,
ConfigurationException

Description copied from interface: Correlator

Updates the internal state of the correlator with the "fresh" data from the resource.

Throws:

SchemaException

CommunicationException

SecurityViolationException

ConfigurationException

resolve

public void resolve(@NotNull
 @NotNull CaseType aCase,
 @NotNull
 @NotNull String outcomeUri,
 @NotNull
 @NotNull Task task,
 @NotNull
 @NotNull OperationResult result)
             throws SchemaException,
CommunicationException,
SecurityViolationException,
ObjectNotFoundException,
ExpressionEvaluationException,
ConfigurationException

Description copied from interface: Correlator

Resolves a correlation case using provided work item output. This includes the processing that needs to be done in the correlator. For the majority of correlators, there's nothing to be done here. Correlators with external and/or internal state (like ID Match) can update that state here.

outcomeUri - It is the same value as in the case. It is mentioned explicitly just to show it's not null.

Throws:

SchemaException

CommunicationException

SecurityViolationException

ObjectNotFoundException

ExpressionEvaluationException

ConfigurationException

getCorrelationPropertiesDefinitions

@NotNull
public @NotNull Collection<CorrelationPropertyDefinition> getCorrelationPropertiesDefinitions(PrismObjectDefinition<? extends FocusType> focusDefinition,
 @NotNull
 @NotNull Task task,
 @NotNull
 @NotNull OperationResult result)

Description copied from interface: Correlator

Returns the correlation properties this correlator uses to do the correlation. These are then e.g. displayed in the correlation case resolution window. May not be completely supported by all correlators. If the optional focus definition is present, the CorrelationPropertyDefinition objects returned are more precise: the paths are qualified (if possible), and the respective item definitions are set (again, if possible).