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
static class	SearchProperties.Server
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 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	maxPrefixLength	Maximum length of prefix terms generated by edge N-gram analyzer for prefix search.
protected final int	maxSearchPageCount	Max amount of result pages.
protected final int	minPrefixLength	Minimum length of prefix terms generated by edge N-gram analyzer for prefix search.
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 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 SearchProperties.Server	server
protected final boolean	unsupportedSearchStrategyVisible	Whether the additional search strategy provided by Extended search is visible if there are no index definitions with enabled Extended search.
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.
protected final boolean	wildcardPrefixQueryEnabled	Whether the wildcard query will be used if input search word is longer than prefix maximum length.

Constructor Summary

Constructors

Constructor

Description

SearchProperties(int searchResultPageSize, int maxSearchPageCount, int searchReloadEntitiesBatchSize, int processQueueBatchSize, int reindexEntityEnqueueBatchSize, int minPrefixLength, int maxPrefixLength, boolean changedEntitiesIndexingEnabled, boolean useDefaultIndexingQueueProcessingQuartzConfiguration, boolean useDefaultEnqueueingSessionProcessingQuartzConfiguration, boolean enqueueIndexAllOnStartupIndexRecreationEnabled, boolean unsupportedSearchStrategyVisible, boolean wildcardPrefixQueryEnabled, String enqueueIndexAllOnStartupIndexRecreationEntities, String searchIndexNamePrefix, String defaultSearchStrategy, String indexSchemaManagementStrategy, String indexingQueueProcessingCron, String enqueueingSessionProcessingCron, SearchProperties.Server server)

Method Summary

Modifier and Type	Method	Description
RefreshPolicy	getBulkRequestRefreshPolicy()
String	getDefaultSearchStrategy()
List<String>	getEnqueueIndexAllOnStartupIndexRecreationEntities()
String	getEnqueueingSessionProcessingCron()
String	getIndexingQueueProcessingCron()
IndexSchemaManagementStrategy	getIndexSchemaManagementStrategy()
int	getMaxPrefixLength()
int	getMaxSearchPageCount()
int	getMinPrefixLength()
int	getProcessQueueBatchSize()
int	getReindexEntityEnqueueBatchSize()
String	getSearchIndexNamePrefix()
int	getSearchReloadEntitiesBatchSize()
int	getSearchResultPageSize()
String	getServerLogin()
String	getServerPassword()
String	getServerSslCertificateAlias()
String	getServerSslCertificateFactoryType()
String	getServerSslCertificateLocation()
String	getServerSslKeyStoreType()
String	getServerUrl()
boolean	isChangedEntitiesIndexingEnabled()
boolean	isEnqueueIndexAllOnStartupIndexRecreationEnabled()
boolean	isUnsupportedSearchStrategyVisible()
boolean	isUseDefaultEnqueueingSessionProcessingQuartzConfiguration()
boolean	isUseDefaultIndexingQueueProcessingQuartzConfiguration()
boolean	isWildcardPrefixQueryEnabled()
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.

server

protected final SearchProperties.Server server

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.

minPrefixLength

protected final int minPrefixLength

Minimum length of prefix terms generated by edge N-gram analyzer for prefix search.

See Also:

• maxPrefixLength

maxPrefixLength

protected final int maxPrefixLength

Maximum length of prefix terms generated by edge N-gram analyzer for prefix search.

See Also:

• minPrefixLength

unsupportedSearchStrategyVisible

protected final boolean unsupportedSearchStrategyVisible

Whether the additional search strategy provided by Extended search is visible if there are no index definitions with enabled Extended search.

wildcardPrefixQueryEnabled

protected final boolean wildcardPrefixQueryEnabled

Whether the wildcard query will be used if input search word is longer than prefix maximum length.

See Also:

• maxPrefixLength

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("3")
 int minPrefixLength,
 @DefaultValue("8")
 int maxPrefixLength,
 @DefaultValue("true")
 boolean changedEntitiesIndexingEnabled,
 @DefaultValue("true")
 boolean useDefaultIndexingQueueProcessingQuartzConfiguration,
 @DefaultValue("true")
 boolean useDefaultEnqueueingSessionProcessingQuartzConfiguration,
 @DefaultValue("true")
 boolean enqueueIndexAllOnStartupIndexRecreationEnabled,
 @DefaultValue("false")
 boolean unsupportedSearchStrategyVisible,
 @DefaultValue("true")
 boolean wildcardPrefixQueryEnabled,
 @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.Server server)

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

getMinPrefixLength

public int getMinPrefixLength()

getMaxPrefixLength

public int getMaxPrefixLength()

isUnsupportedSearchStrategyVisible

public boolean isUnsupportedSearchStrategyVisible()

isWildcardPrefixQueryEnabled

public boolean isWildcardPrefixQueryEnabled()

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

getEnqueueIndexAllOnStartupIndexRecreationEntities

public List<String> getEnqueueIndexAllOnStartupIndexRecreationEntities()

See Also:

• enqueueIndexAllOnStartupIndexRecreationEntities

getDefaultSearchStrategy

public String getDefaultSearchStrategy()

See Also:

• defaultSearchStrategy

getServerUrl

public String getServerUrl()

See Also:

• SearchProperties.Server.url

getServerLogin

public String getServerLogin()

See Also:

• SearchProperties.Server.login

getServerPassword

public String getServerPassword()

See Also:

• SearchProperties.Server.password

getServerSslCertificateLocation

public String getServerSslCertificateLocation()

See Also:

• SearchProperties.SSL.certificateLocation

getServerSslCertificateAlias

public String getServerSslCertificateAlias()

See Also:

• SearchProperties.SSL.certificateAlias

getServerSslCertificateFactoryType

public String getServerSslCertificateFactoryType()

See Also:

• SearchProperties.SSL.certificateFactoryType

getServerSslKeyStoreType

public String getServerSslKeyStoreType()

See Also:

• SearchProperties.SSL.keyStoreType

getBulkRequestRefreshPolicy

public RefreshPolicy getBulkRequestRefreshPolicy()

See Also:

• SearchProperties.Server.bulkRequestRefreshPolicy

getIndexSchemaManagementStrategy

public IndexSchemaManagementStrategy getIndexSchemaManagementStrategy()

See Also:

• indexSchemaManagementStrategy

prepareStartupEnqueueingEntities

protected List<String> prepareStartupEnqueueingEntities(String enqueueIndexAllOnStartupIndexRecreationEntities)