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, javax.jcr.ValueFactory) 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, javax.jcr.ValueFactory valueFactory) Initializes a sync context which is used to start the sync operations.
SyncedIdentity	findIdentity(org.apache.jackrabbit.api.security.user.UserManager userManager, String id) Tries to find the identity with the given authorizable id or name.
String	getName() Returns the name of this sync handler.
Iterator<SyncedIdentity>	listIdentities(org.apache.jackrabbit.api.security.user.UserManager userManager) Lists all externally synced identities.
boolean	requiresSync(SyncedIdentity identity) Checks if the identity requires sync based on the configuration, type and last sync time.

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
                                javax.jcr.ValueFactory valueFactory)
                          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

valueFactory - the value factory to create values

Returns:

the sync context

Throws:

SyncException - if an error occurs

findIdentity

@CheckForNull
SyncedIdentity findIdentity(@Nonnull
                                       org.apache.jackrabbit.api.security.user.UserManager userManager,
                                       @Nonnull
                                       String id)
                            throws javax.jcr.RepositoryException

Tries to find the identity with the given authorizable id or name.

Parameters:

userManager - the user manager

id - the id or name of the authorizable

Returns:

a synced identity object or null

Throws:

javax.jcr.RepositoryException - if an error occurs

requiresSync

boolean requiresSync(@Nonnull
                   SyncedIdentity identity)

Checks if the identity requires sync based on the configuration, type and last sync time.

Parameters:

identity - the identity to check

Returns:

true if the identity requires synchronization.

listIdentities

@Nonnull
Iterator<SyncedIdentity> listIdentities(@Nonnull
                                              org.apache.jackrabbit.api.security.user.UserManager userManager)
                                        throws javax.jcr.RepositoryException

Lists all externally synced identities.

Parameters:

userManager - the user manager

Returns:

an iterator over all authorizable that are externally synced.

Throws:

javax.jcr.RepositoryException - if an error occurs