java.lang.Object
- com.evolveum.midpoint.model.impl.correlator.BaseCorrelator<CCB>

Type Parameters:

CCB - correlator configuration bean

All Implemented Interfaces:

Correlator
```
public abstract class BaseCorrelator<CCB extends AbstractCorrelatorType>
extends Object
implements Correlator
```
Abstract superclass for non-trivial built-in correlators.

Field Summary

Fields
Modifier and Type	Field	Description
`protected @NotNull ModelBeans`	`beans`	Useful beans.
`protected CCB`	`configurationBean`	Configuration of the correlator.
`protected @NotNull CorrelatorContext<CCB>`	`correlatorContext`	Correlator [instantiation] context.
`protected static int`	`MAX_CANDIDATES`
`protected @NotNull String`	`typeName`	Correlator type name (like "filter", "expression", etc) - for diagnostics purposes.

Constructor Summary

Constructors
Modifier	Constructor	Description
`protected`	`BaseCorrelator(@NotNull Trace logger, @NotNull String typeName, @NotNull CorrelatorContext<CCB> correlatorContext, @NotNull ModelBeans beans)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`@NotNull CorrelationResult`	`correlate(@NotNull CorrelationContext correlationContext, @NotNull OperationResult parentResult)`	Finds matching focus object (or potentially matching objects) for given resource object.
`protected abstract @NotNull CorrelationResult`	`correlateInternal(@NotNull CorrelationContext correlationContext, @NotNull OperationResult result)`
`protected @NotNull String`	`getDefaultContextDescription(@NotNull CorrelationContext correlationContext)`
`protected @NotNull Correlator`	`instantiateChild(@NotNull CorrelatorConfiguration childConfiguration, @NotNull Task task, @NotNull OperationResult result)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.evolveum.midpoint.model.api.correlator.Correlator
resolve, update

Field Detail

typeName
```
@NotNull
protected final @NotNull String typeName
```
Correlator type name (like "filter", "expression", etc) - for diagnostics purposes.

correlatorContext

@NotNull
protected final @NotNull CorrelatorContext<CCB extends AbstractCorrelatorType> correlatorContext

Correlator [instantiation] context.

configurationBean

@NotNull
protected final CCB extends AbstractCorrelatorType configurationBean

Configuration of the correlator.

beans

@NotNull
protected final @NotNull ModelBeans beans

Useful beans.

MAX_CANDIDATES
```
protected static final int MAX_CANDIDATES
```
See Also:

Constant Field Values

Constructor Detail

BaseCorrelator

protected BaseCorrelator(@NotNull
                         @NotNull Trace logger,
                         @NotNull
                         @NotNull String typeName,
                         @NotNull
                         @NotNull CorrelatorContext<CCB> correlatorContext,
                         @NotNull
                         @NotNull ModelBeans beans)

Method Detail

correlate

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

Description copied from interface: Correlator

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

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

correlateInternal

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

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

getDefaultContextDescription

@NotNull
protected @NotNull String getDefaultContextDescription(@NotNull
                                                       @NotNull CorrelationContext correlationContext)

instantiateChild

@NotNull
protected @NotNull Correlator instantiateChild(@NotNull
                                               @NotNull CorrelatorConfiguration childConfiguration,
                                               @NotNull
                                               @NotNull Task task,
                                               @NotNull
                                               @NotNull OperationResult result)
                                        throws SchemaException,
                                               ConfigurationException

Throws:: SchemaException; ConfigurationException

Class BaseCorrelator<CCB extends AbstractCorrelatorType>