public class SyncMBeanImpl extends java.lang.Object implements SynchronizationMBean
SynchronizationMBean
interface.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) |
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.
|
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)
@NotNull public @NotNull java.lang.String getSyncHandlerName()
SynchronizationMBean
SyncHandler
that this MBean operates on.getSyncHandlerName
in interface SynchronizationMBean
@NotNull public @NotNull java.lang.String getIDPName()
SynchronizationMBean
ExternalIdentityProvider
that this MBean operates on.getIDPName
in interface SynchronizationMBean
@NotNull public @NotNull java.lang.String[] syncUsers(@NotNull @NotNull java.lang.String[] userIds, boolean purge)
SynchronizationMBean
syncUsers
in interface SynchronizationMBean
userIds
- the user idspurge
- if true
users that don't exist in the IDP are deleted.@NotNull public @NotNull java.lang.String[] syncAllUsers(boolean purge)
SynchronizationMBean
syncAllUsers
in interface SynchronizationMBean
purge
- if true
users that don't exist in the IDP are deleted.@NotNull public @NotNull java.lang.String[] syncExternalUsers(@NotNull @NotNull java.lang.String[] externalIds)
SynchronizationMBean
syncExternalUsers
in interface SynchronizationMBean
externalIds
- the external id@NotNull public @NotNull java.lang.String[] syncAllExternalUsers()
SynchronizationMBean
syncAllExternalUsers
in interface SynchronizationMBean
@NotNull public @NotNull java.lang.String[] listOrphanedUsers()
SynchronizationMBean
listOrphanedUsers
in interface SynchronizationMBean
@NotNull public @NotNull java.lang.String[] purgeOrphanedUsers()
SynchronizationMBean
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.purgeOrphanedUsers
in interface SynchronizationMBean
@NotNull public @NotNull java.lang.String[] convertToDynamicMembership()
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.
convertToDynamicMembership
in interface SynchronizationMBean
DefaultSyncConfig.User.getDynamicMembership()
Copyright © 2012–2022 The Apache Software Foundation. All rights reserved.