CacheManagement (Nuxeo 2021.1.19 API Documentation)

All Superinterfaces:

Cache

All Known Implementing Classes:

AbstractCache, CacheAttributesChecker, CacheInvalidator, CacheMetrics, CacheWrapper, InMemoryCacheImpl
```
public interface CacheManagement
extends Cache
```
Management-related APIs for a Cache.

Since:

9.3

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`long`	`getSize()`	Returns this cache size (approximate number of entries), or `-1` if the number of entries is unknown or too expensive to compute.
`void`	`invalidateLocal(String key)`	Invalidates the given key locally.
`void`	`invalidateLocalAll()`	Invalidates all keys locally.
`void`	`putLocal(String key, Serializable value)`	Stores a `Serializable` value into the cache locally.
`void`	`start()`	Starts this cache.
`void`	`stop()`	Stops this cache and releases related resources.

Methods inherited from interface org.nuxeo.ecm.core.cache.Cache
get, getName, hasEntry, invalidate, invalidateAll, keySet, put

- Method Detail
  - start
```
void start()
```
    Starts this cache.
  - stop
```
void stop()
```
    Stops this cache and releases related resources.
  - getSize
```
long getSize()
```
    Returns this cache size (approximate number of entries), or -1 if the number of entries is unknown or too expensive to compute.
    
    Returns:
    
    the approximate number of entries, or -1
    
    Since:
    
    9.1
  - putLocal
```
void putLocal(String key,
              Serializable value)
```
    Stores a Serializable value into the cache locally. Does not propagate invalidations.
    
    Parameters:
    
    key - the key
    
    value - the value
    
    Since:
    
    9.3
  - invalidateLocal
```
void invalidateLocal(String key)
```
    Invalidates the given key locally. Does not propagate invalidations.
    
    Parameters:
    
    key - the key to remove from the cache
    
    Since:
    
    9.3
  - invalidateLocalAll
```
void invalidateLocalAll()
```
    Invalidates all keys locally. Does not propagate invalidations.
    
    Since:
    
    9.3