Package org.springframework.data.elasticsearch.config

Class ElasticsearchConfigurationSupport

java.lang.Object

org.springframework.data.elasticsearch.config.ElasticsearchConfigurationSupport

Direct Known Subclasses:

ElasticsearchConfiguration, ReactiveElasticsearchConfiguration

@Configuration(proxyBeanMethods=false)
public class ElasticsearchConfigurationSupport
extends Object

Since:

3.2

Author:

Christoph Strobl, Peter-Josef Meisch

Constructor Summary

Constructors

Constructor	Description
ElasticsearchConfigurationSupport()

Method Summary

Modifier and Type	Method	Description
ElasticsearchCustomConversions	elasticsearchCustomConversions()	Register custom Converters in a ElasticsearchCustomConversions object if required.
ElasticsearchConverter	elasticsearchEntityMapper(SimpleElasticsearchMappingContext elasticsearchMappingContext, ElasticsearchCustomConversions elasticsearchCustomConversions)
SimpleElasticsearchMappingContext	elasticsearchMappingContext(ElasticsearchCustomConversions elasticsearchCustomConversions)	Creates a SimpleElasticsearchMappingContext equipped with entity classes scanned from the mapping base package.
protected FieldNamingStrategy	fieldNamingStrategy()	Configures a FieldNamingStrategy on the SimpleElasticsearchMappingContext instance created.
protected Set<Class<?>>	getInitialEntitySet()	Scans the mapping base package for classes annotated with Document.
protected Collection<String>	getMappingBasePackages()	Returns the base packages to scan for Elasticsearch mapped entities at startup.
protected RefreshPolicy	refreshPolicy()	Set up the write RefreshPolicy.
protected Set<Class<?>>	scanForEntities(String basePackage)	Scans the given base package for entities, i.e.
protected boolean	writeTypeHints()	Flag specifiying if type hints (_class fields) should be written in the index.

Methods inherited from class java.lang.Object

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

Constructor Details

ElasticsearchConfigurationSupport

public ElasticsearchConfigurationSupport()

Method Details

elasticsearchEntityMapper

@Bean
public ElasticsearchConverter elasticsearchEntityMapper(SimpleElasticsearchMappingContext elasticsearchMappingContext,
 ElasticsearchCustomConversions elasticsearchCustomConversions)

elasticsearchMappingContext

@Bean
public SimpleElasticsearchMappingContext elasticsearchMappingContext(ElasticsearchCustomConversions elasticsearchCustomConversions)

Creates a SimpleElasticsearchMappingContext equipped with entity classes scanned from the mapping base package.

Returns:

never null.

See Also:

• getMappingBasePackages()

elasticsearchCustomConversions

@Bean
public ElasticsearchCustomConversions elasticsearchCustomConversions()

Register custom Converters in a ElasticsearchCustomConversions object if required.

Returns:

never null.

getMappingBasePackages

protected Collection<String> getMappingBasePackages()

Returns the base packages to scan for Elasticsearch mapped entities at startup. Will return the package name of the configuration class' (the concrete class, not this one here) by default. So if you have a com.acme.AppConfig extending ElasticsearchConfigurationSupport the base package will be considered com.acme unless the method is overridden to implement alternate behavior.

Returns:

the base packages to scan for mapped Document classes or an empty collection to not enable scanning for entities.

getInitialEntitySet

protected Set<Class<?>> getInitialEntitySet()

Scans the mapping base package for classes annotated with Document. By default, it scans for entities in all packages returned by getMappingBasePackages().

Returns:

never null.

See Also:

• getMappingBasePackages()

scanForEntities

protected Set<Class<?>> scanForEntities(String basePackage)

Scans the given base package for entities, i.e. Elasticsearch specific types annotated with Document.

Parameters:

basePackage - must not be null.

Returns:

never null.

refreshPolicy

@Nullable
protected RefreshPolicy refreshPolicy()

Set up the write RefreshPolicy. Default is set to null to use the cluster defaults..

Returns:

null to use the server defaults.

fieldNamingStrategy

protected FieldNamingStrategy fieldNamingStrategy()

Configures a FieldNamingStrategy on the SimpleElasticsearchMappingContext instance created.

Returns:

the FieldNamingStrategy to use

Since:

4.2

writeTypeHints

protected boolean writeTypeHints()

Flag specifiying if type hints (_class fields) should be written in the index. It is strongly advised to keep the default value of true. If you need to write to an existing index that does not have a mapping defined for these fields and that has a strict mapping set, then it might be necessary to disable type hints. But notice that in this case reading polymorphic types may fail.

Returns:

flag if type hints should be written

Since:

4.3