Package com.flowable.indexing.impl

Class IndexingServiceImpl

java.lang.Object

com.flowable.indexing.impl.IndexingServiceImpl

All Implemented Interfaces:

IndexingService, LowLevelIndexingService

public class IndexingServiceImpl
extends Object
implements IndexingService, LowLevelIndexingService

Nested Class Summary

Nested classes/interfaces inherited from interface com.flowable.indexing.api.LowLevelIndexingService

LowLevelIndexingService.BulkIndexRequestConflictHandler

Field Summary

Fields

Modifier and Type	Field	Description
protected SpringAsyncHistoryExecutor	asyncHistoryExecutor
protected List<BulkIndexRequestInterceptor>	bulkIndexRequestInterceptors
protected ElasticsearchClient	elasticsearchClient
protected boolean	indexingEnabled
protected IndexManager	indexManager
protected com.fasterxml.jackson.databind.ObjectMapper	objectMapper
protected ObjectSerializationService	objectSerializationService

Constructor Summary

Constructors

Constructor	Description
IndexingServiceImpl(boolean indexingEnabled, ElasticsearchClient elasticsearchClient, ObjectSerializationService objectSerializationService, IndexManager indexManager, com.fasterxml.jackson.databind.ObjectMapper objectMapper, SpringAsyncHistoryExecutor asyncHistoryExecutor, List<BulkIndexRequestInterceptor> bulkIndexRequestInterceptors)

Method Summary

Modifier and Type	Method	Description
void	addToCurrentBulkRequestAsFullIndex(CommandContext commandContext, String type, String id, com.fasterxml.jackson.databind.node.ObjectNode data, String idFieldName)	Adds the ObjectNode data as a full index (i.e.
void	addToCurrentBulkRequestAsFullIndexWithExternalVersion(CommandContext commandContext, String type, String id, com.fasterxml.jackson.databind.node.ObjectNode data, String idFieldName, LowLevelIndexingService.BulkIndexRequestConflictHandler bulkIndexRequestConflictHandler)	Equivalent to LowLevelIndexingService.addToCurrentBulkRequestAsFullIndex(CommandContext, String, String, ObjectNode, String), but using external versioning (vs the one from Elasticsearch).
void	addToCurrentBulkRequestAsUpsert(CommandContext commandContext, String type, com.fasterxml.jackson.databind.node.ObjectNode data, String idFieldName)	Adds the ObjectNode data as an upsert (i.e.
void	addToCurrentBulkRequestAsUpsertWithScript(CommandContext commandContext, com.fasterxml.jackson.databind.node.ObjectNode dataNode, com.fasterxml.jackson.databind.node.ObjectNode scriptNode, String idFieldName)	Adds the ObjectNode data as an upsert (i.e.
protected HistoryJobEntity	createHistoryJobEntity(String handlerType)
void	deleteByQuery(String aliasName, com.fasterxml.jackson.databind.node.ObjectNode query)	Delete indexed objects based on a query.
void	deleteIndexedObject(String aliasName, String id)	Delete the indexed object using the provided id.
protected String	determineIndex(com.fasterxml.jackson.databind.node.ObjectNode objectNode, IndexedDataObject indexedDataObject)
protected String	determineIndex(IndexMapping indexMapping)
void	indexObject(Object object, String idFieldName)	Similar to LowLevelIndexingService.indexObject(Object), but by providing an alternative field name that contains the id, instead of depending on the IndexingJsonConstants.PROPERTY_ID in the json.
boolean	isFullIndexRegisteredOnCurrentBulkRequest(CommandContext commandContext, String type, String id)	Returns whether a full index was already registered before during the current transaction.
boolean	isIndexingEnabled()
void	scheduleIndexedObjectDelete(String aliasName, String id)	Schedule a delete of an object from an index.
void	scheduleIndexing(Object object, String tenantId)	Schedule to index a generic object, that will pass the IndexableObjectSerializer first.
void	scheduleIndexing(String type, com.fasterxml.jackson.databind.node.ObjectNode dataNode, String tenantId)	Schedule the json directly to be indexed using the provided type.
void	scheduleUpdateByQuery(String mappingType, com.fasterxml.jackson.databind.node.ObjectNode updateByQueryBody)	Schedule an update by query with an abitrary body.
protected com.fasterxml.jackson.databind.node.ObjectNode	serializeObject(Object object)
protected List<IndexedDataObject>	transformObjectToIndexedDataObjects(com.fasterxml.jackson.databind.node.ObjectNode objectNode, String idFieldName)
void	updateByQuery(String mappingType, com.fasterxml.jackson.databind.node.ObjectNode data)	Perform Update by Query for the given Mapping type.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.flowable.indexing.api.LowLevelIndexingService

indexObject

Field Details

indexingEnabled

protected boolean indexingEnabled

elasticsearchClient

protected ElasticsearchClient elasticsearchClient

objectSerializationService

protected ObjectSerializationService objectSerializationService

indexManager

protected IndexManager indexManager

objectMapper

protected com.fasterxml.jackson.databind.ObjectMapper objectMapper

asyncHistoryExecutor

protected SpringAsyncHistoryExecutor asyncHistoryExecutor

bulkIndexRequestInterceptors

protected List<BulkIndexRequestInterceptor> bulkIndexRequestInterceptors

Constructor Details

IndexingServiceImpl

public IndexingServiceImpl(boolean indexingEnabled,
 ElasticsearchClient elasticsearchClient,
 ObjectSerializationService objectSerializationService,
 IndexManager indexManager,
 com.fasterxml.jackson.databind.ObjectMapper objectMapper,
 SpringAsyncHistoryExecutor asyncHistoryExecutor,
 List<BulkIndexRequestInterceptor> bulkIndexRequestInterceptors)

Method Details

isIndexingEnabled

public boolean isIndexingEnabled()

Specified by:

isIndexingEnabled in interface IndexingService

indexObject

public void indexObject(Object object,
 String idFieldName)

Description copied from interface: LowLevelIndexingService

Similar to LowLevelIndexingService.indexObject(Object), but by providing an alternative field name that contains the id, instead of depending on the IndexingJsonConstants.PROPERTY_ID in the json. Deprecated: This method will be removed in a future version.

Specified by:

indexObject in interface LowLevelIndexingService

transformObjectToIndexedDataObjects

protected List<IndexedDataObject> transformObjectToIndexedDataObjects(com.fasterxml.jackson.databind.node.ObjectNode objectNode,
 String idFieldName)

serializeObject

protected com.fasterxml.jackson.databind.node.ObjectNode serializeObject(Object object)

scheduleIndexing

public void scheduleIndexing(Object object,
 String tenantId)

Description copied from interface: IndexingService

Schedule to index a generic object, that will pass the IndexableObjectSerializer first.

Specified by:

scheduleIndexing in interface IndexingService

scheduleIndexing

public void scheduleIndexing(String type,
 com.fasterxml.jackson.databind.node.ObjectNode dataNode,
 String tenantId)

Description copied from interface: IndexingService

Schedule the json directly to be indexed using the provided type.

Specified by:

scheduleIndexing in interface IndexingService

deleteIndexedObject

public void deleteIndexedObject(String aliasName,
 String id)

Description copied from interface: LowLevelIndexingService

Delete the indexed object using the provided id.

Specified by:

deleteIndexedObject in interface LowLevelIndexingService

deleteByQuery

public void deleteByQuery(String aliasName,
 com.fasterxml.jackson.databind.node.ObjectNode query)

Description copied from interface: LowLevelIndexingService

Delete indexed objects based on a query.

Specified by:

deleteByQuery in interface LowLevelIndexingService

scheduleUpdateByQuery

public void scheduleUpdateByQuery(String mappingType,
 com.fasterxml.jackson.databind.node.ObjectNode updateByQueryBody)

Description copied from interface: IndexingService

Schedule an update by query with an abitrary body. The mappingType parameter is used to determine which indexes this will be applied to.

Specified by:

scheduleUpdateByQuery in interface IndexingService

updateByQuery

public void updateByQuery(String mappingType,
 com.fasterxml.jackson.databind.node.ObjectNode data)

Description copied from interface: LowLevelIndexingService

Perform Update by Query for the given Mapping type.

Specified by:

updateByQuery in interface LowLevelIndexingService

Parameters:

mappingType - the type of the mapping for which the update should be done

data - the update by query request data

scheduleIndexedObjectDelete

public void scheduleIndexedObjectDelete(String aliasName,
 String id)

Description copied from interface: IndexingService

Schedule a delete of an object from an index.

Specified by:

scheduleIndexedObjectDelete in interface IndexingService

addToCurrentBulkRequestAsUpsert

public void addToCurrentBulkRequestAsUpsert(CommandContext commandContext,
 String type,
 com.fasterxml.jackson.databind.node.ObjectNode data,
 String idFieldName)

Description copied from interface: LowLevelIndexingService

Adds the ObjectNode data as an upsert (i.e. merge if exist, insert if not) to the current bulk request (or creates a bulk request if needed). The bulk request is executed at the end of the transactions, when all items for indexing have been added.

Specified by:

addToCurrentBulkRequestAsUpsert in interface LowLevelIndexingService

addToCurrentBulkRequestAsFullIndex

public void addToCurrentBulkRequestAsFullIndex(CommandContext commandContext,
 String type,
 String id,
 com.fasterxml.jackson.databind.node.ObjectNode data,
 String idFieldName)

Description copied from interface: LowLevelIndexingService

Adds the ObjectNode data as a full index (i.e. replace the current indexed document if any exists) to the current bulk request (or creates a bulk request if needed). The bulk request is executed at the end of the transactions, when all items for indexing have been added. The {type, id} parameters are not used during indexing, but is registered internally and can be used to check whether indexing was already triggered via the LowLevelIndexingService.isFullIndexRegisteredOnCurrentBulkRequest(CommandContext, String, String) method. This allows to avoid costly recalculation of data or doing the same indexing operation multiple times in ES. Note that this method doesn't apply that check automatically, and the caller is responsible for calling it.

Specified by:

addToCurrentBulkRequestAsFullIndex in interface LowLevelIndexingService

addToCurrentBulkRequestAsFullIndexWithExternalVersion

public void addToCurrentBulkRequestAsFullIndexWithExternalVersion(CommandContext commandContext,
 String type,
 String id,
 com.fasterxml.jackson.databind.node.ObjectNode data,
 String idFieldName,
 LowLevelIndexingService.BulkIndexRequestConflictHandler bulkIndexRequestConflictHandler)

Description copied from interface: LowLevelIndexingService

Equivalent to LowLevelIndexingService.addToCurrentBulkRequestAsFullIndex(CommandContext, String, String, ObjectNode, String), but using external versioning (vs the one from Elasticsearch).

Specified by:

addToCurrentBulkRequestAsFullIndexWithExternalVersion in interface LowLevelIndexingService

addToCurrentBulkRequestAsUpsertWithScript

public void addToCurrentBulkRequestAsUpsertWithScript(CommandContext commandContext,
 com.fasterxml.jackson.databind.node.ObjectNode dataNode,
 com.fasterxml.jackson.databind.node.ObjectNode scriptNode,
 String idFieldName)

Description copied from interface: LowLevelIndexingService

Adds the ObjectNode data as an upsert (i.e. merge if exist, insert if not) using an update script to the current bulk request (or creates a bulk request if needed). The bulk request is executed at the end of the transactions, when all items for indexing have been added.

Specified by:

addToCurrentBulkRequestAsUpsertWithScript in interface LowLevelIndexingService

isFullIndexRegisteredOnCurrentBulkRequest

public boolean isFullIndexRegisteredOnCurrentBulkRequest(CommandContext commandContext,
 String type,
 String id)

Description copied from interface: LowLevelIndexingService

Returns whether a full index was already registered before during the current transaction. Used in conjunction with the {type, id} parameters in the LowLevelIndexingService.addToCurrentBulkRequestAsFullIndex(CommandContext, String, String, ObjectNode, String) method.

Specified by:

isFullIndexRegisteredOnCurrentBulkRequest in interface LowLevelIndexingService

determineIndex

protected String determineIndex(com.fasterxml.jackson.databind.node.ObjectNode objectNode,
 IndexedDataObject indexedDataObject)

determineIndex

protected String determineIndex(IndexMapping indexMapping)

createHistoryJobEntity

protected HistoryJobEntity createHistoryJobEntity(String handlerType)