StatisticsAwareCache (edoras one Java API (2.0.6))

All Known Implementing Classes:

DefaultStatisticsAwareCache
```
public interface StatisticsAwareCache
```
One cache class which generically handles all needed cache operations.

Field Summary

Fields
Modifier and Type	Field and Description
`static String[]`	`ALL_DEFINITION_CACHES`
`static String`	`EDORAS_GEAR_ANY_WORK_OBJECT_DEFINITIONS_BY_EXTERNAL_ID_CACHE_NAME`
`static String`	`EDORAS_GEAR_ANY_WORK_OBJECT_DEFINITIONS_BY_ID_CACHE_NAME`
`static String`	`EDORAS_GEAR_CONTENT_METADATA_BY_CONTENT_REFERENCE_ID`
`static String`	`EDORAS_GEAR_CONTENT_REFERENCES_BY_CONTENT_SOURCE_ID`
`static String`	`EDORAS_GEAR_CONTENT_VERSIONS_BY_CONTENT_REFERENCE_ID`
`static String`	`EDORAS_GEAR_FORM_DEFINITIONS_BY_KEY_CACHE_NAME`
`static String`	`EDORAS_GEAR_GLOBAL_ID_BY_WORK_OBJECT_ID_CACHE_NAME`
`static String`	`EDORAS_GEAR_WORK_OBJECT_ID_BY_GLOBAL_ID_CACHE_NAME`
`static String`	`EDORAS_ONE_CONVERTED_DOCUMENTS_CACHE_NAME`
`static String`	`EDORAS_ONE_DEFINITION_ID_BY_MODEL_ID_CACHE_NAME`
`static String`	`EDORAS_ONE_LANGUAGES_BY_LOCALE_CACHE_NAME`
`static String`	`EDORAS_ONE_PREVIEWED_DOCUMENTS_CACHE_NAME`
`static String`	`EDORAS_ONE_SYSTEM_GROUPS_BY_TENANT_ID_CACHE_NAME`
`static String`	`EDORAS_ONE_TENANT_ID_BY_NAME_CACHE_NAME`
`static String`	`EDORAS_ONE_TENANT_NAME_BY_ID_CACHE_NAME`
`static String`	`EDORAS_VIS_PALETTE_CACHE_NAME`
`static String`	`EDORAS_VIS_UTIL_CACHE_NAME`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`clear(String... cacheNames)` Clears all values from the specified cache by name.
`void`	`evict(String cacheName, Object key)` Evicts the value in the specified cache by name and key.
`<T> T`	`get(String cacheName, Object key, Class<T> valueClass)` Gets the value from the specified cache by name and key.
`org.springframework.cache.Cache`	`getCache(String cacheName)` Return the cache instance by the given cache name.
`List<CacheStatistics>`	`getCacheStatistics()` Returns the `CacheStatistics` of all currently used cache instances.
`void`	`put(String cacheName, Object key, Object value)` Saves the value in the specified cache by name and key.

- Field Detail
  - EDORAS_GEAR_GLOBAL_ID_BY_WORK_OBJECT_ID_CACHE_NAME
```
static final String EDORAS_GEAR_GLOBAL_ID_BY_WORK_OBJECT_ID_CACHE_NAME
```
    See Also:
    
    Constant Field Values
  - EDORAS_GEAR_WORK_OBJECT_ID_BY_GLOBAL_ID_CACHE_NAME
```
static final String EDORAS_GEAR_WORK_OBJECT_ID_BY_GLOBAL_ID_CACHE_NAME
```
    See Also:
    
    Constant Field Values
  - EDORAS_GEAR_FORM_DEFINITIONS_BY_KEY_CACHE_NAME
```
static final String EDORAS_GEAR_FORM_DEFINITIONS_BY_KEY_CACHE_NAME
```
    See Also:
    
    Constant Field Values
  - EDORAS_GEAR_ANY_WORK_OBJECT_DEFINITIONS_BY_ID_CACHE_NAME
```
static final String EDORAS_GEAR_ANY_WORK_OBJECT_DEFINITIONS_BY_ID_CACHE_NAME
```
    See Also:
    
    Constant Field Values
  - EDORAS_GEAR_ANY_WORK_OBJECT_DEFINITIONS_BY_EXTERNAL_ID_CACHE_NAME
```
static final String EDORAS_GEAR_ANY_WORK_OBJECT_DEFINITIONS_BY_EXTERNAL_ID_CACHE_NAME
```
    See Also:
    
    Constant Field Values
  - EDORAS_GEAR_CONTENT_METADATA_BY_CONTENT_REFERENCE_ID
```
static final String EDORAS_GEAR_CONTENT_METADATA_BY_CONTENT_REFERENCE_ID
```
    See Also:
    
    Constant Field Values
  - EDORAS_GEAR_CONTENT_VERSIONS_BY_CONTENT_REFERENCE_ID
```
static final String EDORAS_GEAR_CONTENT_VERSIONS_BY_CONTENT_REFERENCE_ID
```
    See Also:
    
    Constant Field Values
  - EDORAS_GEAR_CONTENT_REFERENCES_BY_CONTENT_SOURCE_ID
```
static final String EDORAS_GEAR_CONTENT_REFERENCES_BY_CONTENT_SOURCE_ID
```
    See Also:
    
    Constant Field Values
  - EDORAS_ONE_SYSTEM_GROUPS_BY_TENANT_ID_CACHE_NAME
```
static final String EDORAS_ONE_SYSTEM_GROUPS_BY_TENANT_ID_CACHE_NAME
```
    See Also:
    
    Constant Field Values
  - EDORAS_ONE_TENANT_NAME_BY_ID_CACHE_NAME
```
static final String EDORAS_ONE_TENANT_NAME_BY_ID_CACHE_NAME
```
    See Also:
    
    Constant Field Values
  - EDORAS_ONE_TENANT_ID_BY_NAME_CACHE_NAME
```
static final String EDORAS_ONE_TENANT_ID_BY_NAME_CACHE_NAME
```
    See Also:
    
    Constant Field Values
  - EDORAS_ONE_LANGUAGES_BY_LOCALE_CACHE_NAME
```
static final String EDORAS_ONE_LANGUAGES_BY_LOCALE_CACHE_NAME
```
    See Also:
    
    Constant Field Values
  - EDORAS_ONE_CONVERTED_DOCUMENTS_CACHE_NAME
```
static final String EDORAS_ONE_CONVERTED_DOCUMENTS_CACHE_NAME
```
    See Also:
    
    Constant Field Values
  - EDORAS_ONE_PREVIEWED_DOCUMENTS_CACHE_NAME
```
static final String EDORAS_ONE_PREVIEWED_DOCUMENTS_CACHE_NAME
```
    See Also:
    
    Constant Field Values
  - EDORAS_ONE_DEFINITION_ID_BY_MODEL_ID_CACHE_NAME
```
static final String EDORAS_ONE_DEFINITION_ID_BY_MODEL_ID_CACHE_NAME
```
    See Also:
    
    Constant Field Values
  - EDORAS_VIS_UTIL_CACHE_NAME
```
static final String EDORAS_VIS_UTIL_CACHE_NAME
```
    See Also:
    
    Constant Field Values
  - EDORAS_VIS_PALETTE_CACHE_NAME
```
static final String EDORAS_VIS_PALETTE_CACHE_NAME
```
    See Also:
    
    Constant Field Values
  - ALL_DEFINITION_CACHES
```
static final String[] ALL_DEFINITION_CACHES
```
- Method Detail
  - getCacheStatistics
```
List<CacheStatistics> getCacheStatistics()
```
    Returns the CacheStatistics of all currently used cache instances. If the configured Cache does not implement the CacheStatistics interface, the statistics are not returned for this instance.
    
    Returns:
    
    the CacheStatistics of all currently used cache instances.
  - getCache
```
org.springframework.cache.Cache getCache(String cacheName)
```
    Return the cache instance by the given cache name.
    
    Parameters:
    
    cacheName - the cache name for which the cache is returned
    
    Returns:
    
    the cache instance with the given cache name
  - get
```
<T> T get(String cacheName,
          Object key,
          Class<T> valueClass)
```
    Gets the value from the specified cache by name and key. The return value is casted to the specified value class.
    
    Type Parameters:
    
    T - the class of the returned value
    
    Parameters:
    
    cacheName - the name of the cache to get the value from
    
    key - the key of the value
    
    valueClass - the class of the returned value
    
    Returns:
    
    the value for the key casted to the specified value class
    
    Throws:
    
    IllegalArgumentException - if the parameters are invalid or when the cache with the specified name is not present
    
    ClassCastException - if the value from the cache is not derived from the provided value class
  - put
```
void put(String cacheName,
         Object key,
         Object value)
```
    Saves the value in the specified cache by name and key.
    
    Parameters:
    
    cacheName - the name of the cache to save the value to
    
    key - the key of the value
    
    value - the value to be saved. Depending on the underlying cache implementation, the value can be null.
    
    Throws:
    
    IllegalArgumentException - if the parameters are invalid or when the cache with the specified name is not present
  - evict
```
void evict(String cacheName,
           Object key)
```
    Evicts the value in the specified cache by name and key.
    
    Parameters:
    
    cacheName - the name of the cache to evict the value from
    
    key - the key of the value
    
    Throws:
    
    IllegalArgumentException - if the parameters are invalid or when the cache with the specified name is not present
  - clear
```
void clear(String... cacheNames)
```
    Clears all values from the specified cache by name.
    
    Parameters:
    
    cacheNames - the names of the caches to evict the value from
    
    Throws:
    
    IllegalArgumentException - if the parameters are invalid or when the cache with the specified name is not present

Interface StatisticsAwareCache

Field Summary

Method Summary

Field Detail

EDORAS_GEAR_GLOBAL_ID_BY_WORK_OBJECT_ID_CACHE_NAME

EDORAS_GEAR_WORK_OBJECT_ID_BY_GLOBAL_ID_CACHE_NAME

EDORAS_GEAR_FORM_DEFINITIONS_BY_KEY_CACHE_NAME

EDORAS_GEAR_ANY_WORK_OBJECT_DEFINITIONS_BY_ID_CACHE_NAME

EDORAS_GEAR_ANY_WORK_OBJECT_DEFINITIONS_BY_EXTERNAL_ID_CACHE_NAME

EDORAS_GEAR_CONTENT_METADATA_BY_CONTENT_REFERENCE_ID

EDORAS_GEAR_CONTENT_VERSIONS_BY_CONTENT_REFERENCE_ID

EDORAS_GEAR_CONTENT_REFERENCES_BY_CONTENT_SOURCE_ID

EDORAS_ONE_SYSTEM_GROUPS_BY_TENANT_ID_CACHE_NAME

EDORAS_ONE_TENANT_NAME_BY_ID_CACHE_NAME

EDORAS_ONE_TENANT_ID_BY_NAME_CACHE_NAME

EDORAS_ONE_LANGUAGES_BY_LOCALE_CACHE_NAME

EDORAS_ONE_CONVERTED_DOCUMENTS_CACHE_NAME

EDORAS_ONE_PREVIEWED_DOCUMENTS_CACHE_NAME

EDORAS_ONE_DEFINITION_ID_BY_MODEL_ID_CACHE_NAME

EDORAS_VIS_UTIL_CACHE_NAME

EDORAS_VIS_PALETTE_CACHE_NAME

ALL_DEFINITION_CACHES

Method Detail

getCacheStatistics

getCache

get

put

evict

clear