Make sure Hazelcast bootstraps before any JCache setup

This commit makes sure that if a `javax.cache.CacheManager` is required,
an auto-configured `HazelcastInstance` is fully resolved first. This
prevents the case where the JCache bootstrap actually starts an instance
early, followed by a second (potentially unwanted) instance created by the
regular auto-configuration.

Since the JCache implementation works with an `HazelcastInstance` behind
the scenes, if there is one `HazelcastInstance` configured and it has a
name, then we configure the `CacheProvider` to use that. Future Hazelcast
version will allow to pass the instance directly (i.e. not requiring an
actual name).

Closes gh-8484

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

+/*
+ * Copyright 2012-2017 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.io.IOException;
+import java.net.URI;
+import java.util.Properties;
+
+import com.hazelcast.core.HazelcastInstance;
+
+import org.springframework.beans.factory.ObjectProvider;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.core.io.Resource;
+
+/**
+ * JCache customization for Hazelcast.
+ *
+ * @author Stephane Nicoll
+ */
+@Configuration
+@ConditionalOnClass(HazelcastInstance.class)
+class HazelcastJCacheCustomizationConfiguration {
+
+	@Bean
+	public HazelcastPropertiesCustomizer hazelcastPropertiesCustomizer(
+			ObjectProvider<HazelcastInstance> hazelcastInstance) {
+		return new HazelcastPropertiesCustomizer(
+				hazelcastInstance.getIfUnique());
+	}
+
+	private static class HazelcastPropertiesCustomizer
+			implements JCachePropertiesCustomizer {
+
+		private final HazelcastInstance hazelcastInstance;
+
+		HazelcastPropertiesCustomizer(HazelcastInstance hazelcastInstance) {
+			this.hazelcastInstance = hazelcastInstance;
+		}
+
+		@Override
+		public void customize(CacheProperties cacheProperties, Properties properties) {
+			Resource configLocation = cacheProperties
+					.resolveConfigLocation(cacheProperties.getJcache().getConfig());
+			if (configLocation != null) {
+				// Hazelcast does not use the URI as a mean to specify a custom config.
+				properties.setProperty("hazelcast.config.location",
+						toUri(configLocation).toString());
+			}
+			else if (this.hazelcastInstance != null) {
+				String name = this.hazelcastInstance.getName();
+				if (name != null) {
+					properties.setProperty("hazelcast.instance.name", name);
+				}
+			}
+		}
+
+		private static URI toUri(Resource config) {
+			try {
+				return config.getURI();
+			}
+			catch (IOException ex) {
+				throw new IllegalArgumentException(
+						"Could not get URI from " + config, ex);
+			}
+		}
+
+	}
+
+}

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

@@ -40,6 +40,7 @@ import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.ConditionContext;
 import org.springframework.context.annotation.Conditional;
 import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.Import;
 import org.springframework.core.Ordered;
 import org.springframework.core.annotation.AnnotationAwareOrderComparator;
 import org.springframework.core.annotation.Order;
@@ -59,6 +60,7 @@ import org.springframework.util.StringUtils;
 @ConditionalOnMissingBean(org.springframework.cache.CacheManager.class)
 @Conditional({ CacheCondition.class,
 		JCacheCacheConfiguration.JCacheAvailableCondition.class })
+@Import(HazelcastJCacheCustomizationConfiguration.class)
 class JCacheCacheConfiguration {
 
 	private final CacheProperties cacheProperties;
@@ -69,15 +71,19 @@ class JCacheCacheConfiguration {
 
 	private final List<JCacheManagerCustomizer> cacheManagerCustomizers;
 
+	private final List<JCachePropertiesCustomizer> cachePropertiesCustomizers;
+
 	JCacheCacheConfiguration(CacheProperties cacheProperties,
 			CacheManagerCustomizers customizers,
 			ObjectProvider<javax.cache.configuration.Configuration<?, ?>> defaultCacheConfigurationProvider,
-			ObjectProvider<List<JCacheManagerCustomizer>> cacheManagerCustomizersProvider) {
+			ObjectProvider<List<JCacheManagerCustomizer>> cacheManagerCustomizersProvider,
+			ObjectProvider<List<JCachePropertiesCustomizer>> cachePropertiesCustomizers) {
 		this.cacheProperties = cacheProperties;
 		this.customizers = customizers;
 		this.defaultCacheConfiguration = defaultCacheConfigurationProvider
 				.getIfAvailable();
 		this.cacheManagerCustomizers = cacheManagerCustomizersProvider.getIfAvailable();
+		this.cachePropertiesCustomizers = cachePropertiesCustomizers.getIfAvailable();
 	}
 
 	@Bean
@@ -103,14 +109,14 @@ class JCacheCacheConfiguration {
 	private CacheManager createCacheManager() throws IOException {
 		CachingProvider cachingProvider = getCachingProvider(
 				this.cacheProperties.getJcache().getProvider());
+		Properties properties = createCacheManagerProperties();
 		Resource configLocation = this.cacheProperties
 				.resolveConfigLocation(this.cacheProperties.getJcache().getConfig());
 		if (configLocation != null) {
 			return cachingProvider.getCacheManager(configLocation.getURI(),
-					cachingProvider.getDefaultClassLoader(),
-					createCacheManagerProperties(configLocation));
+					cachingProvider.getDefaultClassLoader(), properties);
 		}
-		return cachingProvider.getCacheManager();
+		return cachingProvider.getCacheManager(null, null, properties);
 	}
 
 	private CachingProvider getCachingProvider(String cachingProviderFqn) {
@@ -120,12 +126,13 @@ class JCacheCacheConfiguration {
 		return Caching.getCachingProvider();
 	}
 
-	private Properties createCacheManagerProperties(Resource configLocation)
-			throws IOException {
+	private Properties createCacheManagerProperties() {
 		Properties properties = new Properties();
-		// Hazelcast does not use the URI as a mean to specify a custom config.
-		properties.setProperty("hazelcast.config.location",
-				configLocation.getURI().toString());
+		if (this.cachePropertiesCustomizers != null) {
+			for (JCachePropertiesCustomizer customizer : this.cachePropertiesCustomizers) {
+				customizer.customize(this.cacheProperties, properties);
+			}
+		}
 		return properties;
 	}
 

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

+/*
+ * Copyright 2012-2017 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.Properties;
+
+import javax.cache.CacheManager;
+import javax.cache.spi.CachingProvider;
+
+/**
+ * Callback interface that can be implemented by beans wishing to customize the properties
+ * used by the {@link CachingProvider} to create the {@link CacheManager}.
+ *
+ * @author Stephane Nicoll
+ */
+interface JCachePropertiesCustomizer {
+
+	/**
+	 * Customize the properties.
+	 * @param cacheProperties the cache properties
+	 * @param properties the current properties
+	 * @see CachingProvider#getCacheManager(java.net.URI, ClassLoader, Properties)
+	 */
+	void customize(CacheProperties cacheProperties, Properties properties);
+
+}

spring-boot-autoconfigure/src/test/resources/hazelcast.xml

@@ -3,6 +3,8 @@
 		xmlns="http://www.hazelcast.com/schema/config"
 		xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
 
+	<instance-name>default-instance</instance-name>
+
 	<map name="defaultCache" />
 
 </hazelcast>

spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc

@@ -3984,6 +3984,10 @@ NOTE: Since a cache library may offer both a native implementation and JSR-107 s
 Spring Boot will prefer the JSR-107 support so that the same features are available if
 you switch to a different JSR-107 implementation.
 
+TIP: Spring Boot has a <<boot-features-hazelcast,general support for Hazelcast>>t. If
+a single `HazelcastInstance` is available, it is automatically reused for the
+`CacheManager` as well unless the `spring.cache.jcache.config` property is specified.
+
 There are several ways to customize the underlying `javax.cache.cacheManager`:
 
 * Caches can be created on startup via the `spring.cache.cache-names` property. If a