Package io.jmix.search

Class SearchProperties

java.lang.Object

io.jmix.search.SearchProperties

@ConfigurationProperties(prefix="jmix.search")
public class SearchProperties
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	SearchProperties.Elasticsearch
protected static class	SearchProperties.SSL

Field Summary

Fields

Modifier and Type	Field	Description
protected final boolean	changedEntitiesIndexingEnabled	Whether automatic indexing of changed entities is enabled.
protected final String	defaultSearchStrategy	Name of default search strategy
protected final SearchProperties.Elasticsearch	elasticsearch
protected final boolean	enqueueIndexAllOnStartupIndexRecreationEnabled	Whether all entity instances related to indexes created or recreated on startup should be enqueued automatically.
protected final List<String>	enqueueIndexAllOnStartupIndexRecreationEntities	List of entities that should be automatically enqueued on startup in case of index recreation.
protected final String	enqueueingSessionProcessingCron	CRON expression that is used by default Enqueueing Session processing quartz scheduling configuration.
protected final String	indexingQueueProcessingCron	CRON expression that is used by default Indexing Queue processing quartz scheduling configuration.
protected final IndexSchemaManagementStrategy	indexSchemaManagementStrategy	The way of index schema synchronization.
protected final int	maxSearchPageCount	Max amount of result pages.
protected final int	processQueueBatchSize	Amount of queue items processed in single batch.
protected final int	reindexEntityEnqueueBatchSize	Amount of entity instances enqueued in single batch during entity reindex process.
protected final boolean	restHighLevelClientApiCompatibilityModeEnabled	Whether the Rest High Level Client should be able to communicate with Elasticsearch version 8.x.
protected final String	searchIndexNamePrefix	Prefix for search index name.
protected final int	searchReloadEntitiesBatchSize	Batch size for post-search entity processing.
protected final int	searchResultPageSize	Max amount of objects displayed on single page of search result.
protected final boolean	useDefaultEnqueueingSessionProcessingQuartzConfiguration	Whether the default Enqueueing Session processing quartz scheduling configuration is used.
protected final boolean	useDefaultIndexingQueueProcessingQuartzConfiguration	Whether the default Indexing Queue processing quartz scheduling configuration is used.

Constructor Summary

Constructors

Constructor

Description

SearchProperties(int searchResultPageSize, int maxSearchPageCount, int searchReloadEntitiesBatchSize, int processQueueBatchSize, int reindexEntityEnqueueBatchSize, boolean changedEntitiesIndexingEnabled, boolean useDefaultIndexingQueueProcessingQuartzConfiguration, boolean useDefaultEnqueueingSessionProcessingQuartzConfiguration, boolean enqueueIndexAllOnStartupIndexRecreationEnabled, boolean restHighLevelClientApiCompatibilityModeEnabled, String enqueueIndexAllOnStartupIndexRecreationEntities, String searchIndexNamePrefix, String defaultSearchStrategy, String indexSchemaManagementStrategy, String indexingQueueProcessingCron, String enqueueingSessionProcessingCron, SearchProperties.Elasticsearch elasticsearch)

Method Summary

Modifier and Type	Method	Description
String	getDefaultSearchStrategy()
org.elasticsearch.action.support.WriteRequest.RefreshPolicy	getElasticsearchBulkRequestRefreshPolicy()
String	getElasticsearchLogin()
String	getElasticsearchPassword()
String	getElasticsearchSslCertificateAlias()
String	getElasticsearchSslCertificateFactoryType()
String	getElasticsearchSslCertificateLocation()
String	getElasticsearchSslKeyStoreType()
String	getElasticsearchUrl()
List<String>	getEnqueueIndexAllOnStartupIndexRecreationEntities()
String	getEnqueueingSessionProcessingCron()
String	getIndexingQueueProcessingCron()
IndexSchemaManagementStrategy	getIndexSchemaManagementStrategy()
int	getMaxSearchPageCount()
int	getProcessQueueBatchSize()
int	getReindexEntityEnqueueBatchSize()
String	getSearchIndexNamePrefix()
int	getSearchReloadEntitiesBatchSize()
int	getSearchResultPageSize()
boolean	isChangedEntitiesIndexingEnabled()
boolean	isEnqueueIndexAllOnStartupIndexRecreationEnabled()
boolean	isRestHighLevelClientApiCompatibilityModeEnabled()
boolean	isUseDefaultEnqueueingSessionProcessingQuartzConfiguration()
boolean	isUseDefaultIndexingQueueProcessingQuartzConfiguration()
protected List<String>	prepareStartupEnqueueingEntities(String enqueueIndexAllOnStartupIndexRecreationEntities)

Methods inherited from class java.lang.Object

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

Field Details

searchResultPageSize

protected final int searchResultPageSize

Max amount of objects displayed on single page of search result.

maxSearchPageCount

protected final int maxSearchPageCount

Max amount of result pages.

searchReloadEntitiesBatchSize

protected final int searchReloadEntitiesBatchSize

Batch size for post-search entity processing.

processQueueBatchSize

protected final int processQueueBatchSize

Amount of queue items processed in single batch.

reindexEntityEnqueueBatchSize

protected final int reindexEntityEnqueueBatchSize

Amount of entity instances enqueued in single batch during entity reindex process.

changedEntitiesIndexingEnabled

protected final boolean changedEntitiesIndexingEnabled

Whether automatic indexing of changed entities is enabled.

useDefaultIndexingQueueProcessingQuartzConfiguration

protected final boolean useDefaultIndexingQueueProcessingQuartzConfiguration

Whether the default Indexing Queue processing quartz scheduling configuration is used.

useDefaultEnqueueingSessionProcessingQuartzConfiguration

protected final boolean useDefaultEnqueueingSessionProcessingQuartzConfiguration

Whether the default Enqueueing Session processing quartz scheduling configuration is used.

enqueueIndexAllOnStartupIndexRecreationEnabled

protected final boolean enqueueIndexAllOnStartupIndexRecreationEnabled

Whether all entity instances related to indexes created or recreated on startup should be enqueued automatically.

restHighLevelClientApiCompatibilityModeEnabled

protected final boolean restHighLevelClientApiCompatibilityModeEnabled

Whether the Rest High Level Client should be able to communicate with Elasticsearch version 8.x. Note that when compatibility mode is enabled, the Rest High Level Client not able to communicate with Elasticsearch version lower than 7.11.

elasticsearch

protected final SearchProperties.Elasticsearch elasticsearch

defaultSearchStrategy

protected final String defaultSearchStrategy

Name of default search strategy

indexingQueueProcessingCron

protected final String indexingQueueProcessingCron

CRON expression that is used by default Indexing Queue processing quartz scheduling configuration.

enqueueingSessionProcessingCron

protected final String enqueueingSessionProcessingCron

CRON expression that is used by default Enqueueing Session processing quartz scheduling configuration.

searchIndexNamePrefix

protected final String searchIndexNamePrefix

Prefix for search index name. Index naming template: <prefix><entity_name>. Default prefix is 'search_index_'.

indexSchemaManagementStrategy

protected final IndexSchemaManagementStrategy indexSchemaManagementStrategy

The way of index schema synchronization.

enqueueIndexAllOnStartupIndexRecreationEntities

protected final List<String> enqueueIndexAllOnStartupIndexRecreationEntities

List of entities that should be automatically enqueued on startup in case of index recreation. Empty list means all indexed entities.

Constructor Details

SearchProperties

public SearchProperties(@DefaultValue("100")
 int searchResultPageSize,
 @DefaultValue("100")
 int maxSearchPageCount,
 @DefaultValue("100")
 int searchReloadEntitiesBatchSize,
 @DefaultValue("100")
 int processQueueBatchSize,
 @DefaultValue("100")
 int reindexEntityEnqueueBatchSize,
 @DefaultValue("true")
 boolean changedEntitiesIndexingEnabled,
 @DefaultValue("true")
 boolean useDefaultIndexingQueueProcessingQuartzConfiguration,
 @DefaultValue("true")
 boolean useDefaultEnqueueingSessionProcessingQuartzConfiguration,
 @DefaultValue("true")
 boolean enqueueIndexAllOnStartupIndexRecreationEnabled,
 @DefaultValue("true")
 boolean restHighLevelClientApiCompatibilityModeEnabled,
 @DefaultValue("")
 String enqueueIndexAllOnStartupIndexRecreationEntities,
 @DefaultValue("search_index_")
 String searchIndexNamePrefix,
 @DefaultValue("anyTermAnyField")
 String defaultSearchStrategy,
 @DefaultValue("create-or-recreate")
 String indexSchemaManagementStrategy,
 @DefaultValue("0/5 * * * * ?")
 String indexingQueueProcessingCron,
 @DefaultValue("0/5 * * * * ?")
 String enqueueingSessionProcessingCron,
 @DefaultValue
 SearchProperties.Elasticsearch elasticsearch)

Method Details

getSearchResultPageSize

public int getSearchResultPageSize()

See Also:

• searchResultPageSize

getMaxSearchPageCount

public int getMaxSearchPageCount()

See Also:

• maxSearchPageCount

getSearchReloadEntitiesBatchSize

public int getSearchReloadEntitiesBatchSize()

See Also:

• searchReloadEntitiesBatchSize

getProcessQueueBatchSize

public int getProcessQueueBatchSize()

See Also:

• processQueueBatchSize

getReindexEntityEnqueueBatchSize

public int getReindexEntityEnqueueBatchSize()

See Also:

• reindexEntityEnqueueBatchSize

isChangedEntitiesIndexingEnabled

public boolean isChangedEntitiesIndexingEnabled()

See Also:

• changedEntitiesIndexingEnabled

isUseDefaultIndexingQueueProcessingQuartzConfiguration

public boolean isUseDefaultIndexingQueueProcessingQuartzConfiguration()

See Also:

• useDefaultIndexingQueueProcessingQuartzConfiguration

isUseDefaultEnqueueingSessionProcessingQuartzConfiguration

public boolean isUseDefaultEnqueueingSessionProcessingQuartzConfiguration()

See Also:

• useDefaultEnqueueingSessionProcessingQuartzConfiguration

getIndexingQueueProcessingCron

public String getIndexingQueueProcessingCron()

See Also:

• indexingQueueProcessingCron

getEnqueueingSessionProcessingCron

public String getEnqueueingSessionProcessingCron()

See Also:

• enqueueingSessionProcessingCron

getSearchIndexNamePrefix

public String getSearchIndexNamePrefix()

See Also:

• searchIndexNamePrefix

isEnqueueIndexAllOnStartupIndexRecreationEnabled

public boolean isEnqueueIndexAllOnStartupIndexRecreationEnabled()

See Also:

• enqueueIndexAllOnStartupIndexRecreationEnabled

isRestHighLevelClientApiCompatibilityModeEnabled

public boolean isRestHighLevelClientApiCompatibilityModeEnabled()

See Also:

• restHighLevelClientApiCompatibilityModeEnabled

getEnqueueIndexAllOnStartupIndexRecreationEntities

public List<String> getEnqueueIndexAllOnStartupIndexRecreationEntities()

See Also:

• enqueueIndexAllOnStartupIndexRecreationEntities

getDefaultSearchStrategy

public String getDefaultSearchStrategy()

See Also:

• defaultSearchStrategy

getElasticsearchUrl

public String getElasticsearchUrl()

See Also:

• SearchProperties.Elasticsearch.url

getElasticsearchLogin

public String getElasticsearchLogin()

See Also:

• SearchProperties.Elasticsearch.login

getElasticsearchPassword

public String getElasticsearchPassword()

See Also:

• SearchProperties.Elasticsearch.password

getElasticsearchSslCertificateLocation

public String getElasticsearchSslCertificateLocation()

See Also:

• SearchProperties.SSL.certificateLocation

getElasticsearchSslCertificateAlias

public String getElasticsearchSslCertificateAlias()

See Also:

• SearchProperties.SSL.certificateAlias

getElasticsearchSslCertificateFactoryType

public String getElasticsearchSslCertificateFactoryType()

See Also:

• SearchProperties.SSL.certificateFactoryType

getElasticsearchSslKeyStoreType

public String getElasticsearchSslKeyStoreType()

See Also:

• SearchProperties.SSL.keyStoreType

getElasticsearchBulkRequestRefreshPolicy

public org.elasticsearch.action.support.WriteRequest.RefreshPolicy getElasticsearchBulkRequestRefreshPolicy()

See Also:

• SearchProperties.Elasticsearch.bulkRequestRefreshPolicy

getIndexSchemaManagementStrategy

public IndexSchemaManagementStrategy getIndexSchemaManagementStrategy()

See Also:

• indexSchemaManagementStrategy

prepareStartupEnqueueingEntities

protected List<String> prepareStartupEnqueueingEntities(String enqueueIndexAllOnStartupIndexRecreationEntities)