org.springframework.boot.actuate.cache

类 CachesEndpoint

java.lang.Object

org.springframework.boot.actuate.cache.CachesEndpoint

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

@Endpoint to expose available caches.

从以下版本开始:

2.1.0

嵌套类概要

嵌套类

限定符和类型	类和说明
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.

构造器概要

构造器

构造器和说明
CachesEndpoint(java.util.Map<java.lang.String,org.springframework.cache.CacheManager> cacheManagers) Create a new endpoint with the CacheManager instances to use.

方法概要

限定符和类型	方法和说明
CachesEndpoint.CacheEntry	cache(java.lang.String cache, java.lang.String cacheManager) Return a CachesEndpoint.CacheDescriptor for the specified cache.
CachesEndpoint.CachesReport	caches() Return a CachesEndpoint.CachesReport of all available caches.
boolean	clearCache(java.lang.String cache, java.lang.String cacheManager) Clear the specific Cache.
void	clearCaches() Clear all the available caches.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

CachesEndpoint

public CachesEndpoint(java.util.Map<java.lang.String,org.springframework.cache.CacheManager> cacheManagers)

Create a new endpoint with the CacheManager instances to use.

参数:

cacheManagers - the cache managers to use, indexed by name

方法详细资料

caches

@ReadOperation
public CachesEndpoint.CachesReport caches()

Return a CachesEndpoint.CachesReport of all available caches.

返回:

a caches reports

cache

@ReadOperation
public CachesEndpoint.CacheEntry cache(@Selector
                                                       java.lang.String cache,
                                                       @Nullable
                                                       java.lang.String cacheManager)

Return a CachesEndpoint.CacheDescriptor for the specified cache.

参数:

cache - the name of the cache

cacheManager - the name of the cacheManager (can be null

返回:

the descriptor of the cache or null if no such cache exists

抛出:

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
                                            java.lang.String cache,
                                            @Nullable
                                            java.lang.String cacheManager)

Clear the specific Cache.

参数:

cache - the name of the cache

cacheManager - the name of the cacheManager (can be null to match all)

返回:

true if the cache was cleared or false if no such cache exists

抛出:

NonUniqueCacheException - if more than one cache with that name exists and no cacheManager was provided to identify a unique candidate