org.springframework.data.elasticsearch.core

Class AbstractElasticsearchRestTransportTemplate

java.lang.Object

org.springframework.data.elasticsearch.core.AbstractElasticsearchTemplate

org.springframework.data.elasticsearch.core.AbstractElasticsearchRestTransportTemplate

All Implemented Interfaces:

Aware, ApplicationContextAware, DocumentOperations, ElasticsearchOperations, SearchOperations

Direct Known Subclasses:

ElasticsearchRestTemplate, ElasticsearchTemplate

public abstract class AbstractElasticsearchRestTransportTemplate
extends AbstractElasticsearchTemplate

This class contains methods that are common the implementations derived from AbstractElasticsearchTemplate using either the TransportClient or the RestHighLevelClient and that use Elasticsearch specific libraries.

Note: Although this class is public, it is not considered to be part of the official Spring Data Elasticsearch API and so might change at any time.

Author:

Peter-Josef Meisch

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.data.elasticsearch.core.AbstractElasticsearchTemplate

AbstractElasticsearchTemplate.DocumentCallback<T>, AbstractElasticsearchTemplate.ReadDocumentCallback<T>, AbstractElasticsearchTemplate.ReadSearchDocumentResponseCallback<T>, AbstractElasticsearchTemplate.ReadSearchScrollDocumentResponseCallback<T>, AbstractElasticsearchTemplate.SearchDocumentResponseCallback<T>

Field Summary

Fields inherited from class org.springframework.data.elasticsearch.core.AbstractElasticsearchTemplate

elasticsearchConverter, entityCallbacks, entityOperations, refreshPolicy, requestFactory, routingResolver

Constructor Summary

Constructors

Constructor and Description
AbstractElasticsearchRestTransportTemplate()

Method Summary

Modifier and Type	Method and Description
protected List<IndexedObjectInformation>	checkForBulkOperationFailure(org.elasticsearch.action.bulk.BulkResponse bulkResponse)
protected <T> SearchHits<T>	doSearch(MoreLikeThisQuery query, Class<T> clazz, IndexCoordinates index)
protected <T> SearchDocumentResponse.EntityCreator<T>	getEntityCreator(AbstractElasticsearchTemplate.ReadDocumentCallback<T> documentCallback)
protected abstract org.elasticsearch.action.search.MultiSearchResponse.Item[]	getMultiSearchResult(org.elasticsearch.action.search.MultiSearchRequest request)
protected String	getRuntimeLibraryVersion()
protected String	getVendor()
Query	idsQuery(List<String> ids) Creates a Query to find get all documents with given ids.
Query	matchAllQuery() Creates a Query to get all documents.
<T> List<SearchHits<T>>	multiSearch(List<? extends Query> queries, Class<T> clazz, IndexCoordinates index) Execute the multi search query against elasticsearch and return result as List of SearchHits.
List<SearchHits<?>>	multiSearch(List<? extends Query> queries, List<Class<?>> classes) Execute the multi search query against elasticsearch and return result as List of SearchHits.
List<SearchHits<?>>	multiSearch(List<? extends Query> queries, List<Class<?>> classes, IndexCoordinates index) Execute the multi search query against elasticsearch and return result as List of SearchHits.
org.elasticsearch.action.search.SearchResponse	suggest(org.elasticsearch.search.suggest.SuggestBuilder suggestion, Class<?> clazz) Deprecated.

Methods inherited from class org.springframework.data.elasticsearch.core.AbstractElasticsearchTemplate

bulkIndex, bulkIndex, bulkIndex, bulkOperation, bulkUpdate, count, createElasticsearchConverter, delete, delete, delete, delete, delete, delete, doBulkOperation, doCopy, doDelete, doExists, doIndex, exists, exists, get, getClusterVersion, getElasticsearchConverter, getEntityRouting, getIndexCoordinatesFor, getRefreshPolicy, getRequestFactory, index, initialize, logVersions, maybeCallbackAfterConvert, maybeCallbackAfterSave, maybeCallbackAfterSaveWithQueries, maybeCallbackAfterSaveWithQuery, maybeCallbackBeforeConvert, maybeCallbackBeforeConvertWithQueries, maybeCallbackBeforeConvertWithQuery, multiGet, multiSearch, save, save, save, save, save, search, search, search, searchForStream, searchForStream, searchScrollClear, searchScrollClear, searchScrollContinue, searchScrollStart, setApplicationContext, setEntityCallbacks, setRefreshPolicy, toArray, updateIndexedObject, updateIndexedObjectsWithQueries, withRouting

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.data.elasticsearch.core.ElasticsearchOperations

cluster, indexOps, indexOps, stringIdRepresentation

Methods inherited from interface org.springframework.data.elasticsearch.core.DocumentOperations

bulkIndex, bulkUpdate, bulkUpdate, delete, get, multiGet, update, updateByQuery

Methods inherited from interface org.springframework.data.elasticsearch.core.SearchOperations

count, count, search, searchOne, searchOne, suggest

Constructor Detail

AbstractElasticsearchRestTransportTemplate

public AbstractElasticsearchRestTransportTemplate()

Method Detail

checkForBulkOperationFailure

protected List<IndexedObjectInformation> checkForBulkOperationFailure(org.elasticsearch.action.bulk.BulkResponse bulkResponse)

Parameters:

bulkResponse -

Returns:

the list of the item id's

doSearch

protected <T> SearchHits<T> doSearch(MoreLikeThisQuery query,
                                     Class<T> clazz,
                                     IndexCoordinates index)

Specified by:

doSearch in class AbstractElasticsearchTemplate

multiSearch

public <T> List<SearchHits<T>> multiSearch(List<? extends Query> queries,
                                           Class<T> clazz,
                                           IndexCoordinates index)

Description copied from interface: SearchOperations

Execute the multi search query against elasticsearch and return result as List of SearchHits.

Type Parameters:

T - element return type

Parameters:

queries - the queries to execute

clazz - the entity clazz used for property mapping

index - the index to run the query against

Returns:

list of SearchHits

multiSearch

public List<SearchHits<?>> multiSearch(List<? extends Query> queries,
                                       List<Class<?>> classes)

Description copied from interface: SearchOperations

Execute the multi search query against elasticsearch and return result as List of SearchHits.

Parameters:

queries - the queries to execute

classes - the entity classes

Returns:

list of SearchHits

multiSearch

public List<SearchHits<?>> multiSearch(List<? extends Query> queries,
                                       List<Class<?>> classes,
                                       IndexCoordinates index)

Description copied from interface: SearchOperations

Execute the multi search query against elasticsearch and return result as List of SearchHits.

Parameters:

queries - the queries to execute

classes - the entity classes used for property mapping

index - the index to run the query against

Returns:

list of SearchHits

getMultiSearchResult

protected abstract org.elasticsearch.action.search.MultiSearchResponse.Item[] getMultiSearchResult(org.elasticsearch.action.search.MultiSearchRequest request)

matchAllQuery

public Query matchAllQuery()

Description copied from interface: SearchOperations

Creates a Query to get all documents. Must be implemented by the concrete implementations to provide an appropriate query using the respective client.

Returns:

a query to find all documents

idsQuery

public Query idsQuery(List<String> ids)

Description copied from interface: SearchOperations

Creates a Query to find get all documents with given ids. Must be implemented by the concrete implementations to provide an appropriate query using the respective client.

Parameters:

ids - the list of ids must not be null

Returns:

query returning the documents with the given ids

getVendor

protected String getVendor()

Specified by:

getVendor in class AbstractElasticsearchTemplate

Returns:

the vendor name of the used cluster and client library

getRuntimeLibraryVersion

protected String getRuntimeLibraryVersion()

Specified by:

getRuntimeLibraryVersion in class AbstractElasticsearchTemplate

Returns:

the version of the used client runtime library.

suggest

@Deprecated
public org.elasticsearch.action.search.SearchResponse suggest(org.elasticsearch.search.suggest.SuggestBuilder suggestion,
                                                                          Class<?> clazz)

Deprecated.

Description copied from interface: SearchOperations

Does a suggest query

Parameters:

suggestion - the query

clazz - the entity class

Returns:

the suggest response

getEntityCreator

protected <T> SearchDocumentResponse.EntityCreator<T> getEntityCreator(AbstractElasticsearchTemplate.ReadDocumentCallback<T> documentCallback)