com.flowable.indexing

Class IndexManagerImpl

java.lang.Object

com.flowable.indexing.IndexManagerImpl

All Implemented Interfaces:

IndexManager, EventListener, Aware, InitializingBean, ApplicationContextAware, ApplicationListener<ContextRefreshedEvent>, Ordered

public class IndexManagerImpl
extends Object
implements IndexManager, ApplicationListener<ContextRefreshedEvent>, ApplicationContextAware, Ordered, InitializingBean

Field Summary

Fields

Modifier and Type	Field and Description
protected ApplicationContext	applicationContext
protected List<CustomIndexConfiguration>	customConfigurations
protected Map<String,IndexMapping>	customMappings
static int	DEFAULT_ORDER
protected ElasticsearchClient	elasticsearchClient
protected static String	FULL_TEXT_VARIABLES_FIELD
protected static DateTimeFormatter	INDEX_SUFFIX_FORMAT
protected Map<String,CustomIndexConfiguration>	indexedDocumentTypes
protected Map<String,IndexMapping>	indexMappings
protected String	indexNamePrefix
protected IndexTemplateComposer	indexTemplateComposer
protected List<String>	indices
protected Function<String,LockManager>	lockManagerProvider
protected Resource[]	mappingExtensionResources
protected Resource[]	mappingResources
protected Duration	mappingSchemaLockWaitTime
protected static int	MINIMAL_COMPATIBLE_ES_VERSION
protected com.fasterxml.jackson.databind.ObjectMapper	objectMapper
protected int	order
protected static String	PROPERTIES_FIELD
protected static String	SETTINGS_FIELD
protected boolean	useLockForIndexMappingCreation
protected static String	VARIABLE_EXTRACTORS_FIELD
protected static String	VARIABLE_PROPERTIES_FIELD

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
IndexManagerImpl(ElasticsearchClient elasticsearchClient, Function<String,LockManager> lockManagerProvider, String indexNamePrefix, String projectName, Resource[] mappingResources, Resource[] mappingExtensionResources, IndexTemplateComposer indexTemplateComposer, com.fasterxml.jackson.databind.ObjectMapper objectMapper)
IndexManagerImpl(ElasticsearchClient elasticsearchClient, Function<String,LockManager> lockManagerProvider, String indexNamePrefix, String projectName, Resource[] mappingResources, Resource[] mappingExtensionResources, IndexTemplateComposer indexTemplateComposer, com.fasterxml.jackson.databind.ObjectMapper objectMapper, boolean useLockForIndexMappingCreation, Duration mappingSchemaLockWaitTime)

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
protected boolean	compareExtensionMetadata(com.fasterxml.jackson.databind.JsonNode currentMapping, com.fasterxml.jackson.databind.JsonNode updateMapping)
protected void	createCustomAlias(String alias, String indexMapping)
protected Map<String,List<com.fasterxml.jackson.databind.JsonNode>>	createCustomAliasesFromMappings(Map<String,com.fasterxml.jackson.databind.JsonNode> indexMetaData)
protected void	createCustomMappings()
com.fasterxml.jackson.databind.JsonNode	createIndexAndAlias(String alias, String indexMapping)
void	createIndexesAndCustomAliasesFromMappings()
Map<String,com.fasterxml.jackson.databind.JsonNode>	createIndexesFromMappings() Creates the indices for all known mappings
com.fasterxml.jackson.databind.JsonNode	createIndexWithAlias(String indexName) Creates an index.
String	createIndexWithoutAlias(String indexName) Similar to IndexManager.createIndexWithAlias(String), but doesn't create an alias, only the index with the mapping.
void	deleteAliasAndRelatedIndices(String indexName) Deletes the given index and all its aliases.
void	deleteAllKnownIndices() Deletes all indices registered in the system
void	deleteIndex(String indexName) Deletes the index with the given name.
protected String	enhanceIndexName(String indexName)
protected void	enhanceMappingWithExtension(Map<String,List<com.fasterxml.jackson.databind.JsonNode>> mappingExtensionConfigurations, CustomIndexConfiguration customIndexConfiguration, String indexName)
protected void	enhanceProperties(Map<String,List<com.fasterxml.jackson.databind.JsonNode>> mappingExtensionConfigurations, CustomIndexConfiguration customIndexConfiguration, String indexName)
protected void	enhanceSettings(Map<String,List<com.fasterxml.jackson.databind.JsonNode>> mappingExtensionConfigurations, CustomIndexConfiguration customIndexConfiguration, String indexName)
protected void	enhanceVariableProperties(Map<String,List<com.fasterxml.jackson.databind.JsonNode>> mappingExtensionConfigurations, CustomIndexConfiguration customIndexConfiguration, String indexName)
IndexMapping	findIndexMapping(String indexName)
List<IndexMapping>	findMatchingCustomMappings(String indexName) Returns a list of IndexMapping(s) that are applicable for the provided index name.
List<IndexMapping>	findMatchingIndexMappings(com.fasterxml.jackson.databind.node.ObjectNode objectNode) Returns a list of IndexMapping instances that are applicable for the provided data.
List<IndexMapping>	findMatchingIndexMappings(String mappingType) Returns a list of IndexMapping(s) that are applicable for the provided mapping type.
IndexMapping	getCustomQueryMapping(String indexName, String mappingName) Get custom query mapping for given index if exists.
String	getESIndexName(String indexName) Returns the internal index name for the provided raw index name.
CustomIndexConfiguration	getIndexConfiguration(String indexName) Returns the mapping information for the given index.
String	getIndexNamePrefix() Returns the prefix that is added to all indices.
Function<String,LockManager>	getLockManagerProvider()
protected com.fasterxml.jackson.databind.node.ObjectNode	getMappingDelta(com.fasterxml.jackson.databind.JsonNode currentMapping, com.fasterxml.jackson.databind.JsonNode updateMapping, String currentType)
Resource[]	getMappingExtensionResources()
Resource[]	getMappingResources()
int	getOrder()
boolean	isKnownIndex(String index) Returns whether the index is a known mapped index.
protected void	logElasticsearchVersionInformation()
void	onApplicationEvent(ContextRefreshedEvent event)
protected Map<String,List<com.fasterxml.jackson.databind.JsonNode>>	processMappingExtensionResources()
protected void	processMappingResources(Map<String,List<com.fasterxml.jackson.databind.JsonNode>> mappingExtensionConfigurations)
protected void	processResources()
protected void	processVariableMappings(CustomIndexMapping indexMapping, com.fasterxml.jackson.databind.JsonNode jsonNode)
IndexMapping	recreateMapping(IndexMapping indexMapping) Used to recreate mapping if CustomIndexConfiguration changed.
boolean	reloadIndex(String indexName) Reloads selected index
boolean	reloadIndices() Reloads all indexes
void	setApplicationContext(ApplicationContext applicationContext)
void	setIndexNamePrefix(String indexNamePrefix)
void	setLockManagerProvider(Function<String,LockManager> lockManagerProvider)
void	setMappingExtensionResources(Resource[] mappingExtensionResources)
void	setMappingResources(Resource[] mappingResources)
void	setOrder(int order)
protected void	updateExistingAliasMapping(IndexMapping customMapping)
protected com.fasterxml.jackson.databind.JsonNode	updateExistingMappingIfNeeded(String indexName, IndexMapping indexMapping)
protected void	updateIndexAndMappingMetaData(String index, com.fasterxml.jackson.databind.JsonNode metaData)
protected void	updateIndexMetaData(Map<String,com.fasterxml.jackson.databind.JsonNode> indicesMetaData, Map<String,List<com.fasterxml.jackson.databind.JsonNode>> aliasesMetaData)
protected boolean	validateMappingExtensionJson(Resource mappingExtensionResource, com.fasterxml.jackson.databind.JsonNode mappingExtensionJson)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.context.ApplicationListener

forPayload

Field Detail

DEFAULT_ORDER

public static final int DEFAULT_ORDER

See Also:

Constant Field Values

INDEX_SUFFIX_FORMAT

protected static final DateTimeFormatter INDEX_SUFFIX_FORMAT

MINIMAL_COMPATIBLE_ES_VERSION

protected static int MINIMAL_COMPATIBLE_ES_VERSION

PROPERTIES_FIELD

protected static final String PROPERTIES_FIELD

See Also:

Constant Field Values

SETTINGS_FIELD

protected static final String SETTINGS_FIELD

See Also:

Constant Field Values

VARIABLE_PROPERTIES_FIELD

protected static final String VARIABLE_PROPERTIES_FIELD

See Also:

Constant Field Values

VARIABLE_EXTRACTORS_FIELD

protected static final String VARIABLE_EXTRACTORS_FIELD

See Also:

Constant Field Values

FULL_TEXT_VARIABLES_FIELD

protected static final String FULL_TEXT_VARIABLES_FIELD

See Also:

Constant Field Values

elasticsearchClient

protected ElasticsearchClient elasticsearchClient

lockManagerProvider

protected Function<String,LockManager> lockManagerProvider

mappingResources

protected Resource[] mappingResources

mappingExtensionResources

protected Resource[] mappingExtensionResources

indexTemplateComposer

protected IndexTemplateComposer indexTemplateComposer

objectMapper

protected com.fasterxml.jackson.databind.ObjectMapper objectMapper

indexNamePrefix

protected String indexNamePrefix

useLockForIndexMappingCreation

protected boolean useLockForIndexMappingCreation

mappingSchemaLockWaitTime

protected Duration mappingSchemaLockWaitTime

indexMappings

protected Map<String,IndexMapping> indexMappings

customMappings

protected Map<String,IndexMapping> customMappings

customConfigurations

protected List<CustomIndexConfiguration> customConfigurations

indices

protected List<String> indices

indexedDocumentTypes

protected Map<String,CustomIndexConfiguration> indexedDocumentTypes

applicationContext

protected ApplicationContext applicationContext

order

protected int order

Constructor Detail

IndexManagerImpl

public IndexManagerImpl(ElasticsearchClient elasticsearchClient,
                        Function<String,LockManager> lockManagerProvider,
                        String indexNamePrefix,
                        String projectName,
                        Resource[] mappingResources,
                        Resource[] mappingExtensionResources,
                        IndexTemplateComposer indexTemplateComposer,
                        com.fasterxml.jackson.databind.ObjectMapper objectMapper)

IndexManagerImpl

public IndexManagerImpl(ElasticsearchClient elasticsearchClient,
                        Function<String,LockManager> lockManagerProvider,
                        String indexNamePrefix,
                        String projectName,
                        Resource[] mappingResources,
                        Resource[] mappingExtensionResources,
                        IndexTemplateComposer indexTemplateComposer,
                        com.fasterxml.jackson.databind.ObjectMapper objectMapper,
                        boolean useLockForIndexMappingCreation,
                        Duration mappingSchemaLockWaitTime)

Method Detail

getOrder

public int getOrder()

Specified by:

getOrder in interface Ordered

setOrder

public void setOrder(int order)

processResources

protected void processResources()

processMappingExtensionResources

protected Map<String,List<com.fasterxml.jackson.databind.JsonNode>> processMappingExtensionResources()

validateMappingExtensionJson

protected boolean validateMappingExtensionJson(Resource mappingExtensionResource,
                                               com.fasterxml.jackson.databind.JsonNode mappingExtensionJson)

processMappingResources

protected void processMappingResources(Map<String,List<com.fasterxml.jackson.databind.JsonNode>> mappingExtensionConfigurations)

processVariableMappings

protected void processVariableMappings(CustomIndexMapping indexMapping,
                                       com.fasterxml.jackson.databind.JsonNode jsonNode)

enhanceMappingWithExtension

protected void enhanceMappingWithExtension(Map<String,List<com.fasterxml.jackson.databind.JsonNode>> mappingExtensionConfigurations,
                                           CustomIndexConfiguration customIndexConfiguration,
                                           String indexName)

enhanceProperties

protected void enhanceProperties(Map<String,List<com.fasterxml.jackson.databind.JsonNode>> mappingExtensionConfigurations,
                                 CustomIndexConfiguration customIndexConfiguration,
                                 String indexName)

enhanceVariableProperties

protected void enhanceVariableProperties(Map<String,List<com.fasterxml.jackson.databind.JsonNode>> mappingExtensionConfigurations,
                                         CustomIndexConfiguration customIndexConfiguration,
                                         String indexName)

enhanceSettings

protected void enhanceSettings(Map<String,List<com.fasterxml.jackson.databind.JsonNode>> mappingExtensionConfigurations,
                               CustomIndexConfiguration customIndexConfiguration,
                               String indexName)

getIndexNamePrefix

public String getIndexNamePrefix()

Description copied from interface: IndexManager

Returns the prefix that is added to all indices. Empty by default.

Specified by:

getIndexNamePrefix in interface IndexManager

setIndexNamePrefix

public void setIndexNamePrefix(String indexNamePrefix)

getESIndexName

public String getESIndexName(String indexName)

Description copied from interface: IndexManager

Returns the internal index name for the provided raw index name. As there might be an index-prefix in place, the index name towards the Elasticsearch client needs to use the internal name though which is returned using this method.

Specified by:

getESIndexName in interface IndexManager

Parameters:

indexName - the index name as being used in configuration, query DSL and API

Returns:

the index name as being used towards Elasticsearch (might have a prefix)

createIndexWithAlias

public com.fasterxml.jackson.databind.JsonNode createIndexWithAlias(String indexName)

Description copied from interface: IndexManager

Creates an index. The index mapping that is used will need to have as 'name' the passed index name. In fact, creates both an alias with the given name and the actual index, prefixed with the project name and with a timestamp. This allows later to change indices, but keep the alias and reindex.

Specified by:

createIndexWithAlias in interface IndexManager

createIndexWithoutAlias

public String createIndexWithoutAlias(String indexName)

Description copied from interface: IndexManager

Similar to IndexManager.createIndexWithAlias(String), but doesn't create an alias, only the index with the mapping. Note that the index will still follow the aliasName-timeStamp pattern. Note that the mapping will be looked up based on the name passed.

Specified by:

createIndexWithoutAlias in interface IndexManager

createIndexAndAlias

public com.fasterxml.jackson.databind.JsonNode createIndexAndAlias(String alias,
                                                                   String indexMapping)

getCustomQueryMapping

public IndexMapping getCustomQueryMapping(String indexName,
                                          String mappingName)

Description copied from interface: IndexManager

Get custom query mapping for given index if exists.

Specified by:

getCustomQueryMapping in interface IndexManager

deleteAliasAndRelatedIndices

public void deleteAliasAndRelatedIndices(String indexName)

Description copied from interface: IndexManager

Deletes the given index and all its aliases. Or, when the name is an alias, deletes the alias and all indices.

Specified by:

deleteAliasAndRelatedIndices in interface IndexManager

deleteIndex

public void deleteIndex(String indexName)

Description copied from interface: IndexManager

Deletes the index with the given name. Does not delete the alias, if one exists.

Specified by:

deleteIndex in interface IndexManager

deleteAllKnownIndices

public void deleteAllKnownIndices()

Description copied from interface: IndexManager

Deletes all indices registered in the system

Specified by:

deleteAllKnownIndices in interface IndexManager

enhanceIndexName

protected String enhanceIndexName(String indexName)

isKnownIndex

public boolean isKnownIndex(String index)

Description copied from interface: IndexManager

Returns whether the index is a known mapped index. This is useful when parsing queries.

Specified by:

isKnownIndex in interface IndexManager

findMatchingIndexMappings

public List<IndexMapping> findMatchingIndexMappings(com.fasterxml.jackson.databind.node.ObjectNode objectNode)

Description copied from interface: IndexManager

Returns a list of IndexMapping instances that are applicable for the provided data.

Specified by:

findMatchingIndexMappings in interface IndexManager

findMatchingIndexMappings

public List<IndexMapping> findMatchingIndexMappings(String mappingType)

Description copied from interface: IndexManager

Returns a list of IndexMapping(s) that are applicable for the provided mapping type.

Specified by:

findMatchingIndexMappings in interface IndexManager

findMatchingCustomMappings

public List<IndexMapping> findMatchingCustomMappings(String indexName)

Description copied from interface: IndexManager

Returns a list of IndexMapping(s) that are applicable for the provided index name.

Specified by:

findMatchingCustomMappings in interface IndexManager

findIndexMapping

public IndexMapping findIndexMapping(String indexName)

Specified by:

findIndexMapping in interface IndexManager

getIndexConfiguration

public CustomIndexConfiguration getIndexConfiguration(String indexName)

Description copied from interface: IndexManager

Returns the mapping information for the given index.

Specified by:

getIndexConfiguration in interface IndexManager

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface InitializingBean

Throws:

Exception

onApplicationEvent

public void onApplicationEvent(ContextRefreshedEvent event)

Specified by:

onApplicationEvent in interface ApplicationListener<ContextRefreshedEvent>

createIndexesAndCustomAliasesFromMappings

public void createIndexesAndCustomAliasesFromMappings()

Specified by:

createIndexesAndCustomAliasesFromMappings in interface IndexManager

updateIndexMetaData

protected void updateIndexMetaData(Map<String,com.fasterxml.jackson.databind.JsonNode> indicesMetaData,
                                   Map<String,List<com.fasterxml.jackson.databind.JsonNode>> aliasesMetaData)

updateIndexAndMappingMetaData

protected void updateIndexAndMappingMetaData(String index,
                                             com.fasterxml.jackson.databind.JsonNode metaData)

createCustomMappings

protected void createCustomMappings()

recreateMapping

public IndexMapping recreateMapping(IndexMapping indexMapping)

Description copied from interface: IndexManager

Used to recreate mapping if CustomIndexConfiguration changed.

Specified by:

recreateMapping in interface IndexManager

Returns:

Updated indexMapping

createCustomAliasesFromMappings

protected Map<String,List<com.fasterxml.jackson.databind.JsonNode>> createCustomAliasesFromMappings(Map<String,com.fasterxml.jackson.databind.JsonNode> indexMetaData)

updateExistingAliasMapping

protected void updateExistingAliasMapping(IndexMapping customMapping)

createIndexesFromMappings

public Map<String,com.fasterxml.jackson.databind.JsonNode> createIndexesFromMappings()

Description copied from interface: IndexManager

Creates the indices for all known mappings

Specified by:

createIndexesFromMappings in interface IndexManager

updateExistingMappingIfNeeded

protected com.fasterxml.jackson.databind.JsonNode updateExistingMappingIfNeeded(String indexName,
                                                                                IndexMapping indexMapping)

compareExtensionMetadata

protected boolean compareExtensionMetadata(com.fasterxml.jackson.databind.JsonNode currentMapping,
                                           com.fasterxml.jackson.databind.JsonNode updateMapping)

getMappingDelta

protected com.fasterxml.jackson.databind.node.ObjectNode getMappingDelta(com.fasterxml.jackson.databind.JsonNode currentMapping,
                                                                         com.fasterxml.jackson.databind.JsonNode updateMapping,
                                                                         String currentType)

createCustomAlias

protected void createCustomAlias(String alias,
                                 String indexMapping)

logElasticsearchVersionInformation

protected void logElasticsearchVersionInformation()

reloadIndices

public boolean reloadIndices()

Description copied from interface: IndexManager

Reloads all indexes

Specified by:

reloadIndices in interface IndexManager

reloadIndex

public boolean reloadIndex(String indexName)

Description copied from interface: IndexManager

Reloads selected index

Specified by:

reloadIndex in interface IndexManager

setApplicationContext

public void setApplicationContext(ApplicationContext applicationContext)
                           throws BeansException

Specified by:

setApplicationContext in interface ApplicationContextAware

Throws:

BeansException

getLockManagerProvider

public Function<String,LockManager> getLockManagerProvider()

setLockManagerProvider

public void setLockManagerProvider(Function<String,LockManager> lockManagerProvider)

getMappingResources

public Resource[] getMappingResources()

setMappingResources

public void setMappingResources(Resource[] mappingResources)

getMappingExtensionResources

public Resource[] getMappingExtensionResources()

setMappingExtensionResources

public void setMappingExtensionResources(Resource[] mappingExtensionResources)