Interface SolrCache<K,V>
-
- All Superinterfaces:
AutoCloseable
,SolrInfoBean
,SolrMetricProducer
- All Known Implementing Classes:
CaffeineCache
public interface SolrCache<K,V> extends SolrInfoBean
Primary API for dealing with Solr's internal caches.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
SolrCache.State
Enumeration of possible States for cache instances.-
Nested classes/interfaces inherited from interface org.apache.solr.core.SolrInfoBean
SolrInfoBean.Category, SolrInfoBean.Group
-
-
Field Summary
Fields Modifier and Type Field Description static String
ASYNC_PARAM
static String
CLEANUP_THREAD_PARAM
static String
EVICTIONS_PARAM
static String
HIT_RATIO_PARAM
static String
HITS_PARAM
static String
INITIAL_SIZE_PARAM
static String
INSERTS_PARAM
static String
LOOKUPS_PARAM
static String
MAX_IDLE_TIME_PARAM
static String
MAX_RAM_MB_PARAM
static String
MAX_SIZE_PARAM
static String
RAM_BYTES_USED_PARAM
static String
SIZE_PARAM
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description void
clear()
:TODO: copy from Mapdefault void
close()
Frees any non-memory resourcesV
computeIfAbsent(K key, IOFunction<? super K,? extends V> mappingFunction)
Get an existing element or atomically compute it if missing.V
get(K key)
:TODO: copy from Mapint
getMaxRamMB()
Returns maximum size limit (in MB) if set and supported, -1 otherwise.int
getMaxSize()
Returns maximum size limit (number of items) if set and supported, -1 otherwise.SolrCache.State
getState()
Returns the last State set on this instanceObject
init(Map<String,String> args, Object persistence, CacheRegenerator regenerator)
The initialization routine.default void
initialSearcher(SolrIndexSearcher initialSearcher)
A hook for caches that would like to perform some initialization for the first registered searcher.default boolean
isRecursionSupported()
Check if this SolrCache supports recursive calls tocomputeIfAbsent(Object, IOFunction)
.String
name()
Name the Cache can be referenced with by SolrRequestHandlers.V
put(K key, V value)
:TODO: copy from MapV
remove(K key)
void
setMaxRamMB(int maxRamMB)
Set maximum size limit (in MB), or -1 for unlimited.void
setMaxSize(int maxSize)
Set maximum size limit (number of items), or -1 for unlimited.void
setState(SolrCache.State state)
Set different cache states.int
size()
:TODO: copy from Mapvoid
warm(SolrIndexSearcher searcher, SolrCache<K,V> old)
Warm this cache associated withsearcher
using theold
cache object.-
Methods inherited from interface org.apache.solr.core.SolrInfoBean
getCategory, getDescription, getName
-
Methods inherited from interface org.apache.solr.metrics.SolrMetricProducer
getSolrMetricsContext, initializeMetrics
-
-
-
-
Field Detail
-
HIT_RATIO_PARAM
static final String HIT_RATIO_PARAM
- See Also:
- Constant Field Values
-
HITS_PARAM
static final String HITS_PARAM
- See Also:
- Constant Field Values
-
INSERTS_PARAM
static final String INSERTS_PARAM
- See Also:
- Constant Field Values
-
EVICTIONS_PARAM
static final String EVICTIONS_PARAM
- See Also:
- Constant Field Values
-
LOOKUPS_PARAM
static final String LOOKUPS_PARAM
- See Also:
- Constant Field Values
-
SIZE_PARAM
static final String SIZE_PARAM
- See Also:
- Constant Field Values
-
MAX_SIZE_PARAM
static final String MAX_SIZE_PARAM
- See Also:
- Constant Field Values
-
RAM_BYTES_USED_PARAM
static final String RAM_BYTES_USED_PARAM
- See Also:
- Constant Field Values
-
MAX_RAM_MB_PARAM
static final String MAX_RAM_MB_PARAM
- See Also:
- Constant Field Values
-
MAX_IDLE_TIME_PARAM
static final String MAX_IDLE_TIME_PARAM
- See Also:
- Constant Field Values
-
INITIAL_SIZE_PARAM
static final String INITIAL_SIZE_PARAM
- See Also:
- Constant Field Values
-
CLEANUP_THREAD_PARAM
static final String CLEANUP_THREAD_PARAM
- See Also:
- Constant Field Values
-
ASYNC_PARAM
static final String ASYNC_PARAM
- See Also:
- Constant Field Values
-
-
Method Detail
-
init
Object init(Map<String,String> args, Object persistence, CacheRegenerator regenerator)
The initialization routine. Instance specific arguments are passed in theargs
map.The persistence object will exist across different lifetimes of similar caches. For example, all filter caches will share the same persistence object, sometimes at the same time (it must be thread-safe). If null is passed, then the cache implementation should create and return a new persistence object. If not null, the passed in object should be returned again.
Since it will exist across the lifetime of many caches, care should be taken to not reference any particular cache instance and prevent it from being garbage collected (no using inner classes unless they are static).
The persistence object is designed to be used as a way for statistics to accumulate across all instances of the same type of cache, however the object may be of any type desired by the cache implementation.
The
CacheRegenerator
is what the cache uses during auto-warming to regenerate an item in the new cache from an entry in the old cache.
-
name
String name()
Name the Cache can be referenced with by SolrRequestHandlers.This method must return the identifier that the Cache instance expects SolrRequestHandlers to use when requesting access to it from the SolrIndexSearcher. It is strongly recommended that this method return the value of the "name" parameter from the init args.
:TODO: verify this.
-
size
int size()
:TODO: copy from Map
-
computeIfAbsent
V computeIfAbsent(K key, IOFunction<? super K,? extends V> mappingFunction) throws IOException
Get an existing element or atomically compute it if missing.- Parameters:
key
- keymappingFunction
- function to compute the element. If the function returns a null result the cache mapping will not be created. NOTE: this function must NOT attempt to modify any mappings in the cache.- Returns:
- existing or newly computed value, null if there was no existing value and it was not possible to compute a new value (in which case the new mapping won't be created).
- Throws:
IOException
- if and only if mappingFunction threw an IOException. A cache mapping will not be created in this case
-
clear
void clear()
:TODO: copy from Map
-
setState
void setState(SolrCache.State state)
Set different cache states. The state a cache is in can have an effect on how statistics are kept. The cache user (SolrIndexSearcher) will take care of switching cache states.
-
getState
SolrCache.State getState()
Returns the last State set on this instance
-
initialSearcher
default void initialSearcher(SolrIndexSearcher initialSearcher)
A hook for caches that would like to perform some initialization for the first registered searcher. This method is analogous towarm(SolrIndexSearcher, SolrCache)
. The default implementation is a no-op. Implementers should not retain object references to the specified searcher.
-
warm
void warm(SolrIndexSearcher searcher, SolrCache<K,V> old)
Warm this cache associated withsearcher
using theold
cache object.this
andold
will have the same concrete type.
-
close
default void close() throws IOException
Frees any non-memory resources- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceSolrMetricProducer
- Throws:
IOException
-
getMaxSize
int getMaxSize()
Returns maximum size limit (number of items) if set and supported, -1 otherwise.
-
setMaxSize
void setMaxSize(int maxSize)
Set maximum size limit (number of items), or -1 for unlimited. Note: this has effect only on implementations that support it, it's a no-op otherwise
-
getMaxRamMB
int getMaxRamMB()
Returns maximum size limit (in MB) if set and supported, -1 otherwise.
-
setMaxRamMB
void setMaxRamMB(int maxRamMB)
Set maximum size limit (in MB), or -1 for unlimited. Note: this has effect only on implementations that support it, it's a no-op otherwise.
-
isRecursionSupported
default boolean isRecursionSupported()
Check if this SolrCache supports recursive calls tocomputeIfAbsent(Object, IOFunction)
. Caches backed byConcurrentHashMap.computeIfAbsent(Object, Function)
explicitly do not support that, but other caches might.- Returns:
- whether this cache allows recursive computations
-
-