T
- The type of configuration handled by this entry cache.@PublicAPI(stability=VOLATILE, mayInstantiate=false, mayExtend=true, mayInvoke=true, notes="Entry cache methods may only be invoked by backends") public abstract class EntryCache<T extends org.forgerock.opendj.server.config.server.EntryCacheCfg> extends Object
putEntry
to store an entry in the cache, there is no guarantee that immediately calling getEntry
will
be able to retrieve it. There are several potential reasons for this, including:
putEntry
and getEntry
calls.putEntry
and getEntry
calls.Modifier and Type | Field and Description |
---|---|
protected AtomicLong |
cacheHits
Arbitrary number of cache hits for monitoring.
|
protected AtomicLong |
cacheMisses
Arbitrary number of cache misses for monitoring.
|
Constructor and Description |
---|
EntryCache()
Default constructor which is implicitly called from all entry cache implementations.
|
Modifier and Type | Method and Description |
---|---|
abstract void |
clear()
Removes all entries from the cache.
|
abstract void |
clearBackend(String backendID)
Removes all entries from the cache that are associated with the provided backend.
|
abstract boolean |
containsEntry(org.forgerock.opendj.ldap.Dn entryDN)
Indicates whether the entry cache currently contains the entry with the specified DN.
|
boolean |
filtersAllowCaching(Entry entry)
Indicates whether the current set of exclude and include filters allow caching of the specified entry.
|
abstract void |
finalizeEntryCache()
Performs any necessary cleanup work (e.g., flushing all cached entries and releasing any other held resources)
that should be performed when the server is to be shut down or the entry cache destroyed or replaced.
|
abstract Long |
getCacheCount()
Retrieves the current number of entries stored within the cache.
|
long |
getCacheHits()
Retrieves the current number of cache hits for this cache.
|
long |
getCacheMisses()
Retrieves the current number of cache misses for this cache.
|
abstract Entry |
getEntry(org.forgerock.opendj.ldap.Dn entryDN)
Retrieves the entry with the specified DN from the cache.
|
Entry |
getEntry(String backendID,
long entryID)
Retrieves the requested entry if it is present in the cache.
|
EntryCacheMonitorProvider |
getEntryCacheMonitor()
Retrieves the monitor that is associated with this entry cache.
|
abstract org.forgerock.opendj.ldap.Dn |
getEntryDN(String backendID,
long entryID)
Retrieves the entry DN for the entry with the specified ID on the specific backend from the cache.
|
abstract long |
getEntryID(org.forgerock.opendj.ldap.Dn entryDN)
Retrieves the entry ID for the entry with the specified DN from the cache.
|
Set<SearchFilter> |
getExcludeFilters()
Retrieves the set of search filters that may be used to determine whether an entry should be excluded from the
cache.
|
Set<SearchFilter> |
getIncludeFilters()
Retrieves the set of search filters that may be used to determine whether an entry should be included in the
cache.
|
abstract MonitorData |
getMonitorData()
Retrieves a set of attributes containing monitor data that should be returned to the client if the corresponding
monitor entry is requested.
|
abstract void |
handleLowMemory()
Attempts to react to a scenario in which it is determined that the system is running low on available memory.
|
abstract void |
initializeEntryCache(ServerContext serverContext,
T configuration)
Initializes this entry cache implementation so that it will be available for storing and retrieving entries.
|
boolean |
isConfigurationAcceptable(T configuration,
List<LocalizableMessage> unacceptableReasons)
Indicates whether the provided configuration is acceptable for this entry cache.
|
abstract void |
putEntry(Entry entry,
String backendID,
long entryID)
Stores the provided entry in the cache.
|
abstract boolean |
putEntryIfAbsent(Entry entry,
String backendID,
long entryID)
Stores the provided entry in the cache only if it does not conflict with an entry that already exists.
|
abstract void |
removeEntry(org.forgerock.opendj.ldap.Dn entryDN)
Removes the specified entry from the cache.
|
void |
setEntryCacheMonitor(EntryCacheMonitorProvider entryCacheMonitor)
Sets the monitor for this entry cache.
|
void |
setExcludeFilters(Set<SearchFilter> excludeFilters)
Specifies the set of search filters that may be used to determine whether an entry should be excluded from the
cache.
|
void |
setIncludeFilters(Set<SearchFilter> includeFilters)
Specifies the set of search filters that may be used to determine whether an entry should be included in the
cache.
|
abstract String |
toVerboseString()
Return a verbose string representation of the current cache maps.
|
protected AtomicLong cacheHits
protected AtomicLong cacheMisses
public EntryCache()
public abstract void initializeEntryCache(ServerContext serverContext, T configuration) throws org.forgerock.opendj.config.server.ConfigException, InitializationException
serverContext
- The server context.configuration
- The configuration to use to initialize the entry cache.org.forgerock.opendj.config.server.ConfigException
- If there is a problem with the provided configuration entry that would prevent this entry cache from
being used.InitializationException
- If a problem occurs during the initialization process that is not related to the configuration.public boolean isConfigurationAcceptable(T configuration, List<LocalizableMessage> unacceptableReasons)
configuration
- The entry cache configuration for which to make the determination.unacceptableReasons
- A list that may be used to hold the reasons that the provided configuration is not acceptable.true
if the provided configuration is acceptable for this entry cache, or false
if not.public abstract void finalizeEntryCache()
public abstract boolean containsEntry(org.forgerock.opendj.ldap.Dn entryDN)
entryDN
- The DN for which to make the determination.true
if the entry cache currently contains the entry with the specified DN, or false
if
not.public abstract Entry getEntry(org.forgerock.opendj.ldap.Dn entryDN)
entryDN
- The DN of the entry to retrieve.null
if it is not present.public Entry getEntry(String backendID, long entryID)
backendID
- ID of the backend associated with the entry to retrieve.entryID
- The entry ID within the provided backend for the specified entry.null
if it is not present.public abstract long getEntryID(org.forgerock.opendj.ldap.Dn entryDN)
entryDN
- The DN of the entry for which to retrieve the entry ID.public abstract org.forgerock.opendj.ldap.Dn getEntryDN(String backendID, long entryID)
backendID
- ID of the backend associated with the entry for which to retrieve the entry DN.entryID
- The entry ID within the provided backend for which to retrieve the entry DN.null
if it is not present in the cache.public abstract void putEntry(Entry entry, String backendID, long entryID)
entry
- The entry to store in the cache.backendID
- ID of the backend with which the entry is associated.entryID
- The entry ID within the provided backend that uniquely identifies the specified entry.public abstract boolean putEntryIfAbsent(Entry entry, String backendID, long entryID)
entry
- The entry to store in the cache.backendID
- ID of the backend with which the entry is associated.entryID
- The entry ID within the provided backend that uniquely identifies the specified entry.false
if an existing entry or some other problem prevented the method from completing
successfully, or true
if there was no conflict and the entry was either stored or the cache
determined that this entry should never be cached for some reason.public abstract void removeEntry(org.forgerock.opendj.ldap.Dn entryDN)
entryDN
- The DN of the entry to remove from the cache.public abstract void clear()
public abstract void clearBackend(String backendID)
backendID
- ID of the backend for which to flush the associated entries.public abstract void handleLowMemory()
public final EntryCacheMonitorProvider getEntryCacheMonitor()
null
if none has been assigned.public final void setEntryCacheMonitor(EntryCacheMonitorProvider entryCacheMonitor)
entryCacheMonitor
- The monitor for this entry cache.public abstract MonitorData getMonitorData()
public abstract Long getCacheCount()
public long getCacheHits()
public long getCacheMisses()
public Set<SearchFilter> getExcludeFilters()
public void setExcludeFilters(Set<SearchFilter> excludeFilters)
excludeFilters
- The set of search filters that may be used to determine whether an entry should be excluded from the
cache.public Set<SearchFilter> getIncludeFilters()
public void setIncludeFilters(Set<SearchFilter> includeFilters)
includeFilters
- The set of search filters that may be used to determine whether an entry should be included in the
cache.public boolean filtersAllowCaching(Entry entry)
entry
- The entry to evaluate against exclude and include filter sets.true
if current set of filters allow caching the entry and false
otherwise.public abstract String toVerboseString()
This method is invoked by unit tests for debugging.
null
if all maps are empty.Copyright © 2010–2017 ForgeRock AS. All rights reserved.