Class WorkIndexService

java.lang.Object

com.flowable.platform.security.service.AbstractPlatformSecurityService

com.flowable.platform.service.index.WorkIndexService

All Implemented Interfaces:

PermissionServiceRegistryAware, Aware

@Transactional
public class WorkIndexService
extends AbstractPlatformSecurityService

Author:

Javier Casal, Joram Barrez, Filip Hrisafov, Yvo Swillens

Field Summary

Fields

Modifier and Type	Field	Description
protected ResultFilter<ActivitySearchRepresentation>	activityResultFilter
protected ActivityResultMapper	activityResultMapper
protected AgentInstanceResultMapper	agentInstanceResultMapper
protected AgentInvocationResultMapper	agentInvocationResultMapper
protected ResultFilter<CaseInstanceSearchRepresentation>	caseInstanceResultFilter
protected CaseInstanceResultMapper	caseInstanceResultMapper
protected ResultFilter<ContentItemRepresentation>	contentItemResultFilter
protected ContentItemResultMapper	contentItemResultMapper
protected Collection<String>	enabledIndices
protected boolean	enableQueryTest
static final String	FILTER_ALL
static final String	FILTER_ASSIGNED_TO_ME
static final String	FILTER_COMPLETED
static final String	FILTER_MINE
static final String	FILTER_OPEN
static final String	FILTER_RUNNING
static final String	FILTER_UNASSIGNED
protected List<String>	filters
protected PlatformIdentityService	identityService
protected IndexManager	indexManager
protected tools.jackson.databind.ObjectMapper	objectMapper
protected ResultFilter<PlanItemSearchRepresentation>	planItemResultFilter
protected PlanItemResultMapper	planItemResultMapper
protected ResultFilter<PlatformGlobalSearchRepresentation>	platformGlobalSearchResultFilter
protected PlatformGlobalSearchResultMapper	platformGlobalSearchResultMapper
protected PlatformRepositoryService	platformRepositoryService
protected ResultFilter<ProcessInstanceSearchRepresentation>	processInstanceResultFilter
protected ProcessInstanceResultMapper	processInstanceResultMapper
protected SearchService	searchService
protected SecurityHelper	securityHelper
protected ResultFilter<TaskSearchRepresentation>	taskInstanceResultFilter
protected TaskResultMapper	taskResultMapper
protected TemplateService	templateService
protected ResultFilter<WorkInstanceSearchRepresentation>	workInstanceResultFilter
protected WorkInstanceResultMapper	workInstanceResultMapper

Fields inherited from class AbstractPlatformSecurityService

additionalAdminUsers, CASE_PREFIX, cmmnRepositoryService, cmmnRuntimeService, cmmnTaskService, defaultSecurityPolicyKey, defaultSecurityPolicyModel, EXTERNAL_WORKER_PREFIX, inspectEnabled, permissionServiceRegistry, platformSecurityInterceptor, policyRepositoryService, PROCESS_PREFIX, repositoryService, runtimeService, SECURITY_POLICY_MODEL, TASK_PREFIX, taskService

Constructor Summary

Constructors

Constructor

Description

WorkIndexService(ResultFilter<ProcessInstanceSearchRepresentation> processInstanceResultFilter, ResultFilter<CaseInstanceSearchRepresentation> caseInstanceResultFilter, ResultFilter<WorkInstanceSearchRepresentation> workInstanceResultFilter, ResultFilter<TaskSearchRepresentation> taskInstanceResultFilter, ResultFilter<ActivitySearchRepresentation> activityResultFilter, ResultFilter<PlanItemSearchRepresentation> planItemResultFilter, ResultFilter<ContentItemRepresentation> contentItemResultFilter, Collection<String> enabledIndices, boolean enableQueryTest)

Method Summary

Modifier and Type	Method	Description
protected void	addPermissions(PlatformIndexQueryRequest request)
protected <T> Page<T>	createInstancesPage(Page<T> page)
protected <RES, REQ extends AbstractIndexQueryRequest, Q extends AbstractIndexQueryBuilder<REQ>> Page<RES>	fetchData(REQ request, Set<String> indices, ElasticsearchResultConverter.ResultMapper<RES> jsonMapper, Supplier<Q> queryBuilderSupplier)
Page<ActivitySearchRepresentation>	findActivitiesWithQueryWithoutPermissions(ActivitiesIndexQueryRequest request)
tools.jackson.databind.JsonNode	findActivity(String activityId)
tools.jackson.databind.JsonNode	findAgentInstance(String agentInstanceId)
Page<AgentInstanceSearchRepresentation>	findAgentInstancesWithQuery(AgentInstancesIndexQueryRequest request)
tools.jackson.databind.JsonNode	findAgentInvocation(String agentInvocationId)
Page<AgentInvocationSearchRepresentation>	findAgentInvocationsWithQuery(AgentInvocationsIndexQueryRequest request)
tools.jackson.databind.JsonNode	findCaseInstance(String caseInstanceId)
Page<CaseInstanceSearchRepresentation>	findCaseInstancesWithQuery(CaseInstancesIndexQueryRequest request)
Page<CaseInstanceSearchRepresentation>	findCaseInstancesWithQuery(String filterId, CaseInstancesIndexQueryRequest request)
tools.jackson.databind.JsonNode	findContentItem(String contentItemId)
Page<ContentItemRepresentation>	findContentItemsWithQueryWithoutPermissions(ContentItemsIndexQueryRequest request)
Page<PlatformGlobalSearchRepresentation>	findGlobalInstancesWithQuery(PlatformGlobalSearchIndexQueryRequest request)
tools.jackson.databind.JsonNode	findPlanItem(String planItemId)
Page<PlanItemSearchRepresentation>	findPlanItemsWithQueryWithoutPermissions(PlanItemsIndexQueryRequest request)
tools.jackson.databind.JsonNode	findProcessInstance(String processInstanceId)
Page<ProcessInstanceSearchRepresentation>	findProcessInstancesWithQuery(ProcessInstancesIndexQueryRequest request)
Page<ProcessInstanceSearchRepresentation>	findProcessInstancesWithQuery(String filterId, ProcessInstancesIndexQueryRequest request)
tools.jackson.databind.JsonNode	findTask(String taskId)
Page<TaskSearchRepresentation>	findTasksWithQuery(TasksIndexQueryRequest request)
Page<TaskSearchRepresentation>	findTasksWithQuery(String filterId, TasksIndexQueryRequest request)
Page<TaskSearchRepresentation>	findTasksWithQueryWithoutPermissions(TasksIndexQueryRequest request)
tools.jackson.databind.JsonNode	findWorkInstance(String workInstanceId)
Page<WorkInstanceSearchRepresentation>	findWorkInstancesWithQuery(WorkInstancesIndexQueryRequest request)
Page<WorkInstanceSearchRepresentation>	findWorkInstancesWithQueryWithoutPermissions(WorkInstancesIndexQueryRequest request)
protected tools.jackson.databind.JsonNode	getActivitiesResultNode(String activityId)
protected tools.jackson.databind.JsonNode	getCaseInstanceResultNode(String caseInstanceId)
protected Map<String, ConfigParameter>	getConfigParameters(Map<String, QueryParameter> queryParameters)
protected tools.jackson.databind.JsonNode	getContentItemsResultNode(String planItemId)
protected Map<String, SortParameter>	getCustomSortParameters(AbstractIndexQueryRequest request, String index, String queryName)
protected Set<String>	getIndices(PlatformGlobalSearchIndexQueryRequest request)
protected <RES, REQ extends AbstractIndexQueryRequest, Q extends AbstractIndexQueryBuilder<REQ>> Page<RES>	getInstanceRepresentationPage(REQ request, String index, ElasticsearchResultConverter.ResultMapper<RES> jsonMapper, ResultFilter<RES> resultFilter, Supplier<Q> queryBuilderSupplier)
protected <RES, REQ extends AbstractIndexQueryRequest, Q extends AbstractIndexQueryBuilder<REQ>> Page<RES>	getInstanceRepresentationPage(REQ request, Set<String> indices, ElasticsearchResultConverter.ResultMapper<RES> jsonMapper, ResultFilter<RES> resultFilter, Supplier<Q> queryBuilderSupplier)
protected tools.jackson.databind.JsonNode	getInstanceResultNode(FilteredFullTextSearchQueryBuilder queryBuilder, String instanceId, String index)
protected tools.jackson.databind.JsonNode	getInstanceResultNode(String instanceId, String index)
protected <T> Page<T>	getPageFromQuery(int start, int size, String index, ElasticsearchResultConverter.ResultMapper<T> jsonMapper, String query, String sort, String order)
protected <T> Page<T>	getPageFromQuery(int start, int size, Set<String> indices, ElasticsearchResultConverter.ResultMapper<T> jsonMapper, String query, String sort, String order)
protected tools.jackson.databind.JsonNode	getPlanItemsResultNode(String planItemId)
protected tools.jackson.databind.JsonNode	getProcessInstanceResultNode(String processInstanceId)
protected Map<String, SortParameter>	getSortParameters(Map<String, QuerySortParameter> querySortParameters)
protected tools.jackson.databind.JsonNode	getTasksResultNode(String taskId)
protected QueryDefinitionModel	getTemplateDefinition(String queryKey)
protected List<TemplateParameter>	getTemplateParameters(Map<String, QueryParameter> queryParameters)
protected tools.jackson.databind.JsonNode	getWorkInstanceResultNode(String workInstanceId)
protected boolean	isCustomQuery(QueryDefinitionModel queryModel)
protected boolean	isIndexingDisabled(String index)
protected boolean	isSafeQuery(QueryDefinitionModel queryModel)
protected void	notAllowed()
protected String	processCustomQueryTemplate(QueryDefinitionModel queryModel, Map<String,Object> payload)
protected tools.jackson.databind.node.ObjectNode	processSafeQueryTemplate(QueryDefinitionModel queryModel, Map<String,Object> payload)
protected <T> Page<T>	queryWithCustomQuery(Set<String> indices, AbstractIndexQueryRequest request, QueryDefinitionModel queryModel, ElasticsearchResultConverter.ResultMapper<T> jsonMapper)
protected <RES, REQ extends AbstractIndexQueryRequest, Q extends AbstractIndexQueryBuilder<REQ>> Page<RES>	queryWithSafeQuery(REQ request, Set<String> indices, QueryDefinitionModel queryModel, ElasticsearchResultConverter.ResultMapper<RES> jsonMapper, Supplier<Q> queryBuilderSupplier)
protected ConfigParameter	transformQueryParameter(QueryParameter queryParameter)
protected TemplateParameter	transformQueryParameter(String key, QueryParameter queryParameter)
protected SortParameter	transformSortParameter(QuerySortParameter querySortParameter)

Methods inherited from class AbstractPlatformSecurityService

addAdditionalPermissions, currentUserHasAdminRights, currentUserIsSuperAdmin, fetchCasePermissionMappings, fetchCasePermissionMappings, fetchCaseSecurityPolicyModel, fetchPermissions, fetchPermissionsForTask, fetchProcessPermissionMappings, fetchProcessPermissionMappings, fetchProcessSecurityPolicyModel, fetchSecurityPolicyModel, fetchSecurityPolicyModel, fetchSecurityPolicyModelForCaseInstance, fetchSecurityPolicyModelForProcessInstance, fetchSecurityPolicyModelForTask, fetchSecurityPolicyModelForTask, fetchTaskPermissionMappings, fetchTaskPermissionMappings, fetchTaskPermissionMappings, fetchTaskPermissionMappingsForCase, fetchTaskPermissionMappingsForProcess, fetchTaskSecurityPolicyModelForCase, fetchTaskSecurityPolicyModelForProcess, filterPermissionsForRole, getCmmnExtensionElementValue, getCurrentGroupKeys, getCurrentSecurityScope, getCurrentTenantId, getCurrentUserId, getDefaultSecurityPolicyModel, getExtensionElementValue, getSecurityPolicyModelByKey, groupOrUserMatches, groupOrUserMatches, hasAnyMatchingIdentityLink, hasAssigneeOrOwnerIdentityLink, hasPermissionForEntityLinks, hasPermissionForHistoricEntityLinks, setPermissionServiceRegistry, translatePermissionForScope

Methods inherited from class Object

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

Field Details

FILTER_COMPLETED

public static final String FILTER_COMPLETED

See Also:

• Constant Field Values

FILTER_RUNNING

public static final String FILTER_RUNNING

See Also:

• Constant Field Values

FILTER_MINE

public static final String FILTER_MINE

See Also:

• Constant Field Values

FILTER_OPEN

public static final String FILTER_OPEN

See Also:

• Constant Field Values

FILTER_ALL

public static final String FILTER_ALL

See Also:

• Constant Field Values

FILTER_UNASSIGNED

public static final String FILTER_UNASSIGNED

See Also:

• Constant Field Values

FILTER_ASSIGNED_TO_ME

public static final String FILTER_ASSIGNED_TO_ME

See Also:

• Constant Field Values

filters

protected List<String> filters

searchService

@Autowired
protected SearchService searchService

indexManager

@Autowired
protected IndexManager indexManager

objectMapper

@Autowired
protected tools.jackson.databind.ObjectMapper objectMapper

processInstanceResultMapper

@Autowired
protected ProcessInstanceResultMapper processInstanceResultMapper

caseInstanceResultMapper

@Autowired
protected CaseInstanceResultMapper caseInstanceResultMapper

taskResultMapper

@Autowired
protected TaskResultMapper taskResultMapper

workInstanceResultMapper

@Autowired
protected WorkInstanceResultMapper workInstanceResultMapper

activityResultMapper

@Autowired
protected ActivityResultMapper activityResultMapper

planItemResultMapper

@Autowired
protected PlanItemResultMapper planItemResultMapper

contentItemResultMapper

@Autowired
protected ContentItemResultMapper contentItemResultMapper

agentInstanceResultMapper

@Autowired(required=false)
protected AgentInstanceResultMapper agentInstanceResultMapper

agentInvocationResultMapper

@Autowired(required=false)
protected AgentInvocationResultMapper agentInvocationResultMapper

platformGlobalSearchResultMapper

@Autowired
protected PlatformGlobalSearchResultMapper platformGlobalSearchResultMapper

identityService

@Autowired
protected PlatformIdentityService identityService

securityHelper

@Autowired
protected SecurityHelper securityHelper

platformRepositoryService

@Autowired
protected PlatformRepositoryService platformRepositoryService

templateService

@Autowired
protected TemplateService templateService

processInstanceResultFilter

protected ResultFilter<ProcessInstanceSearchRepresentation> processInstanceResultFilter

caseInstanceResultFilter

protected ResultFilter<CaseInstanceSearchRepresentation> caseInstanceResultFilter

workInstanceResultFilter

protected ResultFilter<WorkInstanceSearchRepresentation> workInstanceResultFilter

taskInstanceResultFilter

protected ResultFilter<TaskSearchRepresentation> taskInstanceResultFilter

activityResultFilter

protected ResultFilter<ActivitySearchRepresentation> activityResultFilter

planItemResultFilter

protected ResultFilter<PlanItemSearchRepresentation> planItemResultFilter

contentItemResultFilter

protected ResultFilter<ContentItemRepresentation> contentItemResultFilter

platformGlobalSearchResultFilter

protected ResultFilter<PlatformGlobalSearchRepresentation> platformGlobalSearchResultFilter

enabledIndices

protected Collection<String> enabledIndices

enableQueryTest

protected boolean enableQueryTest

Constructor Details

WorkIndexService

public WorkIndexService(ResultFilter<ProcessInstanceSearchRepresentation> processInstanceResultFilter,
 ResultFilter<CaseInstanceSearchRepresentation> caseInstanceResultFilter,
 ResultFilter<WorkInstanceSearchRepresentation> workInstanceResultFilter,
 ResultFilter<TaskSearchRepresentation> taskInstanceResultFilter,
 ResultFilter<ActivitySearchRepresentation> activityResultFilter,
 ResultFilter<PlanItemSearchRepresentation> planItemResultFilter,
 ResultFilter<ContentItemRepresentation> contentItemResultFilter,
 Collection<String> enabledIndices,
 boolean enableQueryTest)

Method Details

findGlobalInstancesWithQuery

public Page<PlatformGlobalSearchRepresentation> findGlobalInstancesWithQuery(PlatformGlobalSearchIndexQueryRequest request)

findProcessInstancesWithQuery

public Page<ProcessInstanceSearchRepresentation> findProcessInstancesWithQuery(String filterId,
 ProcessInstancesIndexQueryRequest request)

findProcessInstancesWithQuery

public Page<ProcessInstanceSearchRepresentation> findProcessInstancesWithQuery(ProcessInstancesIndexQueryRequest request)

findProcessInstance

public tools.jackson.databind.JsonNode findProcessInstance(String processInstanceId)

findCaseInstancesWithQuery

public Page<CaseInstanceSearchRepresentation> findCaseInstancesWithQuery(String filterId,
 CaseInstancesIndexQueryRequest request)

findCaseInstancesWithQuery

public Page<CaseInstanceSearchRepresentation> findCaseInstancesWithQuery(CaseInstancesIndexQueryRequest request)

findCaseInstance

public tools.jackson.databind.JsonNode findCaseInstance(String caseInstanceId)

findWorkInstancesWithQuery

public Page<WorkInstanceSearchRepresentation> findWorkInstancesWithQuery(WorkInstancesIndexQueryRequest request)

findWorkInstancesWithQueryWithoutPermissions

public Page<WorkInstanceSearchRepresentation> findWorkInstancesWithQueryWithoutPermissions(WorkInstancesIndexQueryRequest request)

findWorkInstance

public tools.jackson.databind.JsonNode findWorkInstance(String workInstanceId)

findTasksWithQuery

public Page<TaskSearchRepresentation> findTasksWithQuery(String filterId,
 TasksIndexQueryRequest request)

findTasksWithQuery

public Page<TaskSearchRepresentation> findTasksWithQuery(TasksIndexQueryRequest request)

findTasksWithQueryWithoutPermissions

public Page<TaskSearchRepresentation> findTasksWithQueryWithoutPermissions(TasksIndexQueryRequest request)

findTask

public tools.jackson.databind.JsonNode findTask(String taskId)

findActivitiesWithQueryWithoutPermissions

public Page<ActivitySearchRepresentation> findActivitiesWithQueryWithoutPermissions(ActivitiesIndexQueryRequest request)

findActivity

public tools.jackson.databind.JsonNode findActivity(String activityId)

findPlanItemsWithQueryWithoutPermissions

public Page<PlanItemSearchRepresentation> findPlanItemsWithQueryWithoutPermissions(PlanItemsIndexQueryRequest request)

findPlanItem

public tools.jackson.databind.JsonNode findPlanItem(String planItemId)

findContentItemsWithQueryWithoutPermissions

public Page<ContentItemRepresentation> findContentItemsWithQueryWithoutPermissions(ContentItemsIndexQueryRequest request)

findContentItem

public tools.jackson.databind.JsonNode findContentItem(String contentItemId)

findAgentInstancesWithQuery

public Page<AgentInstanceSearchRepresentation> findAgentInstancesWithQuery(AgentInstancesIndexQueryRequest request)

findAgentInstance

public tools.jackson.databind.JsonNode findAgentInstance(String agentInstanceId)

findAgentInvocationsWithQuery

public Page<AgentInvocationSearchRepresentation> findAgentInvocationsWithQuery(AgentInvocationsIndexQueryRequest request)

findAgentInvocation

public tools.jackson.databind.JsonNode findAgentInvocation(String agentInvocationId)

getInstanceRepresentationPage

protected <RES, REQ extends AbstractIndexQueryRequest, Q extends AbstractIndexQueryBuilder<REQ>>
Page<RES> getInstanceRepresentationPage(REQ request,
 String index,
 ElasticsearchResultConverter.ResultMapper<RES> jsonMapper,
 ResultFilter<RES> resultFilter,
 Supplier<Q> queryBuilderSupplier)

getInstanceRepresentationPage

protected <RES, REQ extends AbstractIndexQueryRequest, Q extends AbstractIndexQueryBuilder<REQ>>
Page<RES> getInstanceRepresentationPage(REQ request,
 Set<String> indices,
 ElasticsearchResultConverter.ResultMapper<RES> jsonMapper,
 ResultFilter<RES> resultFilter,
 Supplier<Q> queryBuilderSupplier)

createInstancesPage

protected <T> Page<T> createInstancesPage(Page<T> page)

fetchData

protected <RES, REQ extends AbstractIndexQueryRequest, Q extends AbstractIndexQueryBuilder<REQ>>
Page<RES> fetchData(REQ request,
 Set<String> indices,
 ElasticsearchResultConverter.ResultMapper<RES> jsonMapper,
 Supplier<Q> queryBuilderSupplier)

isCustomQuery

protected boolean isCustomQuery(QueryDefinitionModel queryModel)

isSafeQuery

protected boolean isSafeQuery(QueryDefinitionModel queryModel)

getTemplateDefinition

protected QueryDefinitionModel getTemplateDefinition(String queryKey)

queryWithCustomQuery

protected <T> Page<T> queryWithCustomQuery(Set<String> indices,
 AbstractIndexQueryRequest request,
 QueryDefinitionModel queryModel,
 ElasticsearchResultConverter.ResultMapper<T> jsonMapper)

queryWithSafeQuery

protected <RES, REQ extends AbstractIndexQueryRequest, Q extends AbstractIndexQueryBuilder<REQ>>
Page<RES> queryWithSafeQuery(REQ request,
 Set<String> indices,
 QueryDefinitionModel queryModel,
 ElasticsearchResultConverter.ResultMapper<RES> jsonMapper,
 Supplier<Q> queryBuilderSupplier)

processCustomQueryTemplate

protected String processCustomQueryTemplate(QueryDefinitionModel queryModel,
 Map<String,Object> payload)

processSafeQueryTemplate

protected tools.jackson.databind.node.ObjectNode processSafeQueryTemplate(QueryDefinitionModel queryModel,
 Map<String,Object> payload)

getTemplateParameters

protected List<TemplateParameter> getTemplateParameters(Map<String, QueryParameter> queryParameters)

transformQueryParameter

protected TemplateParameter transformQueryParameter(String key,
 QueryParameter queryParameter)

getConfigParameters

protected Map<String, ConfigParameter> getConfigParameters(Map<String, QueryParameter> queryParameters)

transformQueryParameter

protected ConfigParameter transformQueryParameter(QueryParameter queryParameter)

getCustomSortParameters

protected Map<String, SortParameter> getCustomSortParameters(AbstractIndexQueryRequest request,
 String index,
 String queryName)

getSortParameters

protected Map<String, SortParameter> getSortParameters(Map<String, QuerySortParameter> querySortParameters)

transformSortParameter

protected SortParameter transformSortParameter(QuerySortParameter querySortParameter)

getProcessInstanceResultNode

protected tools.jackson.databind.JsonNode getProcessInstanceResultNode(String processInstanceId)

getCaseInstanceResultNode

protected tools.jackson.databind.JsonNode getCaseInstanceResultNode(String caseInstanceId)

getWorkInstanceResultNode

protected tools.jackson.databind.JsonNode getWorkInstanceResultNode(String workInstanceId)

getTasksResultNode

protected tools.jackson.databind.JsonNode getTasksResultNode(String taskId)

getActivitiesResultNode

protected tools.jackson.databind.JsonNode getActivitiesResultNode(String activityId)

getPlanItemsResultNode

protected tools.jackson.databind.JsonNode getPlanItemsResultNode(String planItemId)

getContentItemsResultNode

protected tools.jackson.databind.JsonNode getContentItemsResultNode(String planItemId)

getInstanceResultNode

protected tools.jackson.databind.JsonNode getInstanceResultNode(String instanceId,
 String index)

getInstanceResultNode

protected tools.jackson.databind.JsonNode getInstanceResultNode(FilteredFullTextSearchQueryBuilder queryBuilder,
 String instanceId,
 String index)

getPageFromQuery

protected <T> Page<T> getPageFromQuery(int start,
 int size,
 String index,
 ElasticsearchResultConverter.ResultMapper<T> jsonMapper,
 String query,
 String sort,
 String order)

getPageFromQuery

protected <T> Page<T> getPageFromQuery(int start,
 int size,
 Set<String> indices,
 ElasticsearchResultConverter.ResultMapper<T> jsonMapper,
 String query,
 String sort,
 String order)

addPermissions

protected void addPermissions(PlatformIndexQueryRequest request)

notAllowed

protected void notAllowed()

isIndexingDisabled

protected boolean isIndexingDisabled(String index)

getIndices

protected Set<String> getIndices(PlatformGlobalSearchIndexQueryRequest request)