#497 - Add Example for Elasticsearch High Level REST Client.

elasticsearch/rest/src/main/java/example/springdata/elasticsearch/conference/ApplicationConfiguration.java

@@ -0,0 +1,74 @@
+/*
+ * Copyright 2014-2018 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
+ *
+ *      https://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 example.springdata.elasticsearch.conference;
+
+import java.util.Arrays;
+
+import javax.annotation.PostConstruct;
+import javax.annotation.PreDestroy;
+
+import org.elasticsearch.client.RestHighLevelClient;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.data.elasticsearch.client.ClientConfiguration;
+import org.springframework.data.elasticsearch.client.RestClients;
+import org.springframework.data.elasticsearch.config.AbstractElasticsearchConfiguration;
+import org.springframework.data.elasticsearch.core.ElasticsearchOperations;
+import org.springframework.data.elasticsearch.core.geo.GeoPoint;
+import org.springframework.data.elasticsearch.repository.config.EnableElasticsearchRepositories;
+
+/**
+ * @author Artur Konczak
+ * @author Oliver Gierke
+ * @author Christoph Strobl
+ */
+@Configuration
+@EnableElasticsearchRepositories
+class ApplicationConfiguration extends AbstractElasticsearchConfiguration {
+
+	@Override
+	public RestHighLevelClient elasticsearchClient() {
+		return RestClients.create(ClientConfiguration.localhost()).rest();
+	}
+
+	@Autowired ElasticsearchOperations elasticsearchOperations;
+	@Autowired ConferenceRepository repository;
+
+	@PreDestroy
+	public void deleteIndex() {
+		elasticsearchOperations.deleteIndex(Conference.class);
+	}
+
+	@PostConstruct
+	public void insertDataSample() {
+
+		repository.deleteAll();
+		elasticsearchOperations.refresh(Conference.class);
+
+		// Save data sample
+		repository.save(Conference.builder().date("2014-11-06").name("Spring eXchange 2014 - London")
+				.keywords(Arrays.asList("java", "spring")).location(new GeoPoint(51.500152D, -0.126236D)).build());
+		repository.save(Conference.builder().date("2014-12-07").name("Scala eXchange 2014 - London")
+				.keywords(Arrays.asList("scala", "play", "java")).location(new GeoPoint(51.500152D, -0.126236D)).build());
+		repository.save(Conference.builder().date("2014-11-20").name("Elasticsearch 2014 - Berlin")
+				.keywords(Arrays.asList("java", "elasticsearch", "kibana")).location(new GeoPoint(52.5234051D, 13.4113999))
+				.build());
+		repository.save(Conference.builder().date("2014-11-12").name("AWS London 2014")
+				.keywords(Arrays.asList("cloud", "aws")).location(new GeoPoint(51.500152D, -0.126236D)).build());
+		repository.save(Conference.builder().date("2014-10-04").name("JDD14 - Cracow")
+				.keywords(Arrays.asList("java", "spring")).location(new GeoPoint(50.0646501D, 19.9449799)).build());
+	}
+}

elasticsearch/rest/src/main/java/example/springdata/elasticsearch/conference/Conference.java

@@ -0,0 +1,59 @@
+/*
+ * Copyright 2014-2018 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
+ *
+ *      https://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 example.springdata.elasticsearch.conference;
+
+import static org.springframework.data.elasticsearch.annotations.FieldType.*;
+
+import lombok.Builder;
+import lombok.Data;
+
+import java.util.List;
+
+import org.springframework.data.annotation.Id;
+import org.springframework.data.elasticsearch.annotations.Document;
+import org.springframework.data.elasticsearch.annotations.Field;
+import org.springframework.data.elasticsearch.core.geo.GeoPoint;
+
+/**
+ * @author Artur Konczak
+ * @author Oliver Gierke
+ * @auhtor Christoph Strobl
+ */
+@Data
+@Builder
+@Document(indexName = "conference-index", type = "geo-class-point-type", shards = 1, replicas = 0,
+		refreshInterval = "-1")
+public class Conference {
+
+	private @Id String id;
+	private String name;
+	private @Field(type = Date) String date;
+	private GeoPoint location;
+	private List<String> keywords;
+
+	// do not remove it
+	public Conference() {}
+
+	// do not remove it - work around for lombok generated constructor for all params
+	public Conference(String id, String name, String date, GeoPoint location, List<String> keywords) {
+
+		this.id = id;
+		this.name = name;
+		this.date = date;
+		this.location = location;
+		this.keywords = keywords;
+	}
+}

elasticsearch/rest/src/main/java/example/springdata/elasticsearch/conference/ConferenceRepository.java

@@ -0,0 +1,23 @@
+/*
+ * Copyright 2019 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
+ *
+ *      https://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 example.springdata.elasticsearch.conference;
+
+import org.springframework.data.elasticsearch.repository.ElasticsearchRepository;
+
+/**
+ * @author Christoph Strobl
+ */
+interface ConferenceRepository extends ElasticsearchRepository<Conference, String> {}

elasticsearch/rest/src/main/resources/application.properties

@@ -0,0 +1,3 @@
+# Uncomment both entries to connect with local elasticsearch cluster
+#spring.data.elasticsearch.clusterName=elasticsearch
+#spring.data.elasticsearch.clusterNodes=localhost:9300

elasticsearch/rest/src/test/java/example/springdata/elasticsearch/conference/ElasticsearchOperationsTest.java

@@ -0,0 +1,69 @@
+/*
+ * Copyright 2019 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
+ *
+ *      https://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 example.springdata.elasticsearch.conference;
+
+import static org.hamcrest.Matchers.*;
+import static org.junit.Assert.*;
+
+import example.springdata.elasticsearch.util.ElasticsearchAvailable;
+
+import java.text.ParseException;
+import java.text.SimpleDateFormat;
+import java.util.List;
+
+import org.junit.ClassRule;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.data.elasticsearch.core.ElasticsearchOperations;
+import org.springframework.data.elasticsearch.core.query.Criteria;
+import org.springframework.data.elasticsearch.core.query.CriteriaQuery;
+import org.springframework.test.context.junit4.SpringRunner;
+
+/**
+ * Test case to show Spring Data Elasticsearch functionality.
+ *
+ * @author Christoph Strobl
+ */
+@RunWith(SpringRunner.class)
+@SpringBootTest(classes = ApplicationConfiguration.class)
+public class ElasticsearchOperationsTest {
+
+	public static @ClassRule ElasticsearchAvailable elasticsearchAvailable = ElasticsearchAvailable.onLocalhost();
+
+	private static final SimpleDateFormat format = new SimpleDateFormat("yyyy-MM-dd");
+
+	@Autowired ElasticsearchOperations operations;
+
+	@Test
+	public void textSearch() throws ParseException {
+
+		String expectedDate = "2014-10-29";
+		String expectedWord = "java";
+		CriteriaQuery query = new CriteriaQuery(
+				new Criteria("keywords").contains(expectedWord).and(new Criteria("date").greaterThanEqual(expectedDate)));
+
+		List<Conference> result = operations.queryForList(query, Conference.class);
+
+		assertThat(result, hasSize(3));
+
+		for (Conference conference : result) {
+			assertThat(conference.getKeywords(), hasItem(expectedWord));
+			assertThat(format.parse(conference.getDate()), greaterThan(format.parse(expectedDate)));
+		}
+	}
+}

elasticsearch/rest/src/test/java/example/springdata/elasticsearch/util/ElasticsearchAvailable.java

@@ -0,0 +1,70 @@
+/*
+ * Copyright 2019 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
+ *
+ *      https://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 example.springdata.elasticsearch.util;
+
+import java.io.IOException;
+
+import org.apache.http.client.methods.CloseableHttpResponse;
+import org.apache.http.client.methods.HttpHead;
+import org.apache.http.impl.client.CloseableHttpClient;
+import org.apache.http.impl.client.HttpClientBuilder;
+import org.assertj.core.api.Assumptions;
+import org.junit.AssumptionViolatedException;
+import org.junit.rules.TestRule;
+import org.junit.runner.Description;
+import org.junit.runners.model.Statement;
+
+/**
+ * @author Christoph Strobl
+ */
+public class ElasticsearchAvailable implements TestRule {
+
+	private final String url;
+
+	private ElasticsearchAvailable(String url) {
+		this.url = url;
+	}
+
+	public static ElasticsearchAvailable onLocalhost() {
+		return new ElasticsearchAvailable("http://localhost:9200");
+	}
+
+	@Override
+	public Statement apply(Statement base, Description description) {
+
+		return new Statement() {
+
+			@Override
+			public void evaluate() throws Throwable {
+
+				checkServerRunning();
+				base.evaluate();
+			}
+		};
+	}
+
+	private void checkServerRunning() {
+
+		try (CloseableHttpClient client = HttpClientBuilder.create().build()) {
+			CloseableHttpResponse response = client.execute(new HttpHead(url));
+			if (response != null && response.getStatusLine() != null) {
+				Assumptions.assumeThat(response.getStatusLine().getStatusCode()).isEqualTo(200);
+			}
+		} catch (IOException e) {
+			throw new AssumptionViolatedException(String.format("Elasticsearch Server seems to be down. %s", e.getMessage()));
+		}
+	}
+}