Package org.apache.syncope.core.provisioning.api.rules

Interface PullCorrelationRule

All Known Implementing Classes:

DefaultPullCorrelationRule, DummyPullCorrelationRule, LinkedAccountSamplePullCorrelationRule

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface PullCorrelationRule

Interface for correlation rule to be evaluated during PullJob execution.

Field Summary

Fields

Modifier and Type	Field	Description
static PullMatch	NO_MATCH

Method Summary

Modifier and Type	Method	Description
SearchCond	getSearchCond(SyncDelta syncDelta, Provision provision)	Return a search condition.
default PullMatch	matching(Any<?> any, SyncDelta syncDelta, Provision provision)	Create matching information for the given Any, found matching for the given SyncDelta and Provision.
default void	setConf(PullCorrelationRuleConf conf)
default Optional<PullMatch>	unmatching(SyncDelta syncDelta, Provision provision)	Optionally create matching information in case no matching Any was found for the given SyncDelta and Provision.

Field Detail

NO_MATCH

static final PullMatch NO_MATCH

Method Detail

setConf

default void setConf(PullCorrelationRuleConf conf)

getSearchCond

SearchCond getSearchCond(SyncDelta syncDelta,
                         Provision provision)

Return a search condition.

Parameters:

syncDelta - change operation, including external attributes

provision - resource provision

Returns:

search condition.

matching

default PullMatch matching(Any<?> any,
                           SyncDelta syncDelta,
                           Provision provision)

Create matching information for the given Any, found matching for the given SyncDelta and Provision. For users, this might end with creating / updating / deleting a LinkedAccount.

Parameters:

any - any

syncDelta - change operation, including external attributes

provision - resource provision

Returns:

matching information

unmatching

default Optional<PullMatch> unmatching(SyncDelta syncDelta,
                                       Provision provision)

Optionally create matching information in case no matching Any was found for the given SyncDelta and Provision. For users, this might end with creating a LinkedAccount.

Parameters:

syncDelta - change operation, including external attributes

provision - resource provision

Returns:

matching information