Package com.flowable.platform.service.index

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<CaseInstanceSearchRepresentation>	caseInstanceResultFilter
protected CaseInstanceResultMapper	caseInstanceResultMapper
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 com.fasterxml.jackson.databind.ObjectMapper	objectMapper
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 com.flowable.platform.security.service.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, 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 PlatformIndexQueryRequest, Q extends PlatformIndexQueryBuilder<REQ>> Page<RES>	fetchData(REQ request, Set<String> indices, ElasticsearchResultConverter.ResultMapper<RES> jsonMapper, Supplier<Q> queryBuilderSupplier)
com.fasterxml.jackson.databind.JsonNode	findCaseInstance(String caseInstanceId)
Page<CaseInstanceSearchRepresentation>	findCaseInstancesWithQuery(CaseInstancesIndexQueryRequest request)
Page<CaseInstanceSearchRepresentation>	findCaseInstancesWithQuery(String filterId, CaseInstancesIndexQueryRequest request)
Page<PlatformGlobalSearchRepresentation>	findGlobalInstancesWithQuery(PlatformGlobalSearchIndexQueryRequest request)
com.fasterxml.jackson.databind.JsonNode	findProcessInstance(String processInstanceId)
Page<ProcessInstanceSearchRepresentation>	findProcessInstancesWithQuery(ProcessInstancesIndexQueryRequest request)
Page<ProcessInstanceSearchRepresentation>	findProcessInstancesWithQuery(String filterId, ProcessInstancesIndexQueryRequest request)
com.fasterxml.jackson.databind.JsonNode	findTask(String taskId)
Page<TaskSearchRepresentation>	findTasksWithQuery(TasksIndexQueryRequest request)
Page<TaskSearchRepresentation>	findTasksWithQuery(String filterId, TasksIndexQueryRequest request)
Page<TaskSearchRepresentation>	findTasksWithQueryWithoutPermissions(TasksIndexQueryRequest request)
com.fasterxml.jackson.databind.JsonNode	findWorkInstance(String workInstanceId)
Page<WorkInstanceSearchRepresentation>	findWorkInstancesWithQuery(WorkInstancesIndexQueryRequest request)
Page<WorkInstanceSearchRepresentation>	findWorkInstancesWithQueryWithoutPermissions(WorkInstancesIndexQueryRequest request)
protected com.fasterxml.jackson.databind.JsonNode	getCaseInstanceResultNode(String caseInstanceId)
protected Map<String,ConfigParameter>	getConfigParameters(Map<String,QueryParameter> queryParameters)
protected Map<String,SortParameter>	getCustomSortParameters(PlatformIndexQueryRequest request, String index, String queryName)
protected Set<String>	getIndices(PlatformGlobalSearchIndexQueryRequest request)
protected <RES, REQ extends PlatformIndexQueryRequest, Q extends PlatformIndexQueryBuilder<REQ>> Page<RES>	getInstanceRepresentationPage(REQ request, String index, ElasticsearchResultConverter.ResultMapper<RES> jsonMapper, ResultFilter<RES> resultFilter, Supplier<Q> queryBuilderSupplier)
protected <RES, REQ extends PlatformIndexQueryRequest, Q extends PlatformIndexQueryBuilder<REQ>> Page<RES>	getInstanceRepresentationPage(REQ request, Set<String> indices, ElasticsearchResultConverter.ResultMapper<RES> jsonMapper, ResultFilter<RES> resultFilter, Supplier<Q> queryBuilderSupplier)
protected com.fasterxml.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 com.fasterxml.jackson.databind.JsonNode	getProcessInstanceResultNode(String processInstanceId)
protected Map<String,SortParameter>	getSortParameters(Map<String,QuerySortParameter> querySortParameters)
protected com.fasterxml.jackson.databind.JsonNode	getTasksResultNode(String taskId)
protected QueryDefinitionModel	getTemplateDefinition(String queryKey)
protected List<TemplateParameter>	getTemplateParameters(Map<String,QueryParameter> queryParameters)
protected com.fasterxml.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 com.fasterxml.jackson.databind.node.ObjectNode	processSafeQueryTemplate(QueryDefinitionModel queryModel, Map<String,Object> payload)
protected <T> Page<T>	queryWithCustomQuery(Set<String> indices, PlatformIndexQueryRequest request, QueryDefinitionModel queryModel, ElasticsearchResultConverter.ResultMapper<T> jsonMapper)
protected <RES, REQ extends PlatformIndexQueryRequest, Q extends PlatformIndexQueryBuilder<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 com.flowable.platform.security.service.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 java.lang.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 com.fasterxml.jackson.databind.ObjectMapper objectMapper

processInstanceResultMapper

@Autowired
protected ProcessInstanceResultMapper processInstanceResultMapper

caseInstanceResultMapper

@Autowired
protected CaseInstanceResultMapper caseInstanceResultMapper

taskResultMapper

@Autowired
protected TaskResultMapper taskResultMapper

workInstanceResultMapper

@Autowired
protected WorkInstanceResultMapper workInstanceResultMapper

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

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,
 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 com.fasterxml.jackson.databind.JsonNode findProcessInstance(String processInstanceId)

findCaseInstancesWithQuery

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

findCaseInstancesWithQuery

public Page<CaseInstanceSearchRepresentation> findCaseInstancesWithQuery(CaseInstancesIndexQueryRequest request)

findCaseInstance

public com.fasterxml.jackson.databind.JsonNode findCaseInstance(String caseInstanceId)

findWorkInstancesWithQuery

public Page<WorkInstanceSearchRepresentation> findWorkInstancesWithQuery(WorkInstancesIndexQueryRequest request)

findWorkInstancesWithQueryWithoutPermissions

public Page<WorkInstanceSearchRepresentation> findWorkInstancesWithQueryWithoutPermissions(WorkInstancesIndexQueryRequest request)

findWorkInstance

public com.fasterxml.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 com.fasterxml.jackson.databind.JsonNode findTask(String taskId)

getInstanceRepresentationPage

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

getInstanceRepresentationPage

protected <RES,
REQ extends PlatformIndexQueryRequest,
Q extends PlatformIndexQueryBuilder<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 PlatformIndexQueryRequest,
Q extends PlatformIndexQueryBuilder<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,
 PlatformIndexQueryRequest request,
 QueryDefinitionModel queryModel,
 ElasticsearchResultConverter.ResultMapper<T> jsonMapper)

queryWithSafeQuery

protected <RES,
REQ extends PlatformIndexQueryRequest,
Q extends PlatformIndexQueryBuilder<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 com.fasterxml.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(PlatformIndexQueryRequest request,
 String index,
 String queryName)

getSortParameters

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

transformSortParameter

protected SortParameter transformSortParameter(QuerySortParameter querySortParameter)

getProcessInstanceResultNode

protected com.fasterxml.jackson.databind.JsonNode getProcessInstanceResultNode(String processInstanceId)

getCaseInstanceResultNode

protected com.fasterxml.jackson.databind.JsonNode getCaseInstanceResultNode(String caseInstanceId)

getWorkInstanceResultNode

protected com.fasterxml.jackson.databind.JsonNode getWorkInstanceResultNode(String workInstanceId)

getTasksResultNode

protected com.fasterxml.jackson.databind.JsonNode getTasksResultNode(String taskId)

getInstanceResultNode

protected com.fasterxml.jackson.databind.JsonNode getInstanceResultNode(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)