|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.api.EntryCache<T>
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 EntryCacheCfg>
This class defines the set of methods that must be implemented by a
Directory Server entry cache. Note that components accessing the
entry cache must not depend on any particular behavior. For
example, if a call is made to 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.
Field Summary | |
---|---|
protected java.util.concurrent.atomic.AtomicLong |
cacheHits
Arbitrary number of cache hits for monitoring. |
protected java.util.concurrent.atomic.AtomicLong |
cacheMisses
Arbitrary number of cache misses for monitoring. |
Constructor Summary | |
---|---|
EntryCache()
Default constructor which is implicitly called from all entry cache implementations. |
Method Summary | |
---|---|
abstract void |
clear()
Removes all entries from the cache. |
abstract void |
clearBackend(Backend backend)
Removes all entries from the cache that are associated with the provided backend. |
abstract void |
clearSubtree(DN baseDN)
Removes all entries from the cache that are below the provided DN. |
abstract boolean |
containsEntry(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 java.lang.Long |
getCacheCount()
Retrieves the current number of entries stored within the cache. |
java.lang.Long |
getCacheHits()
Retrieves the current number of cache hits for this cache. |
java.lang.Long |
getCacheMisses()
Retrieves the current number of cache misses for this cache. |
Entry |
getEntry(Backend backend,
long entryID,
LockType lockType,
java.util.List<java.util.concurrent.locks.Lock> lockList)
Retrieves the requested entry if it is present in the cache, obtaining a lock on the entry before it is returned. |
abstract Entry |
getEntry(DN entryDN)
Retrieves the entry with the specified DN from the cache. |
Entry |
getEntry(DN entryDN,
LockType lockType,
java.util.List<java.util.concurrent.locks.Lock> lockList)
Retrieves the entry with the specified DN from the cache, obtaining a lock on the entry before it is returned. |
EntryCacheMonitorProvider |
getEntryCacheMonitor()
Retrieves the monitor that is associated with this entry cache. |
abstract DN |
getEntryDN(Backend backend,
long entryID)
Retrieves the entry DN for the entry with the specified ID on the specific backend from the cache. |
abstract long |
getEntryID(DN entryDN)
Retrieves the entry ID for the entry with the specified DN from the cache. |
java.util.Set<SearchFilter> |
getExcludeFilters()
Retrieves the set of search filters that may be used to determine whether an entry should be excluded from the cache. |
java.util.Set<SearchFilter> |
getIncludeFilters()
Retrieves the set of search filters that may be used to determine whether an entry should be included in the cache. |
long |
getLockTimeout()
Retrieves the maximum length of time in milliseconds to wait for a lock before giving up. |
abstract java.util.ArrayList<Attribute> |
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(T configuration)
Initializes this entry cache implementation so that it will be available for storing and retrieving entries. |
boolean |
isConfigurationAcceptable(EntryCacheCfg configuration,
java.util.List<Message> unacceptableReasons)
Indicates whether the provided configuration is acceptable for this entry cache. |
abstract void |
putEntry(Entry entry,
Backend backend,
long entryID)
Stores the provided entry in the cache. |
abstract boolean |
putEntryIfAbsent(Entry entry,
Backend backend,
long entryID)
Stores the provided entry in the cache only if it does not conflict with an entry that already exists. |
abstract void |
removeEntry(DN entryDN)
Removes the specified entry from the cache. |
void |
setEntryCacheMonitor(EntryCacheMonitorProvider entryCacheMonitor)
Sets the monitor for this entry cache. |
void |
setExcludeFilters(java.util.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(java.util.Set<SearchFilter> includeFilters)
Specifies the set of search filters that may be used to determine whether an entry should be included in the cache. |
void |
setLockTimeout(long lockTimeout)
Specifies the maximum length of time in milliseconds to wait for a lock before giving up. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected java.util.concurrent.atomic.AtomicLong cacheHits
protected java.util.concurrent.atomic.AtomicLong cacheMisses
Constructor Detail |
---|
public EntryCache()
Method Detail |
---|
public abstract void initializeEntryCache(T configuration) throws ConfigException, InitializationException
configuration
- The configuration to use to initialize
the entry cache.
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(EntryCacheCfg configuration, java.util.List<Message> 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(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(DN entryDN)
entryDN
- The DN of the entry to retrieve.
null
if it is not present.public Entry getEntry(DN entryDN, LockType lockType, java.util.List<java.util.concurrent.locks.Lock> lockList)
entryDN
- The DN of the entry to retrieve.lockType
- The type of lock to obtain (it may be
NONE
).lockList
- The list to which the obtained lock will be
added (note that no lock will be added if the
lock type was NONE
).
null
if it is not present.public Entry getEntry(Backend backend, long entryID, LockType lockType, java.util.List<java.util.concurrent.locks.Lock> lockList)
backend
- The backend associated with the entry to
retrieve.entryID
- The entry ID within the provided backend for
the specified entry.lockType
- The type of lock to obtain (it may be
NONE
).lockList
- The list to which the obtained lock will be
added (note that no lock will be added if the
lock type was NONE
).
null
if it is not present.public abstract long getEntryID(DN entryDN)
entryDN
- The DN of the entry for which to retrieve the
entry ID.
public abstract DN getEntryDN(Backend backend, long entryID)
backend
- 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, Backend backend, long entryID)
entry
- The entry to store in the cache.backend
- 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, Backend backend, long entryID)
entry
- The entry to store in the cache.backend
- 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(DN entryDN)
entryDN
- The DN of the entry to remove from the cache.public abstract void clear()
public abstract void clearBackend(Backend backend)
backend
- The backend for which to flush the associated
entries.public abstract void clearSubtree(DN baseDN)
baseDN
- The base DN below which all entries should be
flushed.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 java.util.ArrayList<Attribute> getMonitorData()
public abstract java.lang.Long getCacheCount()
public java.lang.Long getCacheHits()
public java.lang.Long getCacheMisses()
public long getLockTimeout()
public void setLockTimeout(long lockTimeout)
lockTimeout
- The maximum length of time in milliseconds
to wait for a lock before giving up.public java.util.Set<SearchFilter> getExcludeFilters()
public void setExcludeFilters(java.util.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 java.util.Set<SearchFilter> getIncludeFilters()
public void setIncludeFilters(java.util.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.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |