Interface CacheRefresher

All Known Implementing Classes:
AbstractCacheRefresher, DeltaQueryCacheRefresher, EventTokenChangedCacheRefresher, RemoteDirectoryCacheRefresher, UserFilterableNonDeltaQueryCacheRefresher, 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 Details

    • synchroniseAll

      Will visit all Users and Groups in the external directory in order to do a Full refresh.
      Parameters:
      directoryCache - the DirectoryCache to update.
      Returns:
      result of synchronisation
      Throws:
      OperationFailedException - if there was an error processing the operation
    • synchroniseChanges

      CacheSynchronisationResult synchroniseChanges(DirectoryCache directoryCache, @Nullable String syncToken) 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:
      result of the synchronisation
      Throws:
      OperationFailedException - if there was an error processing the operation