com.atlassian.crowd.directory.synchronisation.cache

Class UsnChangedCacheRefresher

java.lang.Object

com.atlassian.crowd.directory.synchronisation.cache.AbstractCacheRefresher<LDAPGroupWithAttributes>

com.atlassian.crowd.directory.synchronisation.cache.UsnChangedCacheRefresher

All Implemented Interfaces:

CacheRefresher

public class UsnChangedCacheRefresher
extends AbstractCacheRefresher<LDAPGroupWithAttributes>
implements CacheRefresher

Retrieves latest changes from MS Active Directory in order to allow "delta" cache refreshes.

See http://msdn.microsoft.com/en-us/library/ms677625.aspx and http://msdn.microsoft.com/en-us/library/ms677627%28VS.85%29.aspx for details on polling Microsoft Active Directory.

This class is guaranteed to be run from a single thread at a time by per directory. This means it does not need to worry about race-conditions, but still must consider safe publication of variables (per directory). The incremental sync of users comes in two flavors:

• Legacy mode - based on usnChanged attribute only
• New 'bulletproof' mode (default) - using both usnChanged and ObjectGUID diff between internal and remote directory

It is possible to switch back to 'legacy mode' by supplying a system property named PROPERTY_USE_LEGACY_AD_INCREMENTAL_SYNC set to true.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROPERTY_USE_LEGACY_AD_INCREMENTAL_SYNC

Fields inherited from class com.atlassian.crowd.directory.synchronisation.cache.AbstractCacheRefresher

remoteDirectory

Constructor Summary

Constructors

Constructor and Description
UsnChangedCacheRefresher(MicrosoftActiveDirectory activeDirectory)

Method Summary

Modifier and Type	Method and Description
protected Iterable<Membership>	getMemberships(Collection<LDAPGroupWithAttributes> groupsToInclude, boolean isFullSync)
CacheSynchronisationResult	synchroniseAll(DirectoryCache directoryCache)
protected PartialSynchronisationResult<LDAPGroupWithAttributes>	synchroniseAllGroups(DirectoryCache directoryCache)
protected PartialSynchronisationResult<? extends UserWithAttributes>	synchroniseAllUsers(DirectoryCache directoryCache)
CacheSynchronisationResult	synchroniseChanges(DirectoryCache directoryCache, String highestCommittedUsn)

Methods inherited from class com.atlassian.crowd.directory.synchronisation.cache.AbstractCacheRefresher

directoryDescription, isGroupAttributeSynchronisationEnabled, isIncrementalSyncEnabled, isUserAttributeSynchronisationEnabled, synchroniseAllGroupAttributes, synchroniseAllUserAttributes, synchroniseMemberships

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_USE_LEGACY_AD_INCREMENTAL_SYNC

public static final String PROPERTY_USE_LEGACY_AD_INCREMENTAL_SYNC

See Also:

Constant Field Values

Constructor Detail

UsnChangedCacheRefresher

public UsnChangedCacheRefresher(MicrosoftActiveDirectory activeDirectory)

Method Detail

synchroniseChanges

public CacheSynchronisationResult synchroniseChanges(DirectoryCache directoryCache,
                                                     @Nullable
                                                     String highestCommittedUsn)
                                              throws OperationFailedException

Specified by:

synchroniseChanges in interface CacheRefresher

Throws:

OperationFailedException

synchroniseAll

public CacheSynchronisationResult synchroniseAll(DirectoryCache directoryCache)
                                          throws OperationFailedException

Specified by:

synchroniseAll in interface CacheRefresher

Overrides:

synchroniseAll in class AbstractCacheRefresher<LDAPGroupWithAttributes>

Throws:

OperationFailedException

synchroniseAllUsers

protected PartialSynchronisationResult<? extends UserWithAttributes> synchroniseAllUsers(DirectoryCache directoryCache)
                                                                                  throws OperationFailedException

Specified by:

synchroniseAllUsers in class AbstractCacheRefresher<LDAPGroupWithAttributes>

Throws:

OperationFailedException

synchroniseAllGroups

protected PartialSynchronisationResult<LDAPGroupWithAttributes> synchroniseAllGroups(DirectoryCache directoryCache)
                                                                              throws OperationFailedException

Specified by:

synchroniseAllGroups in class AbstractCacheRefresher<LDAPGroupWithAttributes>

Throws:

OperationFailedException

getMemberships

protected Iterable<Membership> getMemberships(Collection<LDAPGroupWithAttributes> groupsToInclude,
                                              boolean isFullSync)
                                       throws OperationFailedException

Overrides:

getMemberships in class AbstractCacheRefresher<LDAPGroupWithAttributes>

Throws:

OperationFailedException