Package io.jmix.search.index.impl

Class BaseIndexManager<TState,TSettings,TJsonp>

java.lang.Object

io.jmix.search.index.impl.BaseIndexManager<TState,TSettings,TJsonp>

All Implemented Interfaces:

IndexManager

Direct Known Subclasses:

ElasticsearchIndexManager, OpenSearchIndexManager

public abstract class BaseIndexManager<TState,TSettings,TJsonp>
extends Object
implements IndexManager

Contains non-platform-specific operations. Interaction with indexes is performed in platform-specific implementations.

Field Summary

Fields

Modifier and Type	Field	Description
protected final IndexConfigurationComparator<TState,TSettings,TJsonp>	indexConfigurationComparator
protected final IndexConfigurationManager	indexConfigurationManager
protected final IndexStateRegistry	indexStateRegistry
protected final IndexStateResolver<TState,TJsonp>	indexStateResolver
protected final com.fasterxml.jackson.databind.ObjectMapper	objectMapper
protected final SearchProperties	searchProperties

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseIndexManager(IndexConfigurationManager indexConfigurationManager, IndexStateRegistry indexStateRegistry, SearchProperties searchProperties, IndexConfigurationComparator<TState,TSettings,TJsonp> indexConfigurationComparator, IndexStateResolver<TState,TJsonp> indexStateResolver)

Method Summary

Modifier and Type	Method	Description
protected IndexValidationStatus	getIndexValidationStatus(IndexConfiguration indexConfiguration, boolean indexExist)
protected IndexSynchronizationStatus	handleMissingIndex(IndexConfiguration indexConfiguration, IndexSchemaManagementStrategy strategy)
protected abstract boolean	putMapping(String indexName, IndexMappingConfiguration mapping)
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.
protected IndexSynchronizationStatus	recreateIrrelevantIndex(IndexConfiguration indexConfiguration, IndexSchemaManagementStrategy strategy)
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.
protected IndexSynchronizationStatus	updateIndexConfiguration(IndexConfiguration indexConfiguration, IndexSchemaManagementStrategy strategy, ConfigurationComparingResult result)
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

Methods inherited from interface io.jmix.search.index.IndexManager

createIndex, dropIndex, getIndexMetadata, isIndexExist

Field Details

indexConfigurationManager

protected final IndexConfigurationManager indexConfigurationManager

indexStateRegistry

protected final IndexStateRegistry indexStateRegistry

searchProperties

protected final SearchProperties searchProperties

objectMapper

protected final com.fasterxml.jackson.databind.ObjectMapper objectMapper

indexConfigurationComparator

protected final IndexConfigurationComparator<TState,TSettings,TJsonp> indexConfigurationComparator

indexStateResolver

protected final IndexStateResolver<TState,TJsonp> indexStateResolver

Constructor Details

BaseIndexManager

protected BaseIndexManager(IndexConfigurationManager indexConfigurationManager,
 IndexStateRegistry indexStateRegistry,
 SearchProperties searchProperties,
 IndexConfigurationComparator<TState,TSettings,TJsonp> indexConfigurationComparator,
 IndexStateResolver<TState,TJsonp> indexStateResolver)

Method Details

recreateIndexes

public Map<IndexConfiguration,Boolean> recreateIndexes()

Description copied from interface: IndexManager

Drops and creates all search indexes.

Specified by:

recreateIndexes in interface IndexManager

Returns:

Map with operation result per every index configuration

recreateIndexes

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

Description copied from interface: IndexManager

Drops and creates search indexes using provided collection of IndexConfiguration.

Specified by:

recreateIndexes in interface IndexManager

Parameters:

indexConfigurations - index configurations

Returns:

Map with operation result per every index configuration

recreateIndex

public boolean recreateIndex(IndexConfiguration indexConfiguration)

Description copied from interface: IndexManager

Drops and creates search index using provided IndexConfiguration.

Specified by:

recreateIndex in interface IndexManager

Parameters:

indexConfiguration - index configuration

Returns:

true if index was successfully recreated, false otherwise

validateIndexes

public Map<IndexConfiguration,IndexValidationStatus> validateIndexes()

Description copied from interface: IndexManager

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

Specified by:

validateIndexes in interface IndexManager

Returns:

IndexValidationStatus per each IndexConfiguration

validateIndexes

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

Description copied from interface: IndexManager

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

Specified by:

validateIndexes in interface IndexManager

Parameters:

indexConfigurations - actual configurations

Returns:

IndexValidationStatus per each IndexConfiguration

validateIndex

public IndexValidationStatus validateIndex(IndexConfiguration indexConfiguration)

Description copied from interface: IndexManager

Validates current state of index schema.

Specified by:

validateIndex in interface IndexManager

Parameters:

indexConfiguration - actual configuration

Returns:

IndexValidationStatus

getIndexValidationStatus

protected IndexValidationStatus getIndexValidationStatus(IndexConfiguration indexConfiguration,
 boolean indexExist)

synchronizeIndexSchemas

public Map<IndexConfiguration,IndexSynchronizationStatus> synchronizeIndexSchemas()

Description copied from interface: IndexManager

Synchronizes schemas of all search indexes defined in application.

See IndexManager.synchronizeIndexSchemas(Collection)

See IndexManager.synchronizeIndexSchema(IndexConfiguration)

Specified by:

synchronizeIndexSchemas in interface IndexManager

Returns:

IndexSynchronizationStatus per each IndexConfiguration

synchronizeIndexSchemas

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

Description copied from interface: IndexManager

Synchronizes schemas of search indexes for provided collection of IndexConfiguration.

See IndexManager.synchronizeIndexSchema(IndexConfiguration)

Specified by:

synchronizeIndexSchemas in interface IndexManager

Parameters:

indexConfigurations - actual index configurations

Returns:

IndexSynchronizationStatus per each IndexConfiguration

synchronizeIndexSchema

public IndexSynchronizationStatus synchronizeIndexSchema(IndexConfiguration indexConfiguration)

Description copied from interface: IndexManager

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 IndexManager

Parameters:

indexConfiguration - actual index configuration

Returns:

IndexSynchronizationStatus

synchronizeIndexSchema

protected IndexSynchronizationStatus synchronizeIndexSchema(IndexConfiguration indexConfiguration,
 IndexSchemaManagementStrategy strategy)

recreateIrrelevantIndex

protected IndexSynchronizationStatus recreateIrrelevantIndex(IndexConfiguration indexConfiguration,
 IndexSchemaManagementStrategy strategy)

handleMissingIndex

protected IndexSynchronizationStatus handleMissingIndex(IndexConfiguration indexConfiguration,
 IndexSchemaManagementStrategy strategy)

updateIndexConfiguration

protected IndexSynchronizationStatus updateIndexConfiguration(IndexConfiguration indexConfiguration,
 IndexSchemaManagementStrategy strategy,
 ConfigurationComparingResult result)

putMapping

protected abstract boolean putMapping(String indexName,
 IndexMappingConfiguration mapping)