Package io.jmix.search.index.impl

Class NoopIndexManager

java.lang.Object

io.jmix.search.index.impl.NoopIndexManager

All Implemented Interfaces:

IndexManager

@NullMarked
public class NoopIndexManager
extends Object
implements IndexManager

Field Summary

Fields

Modifier and Type	Field	Description
protected final com.fasterxml.jackson.databind.ObjectMapper	objectMapper

Constructor Summary

Constructors

Constructor	Description
NoopIndexManager()

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.
com.fasterxml.jackson.databind.node.ObjectNode	getIndexMetadata(@NonNull String indexName)	Requests info about index from server.
boolean	isIndexExist(String indexName)	Checks if index exists.
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.
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

objectMapper

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

Constructor Details

NoopIndexManager

public NoopIndexManager()

Method Details

createIndex

public boolean createIndex(IndexConfiguration indexConfiguration)

Description copied from interface: IndexManager

Creates index if not exists using provided IndexConfiguration.

Specified by:

createIndex in interface IndexManager

Parameters:

indexConfiguration - index configuration

Returns:

true if index was successfully created, false otherwise

dropIndex

public boolean dropIndex(String indexName)

Description copied from interface: IndexManager

Drops index by name.

Specified by:

dropIndex in interface IndexManager

Parameters:

indexName - index name

Returns:

true if index was successfully dropped, false otherwise

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

isIndexExist

public boolean isIndexExist(String indexName)

Description copied from interface: IndexManager

Checks if index exists.

Specified by:

isIndexExist in interface IndexManager

Parameters:

indexName - index name

Returns:

true if index exists, 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

getIndexMetadata

public com.fasterxml.jackson.databind.node.ObjectNode getIndexMetadata(@NonNull String indexName)

Description copied from interface: IndexManager

Requests info about index from server.

Specified by:

getIndexMetadata in interface IndexManager

Parameters:

indexName - index name

Returns:

response as Json

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