org.springframework.data.elasticsearch.config

Class ElasticsearchConfigurationSupport

java.lang.Object

org.springframework.data.elasticsearch.config.ElasticsearchConfigurationSupport

Direct Known Subclasses:

AbstractElasticsearchConfiguration, AbstractReactiveElasticsearchConfiguration

@Configuration
public class ElasticsearchConfigurationSupport
extends Object

Since:

3.2

Author:

Christoph Strobl

Constructor Summary

Constructors

Constructor and Description
ElasticsearchConfigurationSupport()

Method Summary

Modifier and Type	Method and Description
ElasticsearchConverter	elasticsearchConverter()
ElasticsearchCustomConversions	elasticsearchCustomConversions() Register custom Converters in a ElasticsearchCustomConversions object if required.
SimpleElasticsearchMappingContext	elasticsearchMappingContext() Creates a SimpleElasticsearchMappingContext equipped with entity classes scanned from the mapping base package.
EntityMapper	entityMapper() Returns the EntityMapper used for mapping between the source and domain type.
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.
ResultsMapper	resultsMapper() Returns the ResultsMapper to be used for search responses.
protected Set<Class<?>>	scanForEntities(String basePackage) Scans the given base package for entities, i.e.

Methods inherited from class java.lang.Object

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

Constructor Detail

ElasticsearchConfigurationSupport

public ElasticsearchConfigurationSupport()

Method Detail

elasticsearchConverter

@Bean
public ElasticsearchConverter elasticsearchConverter()

elasticsearchMappingContext

@Bean
public SimpleElasticsearchMappingContext elasticsearchMappingContext()

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

Returns:

never null.

See Also:

getMappingBasePackages()

entityMapper

@Bean
public EntityMapper entityMapper()

Returns the EntityMapper used for mapping between the source and domain type.
Hint: you can use ElasticsearchEntityMapper as an alternative to the DefaultEntityMapper.

 ElasticsearchEntityMapper entityMapper = new ElasticsearchEntityMapper(elasticsearchMappingContext(),
                new DefaultConversionService());
 entityMapper.setConversions(elasticsearchCustomConversions());
 

Returns:

never null.

resultsMapper

@Bean
public ResultsMapper resultsMapper()

Returns the ResultsMapper to be used for search responses.

Returns:

never null.

See Also:

entityMapper()

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()
                                     throws ClassNotFoundException

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.

Throws:

ClassNotFoundException

See Also:

getMappingBasePackages()

scanForEntities

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

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

Parameters:

basePackage - must not be null.

Returns:

never null.

Throws:

ClassNotFoundException