java.lang.Object
- org.springframework.boot.actuate.cache.CachesEndpoint

@Endpoint(id="caches")
public class CachesEndpoint
extends Object

Endpoint to expose available caches.

Since:: 2.1.0

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`CachesEndpoint.CacheDescriptor`	Basic description of a `Cache`, primarily intended for serialization to JSON.
`static class`	`CachesEndpoint.CacheEntry`	Description of a `Cache`, primarily intended for serialization to JSON.
`static class`	`CachesEndpoint.CacheManagerDescriptor`	Description of a `CacheManager`, primarily intended for serialization to JSON.
`static class`	`CachesEndpoint.CachesReport`	A report of available `caches`, primarily intended for serialization to JSON.

Constructor Summary
Constructors
Constructor Description
CachesEndpoint(Map<String,org.springframework.cache.CacheManager> cacheManagers)
Create a new endpoint with the CacheManager instances to use.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`CachesEndpoint.CacheEntry`	`cache(String cache, String cacheManager)`	Return a `CachesEndpoint.CacheDescriptor` for the specified cache.
`CachesEndpoint.CachesReport`	`caches()`	Return a `CachesEndpoint.CachesReport` of all available `caches`.
`boolean`	`clearCache(String cache, String cacheManager)`	Clear the specific `Cache`.
`void`	`clearCaches()`	Clear all the available `caches`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CachesEndpoint
```
public CachesEndpoint(Map<String,org.springframework.cache.CacheManager> cacheManagers)
```
    Create a new endpoint with the CacheManager instances to use.
    Parameters:
    cacheManagers - the cache managers to use, indexed by name
- Method Detail
  - caches
```
@ReadOperation
public CachesEndpoint.CachesReport caches()
```
    Return a CachesEndpoint.CachesReport of all available caches.
    Returns:
    a caches reports
  - cache
```
@ReadOperation
public CachesEndpoint.CacheEntry cache(@Selector
                                       String cache,
                                       @Nullable
                                       String cacheManager)
```
    Return a CachesEndpoint.CacheDescriptor for the specified cache.
    Parameters:
    cache - the name of the cache
    cacheManager - the name of the cacheManager (can be null
    Returns:
    the descriptor of the cache or null if no such cache exists
    Throws:
    NonUniqueCacheException - if more than one cache with that name exists and no cacheManager was provided to identify a unique candidate
  - clearCaches
```
@DeleteOperation
public void clearCaches()
```
    Clear all the available caches.
  - clearCache
```
@DeleteOperation
public boolean clearCache(@Selector
                          String cache,
                          @Nullable
                          String cacheManager)
```
    Clear the specific Cache.
    Parameters:
    cache - the name of the cache
    cacheManager - the name of the cacheManager (can be null to match all)
    Returns:
    true if the cache was cleared or false if no such cache exists
    Throws:
    NonUniqueCacheException - if more than one cache with that name exists and no cacheManager was provided to identify a unique candidate

Class CachesEndpoint

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CachesEndpoint

Method Detail

caches

cache

clearCaches

clearCache