Add auto configuration support for Spring Data Solr

Registers required components in application context if not available to
set up environment for usage with Spring Data Solr. Will listen on
SolrServer and SolrRepositories for configuration.

By default an HttpSolrServer is registered unless a zkHost (zookeeper
host) is defined. In that case an instance of CloudSolrServer will be
created.

By default multicore support is enabled, creating instances of
SolrServer for each core defined via @SolrDocument.

spring-boot-autoconfigure/pom.xml

@@ -56,6 +56,11 @@
 			<artifactId>activemq-pool</artifactId>
 			<optional>true</optional>
 		</dependency>
+		<dependency>
+			<groupId>org.apache.solr</groupId>
+			<artifactId>solr-solrj</artifactId>
+			<optional>true</optional>
+		</dependency>
 		<dependency>
 			<groupId>org.apache.tomcat.embed</groupId>
 			<artifactId>tomcat-embed-core</artifactId>
@@ -171,6 +176,11 @@
 			<artifactId>spring-data-redis</artifactId>
 			<optional>true</optional>
 		</dependency>
+		<dependency>
+			<groupId>org.springframework.data</groupId>
+			<artifactId>spring-data-solr</artifactId>
+			<optional>true</optional>
+		</dependency>
 		<dependency>
 			<groupId>org.springframework.hateoas</groupId>
 			<artifactId>spring-hateoas</artifactId>

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/SolrRepositoriesAutoConfiguration.java

@@ -0,0 +1,48 @@
+/*
+ * Copyright 2014 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.data;
+
+import org.apache.solr.client.solrj.SolrServer;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.Import;
+import org.springframework.data.solr.repository.SolrRepository;
+import org.springframework.data.solr.repository.support.SolrRepositoryFactoryBean;
+
+/**
+ * Enables auto configuration for Spring Data Solr repositories.
+ * <p>
+ * Activates when there is no bean of type
+ * {@link org.springframework.data.solr.repository.support.SolrRepositoryFactoryBean}
+ * found in context, and both
+ * {@link org.springframework.data.solr.repository.SolrRepository} and
+ * {@link org.apache.solr.client.solrj.SolrServer} can be found on classpath.
+ * </p>
+ * If active auto configuration does the same as
+ * {@link org.springframework.data.solr.repository.config.EnableSolrRepositories} would
+ * do.
+ * 
+ * @author Christoph Strobl
+ */
+@Configuration
+@ConditionalOnClass({ SolrServer.class, SolrRepository.class })
+@ConditionalOnMissingBean(SolrRepositoryFactoryBean.class)
+@Import(SolrRepositoriesAutoConfigureRegstrar.class)
+public class SolrRepositoriesAutoConfiguration {
+
+}

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/SolrRepositoriesAutoConfigureRegstrar.java

@@ -0,0 +1,73 @@
+/*
+ * Copyright 2014 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.data;
+
+import java.lang.annotation.Annotation;
+
+import org.springframework.context.annotation.ImportBeanDefinitionRegistrar;
+import org.springframework.data.repository.config.RepositoryConfigurationExtension;
+import org.springframework.data.solr.repository.config.EnableSolrRepositories;
+import org.springframework.data.solr.repository.config.SolrRepositoryConfigExtension;
+
+/**
+ * {@link ImportBeanDefinitionRegistrar} used to auto-configure Spring Data Solr
+ * repositories.
+ * 
+ * @author Christoph Strobl
+ */
+public class SolrRepositoriesAutoConfigureRegstrar extends
+		AbstractRepositoryConfigurationSourceSupport {
+
+	/*
+	 * (non-Javadoc)
+	 * 
+	 * @see org.springframework.boot.autoconfigure.data.
+	 * AbstractRepositoryConfigurationSourceSupport#getAnnotation()
+	 */
+	@Override
+	protected Class<? extends Annotation> getAnnotation() {
+		return EnableSolrRepositories.class;
+	}
+
+	/*
+	 * (non-Javadoc)
+	 * 
+	 * @see org.springframework.boot.autoconfigure.data.
+	 * AbstractRepositoryConfigurationSourceSupport#getConfiguration()
+	 */
+	@Override
+	protected Class<?> getConfiguration() {
+		return EnableSolrRepositoriesConfiguration.class;
+	}
+
+	/*
+	 * (non-Javadoc)
+	 * 
+	 * @see org.springframework.boot.autoconfigure.data.
+	 * AbstractRepositoryConfigurationSourceSupport#getRepositoryConfigurationExtension()
+	 */
+	@Override
+	protected RepositoryConfigurationExtension getRepositoryConfigurationExtension() {
+		return new SolrRepositoryConfigExtension();
+	}
+
+	@EnableSolrRepositories(multicoreSupport = true)
+	private static class EnableSolrRepositoriesConfiguration {
+
+	}
+
+}

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/solr/SolrAutoConfiguration.java

@@ -0,0 +1,68 @@
+/*
+ * Copyright 2014 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.solr;
+
+import javax.annotation.PreDestroy;
+
+import org.apache.solr.client.solrj.SolrServer;
+import org.apache.solr.client.solrj.impl.CloudSolrServer;
+import org.apache.solr.client.solrj.impl.HttpSolrServer;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
+import org.springframework.boot.context.properties.EnableConfigurationProperties;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.util.StringUtils;
+
+/**
+ * Enables auto configuration for Solr.
+ * 
+ * @author Christoph Strobl
+ */
+@Configuration
+@ConditionalOnClass(SolrServer.class)
+@EnableConfigurationProperties(SolrProperties.class)
+public class SolrAutoConfiguration {
+
+	private @Autowired SolrProperties properties;
+
+	private SolrServer solrServer;
+
+	@PreDestroy
+	public void close() {
+		if (this.solrServer != null) {
+			this.solrServer.shutdown();
+		}
+	}
+
+	@Bean
+	@ConditionalOnMissingBean
+	public SolrServer solrServer() {
+
+		this.solrServer = createSolrServer();
+		return this.solrServer;
+	}
+
+	private SolrServer createSolrServer() {
+
+		if (StringUtils.hasText(this.properties.getZkHost())) {
+			return new CloudSolrServer(this.properties.getZkHost());
+		}
+		return new HttpSolrServer(this.properties.getHost());
+	}
+}

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/solr/SolrProperties.java

@@ -0,0 +1,49 @@
+/*
+ * Copyright 2014 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.solr;
+
+import org.springframework.boot.context.properties.ConfigurationProperties;
+
+/**
+ * Configuration properties for Solr.
+ * 
+ * @author Christoph Strobl
+ */
+@ConfigurationProperties(prefix = "spring.data.solr")
+public class SolrProperties {
+
+	private String host = "http://127.0.0.1:8983/solr";
+
+	private String zkHost;
+
+	public String getHost() {
+		return host;
+	}
+
+	public void setHost(String host) {
+		this.host = host;
+	}
+
+	public String getZkHost() {
+		return zkHost;
+	}
+
+	public void setZkHost(String zkHost) {
+		this.zkHost = zkHost;
+	}
+
+}

spring-boot-autoconfigure/src/main/resources/META-INF/spring.factories

@@ -11,6 +11,7 @@ org.springframework.boot.autoconfigure.PropertyPlaceholderAutoConfiguration,\
 org.springframework.boot.autoconfigure.batch.BatchAutoConfiguration,\
 org.springframework.boot.autoconfigure.data.JpaRepositoriesAutoConfiguration,\
 org.springframework.boot.autoconfigure.data.MongoRepositoriesAutoConfiguration,\
+org.springframework.boot.autoconfigure.data.SolrRepositoriesAutoConfiguration,\
 org.springframework.boot.autoconfigure.data.rest.RepositoryRestMvcAutoConfiguration,\
 org.springframework.boot.autoconfigure.freemarker.FreeMarkerAutoConfiguration,\
 org.springframework.boot.autoconfigure.hateoas.HypermediaAutoConfiguration,\
@@ -31,6 +32,7 @@ org.springframework.boot.autoconfigure.reactor.ReactorAutoConfiguration,\
 org.springframework.boot.autoconfigure.redis.RedisAutoConfiguration,\
 org.springframework.boot.autoconfigure.security.SecurityAutoConfiguration,\
 org.springframework.boot.autoconfigure.security.FallbackWebSecurityAutoConfiguration,\
+org.springframework.boot.autoconfigure.solr.SolrAutoConfiguration,\
 org.springframework.boot.autoconfigure.velocity.VelocityAutoConfiguration,\
 org.springframework.boot.autoconfigure.thymeleaf.ThymeleafAutoConfiguration,\
 org.springframework.boot.autoconfigure.web.EmbeddedServletContainerAutoConfiguration,\

spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/data/JpaRepositoriesAutoConfigurationTests.java

@@ -22,6 +22,7 @@
 import org.springframework.boot.autoconfigure.PropertyPlaceholderAutoConfiguration;
 import org.springframework.boot.autoconfigure.TestAutoConfigurationPackage;
 import org.springframework.boot.autoconfigure.data.alt.CityMongoDbRepository;
+import org.springframework.boot.autoconfigure.data.alt.CitySolrRepository;
 import org.springframework.boot.autoconfigure.data.jpa.City;
 import org.springframework.boot.autoconfigure.data.jpa.CityRepository;
 import org.springframework.boot.autoconfigure.jdbc.EmbeddedDataSourceConfiguration;
@@ -81,8 +82,10 @@ protected static class TestConfiguration {
 	}
 
 	@Configuration
-	@EnableJpaRepositories(basePackageClasses = org.springframework.boot.autoconfigure.data.alt.CityJpaRepository.class, excludeFilters = { @Filter(type = FilterType.ASSIGNABLE_TYPE, value = CityMongoDbRepository.class) })
-	@TestAutoConfigurationPackage(City.class)
+	@EnableJpaRepositories(basePackageClasses = org.springframework.boot.autoconfigure.data.alt.CityJpaRepository.class, excludeFilters = {
+        @Filter(type = FilterType.ASSIGNABLE_TYPE, value = CityMongoDbRepository.class),
+        @Filter(type = FilterType.ASSIGNABLE_TYPE, value = CitySolrRepository.class) })
+    @TestAutoConfigurationPackage(City.class)
 	protected static class CustomConfiguration {
 
 	}

spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/data/SolrRepositoriesAutoConfigurationTests.java

@@ -0,0 +1,92 @@
+/*
+ * Copyright 2014 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.data;
+
+import static org.hamcrest.core.IsInstanceOf.*;
+import static org.hamcrest.core.IsNull.*;
+import static org.junit.Assert.*;
+
+import org.apache.solr.client.solrj.SolrServer;
+import org.apache.solr.client.solrj.impl.HttpSolrServer;
+import org.junit.Test;
+import org.springframework.boot.autoconfigure.PropertyPlaceholderAutoConfiguration;
+import org.springframework.boot.autoconfigure.TestAutoConfigurationPackage;
+import org.springframework.boot.autoconfigure.data.alt.CitySolrRepository;
+import org.springframework.boot.autoconfigure.data.solr.City;
+import org.springframework.boot.autoconfigure.data.solr.CityRepository;
+import org.springframework.boot.autoconfigure.solr.SolrAutoConfiguration;
+import org.springframework.context.annotation.AnnotationConfigApplicationContext;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.data.solr.repository.config.EnableSolrRepositories;
+
+/**
+ * @author Christoph Strobl
+ */
+public class SolrRepositoriesAutoConfigurationTests {
+
+	private AnnotationConfigApplicationContext context;
+
+	@Test
+	public void testDefaultRepositoryConfiguration() {
+
+		initContext(TestConfiguration.class);
+
+		assertThat(this.context.getBean(CityRepository.class), notNullValue());
+		assertThat(this.context.getBean(SolrServer.class), instanceOf(HttpSolrServer.class));
+	}
+
+	@Test
+	public void testNoRepositoryConfiguration() {
+
+		initContext(EmptyConfiguration.class);
+		assertThat(this.context.getBean(SolrServer.class), instanceOf(HttpSolrServer.class));
+	}
+
+	@Test
+	public void doesNotTriggerDefaultRepositoryDetectionIfCustomized() {
+
+		initContext(CustomizedConfiguration.class);
+		assertThat(this.context.getBean(CitySolrRepository.class), notNullValue());
+	}
+
+	private void initContext(Class<?> configClass) {
+
+		this.context = new AnnotationConfigApplicationContext();
+		this.context.register(configClass, SolrAutoConfiguration.class, SolrRepositoriesAutoConfiguration.class,
+				PropertyPlaceholderAutoConfiguration.class);
+		this.context.refresh();
+	}
+
+	@Configuration
+	@TestAutoConfigurationPackage(City.class)
+	static class TestConfiguration {
+
+	}
+
+	@Configuration
+	@TestAutoConfigurationPackage(SolrRepositoriesAutoConfigurationTests.class)
+	static class EmptyConfiguration {
+
+	}
+
+	@Configuration
+	@TestAutoConfigurationPackage(SolrRepositoriesAutoConfigurationTests.class)
+	@EnableSolrRepositories(basePackageClasses = CitySolrRepository.class, multicoreSupport = true)
+	protected static class CustomizedConfiguration {
+
+	}
+
+}