Support customization of CacheManager

This commit allows to customize the auto-configured `CacheManager` by
exposing a bean of type `CacheManagerCustomizer`. The implementation may
reference the type of a `CacheManager` to determine in which case it has
to be invoked.

Several implementations can be provided and ordered using the regular
`Ordered` interface and `@Order` annotation.

Closes gh-5039

Author: snicoll

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/cache/CacheAutoConfiguration.java

@@ -66,7 +66,7 @@
 @EnableConfigurationProperties(CacheProperties.class)
 @AutoConfigureBefore(HibernateJpaAutoConfiguration.class)
 @AutoConfigureAfter({ HazelcastAutoConfiguration.class, RedisAutoConfiguration.class })
-@Import(CacheConfigurationImportSelector.class)
+@Import({ CacheManagerCustomizerInvoker.class, CacheConfigurationImportSelector.class })
 public class CacheAutoConfiguration {
 
 	static final String VALIDATOR_BEAN_NAME = "cacheAutoConfigurationValidator";

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/cache/CacheManagerCustomizer.java

@@ -0,0 +1,36 @@
+/*
+ * Copyright 2012-2016 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.boot.autoconfigure.cache;
+
+import org.springframework.cache.CacheManager;
+
+/**
+ * Callback interface that can be implemented by beans wishing to customize the cache
+ * manager before it is fully initialized, in particular to tune its configuration.
+ *
+ * @author Stephane Nicoll
+ * @since 1.3.3
+ */
+public interface CacheManagerCustomizer<C extends CacheManager> {
+
+	/**
+	 * Customize the cache manager.
+	 * @param cacheManager the {@code CacheManager} to customize
+	 */
+	void customize(C cacheManager);
+
+}

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/cache/CacheManagerCustomizerInvoker.java

@@ -0,0 +1,84 @@
+/*
+ * Copyright 2012-2016 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.boot.autoconfigure.cache;
+
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+import java.util.Map;
+
+import org.springframework.beans.BeansException;
+import org.springframework.beans.factory.BeanFactoryUtils;
+import org.springframework.cache.CacheManager;
+import org.springframework.context.ApplicationContext;
+import org.springframework.context.ApplicationContextAware;
+import org.springframework.context.ConfigurableApplicationContext;
+import org.springframework.core.GenericTypeResolver;
+import org.springframework.core.annotation.AnnotationAwareOrderComparator;
+
+/**
+ * Invoke the available {@link CacheManagerCustomizer} instances in the context for a
+ * given {@link CacheManager}.
+ *
+ * @author Stephane Nicoll
+ */
+class CacheManagerCustomizerInvoker implements ApplicationContextAware {
+
+	private ConfigurableApplicationContext applicationContext;
+
+	/**
+	 * Customize the specified {@link CacheManager}. Locates all {@link CacheManagerCustomizer}
+	 * beans able to handle the specified instance and invoke
+	 * {@link CacheManagerCustomizer#customize(CacheManager)} on them.
+	 * @param cacheManager the cache manager to customize
+	 */
+	public void customize(CacheManager cacheManager) {
+		List<CacheManagerCustomizer<CacheManager>> customizers = findCustomizers(cacheManager);
+		AnnotationAwareOrderComparator.sort(customizers);
+		for (CacheManagerCustomizer<CacheManager> customizer : customizers) {
+			customizer.customize(cacheManager);
+		}
+	}
+
+	@SuppressWarnings("unchecked")
+	private List<CacheManagerCustomizer<CacheManager>> findCustomizers(CacheManager cacheManager) {
+		if (this.applicationContext == null) {
+			return Collections.emptyList();
+		}
+		Map<String, CacheManagerCustomizer> map = BeanFactoryUtils
+				.beansOfTypeIncludingAncestors(this.applicationContext.getBeanFactory(), CacheManagerCustomizer.class);
+		List<CacheManagerCustomizer<CacheManager>> customizers
+				= new ArrayList<CacheManagerCustomizer<CacheManager>>();
+		for (CacheManagerCustomizer customizer : map.values()) {
+			Class<?> target = GenericTypeResolver.resolveTypeArgument(
+					customizer.getClass(), CacheManagerCustomizer.class);
+			if (target == null || target.isAssignableFrom(cacheManager.getClass())) {
+				customizers.add(customizer);
+			}
+		}
+		return customizers;
+	}
+
+
+	@Override
+	public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
+		if (applicationContext instanceof ConfigurableApplicationContext) {
+			this.applicationContext = (ConfigurableApplicationContext) applicationContext;
+		}
+	}
+
+}

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/cache/EhCacheCacheConfiguration.java

@@ -48,9 +48,14 @@ class EhCacheCacheConfiguration {
 	@Autowired
 	private CacheProperties cacheProperties;
 
+	@Autowired
+	CacheManagerCustomizerInvoker customizerInvoker;
+
 	@Bean
 	public EhCacheCacheManager cacheManager(CacheManager ehCacheCacheManager) {
-		return new EhCacheCacheManager(ehCacheCacheManager);
+		EhCacheCacheManager cacheManager = new EhCacheCacheManager(ehCacheCacheManager);
+		this.customizerInvoker.customize(cacheManager);
+		return cacheManager;
 	}
 
 	@Bean

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/cache/GenericCacheConfiguration.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2015 the original author or authors.
+ * Copyright 2012-2016 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -18,6 +18,7 @@
 
 import java.util.Collection;
 
+import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.cache.Cache;
@@ -40,10 +41,14 @@
 @Conditional(CacheCondition.class)
 class GenericCacheConfiguration {
 
+	@Autowired
+	CacheManagerCustomizerInvoker customizerInvoker;
+
 	@Bean
 	public SimpleCacheManager cacheManager(Collection<Cache> caches) {
 		SimpleCacheManager cacheManager = new SimpleCacheManager();
 		cacheManager.setCaches(caches);
+		this.customizerInvoker.customize(cacheManager);
 		return cacheManager;
 	}
 

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/cache/GuavaCacheConfiguration.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2015 the original author or authors.
+ * Copyright 2012-2016 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -48,6 +48,9 @@ class GuavaCacheConfiguration {
 	@Autowired
 	private CacheProperties cacheProperties;
 
+	@Autowired
+	CacheManagerCustomizerInvoker customizerInvoker;
+
 	@Autowired(required = false)
 	private CacheBuilder<Object, Object> cacheBuilder;
 
@@ -64,6 +67,7 @@ public GuavaCacheManager cacheManager() {
 		if (!CollectionUtils.isEmpty(cacheNames)) {
 			cacheManager.setCacheNames(cacheNames);
 		}
+		this.customizerInvoker.customize(cacheManager);
 		return cacheManager;
 	}
 

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/cache/HazelcastInstanceConfiguration.java

@@ -48,6 +48,9 @@ static class Existing {
 		@Autowired
 		private CacheProperties cacheProperties;
 
+		@Autowired
+		CacheManagerCustomizerInvoker customizerInvoker;
+
 		@Bean
 		public HazelcastCacheManager cacheManager(
 				HazelcastInstance existingHazelcastInstance) throws IOException {
@@ -58,7 +61,9 @@ public HazelcastCacheManager cacheManager(
 						location).getHazelcastInstance();
 				return new CloseableHazelcastCacheManager(cacheHazelcastInstance);
 			}
-			return new HazelcastCacheManager(existingHazelcastInstance);
+			HazelcastCacheManager cacheManager = new HazelcastCacheManager(existingHazelcastInstance);
+			this.customizerInvoker.customize(cacheManager);
+			return cacheManager;
 		}
 	}
 
@@ -70,6 +75,9 @@ static class Specific {
 		@Autowired
 		private CacheProperties cacheProperties;
 
+		@Autowired
+		CacheManagerCustomizerInvoker customizerInvoker;
+
 		@Bean
 		public HazelcastInstance hazelcastInstance() throws IOException {
 			Resource config = this.cacheProperties.getHazelcast().getConfig();
@@ -82,7 +90,9 @@ public HazelcastInstance hazelcastInstance() throws IOException {
 
 		@Bean
 		public HazelcastCacheManager cacheManager() throws IOException {
-			return new HazelcastCacheManager(hazelcastInstance());
+			HazelcastCacheManager cacheManager = new HazelcastCacheManager(hazelcastInstance());
+			this.customizerInvoker.customize(cacheManager);
+			return cacheManager;
 		}
 
 	}

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/cache/InfinispanCacheConfiguration.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2015 the original author or authors.
+ * Copyright 2012-2016 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -51,13 +51,18 @@ public class InfinispanCacheConfiguration {
 	@Autowired
 	private CacheProperties cacheProperties;
 
+	@Autowired
+	CacheManagerCustomizerInvoker customizerInvoker;
+
 	@Autowired(required = false)
 	private ConfigurationBuilder defaultConfigurationBuilder;
 
 	@Bean
 	public SpringEmbeddedCacheManager cacheManager(
 			EmbeddedCacheManager embeddedCacheManager) {
-		return new SpringEmbeddedCacheManager(embeddedCacheManager);
+		SpringEmbeddedCacheManager cacheManager = new SpringEmbeddedCacheManager(embeddedCacheManager);
+		this.customizerInvoker.customize(cacheManager);
+		return cacheManager;
 	}
 
 	@Bean(destroyMethod = "stop")

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/cache/JCacheCacheConfiguration.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2015 the original author or authors.
+ * Copyright 2012-2016 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -63,6 +63,9 @@ class JCacheCacheConfiguration {
 	@Autowired
 	private CacheProperties cacheProperties;
 
+	@Autowired
+	CacheManagerCustomizerInvoker customizerInvoker;
+
 	@Autowired(required = false)
 	private javax.cache.configuration.Configuration<?, ?> defaultCacheConfiguration;
 
@@ -71,7 +74,9 @@ class JCacheCacheConfiguration {
 
 	@Bean
 	public JCacheCacheManager cacheManager(CacheManager jCacheCacheManager) {
-		return new JCacheCacheManager(jCacheCacheManager);
+		JCacheCacheManager cacheManager = new JCacheCacheManager(jCacheCacheManager);
+		this.customizerInvoker.customize(cacheManager);
+		return cacheManager;
 	}
 
 	@Bean

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/cache/RedisCacheConfiguration.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2015 the original author or authors.
+ * Copyright 2012-2016 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -46,13 +46,17 @@ class RedisCacheConfiguration {
 	@Autowired
 	private CacheProperties cacheProperties;
 
+	@Autowired
+	CacheManagerCustomizerInvoker customizerInvoker;
+
 	@Bean
 	public RedisCacheManager cacheManager(RedisTemplate<Object, Object> redisTemplate) {
 		RedisCacheManager cacheManager = new RedisCacheManager(redisTemplate);
 		List<String> cacheNames = this.cacheProperties.getCacheNames();
 		if (!cacheNames.isEmpty()) {
 			cacheManager.setCacheNames(cacheNames);
 		}
+		this.customizerInvoker.customize(cacheManager);
 		return cacheManager;
 	}