public class SoftReferenceEntryCache extends EntryCache<SoftReferenceEntryCacheCfg> implements ConfigurationChangeListener<SoftReferenceEntryCacheCfg>, Runnable
registry
Constructor and Description |
---|
SoftReferenceEntryCache()
Creates a new instance of this soft reference entry cache.
|
Modifier and Type | Method and Description |
---|---|
ConfigChangeResult |
applyConfigurationChange(SoftReferenceEntryCacheCfg configuration)
Applies the configuration changes to this change listener.
|
void |
clear()
Removes all entries from the cache.
|
void |
clearBackend(String backendID)
Removes all entries from the cache that are associated with the provided backend.
|
boolean |
containsEntry(Dn entryDN)
Indicates whether the entry cache currently contains the entry with the specified DN.
|
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.
|
Entry |
getEntry(Dn entryDN)
Retrieves the entry with the specified DN from the cache.
|
long |
getEntryCount()
Retrieves the current number of entries stored within the cache.
|
Dn |
getEntryDN(String backendID,
long entryID)
Retrieves the entry DN for the entry with the specified ID on the specific backend from the cache.
|
long |
getEntryID(Dn entryDN)
Retrieves the entry ID for the entry with the specified DN from the cache.
|
void |
handleLowMemory()
Attempts to react to a scenario in which it is determined that the system is running low on available memory.
|
void |
initializeEntryCache(ServerContext serverContext,
SoftReferenceEntryCacheCfg configuration)
Initializes this entry cache implementation so that it will be available for storing and retrieving entries.
|
boolean |
isConfigurationAcceptable(SoftReferenceEntryCacheCfg configuration,
List<LocalizableMessage> unacceptableReasons)
Indicates whether the provided configuration is acceptable for this entry cache.
|
boolean |
isConfigurationChangeAcceptable(SoftReferenceEntryCacheCfg configuration,
List<LocalizableMessage> unacceptableReasons)
Indicates whether the proposed change to the configuration is acceptable
to this change listener.
|
boolean |
processEntryCacheConfig(SoftReferenceEntryCacheCfg cfg,
boolean applyChanges,
EntryCacheCommon.ConfigErrorHandler errorHandler)
Parses the provided configuration and configure the entry cache.
|
void |
putEntry(Entry entry,
String backendID,
long entryID)
Stores the provided entry in the cache.
|
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.
|
void |
removeEntry(Dn entryDN)
Removes the specified entry from the cache.
|
void |
run()
Operate in a loop, receiving notification of soft references that have been freed and removing the corresponding
entries from the cache.
|
String |
toVerboseString()
Return a verbose string representation of the current cache maps.
|
addMonitorObjectClassNames, bindTo, computeMonitorInstanceDn, filtersAllowCaching, getEntry, newMeterRegistryHolder, recordMiss, recordTry, setIncludeExcludeFilters
configurationDnToMonitorDn, deregisterAll, getMonitorEntry, getMonitorInstanceDn, toString
public SoftReferenceEntryCache()
initializeEntryCache
method.public void initializeEntryCache(ServerContext serverContext, SoftReferenceEntryCacheCfg configuration) throws ConfigException, InitializationException
EntryCache
initializeEntryCache
in class EntryCache<SoftReferenceEntryCacheCfg>
serverContext
- The server context.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 void finalizeEntryCache()
EntryCache
finalizeEntryCache
in class EntryCache<SoftReferenceEntryCacheCfg>
public boolean containsEntry(Dn entryDN)
EntryCache
containsEntry
in class EntryCache<SoftReferenceEntryCacheCfg>
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 Entry getEntry(Dn entryDN)
EntryCache
getEntry
in class EntryCache<SoftReferenceEntryCacheCfg>
entryDN
- The DN of the entry to retrieve.null
if it is not present.public long getEntryID(Dn entryDN)
EntryCache
getEntryID
in class EntryCache<SoftReferenceEntryCacheCfg>
entryDN
- The DN of the entry for which to retrieve the entry ID.public Dn getEntryDN(String backendID, long entryID)
EntryCache
getEntryDN
in class EntryCache<SoftReferenceEntryCacheCfg>
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 void putEntry(Entry entry, String backendID, long entryID)
EntryCache
putEntry
in class EntryCache<SoftReferenceEntryCacheCfg>
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 boolean putEntryIfAbsent(Entry entry, String backendID, long entryID)
EntryCache
putEntryIfAbsent
in class EntryCache<SoftReferenceEntryCacheCfg>
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 void removeEntry(Dn entryDN)
EntryCache
removeEntry
in class EntryCache<SoftReferenceEntryCacheCfg>
entryDN
- The DN of the entry to remove from the cache.public void clear()
EntryCache
clear
in class EntryCache<SoftReferenceEntryCacheCfg>
public void clearBackend(String backendID)
EntryCache
clearBackend
in class EntryCache<SoftReferenceEntryCacheCfg>
backendID
- ID of the backend for which to flush the associated entries.public void handleLowMemory()
EntryCache
handleLowMemory
in class EntryCache<SoftReferenceEntryCacheCfg>
public boolean isConfigurationAcceptable(SoftReferenceEntryCacheCfg configuration, List<LocalizableMessage> unacceptableReasons)
EntryCache
isConfigurationAcceptable
in class EntryCache<SoftReferenceEntryCacheCfg>
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 boolean isConfigurationChangeAcceptable(SoftReferenceEntryCacheCfg configuration, List<LocalizableMessage> unacceptableReasons)
ConfigurationChangeListener
isConfigurationChangeAcceptable
in interface ConfigurationChangeListener<SoftReferenceEntryCacheCfg>
configuration
- The new configuration containing the changes.unacceptableReasons
- A list that can be used to hold messages about why the
provided configuration is not acceptable.true
if the proposed change is acceptable,
or false
if it is not.public ConfigChangeResult applyConfigurationChange(SoftReferenceEntryCacheCfg configuration)
ConfigurationChangeListener
applyConfigurationChange
in interface ConfigurationChangeListener<SoftReferenceEntryCacheCfg>
configuration
- The new configuration containing the changes.public boolean processEntryCacheConfig(SoftReferenceEntryCacheCfg cfg, boolean applyChanges, EntryCacheCommon.ConfigErrorHandler errorHandler)
cfg
- The new configuration containing the changes.applyChanges
- If true then take into account the new configuration.errorHandler
- An handler used to report errors.true
if configuration is acceptable, or false
otherwise.public void run()
public long getEntryCount()
EntryCache
getEntryCount
in class EntryCache<SoftReferenceEntryCacheCfg>
public String toVerboseString()
EntryCache
This method is invoked by unit tests for debugging.
toVerboseString
in class EntryCache<SoftReferenceEntryCacheCfg>
null
if all maps are empty.Copyright 2010-2022 ForgeRock AS.