Package io.jmix.search.index.impl

Class ESIndexManagerImpl

java.lang.Object

io.jmix.search.index.impl.ESIndexManagerImpl

All Implemented Interfaces:

ESIndexManager

@Component("search_ESIndexManager")
public class ESIndexManagerImpl
extends Object
implements ESIndexManager

Field Summary

Fields

Modifier and Type	Field	Description
protected org.elasticsearch.client.RestHighLevelClient	esClient
protected IndexConfigurationManager	indexConfigurationManager
protected IndexStateRegistry	indexStateRegistry
protected com.fasterxml.jackson.databind.ObjectMapper	objectMapper
protected SearchProperties	searchProperties

Constructor Summary

Constructors

Constructor	Description
ESIndexManagerImpl()

Method Summary

Modifier and Type	Method	Description
boolean	createIndex(IndexConfiguration indexConfiguration)	Creates index if not exists using provided IndexConfiguration.
boolean	dropIndex(String indexName)	Drops index by name.
org.elasticsearch.client.indices.GetIndexResponse	getIndex(String indexName)	Requests info about index from ES cluster.
protected IndexSynchronizationStatus	handleIrrelevantIndex(IndexConfiguration indexConfiguration, IndexSchemaManagementStrategy strategy)
protected IndexSynchronizationStatus	handleMissingIndex(IndexConfiguration indexConfiguration, IndexSchemaManagementStrategy strategy)
protected boolean	isIndexActual(IndexConfiguration indexConfiguration)
boolean	isIndexExist(String indexName)	Checks if index exists.
protected boolean	isIndexMappingActual(IndexConfiguration indexConfiguration, org.elasticsearch.client.indices.GetIndexResponse indexResponse)
protected boolean	isIndexSettingsActual(IndexConfiguration indexConfiguration, org.elasticsearch.client.indices.GetIndexResponse indexResponse)
boolean	recreateIndex(IndexConfiguration indexConfiguration)	Drops and creates search index using provided IndexConfiguration.
Map<IndexConfiguration,Boolean>	recreateIndexes()	Drops and creates all search indexes.
Map<IndexConfiguration,Boolean>	recreateIndexes(Collection<IndexConfiguration> indexConfigurations)	Drops and creates search indexes using provided collection of IndexConfiguration.
IndexSynchronizationStatus	synchronizeIndexSchema(IndexConfiguration indexConfiguration)	Synchronizes schema of search index for provided IndexConfiguration.
protected IndexSynchronizationStatus	synchronizeIndexSchema(IndexConfiguration indexConfiguration, IndexSchemaManagementStrategy strategy)
Map<IndexConfiguration,IndexSynchronizationStatus>	synchronizeIndexSchemas()	Synchronizes schemas of all search indexes defined in application.
Map<IndexConfiguration,IndexSynchronizationStatus>	synchronizeIndexSchemas(Collection<IndexConfiguration> indexConfigurations)	Synchronizes schemas of search indexes for provided collection of IndexConfiguration.
IndexValidationStatus	validateIndex(IndexConfiguration indexConfiguration)	Validates current state of index schema.
Map<IndexConfiguration,IndexValidationStatus>	validateIndexes()	Validates current state of schema of all search indexes defined in application.
Map<IndexConfiguration,IndexValidationStatus>	validateIndexes(Collection<IndexConfiguration> indexConfigurations)	Validates current state of index schema related to provided collection of IndexConfiguration.

Methods inherited from class java.lang.Object

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

Field Details

esClient

@Autowired
protected org.elasticsearch.client.RestHighLevelClient esClient

indexConfigurationManager

@Autowired
protected IndexConfigurationManager indexConfigurationManager

searchProperties

@Autowired
protected SearchProperties searchProperties

indexStateRegistry

@Autowired
protected IndexStateRegistry indexStateRegistry

objectMapper

protected com.fasterxml.jackson.databind.ObjectMapper objectMapper

Constructor Details

ESIndexManagerImpl

public ESIndexManagerImpl()

Method Details

createIndex

public boolean createIndex(IndexConfiguration indexConfiguration)

Description copied from interface: ESIndexManager

Creates index if not exists using provided IndexConfiguration.

Specified by:

createIndex in interface ESIndexManager

Parameters:

indexConfiguration - index configuration

Returns:

true if index was successfully created, false otherwise

dropIndex

public boolean dropIndex(String indexName)

Description copied from interface: ESIndexManager

Drops index by name.

Specified by:

dropIndex in interface ESIndexManager

Parameters:

indexName - index name

Returns:

true if index was successfully dropped, false otherwise

recreateIndexes

public Map<IndexConfiguration,Boolean> recreateIndexes()

Description copied from interface: ESIndexManager

Drops and creates all search indexes.

Specified by:

recreateIndexes in interface ESIndexManager

Returns:

Map with operation result per every index configuration

recreateIndexes

public Map<IndexConfiguration,Boolean> recreateIndexes(Collection<IndexConfiguration> indexConfigurations)

Description copied from interface: ESIndexManager

Drops and creates search indexes using provided collection of IndexConfiguration.

Specified by:

recreateIndexes in interface ESIndexManager

Parameters:

indexConfigurations - index configurations

Returns:

Map with operation result per every index configuration

recreateIndex

public boolean recreateIndex(IndexConfiguration indexConfiguration)

Description copied from interface: ESIndexManager

Drops and creates search index using provided IndexConfiguration.

Specified by:

recreateIndex in interface ESIndexManager

Parameters:

indexConfiguration - index configuration

Returns:

true if index was successfully recreated, false otherwise

isIndexExist

public boolean isIndexExist(String indexName)

Description copied from interface: ESIndexManager

Checks if index exists.

Specified by:

isIndexExist in interface ESIndexManager

Parameters:

indexName - index name

Returns:

true if index exists, false otherwise

validateIndexes

public Map<IndexConfiguration,IndexValidationStatus> validateIndexes()

Description copied from interface: ESIndexManager

Validates current state of schema of all search indexes defined in application.

Specified by:

validateIndexes in interface ESIndexManager

Returns:

IndexValidationStatus per each IndexConfiguration

validateIndexes

public Map<IndexConfiguration,IndexValidationStatus> validateIndexes(Collection<IndexConfiguration> indexConfigurations)

Description copied from interface: ESIndexManager

Validates current state of index schema related to provided collection of IndexConfiguration.

Specified by:

validateIndexes in interface ESIndexManager

Parameters:

indexConfigurations - actual configurations

Returns:

IndexValidationStatus per each IndexConfiguration

validateIndex

public IndexValidationStatus validateIndex(IndexConfiguration indexConfiguration)

Description copied from interface: ESIndexManager

Validates current state of index schema.

Specified by:

validateIndex in interface ESIndexManager

Parameters:

indexConfiguration - actual configuration

Returns:

IndexValidationStatus

getIndex

public org.elasticsearch.client.indices.GetIndexResponse getIndex(String indexName)

Description copied from interface: ESIndexManager

Requests info about index from ES cluster.

Specified by:

getIndex in interface ESIndexManager

Parameters:

indexName - index name

Returns:

response

synchronizeIndexSchemas

public Map<IndexConfiguration,IndexSynchronizationStatus> synchronizeIndexSchemas()

Description copied from interface: ESIndexManager

Synchronizes schemas of all search indexes defined in application.

See ESIndexManager.synchronizeIndexSchemas(Collection)

See ESIndexManager.synchronizeIndexSchema(IndexConfiguration)

Specified by:

synchronizeIndexSchemas in interface ESIndexManager

Returns:

IndexSynchronizationStatus per each IndexConfiguration

synchronizeIndexSchemas

public Map<IndexConfiguration,IndexSynchronizationStatus> synchronizeIndexSchemas(Collection<IndexConfiguration> indexConfigurations)

Description copied from interface: ESIndexManager

Synchronizes schemas of search indexes for provided collection of IndexConfiguration.

See ESIndexManager.synchronizeIndexSchema(IndexConfiguration)

Specified by:

synchronizeIndexSchemas in interface ESIndexManager

Parameters:

indexConfigurations - actual index configurations

Returns:

IndexSynchronizationStatus per each IndexConfiguration

synchronizeIndexSchema

public IndexSynchronizationStatus synchronizeIndexSchema(IndexConfiguration indexConfiguration)

Description copied from interface: ESIndexManager

Synchronizes schema of search index for provided IndexConfiguration.

It tries to update schema to the actual state according to IndexSchemaManagementStrategy defined by 'jmix.search.indexSchemaManagementStrategy' application property.

Specified by:

synchronizeIndexSchema in interface ESIndexManager

Parameters:

indexConfiguration - actual index configuration

Returns:

IndexSynchronizationStatus

synchronizeIndexSchema

protected IndexSynchronizationStatus synchronizeIndexSchema(IndexConfiguration indexConfiguration,
 IndexSchemaManagementStrategy strategy)

handleIrrelevantIndex

protected IndexSynchronizationStatus handleIrrelevantIndex(IndexConfiguration indexConfiguration,
 IndexSchemaManagementStrategy strategy)

handleMissingIndex

protected IndexSynchronizationStatus handleMissingIndex(IndexConfiguration indexConfiguration,
 IndexSchemaManagementStrategy strategy)

isIndexActual

protected boolean isIndexActual(IndexConfiguration indexConfiguration)

isIndexMappingActual

protected boolean isIndexMappingActual(IndexConfiguration indexConfiguration,
 org.elasticsearch.client.indices.GetIndexResponse indexResponse)

isIndexSettingsActual

protected boolean isIndexSettingsActual(IndexConfiguration indexConfiguration,
 org.elasticsearch.client.indices.GetIndexResponse indexResponse)