All Known Implementing Classes:

BaseCorrelator
```
public interface Correlator
```
Finds a focus object for given resource object. TODO Plus other responsibilities

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`@NotNull CorrelationResult`	`correlate(@NotNull CorrelationContext correlationContext, @NotNull OperationResult result)`	Finds matching focus object (or potentially matching objects) for given resource object.
`default void`	`resolve(@NotNull CaseType aCase, @NotNull String outcomeUri, @NotNull Task task, @NotNull OperationResult result)`	Resolves a correlation case using provided work item output.
`default void`	`update(@NotNull CorrelationContext correlationContext, @NotNull OperationResult result)`	Updates the internal state of the correlator with the "fresh" data from the resource.

Method Detail

correlate

@NotNull
@NotNull CorrelationResult correlate(@NotNull
                                     @NotNull CorrelationContext correlationContext,
                                     @NotNull
                                     @NotNull OperationResult result)
                              throws SchemaException,
                                     ExpressionEvaluationException,
                                     CommunicationException,
                                     SecurityViolationException,
                                     ConfigurationException,
                                     ObjectNotFoundException

Finds matching focus object (or potentially matching objects) for given resource object. We assume that the correlator is already configured. See CorrelatorFactory.

Parameters:: correlationContext - Additional information about the overall context for correlation (e.g. type of focal objects); result - Operation result where the method should record its operation
Throws:: SchemaException; ExpressionEvaluationException; CommunicationException; SecurityViolationException; ConfigurationException; ObjectNotFoundException

update

@Experimental
default void update(@NotNull
                    @NotNull CorrelationContext correlationContext,
                    @NotNull
                    @NotNull OperationResult result)
             throws SchemaException,
                    ExpressionEvaluationException,
                    CommunicationException,
                    SecurityViolationException,
                    ConfigurationException,
                    ObjectNotFoundException

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

Throws:: SchemaException; ExpressionEvaluationException; CommunicationException; SecurityViolationException; ConfigurationException; ObjectNotFoundException

resolve

default 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

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.

Parameters:: 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

Interface Correlator

Method Summary

Method Detail

correlate

update

resolve