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

Class DefaultSyncHandler

java.lang.Object

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

All Implemented Interfaces:

SyncHandler

@Service
public class DefaultSyncHandler
extends Object
implements SyncHandler

DefaultSyncHandler implements an sync handler that synchronizes users and groups from an external identity provider with the repository users.

Please refer to DefaultSyncConfig for configuration options.

Constructor Summary

Constructors

Constructor and Description
DefaultSyncHandler() Default constructor for OSGi
DefaultSyncHandler(DefaultSyncConfig config) Constructor for non-OSGi cases.

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultSyncHandler

public DefaultSyncHandler()

Default constructor for OSGi

DefaultSyncHandler

public DefaultSyncHandler(DefaultSyncConfig config)

Constructor for non-OSGi cases.

Parameters:

config - the configuration

Method Detail

getName

@Nonnull
public String getName()

Description copied from interface: SyncHandler

Returns the name of this sync handler.

Specified by:

getName in interface SyncHandler

Returns:

sync handler name

createContext

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

Description copied from interface: SyncHandler

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

Specified by:

createContext in interface SyncHandler

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