Enables Spring Locator-based applications configured and bootstrapped with SDG to use the GemfireBeanFactoryLocator to autowire Apache Geode components.

Closes spring-projects#620.

Author: jxblum

spring-data-geode/src/main/java/org/springframework/data/gemfire/LocatorFactoryBean.java

@@ -15,9 +15,6 @@
  */
 package org.springframework.data.gemfire;
 
-import static org.springframework.data.gemfire.util.ArrayUtils.nullSafeArray;
-import static org.springframework.data.gemfire.util.CollectionUtils.nullSafeIterable;
-
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
@@ -32,8 +29,10 @@
 import org.springframework.beans.factory.InitializingBean;
 import org.springframework.data.gemfire.config.annotation.LocatorConfigurer;
 import org.springframework.data.gemfire.support.AbstractFactoryBeanSupport;
+import org.springframework.data.gemfire.support.GemfireBeanFactoryLocator;
+import org.springframework.data.gemfire.util.ArrayUtils;
 import org.springframework.data.gemfire.util.CollectionUtils;
-import org.springframework.lang.Nullable;
+import org.springframework.lang.NonNull;
 import org.springframework.util.Assert;
 import org.springframework.util.StringUtils;
 
@@ -57,8 +56,10 @@ public class LocatorFactoryBean extends AbstractFactoryBeanSupport<Locator> impl
 	public static final int DEFAULT_PORT = 10334;
 
 	public static final String DEFAULT_LOG_LEVEL = GemFireProperties.LOG_LEVEL.getDefaultValueAsString();
-	private static final String LOCATORS_PROPERTY = GemFireProperties.LOCATORS.toString();
-	public static final String LOG_LEVEL_PROPERTY = GemFireProperties.LOG_LEVEL.toString();
+	private static final String LOCATORS_PROPERTY = GemFireProperties.LOCATORS.getName();
+	public static final String LOG_LEVEL_PROPERTY = GemFireProperties.LOG_LEVEL.getName();
+
+	private boolean useBeanFactoryLocator = false;
 
 	private Integer port = DEFAULT_PORT;
 
@@ -82,16 +83,22 @@ public class LocatorFactoryBean extends AbstractFactoryBeanSupport<Locator> impl
 
 	@Override
 	public void afterPropertiesSet() throws Exception {
-		applyLocatorConfigurers(getCompositeLocatorConfigurer());
+
+		applyLocatorConfigurers();
+		initializeBeanFactoryLocator();
 		init();
 	}
 
+	protected void applyLocatorConfigurers() {
+		applyLocatorConfigurers(getCompositeLocatorConfigurer());
+	}
+
 	protected void applyLocatorConfigurers(LocatorConfigurer... locatorConfigurers) {
-		applyLocatorConfigurers(Arrays.asList(nullSafeArray(locatorConfigurers, LocatorConfigurer.class)));
+		applyLocatorConfigurers(Arrays.asList(ArrayUtils.nullSafeArray(locatorConfigurers, LocatorConfigurer.class)));
 	}
 
 	protected void applyLocatorConfigurers(Iterable<LocatorConfigurer> locatorConfigurers) {
-		StreamSupport.stream(nullSafeIterable(locatorConfigurers).spliterator(), false)
+		StreamSupport.stream(CollectionUtils.nullSafeIterable(locatorConfigurers).spliterator(), false)
 			.forEach(locatorConfigurer -> locatorConfigurer.configure(getBeanName(), this));
 	}
 
@@ -142,6 +149,13 @@ protected LocatorLauncher.Builder configureGemfireProperties(LocatorLauncher.Bui
 		return locatorBuilder;
 	}
 
+	protected void initializeBeanFactoryLocator() {
+
+		if (isUseBeanFactoryLocator()) {
+			GemfireBeanFactoryLocator.newBeanFactoryLocator(getBeanFactory(), getBeanName());
+		}
+	}
+
 	protected LocatorLauncher.Builder newLocatorLauncherBuilder() {
 		return new LocatorLauncher.Builder();
 	}
@@ -162,8 +176,8 @@ public LocatorLauncher getLocatorLauncher() {
 		return this.locatorLauncher;
 	}
 
-	@Nullable @Override
-	public Locator getObject() throws Exception {
+	@Override
+	public @NonNull Locator getObject() throws Exception {
 
 		Locator locator = getLocator();
 
@@ -172,8 +186,8 @@ public Locator getObject() throws Exception {
 		return locator;
 	}
 
-	@Nullable @Override
-	public Class<?> getObjectType() {
+	@Override
+	public @NonNull Class<?> getObjectType() {
 
 		Locator locator  = getLocator();
 
@@ -190,15 +204,15 @@ public Optional<String> getBindAddress() {
 			.filter(StringUtils::hasText);
 	}
 
-	public LocatorConfigurer getCompositeLocatorConfigurer() {
+	public @NonNull LocatorConfigurer getCompositeLocatorConfigurer() {
 		return this.compositeLocatorConfigurer;
 	}
 
 	public void setGemFireProperties(Properties gemfireProperties) {
 		this.gemfireProperties = gemfireProperties;
 	}
 
-	public Properties getGemFireProperties() {
+	public @NonNull Properties getGemFireProperties() {
 
 		if (this.gemfireProperties == null) {
 			this.gemfireProperties = new Properties();
@@ -218,7 +232,7 @@ public Optional<String> getHostnameForClients() {
 	}
 
 	public void setLocatorConfigurers(LocatorConfigurer... locatorConfigurers) {
-		setLocatorConfigurers(Arrays.asList(nullSafeArray(locatorConfigurers, LocatorConfigurer.class)));
+		setLocatorConfigurers(Arrays.asList(ArrayUtils.nullSafeArray(locatorConfigurers, LocatorConfigurer.class)));
 	}
 
 	public void setLocatorConfigurers(List<LocatorConfigurer> locatorConfigurers) {
@@ -263,4 +277,12 @@ public void setPort(Integer port) {
 	public Integer getPort() {
 		return this.port;
 	}
+
+	public void setUseBeanFactoryLocator(boolean useBeanFactoryLocator) {
+		this.useBeanFactoryLocator = useBeanFactoryLocator;
+	}
+
+	public boolean isUseBeanFactoryLocator() {
+		return this.useBeanFactoryLocator;
+	}
 }

spring-data-geode/src/main/java/org/springframework/data/gemfire/config/annotation/BeanFactoryLocatorConfiguration.java

@@ -20,8 +20,10 @@
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.data.gemfire.CacheFactoryBean;
+import org.springframework.data.gemfire.LocatorFactoryBean;
 import org.springframework.data.gemfire.client.ClientCacheFactoryBean;
 import org.springframework.data.gemfire.support.GemfireBeanFactoryLocator;
+import org.springframework.lang.NonNull;
 
 /**
  * The {@link BeanFactoryLocatorConfiguration} class extends the Spring application configuration by enabling
@@ -33,8 +35,10 @@
  * @see org.springframework.context.annotation.Bean
  * @see org.springframework.context.annotation.Configuration
  * @see org.springframework.data.gemfire.CacheFactoryBean
+ * @see org.springframework.data.gemfire.LocatorFactoryBean
  * @see org.springframework.data.gemfire.client.ClientCacheFactoryBean
  * @see org.springframework.data.gemfire.config.annotation.ClientCacheConfigurer
+ * @see org.springframework.data.gemfire.config.annotation.LocatorConfigurer
  * @see org.springframework.data.gemfire.config.annotation.PeerCacheConfigurer
  * @see org.springframework.data.gemfire.config.annotation.EnableBeanFactoryLocator
  * @see org.springframework.data.gemfire.support.GemfireBeanFactoryLocator
@@ -64,6 +68,10 @@ public Object postProcessBeforeInitialization(Object bean, String beanName) thro
 					((CacheFactoryBean) bean).setUseBeanFactoryLocator(true);
 				}
 
+				if (bean instanceof LocatorFactoryBean) {
+					((LocatorFactoryBean) bean).setUseBeanFactoryLocator(true);
+				}
+
 				return bean;
 			}
 		};
@@ -73,25 +81,38 @@ public Object postProcessBeforeInitialization(Object bean, String beanName) thro
 	 * Declares and registers a {@link ClientCacheConfigurer} bean to configure a {@link ClientCacheFactoryBean}
 	 * by setting the {@literal useBeanFactoryLocator} property to {@literal true}.
 	 *
-	 * @return a {@link ClientCacheConfigurer} used to configure and set the SDG {@link ClientCacheFactoryBean}'s
+	 * @return a {@link ClientCacheConfigurer} used to configure and set the SDG {@link ClientCacheFactoryBean}
 	 * {@literal useBeanFactoryLocator} property to {@literal true}.
 	 * @see org.springframework.data.gemfire.config.annotation.ClientCacheConfigurer
 	 */
 	@Bean
-	public ClientCacheConfigurer useBeanFactoryLocatorClientCacheConfigurer() {
+	public @NonNull ClientCacheConfigurer useBeanFactoryLocatorClientCacheConfigurer() {
+		return (beanName, bean) -> bean.setUseBeanFactoryLocator(true);
+	}
+
+	/**
+	 * Declares and registers a {@link LocatorConfigurer} bean to configure a {@link LocatorFactoryBean}
+	 * by setting the {@literal useBeanFactoryLocator} property to {@literal true}.
+	 *
+	 * @return a {@link LocatorConfigurer} used to configure and set the SDG {@link LocatorFactoryBean}
+	 * {@literal useBeanFactoryLocator} property to {@literal true}.
+	 * @see org.springframework.data.gemfire.config.annotation.LocatorConfigurer
+	 */
+	@Bean
+	public @NonNull LocatorConfigurer useBeanFactoryLocatorLocatorConfigurer() {
 		return (beanName, bean) -> bean.setUseBeanFactoryLocator(true);
 	}
 
 	/**
 	 * Declares and registers a {@link PeerCacheConfigurer} bean to configure a {@link CacheFactoryBean}
 	 * by setting the {@literal useBeanFactoryLocator} property to {@literal true}.
 	 *
-	 * @return a {@link PeerCacheConfigurer} used to configure and set the SDG {@link CacheFactoryBean}'s
+	 * @return a {@link PeerCacheConfigurer} used to configure and set the SDG {@link CacheFactoryBean}
 	 * {@literal useBeanFactoryLocator} property to {@literal true}.
 	 * @see org.springframework.data.gemfire.config.annotation.PeerCacheConfigurer
 	 */
 	@Bean
-	public PeerCacheConfigurer useBeanFactoryLocatorPeerCacheConfigurer() {
+	public @NonNull PeerCacheConfigurer useBeanFactoryLocatorPeerCacheConfigurer() {
 		return (beanName, bean) -> bean.setUseBeanFactoryLocator(true);
 	}
 }

spring-data-geode/src/main/java/org/springframework/data/gemfire/config/annotation/LocatorApplication.java

@@ -25,8 +25,10 @@
 
 import org.apache.geode.distributed.Locator;
 
+import org.springframework.beans.factory.BeanFactory;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Import;
+import org.springframework.data.gemfire.support.GemfireBeanFactoryLocator;
 
 /**
  * The {@link LocatorApplication} {@link Annotation} enables a Spring Data for Apache Geode & Pivotal GemFire
@@ -90,7 +92,7 @@
 	String logLevel() default LocatorApplicationConfiguration.DEFAULT_LOG_LEVEL;
 
 	/**
-	 * Configures the name of the {@link Locator} application.
+	 * Configures the {@link String name} of the {@link Locator} application.
 	 *
 	 * Defaults to {@literal SpringBasedLocatorApplication}.
 	 *
@@ -110,4 +112,15 @@
 	 */
 	int port() default LocatorApplicationConfiguration.DEFAULT_PORT;
 
+	/**
+	 * Configures the {@link Locator} application with the {@link GemfireBeanFactoryLocator} in order to look up
+	 * the Spring {@link BeanFactory} used to auto-wire, configure and initialize Apache Geode components
+	 * created in a non-Spring managed, Apache Geode context (for example: {@literal cache.xml}).
+	 *
+	 * Defaults to {@literal false}.
+	 *
+	 * Use {@literal spring.data.gemfire.use-bean-factory-locator} property in {@literal application.properties}.
+	 */
+	boolean useBeanFactoryLocator() default LocatorApplicationConfiguration.DEFAULT_USE_BEAN_FACTORY_LOCATOR;
+
 }