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

Interface IdMatchService

public interface IdMatchService

Represents external ID Match service that is invoked as part of correlation (and other processes) within ID Match-based correlator.

Method Summary

Modifier and Type	Method	Description
@NotNull MatchingResult	executeMatch(@NotNull MatchingRequest request, @NotNull OperationResult result)	Request a match for given resource object attributes.
@NotNull String	resolve(@NotNull IdMatchObject idMatchObject, @Nullable String matchRequestId, @Nullable String referenceId, @NotNull OperationResult result)	Resolves a pending match.
void	update(@NotNull IdMatchObject idMatchObject, @Nullable String referenceId, @NotNull OperationResult result)	Updates an object in ID Match service.

Method Detail

executeMatch

@NotNull
@NotNull MatchingResult executeMatch(@NotNull
                                     @NotNull MatchingRequest request,
                                     @NotNull
                                     @NotNull OperationResult result)
                              throws CommunicationException,
                                     SchemaException,
                                     SecurityViolationException

Request a match for given resource object attributes.

Throws:

CommunicationException

SchemaException

SecurityViolationException

update

void update(@NotNull
            @NotNull IdMatchObject idMatchObject,
            @Nullable
            @Nullable String referenceId,
            @NotNull
            @NotNull OperationResult result)
     throws CommunicationException,
            SchemaException,
            SecurityViolationException

Updates an object in ID Match service.

Throws:

CommunicationException

SchemaException

SecurityViolationException

resolve

@NotNull
@NotNull String resolve(@NotNull
                        @NotNull IdMatchObject idMatchObject,
                        @Nullable
                        @Nullable String matchRequestId,
                        @Nullable
                        @Nullable String referenceId,
                        @NotNull
                        @NotNull OperationResult result)
                 throws CommunicationException,
                        SchemaException,
                        SecurityViolationException

Resolves a pending match.

Parameters:

idMatchObject - Object whose pending match is to be updated.

matchRequestId - Identifier of the match request (if provided by the service)

referenceId - What reference ID to assign. Null means "generate new".

Returns:

Current reference ID

Throws:

CommunicationException

SchemaException

SecurityViolationException