Class CachingConfigurerSupport
- java.lang.Object
- org.springframework.cache.annotation.CachingConfigurerSupport
- All Implemented Interfaces:
CachingConfigurer
- Direct Known Subclasses:
JCacheConfigurerSupport
public class CachingConfigurerSupport extends Object implements CachingConfigurer
An implementation ofCachingConfigurer
with empty methods allowing sub-classes to override only the methods they're interested in.- Since:
- 4.1
- Author:
- Stephane Nicoll
- See Also:
CachingConfigurer
Constructor Summary
Constructors Constructor Description CachingConfigurerSupport()
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CacheManager
cacheManager()
Return the cache manager bean to use for annotation-driven cache management.CacheResolver
cacheResolver()
Return theCacheResolver
bean to use to resolve regular caches for annotation-driven cache management.CacheErrorHandler
errorHandler()
Return theCacheErrorHandler
to use to handle cache-related errors.KeyGenerator
keyGenerator()
Return the key generator bean to use for annotation-driven cache management.
Constructor Detail
CachingConfigurerSupport
public CachingConfigurerSupport()
Method Detail
cacheManager
public CacheManager cacheManager()
Description copied from interface:CachingConfigurer
Return the cache manager bean to use for annotation-driven cache management. A defaultCacheResolver
will be initialized behind the scenes with this cache manager. For more fine-grained management of the cache resolution, consider setting theCacheResolver
directly.Implementations must explicitly declare
@Bean
, e.g.@Configuration @EnableCaching public class AppConfig extends CachingConfigurerSupport { @Bean // important! @Override public CacheManager cacheManager() { // configure and return CacheManager instance } // ... }
See @EnableCaching
for more complete examples.- Specified by:
cacheManager
in interfaceCachingConfigurer
cacheResolver
public CacheResolver cacheResolver()
Description copied from interface:CachingConfigurer
Return theCacheResolver
bean to use to resolve regular caches for annotation-driven cache management. This is an alternative and more powerful option of specifying theCacheManager
to use.If both a
CachingConfigurer.cacheManager()
and#cacheResolver()
are set, the cache manager is ignored.Implementations must explicitly declare
@Bean
, e.g.@Configuration @EnableCaching public class AppConfig extends CachingConfigurerSupport { @Bean // important! @Override public CacheResolver cacheResolver() { // configure and return CacheResolver instance } // ... }
SeeEnableCaching
for more complete examples.- Specified by:
cacheResolver
in interfaceCachingConfigurer
keyGenerator
public KeyGenerator keyGenerator()
Description copied from interface:CachingConfigurer
Return the key generator bean to use for annotation-driven cache management. Implementations must explicitly declare@Bean
, e.g.@Configuration @EnableCaching public class AppConfig extends CachingConfigurerSupport { @Bean // important! @Override public KeyGenerator keyGenerator() { // configure and return KeyGenerator instance } // ... }
See @EnableCaching
for more complete examples.- Specified by:
keyGenerator
in interfaceCachingConfigurer
errorHandler
public CacheErrorHandler errorHandler()
Description copied from interface:CachingConfigurer
Return theCacheErrorHandler
to use to handle cache-related errors.By default,
SimpleCacheErrorHandler
is used and simply throws the exception back at the client.Implementations must explicitly declare
@Bean
, e.g.@Configuration @EnableCaching public class AppConfig extends CachingConfigurerSupport { @Bean // important! @Override public CacheErrorHandler errorHandler() { // configure and return CacheErrorHandler instance } // ... }
See @EnableCaching
for more complete examples.- Specified by:
errorHandler
in interfaceCachingConfigurer