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 boolean	isIncrementalSyncEnabled()
protected boolean	isUserAttributeSynchronisationEnabled()
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 GroupWithAttributes> remoteGroups, DirectoryCache directoryCache)
protected abstract List<? extends GroupWithAttributes>	synchroniseAllGroups(DirectoryCache directoryCache)
protected void	synchroniseAllUserAttributes(List<? extends UserWithAttributes> remoteUsers, DirectoryCache directoryCache)
protected abstract List<? extends UserWithAttributes>	synchroniseAllUsers(DirectoryCache directoryCache, boolean withAttributes)
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

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 List<? extends UserWithAttributes> synchroniseAllUsers(DirectoryCache directoryCache,
                                                                          boolean withAttributes)
                                                                   throws OperationFailedException

Throws:

OperationFailedException

synchroniseAllGroups

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

Throws:

OperationFailedException

isUserAttributeSynchronisationEnabled

protected boolean isUserAttributeSynchronisationEnabled()

synchroniseAllUserAttributes

protected void synchroniseAllUserAttributes(List<? extends UserWithAttributes> remoteUsers,
                                            DirectoryCache directoryCache)
                                     throws OperationFailedException

Throws:

OperationFailedException

synchroniseAllGroupAttributes

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

Throws:

OperationFailedException

synchroniseMemberships

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

Throws:

OperationFailedException

isIncrementalSyncEnabled

protected boolean isIncrementalSyncEnabled()

directoryDescription

protected String directoryDescription()