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

Class SyncMBeanImpl

java.lang.Object

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

All Implemented Interfaces:

SynchronizationMBean

public class SyncMBeanImpl
extends Object
implements SynchronizationMBean

Implementation of the SynchronizationMBean interface.

Constructor Summary

Constructors

Constructor and Description
SyncMBeanImpl(org.apache.jackrabbit.oak.api.ContentRepository repository, org.apache.jackrabbit.oak.spi.security.SecurityProvider securityProvider, SyncManager syncManager, String syncName, ExternalIdentityProviderManager idpManager, String idpName)

Method Summary

Modifier and Type	Method and Description
String	getIDPName() Returns the name of the ExternalIdentityProvider that this MBean operates on.
String	getSyncHandlerName() Returns the name of the SyncHandler that this MBean operates on.
String[]	listOrphanedUsers() Returns a list of orphaned users, i.e.
String[]	purgeOrphanedUsers() Purges all orphaned users.
String[]	syncAllExternalUsers() Synchronizes all the external users, i.e.
String[]	syncAllUsers(boolean purge) Synchronizes all local users with the given user ids.
String[]	syncExternalUsers(String[] externalIds) Synchronizes the external users with the given external ids.
String[]	syncUsers(String[] userIds, boolean purge) Synchronizes the local users with the given user ids.

Methods inherited from class java.lang.Object

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

Constructor Detail

SyncMBeanImpl

public SyncMBeanImpl(@Nonnull
                     org.apache.jackrabbit.oak.api.ContentRepository repository,
                     @Nonnull
                     org.apache.jackrabbit.oak.spi.security.SecurityProvider securityProvider,
                     @Nonnull
                     SyncManager syncManager,
                     @Nonnull
                     String syncName,
                     @Nonnull
                     ExternalIdentityProviderManager idpManager,
                     @Nonnull
                     String idpName)

Method Detail

getSyncHandlerName

@Nonnull
public String getSyncHandlerName()

Description copied from interface: SynchronizationMBean

Returns the name of the SyncHandler that this MBean operates on.

Specified by:

getSyncHandlerName in interface SynchronizationMBean

Returns:

the name of the sync handler.

getIDPName

@Nonnull
public String getIDPName()

Description copied from interface: SynchronizationMBean

Returns the name of the ExternalIdentityProvider that this MBean operates on.

Specified by:

getIDPName in interface SynchronizationMBean

Returns:

the name of the IDP.

syncUsers

@Nonnull
public String[] syncUsers(@Nonnull
                                   String[] userIds,
                                   boolean purge)

Description copied from interface: SynchronizationMBean

Synchronizes the local users with the given user ids.

Specified by:

syncUsers in interface SynchronizationMBean

Parameters:

userIds - the user ids

purge - if true users that don't exist in the IDP are deleted.

Returns:

result messages.

syncAllUsers

@Nonnull
public String[] syncAllUsers(boolean purge)

Description copied from interface: SynchronizationMBean

Synchronizes all local users with the given user ids. Note that this can be an expensive operation since all potential users need to be examined.

Specified by:

syncAllUsers in interface SynchronizationMBean

Parameters:

purge - if true users that don't exist in the IDP are deleted.

Returns:

result messages.

syncExternalUsers

@Nonnull
public String[] syncExternalUsers(@Nonnull
                                           String[] externalIds)

Description copied from interface: SynchronizationMBean

Synchronizes the external users with the given external ids.

Specified by:

syncExternalUsers in interface SynchronizationMBean

Parameters:

externalIds - the external id

Returns:

result messages.

syncAllExternalUsers

@Nonnull
public String[] syncAllExternalUsers()

Description copied from interface: SynchronizationMBean

Synchronizes all the external users, i.e. basically imports the entire IDP. Note that this can be an expensive operation.

Specified by:

syncAllExternalUsers in interface SynchronizationMBean

Returns:

result messages.

listOrphanedUsers

@Nonnull
public String[] listOrphanedUsers()

Description copied from interface: SynchronizationMBean

Returns a list of orphaned users, i.e. users that don't exist anymore on the IDP. Note that this can be an expensive operation since all potential users need to be examined.

Specified by:

listOrphanedUsers in interface SynchronizationMBean

Returns:

a list of the user ids of orphaned users.

purgeOrphanedUsers

@Nonnull
public String[] purgeOrphanedUsers()

Description copied from interface: SynchronizationMBean

Purges all orphaned users. this is similar to invoke SynchronizationMBean.syncUsers(String[], boolean) with the list of orphaned users. Note tha this can be an expensive operation since all potential users need to be examined.

Specified by:

purgeOrphanedUsers in interface SynchronizationMBean

Returns:

result messages.