Package org.springframework.data.elasticsearch.core

Class AbstractElasticsearchTemplate

java.lang.Object

org.springframework.data.elasticsearch.core.AbstractElasticsearchTemplate

All Implemented Interfaces:

Aware, ApplicationContextAware, DocumentOperations, ElasticsearchOperations, SearchOperations

Direct Known Subclasses:

ElasticsearchRestTemplate, ElasticsearchTemplate

public abstract class AbstractElasticsearchTemplate
extends Object
implements ElasticsearchOperations, ApplicationContextAware

This class contains methods that are common to different implementations of the ElasticsearchOperations interface that use different clients, like RestHighLevelClient and the next Java client from Elasticsearch or some future implementation that might use an Opensearch client. This class must not contain imports or use classes that are specific to one of these implementations.

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:

Sascha Woo, Peter-Josef Meisch, Roman Puchkovskiy, Subhobrata Dey, Steven Pearce, Anton Naydenov

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static interface	AbstractElasticsearchTemplate.DocumentCallback<T>
protected class	AbstractElasticsearchTemplate.ReadDocumentCallback<T>
protected class	AbstractElasticsearchTemplate.ReadSearchDocumentResponseCallback<T>
protected class	AbstractElasticsearchTemplate.ReadSearchScrollDocumentResponseCallback<T>
protected static interface	AbstractElasticsearchTemplate.SearchDocumentResponseCallback<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected ElasticsearchConverter	elasticsearchConverter
protected EntityCallbacks	entityCallbacks
protected EntityOperations	entityOperations
protected RefreshPolicy	refreshPolicy
protected RoutingResolver	routingResolver

Constructor Summary

Constructors

Constructor	Description
AbstractElasticsearchTemplate()
AbstractElasticsearchTemplate(ElasticsearchConverter elasticsearchConverter)

Method Summary

Modifier and Type	Method	Description
List<IndexedObjectInformation>	bulkIndex(List<IndexQuery> queries, Class<?> clazz)	Bulk index all objects.
List<IndexedObjectInformation>	bulkIndex(List<IndexQuery> queries, BulkOptions bulkOptions, Class<?> clazz)	Bulk index all objects.
final List<IndexedObjectInformation>	bulkIndex(List<IndexQuery> queries, BulkOptions bulkOptions, IndexCoordinates index)	Bulk index all objects.
List<IndexedObjectInformation>	bulkOperation(List<?> queries, BulkOptions bulkOptions, IndexCoordinates index)
void	bulkUpdate(List<UpdateQuery> queries, Class<?> clazz)	Bulk update all objects.
long	count(Query query, Class<?> clazz)	return number of elements found by given query
String	delete(Object entity)	Deletes the given entity
String	delete(Object entity, IndexCoordinates index)	Deletes the given entity
String	delete(String id, Class<?> entityType)	Delete the one object with provided id.
final String	delete(String id, String routing, IndexCoordinates index)	Deprecated.
String	delete(String id, IndexCoordinates index)	Delete the one object with provided id.
ByQueryResponse	delete(Query query, Class<?> clazz)	Delete all records matching the query.
abstract List<IndexedObjectInformation>	doBulkOperation(List<?> queries, BulkOptions bulkOptions, IndexCoordinates index)
protected abstract AbstractElasticsearchTemplate	doCopy()	must return a copy of this instance that will for example be used to set a custom routing resolver without modifying the original object.
protected abstract String	doDelete(String id, String routing, IndexCoordinates index)
protected abstract boolean	doExists(String id, IndexCoordinates index)
abstract String	doIndex(IndexQuery query, IndexCoordinates indexCoordinates)
protected abstract <T> SearchHits<T>	doSearch(MoreLikeThisQuery query, Class<T> clazz, IndexCoordinates index)
boolean	exists(String id, Class<?> clazz)	Check if an entity with given id exists.
boolean	exists(String id, IndexCoordinates index)	Check if an entity with given id exists.
<T> T	get(String id, Class<T> clazz)	Retrieves an object from the index specified in the entity's Document annotation.
protected abstract String	getClusterVersion()	tries to extract the version of the Elasticsearch cluster
ElasticsearchConverter	getElasticsearchConverter()
protected <T> SearchDocumentResponse.EntityCreator<T>	getEntityCreator(AbstractElasticsearchTemplate.ReadDocumentCallback<T> documentCallback)
String	getEntityRouting(Object entity)	gets the routing for an entity which might be defined by a join-type relation
IndexCoordinates	getIndexCoordinatesFor(Class<?> clazz)
RefreshPolicy	getRefreshPolicy()
protected abstract String	getRuntimeLibraryVersion()
protected abstract String	getVendor()
String	index(IndexQuery query, IndexCoordinates index)	Index an object.
void	logVersions()	logs the versions of the different Elasticsearch components.
protected <T> T	maybeCallbackAfterConvert(T entity, Document document, IndexCoordinates index)
protected <T> Document	maybeCallbackAfterLoad(Document document, Class<T> type, IndexCoordinates indexCoordinates)
protected <T> T	maybeCallbackAfterSave(T entity, IndexCoordinates index)
protected void	maybeCallbackAfterSaveWithQueries(List<?> queries, IndexCoordinates index)
protected void	maybeCallbackAfterSaveWithQuery(Object query, IndexCoordinates index)
protected <T> T	maybeCallbackBeforeConvert(T entity, IndexCoordinates index)
protected void	maybeCallbackBeforeConvertWithQueries(List<?> queries, IndexCoordinates index)
protected void	maybeCallbackBeforeConvertWithQuery(Object query, IndexCoordinates index)
<T> List<MultiGetItem<T>>	multiGet(Query query, Class<T> clazz)	Execute a multiGet against elasticsearch for the given ids.
<T> List<SearchHits<T>>	multiSearch(List<? extends Query> queries, Class<T> clazz)	Execute the multi search query against elasticsearch and return result as List of SearchHits.
<T> Iterable<T>	save(Iterable<T> entities)	saves the given entities to the index retrieved from the entities' Document annotation
<T> Iterable<T>	save(Iterable<T> entities, IndexCoordinates index)	saves the given entities to the given index
<T> T	save(T entity)	Saves an entity to the index specified in the entity's Document annotation
final <T> Iterable<T>	save(T... entities)	saves the given entities to the index retrieved from the entities' Document annotation
<T> T	save(T entity, IndexCoordinates index)	Saves an entity to the index specified in the entity's Document annotation
<T> SearchHits<T>	search(MoreLikeThisQuery query, Class<T> clazz)	more like this query to search for documents that are "like" a specific document.
<T> SearchHits<T>	search(MoreLikeThisQuery query, Class<T> clazz, IndexCoordinates index)	more like this query to search for documents that are "like" a specific document.
<T> SearchHits<T>	search(Query query, Class<T> clazz)	Execute the criteria query against elasticsearch and return result as SearchHits
<T> SearchHitsIterator<T>	searchForStream(Query query, Class<T> clazz)	Executes the given Query against elasticsearch and return result as SearchHitsIterator.
<T> SearchHitsIterator<T>	searchForStream(Query query, Class<T> clazz, IndexCoordinates index)	Executes the given Query against elasticsearch and return result as SearchHitsIterator.
protected void	searchScrollClear(String scrollId)
protected abstract void	searchScrollClear(List<String> scrollIds)
protected abstract <T> SearchScrollHits<T>	searchScrollContinue(String scrollId, long scrollTimeInMillis, Class<T> clazz, IndexCoordinates index)
protected abstract <T> SearchScrollHits<T>	searchScrollStart(long scrollTimeInMillis, Query query, Class<T> clazz, IndexCoordinates index)
void	setApplicationContext(ApplicationContext applicationContext)
void	setEntityCallbacks(EntityCallbacks entityCallbacks)	Set the EntityCallbacks instance to use when invoking callbacks like the BeforeConvertCallback.
void	setRefreshPolicy(RefreshPolicy refreshPolicy)
protected static String[]	toArray(List<String> values)
protected <T> T	updateIndexedObject(T entity, IndexedObjectInformation indexedObjectInformation)
protected void	updateIndexedObjectsWithQueries(List<?> queries, List<IndexedObjectInformation> indexedObjectInformationList)
ElasticsearchOperations	withRouting(RoutingResolver routingResolver)	Returns a copy of this instance with the same configuration, but that uses a different RoutingResolver to obtain routing information.

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.DocumentOperations

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

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

cluster, indexOps, indexOps, stringIdRepresentation

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

count, count, idsQuery, matchAllQuery, multiSearch, multiSearch, multiSearch, search, searchOne, searchOne, suggest, suggest

Field Details

elasticsearchConverter

protected ElasticsearchConverter elasticsearchConverter

entityOperations

protected EntityOperations entityOperations

entityCallbacks

@Nullable
protected EntityCallbacks entityCallbacks

refreshPolicy

@Nullable
protected RefreshPolicy refreshPolicy

routingResolver

protected RoutingResolver routingResolver

Constructor Details

AbstractElasticsearchTemplate

public AbstractElasticsearchTemplate()

AbstractElasticsearchTemplate

public AbstractElasticsearchTemplate(@Nullable
 ElasticsearchConverter elasticsearchConverter)

Method Details

doCopy

protected abstract AbstractElasticsearchTemplate doCopy()

must return a copy of this instance that will for example be used to set a custom routing resolver without modifying the original object.

setApplicationContext

public void setApplicationContext(ApplicationContext applicationContext)
                           throws BeansException

Specified by:

setApplicationContext in interface ApplicationContextAware

Throws:

BeansException

setEntityCallbacks

public void setEntityCallbacks(EntityCallbacks entityCallbacks)

Set the EntityCallbacks instance to use when invoking callbacks like the BeforeConvertCallback. Overrides potentially existing EntityCallbacks.

Parameters:

entityCallbacks - must not be null.

Throws:

IllegalArgumentException - if the given instance is null.

Since:

4.0

setRefreshPolicy

public void setRefreshPolicy(@Nullable
 RefreshPolicy refreshPolicy)

getRefreshPolicy

@Nullable
public RefreshPolicy getRefreshPolicy()

logVersions

public void logVersions()

logs the versions of the different Elasticsearch components.

Since:

4.3

save

public <T> T save(T entity)

Description copied from interface: DocumentOperations

Saves an entity to the index specified in the entity's Document annotation

Specified by:

save in interface DocumentOperations

Type Parameters:

T - the entity type

Parameters:

entity - the entity to save, must not be null

Returns:

the saved entity

save

public <T> T save(T entity,
 IndexCoordinates index)

Description copied from interface: DocumentOperations

Saves an entity to the index specified in the entity's Document annotation

Specified by:

save in interface DocumentOperations

Type Parameters:

T - the entity type

Parameters:

entity - the entity to save, must not be null

index - the index to save the entity in, must not be null

Returns:

the saved entity

save

public <T> Iterable<T> save(Iterable<T> entities)

Description copied from interface: DocumentOperations

saves the given entities to the index retrieved from the entities' Document annotation

Specified by:

save in interface DocumentOperations

Type Parameters:

T - the entity type

Parameters:

entities - must not be null

Returns:

the saved entites

save

public <T> Iterable<T> save(Iterable<T> entities,
 IndexCoordinates index)

Description copied from interface: DocumentOperations

saves the given entities to the given index

Specified by:

save in interface DocumentOperations

Type Parameters:

T - the entity type

Parameters:

entities - must not be null

index - the index to save the entities in, must not be null

Returns:

the saved entities

save

@SafeVarargs
public final <T> Iterable<T> save(T... entities)

Description copied from interface: DocumentOperations

saves the given entities to the index retrieved from the entities' Document annotation

Specified by:

save in interface DocumentOperations

Type Parameters:

T - the entity type

Parameters:

entities - must not be null

Returns:

the saved entities as Iterable

index

public String index(IndexQuery query,
 IndexCoordinates index)

Description copied from interface: DocumentOperations

Index an object. Will do save or update.

Specified by:

index in interface DocumentOperations

Parameters:

query - the query defining the object

index - the index where the object is stored.

Returns:

returns the document id

doIndex

public abstract String doIndex(IndexQuery query,
 IndexCoordinates indexCoordinates)

get

@Nullable
public <T> T get(String id,
 Class<T> clazz)

Description copied from interface: DocumentOperations

Retrieves an object from the index specified in the entity's Document annotation.

Specified by:

get in interface DocumentOperations

Type Parameters:

T - the entity type

Parameters:

id - the id of the object

clazz - the entity class,

Returns:

the entity

multiGet

public <T> List<MultiGetItem<T>> multiGet(Query query,
 Class<T> clazz)

Description copied from interface: DocumentOperations

Execute a multiGet against elasticsearch for the given ids.

Specified by:

multiGet in interface DocumentOperations

Parameters:

query - the query defining the ids of the objects to get

clazz - the type of the object to be returned

Returns:

list of MultiGetItems

See Also:

• Query.multiGetQuery(Collection)
• Query.multiGetQueryWithRouting(List)

exists

public boolean exists(String id,
 Class<?> clazz)

Description copied from interface: DocumentOperations

Check if an entity with given id exists.

Specified by:

exists in interface DocumentOperations

Parameters:

id - the _id of the document to look for.

clazz - the domain type used.

Returns:

true if a matching document exists, false otherwise.

exists

public boolean exists(String id,
 IndexCoordinates index)

Description copied from interface: DocumentOperations

Check if an entity with given id exists.

Specified by:

exists in interface DocumentOperations

Parameters:

id - the _id of the document to look for.

index - the target index, must not be null

Returns:

true if a matching document exists, false otherwise.

doExists

protected abstract boolean doExists(String id,
 IndexCoordinates index)

delete

public String delete(String id,
 Class<?> entityType)

Description copied from interface: DocumentOperations

Delete the one object with provided id.

Specified by:

delete in interface DocumentOperations

Parameters:

id - the document ot delete

entityType - must not be null.

Returns:

documentId of the document deleted

delete

public ByQueryResponse delete(Query query,
 Class<?> clazz)

Description copied from interface: DocumentOperations

Delete all records matching the query.

Specified by:

delete in interface DocumentOperations

Parameters:

query - query defining the objects

clazz - The entity class, must be annotated with Document

Returns:

response with detailed information

delete

public String delete(Object entity)

Description copied from interface: DocumentOperations

Deletes the given entity

Specified by:

delete in interface DocumentOperations

Parameters:

entity - the entity to delete

Returns:

documentId of the document deleted

delete

public String delete(Object entity,
 IndexCoordinates index)

Description copied from interface: DocumentOperations

Deletes the given entity

Specified by:

delete in interface DocumentOperations

Parameters:

entity - the entity to delete

index - the index from which to delete

Returns:

documentId of the document deleted

delete

public String delete(String id,
 IndexCoordinates index)

Description copied from interface: DocumentOperations

Delete the one object with provided id.

Specified by:

delete in interface DocumentOperations

Parameters:

id - the document to delete

index - the index from which to delete

Returns:

documentId of the document deleted

delete

@Deprecated
public final String delete(String id,
 @Nullable
 String routing,
 IndexCoordinates index)

Deprecated.

Description copied from interface: DocumentOperations

Delete the one object with provided id.

Specified by:

delete in interface DocumentOperations

Parameters:

id - the document to delete

routing - the optional routing for the document to be deleted

index - the index from which to delete

Returns:

documentId of the document deleted

doDelete

protected abstract String doDelete(String id,
 @Nullable
 String routing,
 IndexCoordinates index)

bulkIndex

public List<IndexedObjectInformation> bulkIndex(List<IndexQuery> queries,
 Class<?> clazz)

Description copied from interface: DocumentOperations

Bulk index all objects. Will do save or update.

Specified by:

bulkIndex in interface DocumentOperations

Parameters:

queries - the queries to execute in bulk

clazz - the entity class

Returns:

the information about the indexed objects

bulkIndex

public List<IndexedObjectInformation> bulkIndex(List<IndexQuery> queries,
 BulkOptions bulkOptions,
 Class<?> clazz)

Description copied from interface: DocumentOperations

Bulk index all objects. Will do save or update.

Specified by:

bulkIndex in interface DocumentOperations

Parameters:

queries - the queries to execute in bulk

bulkOptions - options to be added to the bulk request

clazz - the entity class

Returns:

the information about of the indexed objects

bulkIndex

public final List<IndexedObjectInformation> bulkIndex(List<IndexQuery> queries,
 BulkOptions bulkOptions,
 IndexCoordinates index)

Description copied from interface: DocumentOperations

Bulk index all objects. Will do save or update.

Specified by:

bulkIndex in interface DocumentOperations

Parameters:

queries - the queries to execute in bulk

bulkOptions - options to be added to the bulk request

Returns:

the information about of the indexed objects

bulkUpdate

public void bulkUpdate(List<UpdateQuery> queries,
 Class<?> clazz)

Description copied from interface: DocumentOperations

Bulk update all objects. Will do update.

Specified by:

bulkUpdate in interface DocumentOperations

Parameters:

queries - the queries to execute in bulk

clazz - the entity class

bulkOperation

public List<IndexedObjectInformation> bulkOperation(List<?> queries,
 BulkOptions bulkOptions,
 IndexCoordinates index)

doBulkOperation

public abstract List<IndexedObjectInformation> doBulkOperation(List<?> queries,
 BulkOptions bulkOptions,
 IndexCoordinates index)

count

public long count(Query query,
 Class<?> clazz)

Description copied from interface: SearchOperations

return number of elements found by given query

Specified by:

count in interface SearchOperations

Parameters:

query - the query to execute

clazz - the entity clazz used for property mapping and index name extraction

Returns:

count

searchForStream

public <T> SearchHitsIterator<T> searchForStream(Query query,
 Class<T> clazz)

Description copied from interface: SearchOperations

Executes the given Query against elasticsearch and return result as SearchHitsIterator.

Specified by:

searchForStream in interface SearchOperations

Type Parameters:

T - element return type

Parameters:

query - the query to execute

clazz - the entity clazz used for property mapping and index name extraction

Returns:

a SearchHitsIterator that wraps an Elasticsearch scroll context that needs to be closed. The try-with-resources construct should be used to ensure that the close method is invoked after the operations are completed.

searchForStream

public <T> SearchHitsIterator<T> searchForStream(Query query,
 Class<T> clazz,
 IndexCoordinates index)

Description copied from interface: SearchOperations

Executes the given Query against elasticsearch and return result as SearchHitsIterator.

Specified by:

searchForStream in interface SearchOperations

Type Parameters:

T - element return type

Parameters:

query - the query to execute

clazz - the entity clazz used for property mapping

index - the index to run the query against

Returns:

a SearchHitsIterator that wraps an Elasticsearch scroll context that needs to be closed. The try-with-resources construct should be used to ensure that the close method is invoked after the operations are completed.

search

public <T> SearchHits<T> search(MoreLikeThisQuery query,
 Class<T> clazz)

Description copied from interface: SearchOperations

more like this query to search for documents that are "like" a specific document.

Specified by:

search in interface SearchOperations

Type Parameters:

T - element return type

Parameters:

query - the query to execute

clazz - the entity clazz used for property mapping and index name extraction

Returns:

SearchHits containing the list of found objects

search

public <T> SearchHits<T> search(MoreLikeThisQuery query,
 Class<T> clazz,
 IndexCoordinates index)

Description copied from interface: SearchOperations

more like this query to search for documents that are "like" a specific document.

Specified by:

search in interface SearchOperations

Type Parameters:

T - element return type

Parameters:

query - the query to execute

clazz - the entity clazz used for property mapping

index - the index to run the query against

Returns:

SearchHits containing the list of found objects

doSearch

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

multiSearch

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

Description copied from interface: SearchOperations

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

Specified by:

multiSearch in interface SearchOperations

Type Parameters:

T - element return type

Parameters:

queries - the queries to execute

clazz - the entity clazz

Returns:

list of SearchHits

search

public <T> SearchHits<T> search(Query query,
 Class<T> clazz)

Description copied from interface: SearchOperations

Execute the criteria query against elasticsearch and return result as SearchHits

Specified by:

search in interface SearchOperations

Type Parameters:

T - element return type

Parameters:

query - the query to execute

clazz - the entity clazz used for property mapping and index name extraction

Returns:

SearchHits containing the list of found objects

searchScrollStart

protected abstract <T> SearchScrollHits<T> searchScrollStart(long scrollTimeInMillis,
 Query query,
 Class<T> clazz,
 IndexCoordinates index)

searchScrollContinue

protected abstract <T> SearchScrollHits<T> searchScrollContinue(String scrollId,
 long scrollTimeInMillis,
 Class<T> clazz,
 IndexCoordinates index)

searchScrollClear

protected void searchScrollClear(String scrollId)

searchScrollClear

protected abstract void searchScrollClear(List<String> scrollIds)

getElasticsearchConverter

public ElasticsearchConverter getElasticsearchConverter()

Specified by:

getElasticsearchConverter in interface ElasticsearchOperations

toArray

protected static String[] toArray(List<String> values)

getIndexCoordinatesFor

public IndexCoordinates getIndexCoordinatesFor(Class<?> clazz)

Specified by:

getIndexCoordinatesFor in interface ElasticsearchOperations

Parameters:

clazz - the entity class

Returns:

the IndexCoordinates defined on the entity.

Since:

4.0

updateIndexedObject

protected <T> T updateIndexedObject(T entity,
 IndexedObjectInformation indexedObjectInformation)

getEntityRouting

@Nullable
public String getEntityRouting(Object entity)

Description copied from interface: ElasticsearchOperations

gets the routing for an entity which might be defined by a join-type relation

Specified by:

getEntityRouting in interface ElasticsearchOperations

Parameters:

entity - the entity

Returns:

the routing, may be null if not set.

getEntityCreator

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

getClusterVersion

@Nullable
protected abstract String getClusterVersion()

tries to extract the version of the Elasticsearch cluster

Returns:

the version as string if it can be retrieved

getVendor

protected abstract String getVendor()

Returns:

the vendor name of the used cluster and client library

Since:

4.3

getRuntimeLibraryVersion

protected abstract String getRuntimeLibraryVersion()

Returns:

the version of the used client runtime library.

Since:

4.3

maybeCallbackBeforeConvert

protected <T> T maybeCallbackBeforeConvert(T entity,
 IndexCoordinates index)

maybeCallbackBeforeConvertWithQuery

protected void maybeCallbackBeforeConvertWithQuery(Object query,
 IndexCoordinates index)

maybeCallbackBeforeConvertWithQueries

protected void maybeCallbackBeforeConvertWithQueries(List<?> queries,
 IndexCoordinates index)

maybeCallbackAfterSave

protected <T> T maybeCallbackAfterSave(T entity,
 IndexCoordinates index)

maybeCallbackAfterSaveWithQuery

protected void maybeCallbackAfterSaveWithQuery(Object query,
 IndexCoordinates index)

maybeCallbackAfterSaveWithQueries

protected void maybeCallbackAfterSaveWithQueries(List<?> queries,
 IndexCoordinates index)

maybeCallbackAfterConvert

protected <T> T maybeCallbackAfterConvert(T entity,
 Document document,
 IndexCoordinates index)

maybeCallbackAfterLoad

protected <T> Document maybeCallbackAfterLoad(Document document,
 Class<T> type,
 IndexCoordinates indexCoordinates)

updateIndexedObjectsWithQueries

protected void updateIndexedObjectsWithQueries(List<?> queries,
 List<IndexedObjectInformation> indexedObjectInformationList)

withRouting

public ElasticsearchOperations withRouting(RoutingResolver routingResolver)

Description copied from interface: ElasticsearchOperations

Returns a copy of this instance with the same configuration, but that uses a different RoutingResolver to obtain routing information.

Specified by:

withRouting in interface ElasticsearchOperations

Parameters:

routingResolver - the RoutingResolver value, must not be null.

Returns:

DocumentOperations instance