org.apache.jackrabbit.oak.spi.security.authentication.external

Interface SyncHandler

All Known Implementing Classes:

DefaultSyncHandler

public interface SyncHandler

SyncHandler is used to sync users and groups from an ExternalIdentityProvider. The synchronization performed within the scope of a SyncContext which is acquired during the createContext(ExternalIdentityProvider, org.apache.jackrabbit.api.security.user.UserManager, org.apache.jackrabbit.oak.api.Root) call. The exact configuration is managed by the sync handler instance. The system may contain several sync handler implementations with different configurations. those are managed by the SyncManager.

See Also:

SyncContext, SyncManager

Method Summary

Methods

Modifier and Type	Method and Description
SyncContext	createContext(ExternalIdentityProvider idp, org.apache.jackrabbit.api.security.user.UserManager userManager, org.apache.jackrabbit.oak.api.Root root) Initializes a sync context which is used to start the sync operations.
String	getName() Returns the name of this sync handler.

Method Detail

getName

@Nonnull
String getName()

Returns the name of this sync handler.

Returns:

sync handler name

createContext

@Nonnull
SyncContext createContext(@Nonnull
                                ExternalIdentityProvider idp,
                                @Nonnull
                                org.apache.jackrabbit.api.security.user.UserManager userManager,
                                @Nonnull
                                org.apache.jackrabbit.oak.api.Root root)
                          throws SyncException

Initializes a sync context which is used to start the sync operations.

Parameters:

idp - the external identity provider used for syncing

userManager - user manager for managing authorizables

root - root of the current tree

Returns:

the sync context

Throws:

SyncException - if an error occurs