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 java.lang.Object
implements SynchronizationMBean

Implementation of the SynchronizationMBean interface.

Constructor Summary

Constructors

Constructor and Description
SyncMBeanImpl(@NotNull ContentRepository repository, @NotNull SecurityProvider securityProvider, @NotNull SyncManager syncManager, @NotNull java.lang.String syncName, @NotNull ExternalIdentityProviderManager idpManager, @NotNull java.lang.String idpName)

Method Summary

Modifier and Type	Method and Description
@NotNull java.lang.String[]	convertToDynamicMembership() Migrates all previously synchronized users to have dynamic membership if the SyncHandler has the dynamic membership option enabled.
@NotNull java.lang.String	getIDPName() Returns the name of the ExternalIdentityProvider that this MBean operates on.
@NotNull java.lang.String	getSyncHandlerName() Returns the name of the SyncHandler that this MBean operates on.
@NotNull java.lang.String[]	listOrphanedUsers() Returns a list of orphaned users, i.e.
@NotNull java.lang.String[]	purgeOrphanedUsers() Purges all orphaned users.
@NotNull java.lang.String[]	syncAllExternalUsers() Synchronizes all the external users, i.e.
@NotNull java.lang.String[]	syncAllUsers(boolean purge) Synchronizes all local users for the given IDP.
@NotNull java.lang.String[]	syncExternalUsers(@NotNull java.lang.String[] externalIds) Synchronizes the external users with the given external ids.
@NotNull java.lang.String[]	syncUsers(@NotNull java.lang.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(@NotNull
                     @NotNull ContentRepository repository,
                     @NotNull
                     @NotNull SecurityProvider securityProvider,
                     @NotNull
                     @NotNull SyncManager syncManager,
                     @NotNull
                     @NotNull java.lang.String syncName,
                     @NotNull
                     @NotNull ExternalIdentityProviderManager idpManager,
                     @NotNull
                     @NotNull java.lang.String idpName)

Method Detail

getSyncHandlerName

@NotNull
public @NotNull java.lang.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

@NotNull
public @NotNull java.lang.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

@NotNull
public @NotNull java.lang.String[] syncUsers(@NotNull
                                                      @NotNull java.lang.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

@NotNull
public @NotNull java.lang.String[] syncAllUsers(boolean purge)

Description copied from interface: SynchronizationMBean

Synchronizes all local users for the given IDP. 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

@NotNull
public @NotNull java.lang.String[] syncExternalUsers(@NotNull
                                                              @NotNull java.lang.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

@NotNull
public @NotNull java.lang.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

@NotNull
public @NotNull java.lang.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

@NotNull
public @NotNull java.lang.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.

convertToDynamicMembership

@NotNull
public @NotNull java.lang.String[] convertToDynamicMembership()

Description copied from interface: SynchronizationMBean

Migrates all previously synchronized users to have dynamic membership if the SyncHandler has the dynamic membership option enabled. Otherwise this method will have no effect.

Note: calling this method will only migrate existing group membership information to the dynamic persistence format. It does not retrieve the latest membership information from the external identity provider. Membership information will therefore only be updated upon the next synchronization.

Specified by:

convertToDynamicMembership in interface SynchronizationMBean

Returns:

result messages

See Also:

DefaultSyncConfig.User.getDynamicMembership()