Package com.flowable.indexing.api

Interface PlatformIndexedDataEnhancer

  • All Known Implementing Classes:
    IndexedDataEnhancerAdapter
    public interface PlatformIndexedDataEnhancer
    Implements callback methods to enhance the data before it gets indexed. Note that there is a big difference when using asynchronous history or not: - When using async history, the various methods like enhanceProcessInstanceStartData, enhanceProcessInstanceEndData need to be implemented AND the enhanceHistoricProcessInstanceReindexData needs to be implement similarly to cover the reindexing use case - When using synch history however, only the reindex methods need to be implemented. The reason for this is that the indexing based on sync history is equivalent to trigger a reindex for one specific instance (process, case, task, etc.) Implementing the non-reindex methods will not have any impact. Use the IndexedDataEnhancerAdapter when not all methods are overridden.

    • Method Detail

      • enhanceProcessInstanceStartData

        void enhanceProcessInstanceStartData​(ExecutionEntity processInstance,
                                     com.fasterxml.jackson.databind.node.ObjectNode data,
                                     IndexingManagerHelper indexingManagerHelper)

      • enhanceProcessInstanceNameChangeData

        void enhanceProcessInstanceNameChangeData​(ExecutionEntity processInstance,
                                          String newName,
                                          com.fasterxml.jackson.databind.node.ObjectNode data,
                                          IndexingManagerHelper indexingManagerHelper)

      • enhanceProcessInstanceBusinessKeyChangeData

        void enhanceProcessInstanceBusinessKeyChangeData​(ExecutionEntity processInstance,
                                                 String newBusinessKey,
                                                 com.fasterxml.jackson.databind.node.ObjectNode data,
                                                 IndexingManagerHelper indexingManagerHelper)

      • enhanceProcessInstanceBusinessStatusChangeData

        void enhanceProcessInstanceBusinessStatusChangeData​(ExecutionEntity processInstance,
                                                    String newBusinessStatus,
                                                    com.fasterxml.jackson.databind.node.ObjectNode data,
                                                    IndexingManagerHelper indexingManagerHelper)

      • enhanceProcessInstanceEndData

        void enhanceProcessInstanceEndData​(ExecutionEntity processInstance,
                                   com.fasterxml.jackson.databind.node.ObjectNode data,
                                   IndexingManagerHelper indexingManagerHelper)

      • enhanceProcessDefinitionChangeData

        void enhanceProcessDefinitionChangeData​(ExecutionEntity processInstance,
                                        String processDefinitionId,
                                        com.fasterxml.jackson.databind.node.ObjectNode data,
                                        IndexingManagerHelper indexingManagerHelper)

      • enhanceHistoricProcessInstanceReindexData

        void enhanceHistoricProcessInstanceReindexData​(HistoricProcessInstance historicProcessInstance,
                                               com.fasterxml.jackson.databind.node.ObjectNode data,
                                               IndexingManagerHelper indexingManagerHelper)

      • enhanceActivityEndData

        void enhanceActivityEndData​(ActivityInstance activityInstance,
                            com.fasterxml.jackson.databind.node.ObjectNode data,
                            IndexingManagerHelper indexingManagerHelper)

      • enhanceActivityChangeData

        void enhanceActivityChangeData​(ActivityInstance activityInstance,
                               com.fasterxml.jackson.databind.node.ObjectNode data,
                               IndexingManagerHelper indexingManagerHelper)

      • enhanceActivityStartData

        void enhanceActivityStartData​(ActivityInstance activityInstance,
                              com.fasterxml.jackson.databind.node.ObjectNode data,
                              IndexingManagerHelper indexingManagerHelper)

      • enhanceHistoricActivityReindexData

        void enhanceHistoricActivityReindexData​(HistoricActivityInstance historicActivityInstance,
                                        com.fasterxml.jackson.databind.node.ObjectNode data,
                                        IndexingManagerHelper indexingManagerHelper)

      • enhanceCaseInstanceStartData

        void enhanceCaseInstanceStartData​(CaseInstanceEntity caseInstanceEntity,
                                  com.fasterxml.jackson.databind.node.ObjectNode data,
                                  IndexingManagerHelper indexingManagerHelper)

      • enhanceCaseInstanceNameChangeData

        void enhanceCaseInstanceNameChangeData​(CaseInstanceEntity caseInstanceEntity,
                                       String newName,
                                       com.fasterxml.jackson.databind.node.ObjectNode data,
                                       IndexingManagerHelper indexingManagerHelper)

      • enhanceCaseInstanceBusinessKeyChangeData

        void enhanceCaseInstanceBusinessKeyChangeData​(CaseInstanceEntity caseInstanceEntity,
                                              String newBusinessKey,
                                              com.fasterxml.jackson.databind.node.ObjectNode data,
                                              IndexingManagerHelper indexingManagerHelper)

      • enhanceCaseInstanceBusinessStatusChangeData

        void enhanceCaseInstanceBusinessStatusChangeData​(CaseInstanceEntity caseInstanceEntity,
                                                 String newBusinessStatus,
                                                 com.fasterxml.jackson.databind.node.ObjectNode data,
                                                 IndexingManagerHelper indexingManagerHelper)

      • enhanceCaseInstanceCaseDefinitionChangeData

        void enhanceCaseInstanceCaseDefinitionChangeData​(CaseInstanceEntity caseInstanceEntity,
                                                 CaseDefinition caseDefinition,
                                                 com.fasterxml.jackson.databind.node.ObjectNode data,
                                                 IndexingManagerHelper indexingManagerHelper)

      • enhanceCaseInstanceEndData

        void enhanceCaseInstanceEndData​(CaseInstanceEntity caseInstanceEntity,
                                com.fasterxml.jackson.databind.node.ObjectNode data,
                                IndexingManagerHelper indexingManagerHelper)

      • enhanceCaseInstanceReactivated

        void enhanceCaseInstanceReactivated​(CaseInstanceEntity caseInstanceEntity,
                                    com.fasterxml.jackson.databind.node.ObjectNode data,
                                    IndexingManagerHelper indexingManagerHelper)

      • enhanceHistoricCaseInstanceReindexData

        void enhanceHistoricCaseInstanceReindexData​(HistoricCaseInstance historicCaseInstance,
                                            com.fasterxml.jackson.databind.node.ObjectNode data,
                                            IndexingManagerHelper indexingManagerHelper)

      • enhancePlanItemInstanceCreateData

        void enhancePlanItemInstanceCreateData​(PlanItemInstanceEntity planItemInstanceEntity,
                                       com.fasterxml.jackson.databind.node.ObjectNode data,
                                       IndexingManagerHelper indexingManagerHelper)

      • enhancePlanItemInstanceUpdateData

        void enhancePlanItemInstanceUpdateData​(PlanItemInstanceEntity planItemInstanceEntity,
                                       com.fasterxml.jackson.databind.node.ObjectNode data,
                                       IndexingManagerHelper indexingManagerHelper)

      • enhancePlanItemInstanceAvailableData

        void enhancePlanItemInstanceAvailableData​(PlanItemInstanceEntity planItemInstanceEntity,
                                          com.fasterxml.jackson.databind.node.ObjectNode data,
                                          IndexingManagerHelper indexingManagerHelper)

      • enhancePlanItemInstanceUnavailableData

        void enhancePlanItemInstanceUnavailableData​(PlanItemInstanceEntity planItemInstanceEntity,
                                            com.fasterxml.jackson.databind.node.ObjectNode data,
                                            IndexingManagerHelper indexingManagerHelper)

      • enhancePlanItemInstanceEnabledData

        void enhancePlanItemInstanceEnabledData​(PlanItemInstanceEntity planItemInstanceEntity,
                                        com.fasterxml.jackson.databind.node.ObjectNode data,
                                        IndexingManagerHelper indexingManagerHelper)

      • enhancePlanItemInstanceDisabledData

        void enhancePlanItemInstanceDisabledData​(PlanItemInstanceEntity planItemInstanceEntity,
                                         com.fasterxml.jackson.databind.node.ObjectNode data,
                                         IndexingManagerHelper indexingManagerHelper)

      • enhancePlanItemInstanceStartedData

        void enhancePlanItemInstanceStartedData​(PlanItemInstanceEntity planItemInstanceEntity,
                                        com.fasterxml.jackson.databind.node.ObjectNode data,
                                        IndexingManagerHelper indexingManagerHelper)

      • enhancePlanItemInstanceSuspendedData

        void enhancePlanItemInstanceSuspendedData​(PlanItemInstanceEntity planItemInstanceEntity,
                                          com.fasterxml.jackson.databind.node.ObjectNode data,
                                          IndexingManagerHelper indexingManagerHelper)

      • enhancePlanItemInstanceCompletedData

        void enhancePlanItemInstanceCompletedData​(PlanItemInstanceEntity planItemInstanceEntity,
                                          com.fasterxml.jackson.databind.node.ObjectNode data,
                                          IndexingManagerHelper indexingManagerHelper)

      • enhancePlanItemInstanceOccurredData

        void enhancePlanItemInstanceOccurredData​(PlanItemInstanceEntity planItemInstanceEntity,
                                         com.fasterxml.jackson.databind.node.ObjectNode data,
                                         IndexingManagerHelper indexingManagerHelper)

      • enhancePlanItemInstanceTerminatedData

        void enhancePlanItemInstanceTerminatedData​(PlanItemInstanceEntity planItemInstanceEntity,
                                           com.fasterxml.jackson.databind.node.ObjectNode data,
                                           IndexingManagerHelper indexingManagerHelper)

      • enhancePlanItemInstanceExitedData

        void enhancePlanItemInstanceExitedData​(PlanItemInstanceEntity planItemInstanceEntity,
                                       com.fasterxml.jackson.databind.node.ObjectNode data,
                                       IndexingManagerHelper indexingManagerHelper)

      • enhanceHistoricPlanItemInstanceReindexData

        void enhanceHistoricPlanItemInstanceReindexData​(HistoricPlanItemInstance historicPlanItemInstance,
                                                com.fasterxml.jackson.databind.node.ObjectNode data,
                                                IndexingManagerHelper indexingManagerHelper)

      • enhanceTaskCreateData

        void enhanceTaskCreateData​(TaskEntity taskEntity,
                           com.fasterxml.jackson.databind.node.ObjectNode data,
                           IndexingManagerHelper indexingManagerHelper)

      • enhanceTaskInfoChangeData

        void enhanceTaskInfoChangeData​(TaskEntity taskEntity,
                               com.fasterxml.jackson.databind.node.ObjectNode data,
                               IndexingManagerHelper indexingManagerHelper)

      • enhanceTaskEndData

        void enhanceTaskEndData​(TaskEntity taskEntity,
                        com.fasterxml.jackson.databind.node.ObjectNode data,
                        IndexingManagerHelper indexingManagerHelper)

      • enhanceContentItemCreateData

        void enhanceContentItemCreateData​(ContentItemEntity contentItemEntity,
                                  com.fasterxml.jackson.databind.node.ObjectNode data,
                                  IndexingManagerHelper indexingManagerHelper)

      • enhanceContentItemUpdateData

        void enhanceContentItemUpdateData​(ContentItemEntity contentItemEntity,
                                  com.fasterxml.jackson.databind.node.ObjectNode data,
                                  IndexingManagerHelper indexingManagerHelper)

      • enhanceMetadataInstanceCreateData

        void enhanceMetadataInstanceCreateData​(MetadataInstanceEntity metadataInstanceEntity,
                                       com.fasterxml.jackson.databind.node.ObjectNode data,
                                       IndexingManagerHelper indexingManagerHelper)

      • enhanceMetadataInstanceUpdateData

        void enhanceMetadataInstanceUpdateData​(MetadataInstanceEntity metadataInstanceEntity,
                                       com.fasterxml.jackson.databind.node.ObjectNode data,
                                       IndexingManagerHelper indexingManagerHelper)

      • enhanceMetadataInstanceRemoveData

        void enhanceMetadataInstanceRemoveData​(MetadataInstanceEntity metadataInstanceEntity,
                                       com.fasterxml.jackson.databind.node.ObjectNode data,
                                       IndexingManagerHelper indexingManagerHelper)

      • enhanceContentItemReindexData

        void enhanceContentItemReindexData​(ContentItemEntity contentItemEntity,
                                   com.fasterxml.jackson.databind.node.ObjectNode data,
                                   IndexingManagerHelper indexingManagerHelper)

      • enhanceIdentityLinkCreateData

        void enhanceIdentityLinkCreateData​(IdentityLinkEntity identityLinkEntity,
                                   com.fasterxml.jackson.databind.node.ObjectNode data,
                                   IndexingManagerHelper indexingManagerHelper)

      • enhanceIdentityLinkRemoveData

        void enhanceIdentityLinkRemoveData​(IdentityLinkEntity identityLinkEntity,
                                   com.fasterxml.jackson.databind.node.ObjectNode data,
                                   IndexingManagerHelper indexingManagerHelper)