com.atlassian.crowd.directory.ldap.cache

Class AbstractCacheRefresher

java.lang.Object

com.atlassian.crowd.directory.ldap.cache.AbstractCacheRefresher

All Implemented Interfaces:

CacheRefresher

Direct Known Subclasses:

EventTokenChangedCacheRefresher, RemoteDirectoryCacheRefresher, UsnChangedCacheRefresher

public abstract class AbstractCacheRefresher
extends Object
implements CacheRefresher

Since:

v2.1

Field Summary

Fields

Modifier and Type	Field and Description
protected RemoteDirectory	remoteDirectory

Constructor Summary

Constructors

Constructor and Description
AbstractCacheRefresher(RemoteDirectory remoteDirectory)

Method Summary

Modifier and Type	Method and Description
protected String	directoryDescription()
protected static <T extends Group> List<T>	filterOutDuplicateGroups(List<T> remoteGroups) Remove the duplicate groups from the passed list.
protected Set<String>	getAttributesToDelete(Attributes newAttributes, Attributes oldAttributes)
protected Map<String,Set<String>>	getAttributesToStore(Attributes newAttributes, Attributes oldAttributes)
protected String	getCqlUserFilter()
protected boolean	isIncrementalSyncEnabled()
void	synchroniseAll(DirectoryCache directoryCache) Will visit all Users and Groups in the external directory in order to do a Full refresh.
protected void	synchroniseAllGroupAttributes(List<? extends Group> remoteGroups, DirectoryCache directoryCache)
protected abstract List<? extends Group>	synchroniseAllGroups(DirectoryCache directoryCache)
protected abstract void	synchroniseAllUsers(DirectoryCache directoryCache)
protected void	synchroniseMemberships(List<? extends Group> remoteGroups, DirectoryCache directoryCache)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.crowd.directory.ldap.cache.CacheRefresher

synchroniseChanges

Field Detail

remoteDirectory

protected final RemoteDirectory remoteDirectory

Constructor Detail

AbstractCacheRefresher

public AbstractCacheRefresher(RemoteDirectory remoteDirectory)

Method Detail

filterOutDuplicateGroups

protected static <T extends Group> List<T> filterOutDuplicateGroups(List<T> remoteGroups)

Remove the duplicate groups from the passed list.

Type Parameters:

T - the type of group to filter.

Parameters:

remoteGroups - the groups to filter.

Returns:

the list of groups with duplicates removed.

synchroniseAll

public void synchroniseAll(DirectoryCache directoryCache)
                    throws OperationFailedException

Description copied from interface: CacheRefresher

Will visit all Users and Groups in the external directory in order to do a Full refresh.

Specified by:

synchroniseAll in interface CacheRefresher

Parameters:

directoryCache - the DirectoryCache to update.

Throws:

OperationFailedException - if there was an error processing the operation

synchroniseAllUsers

protected abstract void synchroniseAllUsers(DirectoryCache directoryCache)
                                     throws OperationFailedException

Throws:

OperationFailedException

synchroniseAllGroups

protected abstract List<? extends Group> synchroniseAllGroups(DirectoryCache directoryCache)
                                                       throws OperationFailedException

Throws:

OperationFailedException

synchroniseAllGroupAttributes

protected void synchroniseAllGroupAttributes(List<? extends Group> remoteGroups,
                                             DirectoryCache directoryCache)
                                      throws OperationFailedException

Throws:

OperationFailedException

getAttributesToDelete

protected Set<String> getAttributesToDelete(Attributes newAttributes,
                                            Attributes oldAttributes)

getAttributesToStore

protected Map<String,Set<String>> getAttributesToStore(Attributes newAttributes,
                                                       Attributes oldAttributes)

synchroniseMemberships

protected void synchroniseMemberships(List<? extends Group> remoteGroups,
                                      DirectoryCache directoryCache)
                               throws OperationFailedException

Throws:

OperationFailedException

isIncrementalSyncEnabled

protected boolean isIncrementalSyncEnabled()

getCqlUserFilter

@Nullable
protected String getCqlUserFilter()

directoryDescription

protected String directoryDescription()