From 6ed69709d7d34087a7a37c97840081619fe14571 Mon Sep 17 00:00:00 2001 From: Christoph Strobl Date: Mon, 28 Apr 2014 07:45:19 +0200 Subject: [PATCH] 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 | 10 ++ .../SolrRepositoriesAutoConfiguration.java | 48 ++++++++ ...SolrRepositoriesAutoConfigureRegstrar.java | 73 +++++++++++++ .../solr/SolrAutoConfiguration.java | 68 ++++++++++++ .../autoconfigure/solr/SolrProperties.java | 49 +++++++++ .../main/resources/META-INF/spring.factories | 2 + ...JpaRepositoriesAutoConfigurationTests.java | 7 +- ...olrRepositoriesAutoConfigurationTests.java | 92 ++++++++++++++++ .../data/alt/CitySolrRepository.java | 26 +++++ .../boot/autoconfigure/data/solr/City.java | 47 ++++++++ .../data/solr/CityRepository.java | 28 +++++ spring-boot-dependencies/pom.xml | 6 + spring-boot-samples/pom.xml | 1 + .../spring-boot-sample-data-solr/pom.xml | 42 +++++++ .../main/java/sample/data/solr/Product.java | 103 ++++++++++++++++++ .../sample/data/solr/ProductRepository.java | 30 +++++ .../data/solr/SampleSolrApplication.java | 68 ++++++++++++ .../data/solr/SampleSolrApplicationTests.java | 62 +++++++++++ spring-boot-starters/pom.xml | 1 + .../spring-boot-starter-data-solr/pom.xml | 35 ++++++ .../main/resources/META-INF/spring.provides | 1 + 21 files changed, 797 insertions(+), 2 deletions(-) create mode 100644 spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/SolrRepositoriesAutoConfiguration.java create mode 100644 spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/SolrRepositoriesAutoConfigureRegstrar.java create mode 100644 spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/solr/SolrAutoConfiguration.java create mode 100644 spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/solr/SolrProperties.java create mode 100644 spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/data/SolrRepositoriesAutoConfigurationTests.java create mode 100644 spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/data/alt/CitySolrRepository.java create mode 100644 spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/data/solr/City.java create mode 100644 spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/data/solr/CityRepository.java create mode 100644 spring-boot-samples/spring-boot-sample-data-solr/pom.xml create mode 100644 spring-boot-samples/spring-boot-sample-data-solr/src/main/java/sample/data/solr/Product.java create mode 100644 spring-boot-samples/spring-boot-sample-data-solr/src/main/java/sample/data/solr/ProductRepository.java create mode 100644 spring-boot-samples/spring-boot-sample-data-solr/src/main/java/sample/data/solr/SampleSolrApplication.java create mode 100644 spring-boot-samples/spring-boot-sample-data-solr/src/test/java/sample/data/solr/SampleSolrApplicationTests.java create mode 100644 spring-boot-starters/spring-boot-starter-data-solr/pom.xml create mode 100644 spring-boot-starters/spring-boot-starter-data-solr/src/main/resources/META-INF/spring.provides diff --git a/spring-boot-autoconfigure/pom.xml b/spring-boot-autoconfigure/pom.xml index 3f07add763..b95bfb217c 100644 --- a/spring-boot-autoconfigure/pom.xml +++ b/spring-boot-autoconfigure/pom.xml @@ -56,6 +56,11 @@ activemq-pool true + + org.apache.solr + solr-solrj + true + org.apache.tomcat.embed tomcat-embed-core @@ -171,6 +176,11 @@ spring-data-redis true + + org.springframework.data + spring-data-solr + true + org.springframework.hateoas spring-hateoas diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/SolrRepositoriesAutoConfiguration.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/SolrRepositoriesAutoConfiguration.java new file mode 100644 index 0000000000..2fa95b9984 --- /dev/null +++ b/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. + *

+ * 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. + *

+ * 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 { + +} diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/SolrRepositoriesAutoConfigureRegstrar.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/SolrRepositoriesAutoConfigureRegstrar.java new file mode 100644 index 0000000000..b63badcdf8 --- /dev/null +++ b/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 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 { + + } + +} diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/solr/SolrAutoConfiguration.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/solr/SolrAutoConfiguration.java new file mode 100644 index 0000000000..2e8b66035a --- /dev/null +++ b/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()); + } +} diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/solr/SolrProperties.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/solr/SolrProperties.java new file mode 100644 index 0000000000..83de83c5b4 --- /dev/null +++ b/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; + } + +} diff --git a/spring-boot-autoconfigure/src/main/resources/META-INF/spring.factories b/spring-boot-autoconfigure/src/main/resources/META-INF/spring.factories index cdd3343ee3..d62e1de642 100644 --- a/spring-boot-autoconfigure/src/main/resources/META-INF/spring.factories +++ b/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,\ diff --git a/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/data/JpaRepositoriesAutoConfigurationTests.java b/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/data/JpaRepositoriesAutoConfigurationTests.java index f902d330ef..9a84d3f0bd 100644 --- a/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/data/JpaRepositoriesAutoConfigurationTests.java +++ b/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/data/JpaRepositoriesAutoConfigurationTests.java @@ -22,6 +22,7 @@ import org.junit.Test; 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 @@ public class JpaRepositoriesAutoConfigurationTests { } @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 { } diff --git a/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/data/SolrRepositoriesAutoConfigurationTests.java b/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/data/SolrRepositoriesAutoConfigurationTests.java new file mode 100644 index 0000000000..476c520ee3 --- /dev/null +++ b/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 { + + } + +} diff --git a/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/data/alt/CitySolrRepository.java b/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/data/alt/CitySolrRepository.java new file mode 100644 index 0000000000..750b3c60ac --- /dev/null +++ b/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/data/alt/CitySolrRepository.java @@ -0,0 +1,26 @@ +/* + * 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.alt; + +import org.springframework.boot.autoconfigure.data.solr.City; +import org.springframework.data.repository.Repository; + +/** + * @author Christoph Strobl + */ +public interface CitySolrRepository extends Repository { + +} diff --git a/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/data/solr/City.java b/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/data/solr/City.java new file mode 100644 index 0000000000..9d4584b163 --- /dev/null +++ b/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/data/solr/City.java @@ -0,0 +1,47 @@ +/* + * 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.solr; + +import org.springframework.data.annotation.Id; +import org.springframework.data.solr.core.mapping.Indexed; +import org.springframework.data.solr.core.mapping.SolrDocument; + +/** + * @author Christoph Strobl + */ +@SolrDocument(solrCoreName = "collection1") +public class City { + + private @Id String id; + private @Indexed String name; + + public String getId() { + return id; + } + + public void setId(String id) { + this.id = id; + } + + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } + +} diff --git a/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/data/solr/CityRepository.java b/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/data/solr/CityRepository.java new file mode 100644 index 0000000000..05cf4bd96f --- /dev/null +++ b/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/data/solr/CityRepository.java @@ -0,0 +1,28 @@ +/* + * 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.solr; + +import org.springframework.data.domain.Page; +import org.springframework.data.domain.Pageable; +import org.springframework.data.repository.Repository; + +/** + * @author Christoph Strobl + */ +public interface CityRepository extends Repository { + + Page findByNameStartingWith(String name, Pageable page); +} diff --git a/spring-boot-dependencies/pom.xml b/spring-boot-dependencies/pom.xml index ad640f1d06..9381ea3a65 100644 --- a/spring-boot-dependencies/pom.xml +++ b/spring-boot-dependencies/pom.xml @@ -87,6 +87,7 @@ 3.0.1 1.7.7 1.13 + 4.7.2 0.7-groovy-2.0 4.0.5.RELEASE 1.3.3.RELEASE @@ -770,6 +771,11 @@ slf4j-log4j12 ${slf4j.version} + + org.apache.solr + solr-solrj + ${solr.version} + org.spockframework spock-core diff --git a/spring-boot-samples/pom.xml b/spring-boot-samples/pom.xml index 8fc94ae5ee..9c223a3b2d 100644 --- a/spring-boot-samples/pom.xml +++ b/spring-boot-samples/pom.xml @@ -32,6 +32,7 @@ spring-boot-sample-data-mongodb spring-boot-sample-data-redis spring-boot-sample-data-rest + spring-boot-sample-data-solr spring-boot-sample-flyway spring-boot-sample-integration spring-boot-sample-jetty diff --git a/spring-boot-samples/spring-boot-sample-data-solr/pom.xml b/spring-boot-samples/spring-boot-sample-data-solr/pom.xml new file mode 100644 index 0000000000..6a174cadef --- /dev/null +++ b/spring-boot-samples/spring-boot-sample-data-solr/pom.xml @@ -0,0 +1,42 @@ + + 4.0.0 + + org.springframework.boot + spring-boot-samples + 1.1.0.BUILD-SNAPSHOT + + spring-boot-sample-data-solr + Spring Boot Data Solr Sample + Spring Boot Data Solr Sample + http://projects.spring.io/spring-boot/ + + Pivotal Software, Inc. + http://www.spring.io + + + ${basedir}/../.. + + + + org.springframework.boot + spring-boot-starter + + + org.springframework.boot + spring-boot-starter-data-solr + + + org.springframework.boot + spring-boot-starter-test + test + + + + + + org.springframework.boot + spring-boot-maven-plugin + + + + diff --git a/spring-boot-samples/spring-boot-sample-data-solr/src/main/java/sample/data/solr/Product.java b/spring-boot-samples/spring-boot-sample-data-solr/src/main/java/sample/data/solr/Product.java new file mode 100644 index 0000000000..a91a3f8c96 --- /dev/null +++ b/spring-boot-samples/spring-boot-sample-data-solr/src/main/java/sample/data/solr/Product.java @@ -0,0 +1,103 @@ +/* + * 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 sample.data.solr; + +import java.util.List; + +import org.apache.solr.client.solrj.beans.Field; +import org.springframework.data.annotation.Id; +import org.springframework.data.solr.core.geo.Point; +import org.springframework.data.solr.core.mapping.SolrDocument; + +/** + * @author Christoph Strobl + */ +@SolrDocument(solrCoreName = "collection1") +public class Product { + + @Id + @Field + private String id; + + @Field + private String name; + + @Field + private Double price; + + @Field("cat") + private List category; + + @Field("store") + private Point location; + + public Product() { + } + + public Product(String id, String name) { + super(); + this.id = id; + this.name = name; + } + + public String getId() { + return id; + } + + public void setId(String id) { + this.id = id; + } + + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } + + public Double getPrice() { + return price; + } + + public void setPrice(Double price) { + this.price = price; + } + + public List getCategory() { + return category; + } + + public void setCategory(List category) { + this.category = category; + } + + public Point getLocation() { + return location; + } + + public void setLocation(Point location) { + this.location = location; + } + + @Override + public String toString() { + return "Product [id=" + id + ", name=" + name + ", price=" + price + + ", category=" + category + ", location=" + location + "]"; + } + +} diff --git a/spring-boot-samples/spring-boot-sample-data-solr/src/main/java/sample/data/solr/ProductRepository.java b/spring-boot-samples/spring-boot-sample-data-solr/src/main/java/sample/data/solr/ProductRepository.java new file mode 100644 index 0000000000..e5c5b926b8 --- /dev/null +++ b/spring-boot-samples/spring-boot-sample-data-solr/src/main/java/sample/data/solr/ProductRepository.java @@ -0,0 +1,30 @@ +/* + * 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 sample.data.solr; + +import java.util.List; + +import org.springframework.data.solr.repository.SolrCrudRepository; + +/** + * @author Christoph Strobl + */ +public interface ProductRepository extends SolrCrudRepository { + + List findByNameStartingWith(String name); + +} diff --git a/spring-boot-samples/spring-boot-sample-data-solr/src/main/java/sample/data/solr/SampleSolrApplication.java b/spring-boot-samples/spring-boot-sample-data-solr/src/main/java/sample/data/solr/SampleSolrApplication.java new file mode 100644 index 0000000000..825c787d18 --- /dev/null +++ b/spring-boot-samples/spring-boot-sample-data-solr/src/main/java/sample/data/solr/SampleSolrApplication.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 sample.data.solr; + +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.CommandLineRunner; +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.EnableAutoConfiguration; +import org.springframework.context.annotation.ComponentScan; +import org.springframework.context.annotation.Configuration; + +/** + * @author Christoph Strobl + */ +@Configuration +@EnableAutoConfiguration +@ComponentScan +public class SampleSolrApplication implements CommandLineRunner { + + @Autowired + private ProductRepository repository; + + @Override + public void run(String... args) throws Exception { + + repository.deleteAll(); + + // insert some products + repository.save(new Product("1", "Nintendo Entertainment System")); + repository.save(new Product("2", "Sega Megadrive")); + repository.save(new Product("3", "Sony Playstation")); + + // fetch all + System.out.println("Products found by findAll():"); + System.out.println("----------------------------"); + for (Product product : repository.findAll()) { + System.out.println(product); + } + System.out.println(); + + // fetch a single product + System.out.println("Products founds with findByNameStartingWith('So'):"); + System.out.println("--------------------------------"); + for (Product product : repository.findByNameStartingWith("So")) { + System.out.println(product); + } + System.out.println(); + } + + public static void main(String[] args) throws Exception { + SpringApplication.run(SampleSolrApplication.class, args); + } + +} diff --git a/spring-boot-samples/spring-boot-sample-data-solr/src/test/java/sample/data/solr/SampleSolrApplicationTests.java b/spring-boot-samples/spring-boot-sample-data-solr/src/test/java/sample/data/solr/SampleSolrApplicationTests.java new file mode 100644 index 0000000000..2361d5b64d --- /dev/null +++ b/spring-boot-samples/spring-boot-sample-data-solr/src/test/java/sample/data/solr/SampleSolrApplicationTests.java @@ -0,0 +1,62 @@ +/* + * 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 sample.data.solr; + +import static org.junit.Assert.*; + +import org.apache.solr.client.solrj.SolrServerException; +import org.junit.Rule; +import org.junit.Test; +import org.springframework.boot.test.OutputCapture; +import org.springframework.core.NestedCheckedException; + +/** + * @author Christoph Strobl + */ +public class SampleSolrApplicationTests { + + @Rule + public OutputCapture outputCapture = new OutputCapture(); + + @Test + public void testDefaultSettings() throws Exception { + + try { + SampleSolrApplication.main(new String[0]); + } catch (IllegalStateException ex) { + if (serverNotRunning(ex)) { + return; + } + } + String output = this.outputCapture.toString(); + assertTrue("Wrong output: " + output, output.contains("name=Sony Playstation")); + } + + private boolean serverNotRunning(IllegalStateException ex) { + + @SuppressWarnings("serial") + NestedCheckedException nested = new NestedCheckedException("failed", ex) { + }; + if (nested.contains(SolrServerException.class)) { + Throwable root = nested.getRootCause(); + if (root.getMessage().contains("Connection refused")) { + return true; + } + } + return false; + } +} diff --git a/spring-boot-starters/pom.xml b/spring-boot-starters/pom.xml index 65a2fe3442..8f14737914 100644 --- a/spring-boot-starters/pom.xml +++ b/spring-boot-starters/pom.xml @@ -28,6 +28,7 @@ spring-boot-starter-data-jpa spring-boot-starter-data-mongodb spring-boot-starter-data-rest + spring-boot-starter-data-solr spring-boot-starter-freemarker spring-boot-starter-integration spring-boot-starter-jdbc diff --git a/spring-boot-starters/spring-boot-starter-data-solr/pom.xml b/spring-boot-starters/spring-boot-starter-data-solr/pom.xml new file mode 100644 index 0000000000..205c2eebba --- /dev/null +++ b/spring-boot-starters/spring-boot-starter-data-solr/pom.xml @@ -0,0 +1,35 @@ + + + 4.0.0 + + org.springframework.boot + spring-boot-starters + 1.1.0.BUILD-SNAPSHOT + + spring-boot-starter-data-solr + Spring Boot Data Solr Starter + Spring Boot Data Solr Starter + http://projects.spring.io/spring-boot/ + + Pivotal Software, Inc. + http://www.spring.io + + + ${basedir}/../.. + + + + ${project.groupId} + spring-boot-starter + ${project.version} + + + org.apache.solr + solr-solrj + + + org.springframework.data + spring-data-solr + + + diff --git a/spring-boot-starters/spring-boot-starter-data-solr/src/main/resources/META-INF/spring.provides b/spring-boot-starters/spring-boot-starter-data-solr/src/main/resources/META-INF/spring.provides new file mode 100644 index 0000000000..7c307abea5 --- /dev/null +++ b/spring-boot-starters/spring-boot-starter-data-solr/src/main/resources/META-INF/spring.provides @@ -0,0 +1 @@ +provides: spring-data-solr, solr-solrj \ No newline at end of file