com.atlassian.crowd.directory.ldap.cache
Interface CacheRefresher

All Known Implementing Classes:
AbstractCacheRefresher, EventTokenChangedCacheRefresher, RemoteDirectoryCacheRefresher, UsnChangedCacheRefresher

public interface CacheRefresher

Represents a way of refreshing a local cache of an external directory.

This was introduced in order to enable Active Directory delta cache updates.

Since:
v2.1

Method Summary
 void synchroniseAll(DirectoryCache directoryCache)
          Will visit all Users and Groups in the external directory in order to do a Full refresh.
 boolean synchroniseChanges(DirectoryCache directoryCache)
          Attempts to synchronise changes since the last refresh as opposed to performing a full synchronisation.
 

Method Detail

synchroniseAll

void synchroniseAll(DirectoryCache directoryCache)
                    throws OperationFailedException
Will visit all Users and Groups in the external directory in order to do a Full refresh.

Parameters:
directoryCache - the DirectoryCache to update.
Throws:
OperationFailedException - if there was an error processing the operation

synchroniseChanges

boolean synchroniseChanges(DirectoryCache directoryCache)
                           throws OperationFailedException
Attempts to synchronise changes since the last refresh as opposed to performing a full synchronisation. Returns true if changes since the last refresh were synchronised successfully.

Parameters:
directoryCache - the DirectoryCache to update.
Returns:
true if changes were synchronised
Throws:
OperationFailedException - if there was an error processing the operation


Copyright © 2013 Atlassian. All Rights Reserved.