All Downloads are FREE. Search and download functionalities are using the official Maven repository.
Please wait. This can take some minutes ...
Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
org.camunda.bpm.engine.rest.dto.runtime.ProcessInstanceQueryDto Maven / Gradle / Ivy
/*
* Copyright Camunda Services GmbH and/or licensed to Camunda Services GmbH
* under one or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information regarding copyright
* ownership. Camunda licenses this file to you under the Apache License,
* Version 2.0; you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.camunda.bpm.engine.rest.dto.runtime;
import static java.lang.Boolean.TRUE;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Set;
import javax.ws.rs.core.MultivaluedMap;
import javax.ws.rs.core.Response.Status;
import org.camunda.bpm.engine.ProcessEngine;
import org.camunda.bpm.engine.impl.ProcessInstanceQueryImpl;
import org.camunda.bpm.engine.rest.dto.AbstractQueryDto;
import org.camunda.bpm.engine.rest.dto.CamundaQueryParam;
import org.camunda.bpm.engine.rest.dto.VariableQueryParameterDto;
import org.camunda.bpm.engine.rest.dto.converter.BooleanConverter;
import org.camunda.bpm.engine.rest.dto.converter.StringListConverter;
import org.camunda.bpm.engine.rest.dto.converter.StringSetConverter;
import org.camunda.bpm.engine.rest.dto.converter.VariableListConverter;
import org.camunda.bpm.engine.rest.exception.InvalidRequestException;
import org.camunda.bpm.engine.runtime.ProcessInstanceQuery;
import com.fasterxml.jackson.databind.ObjectMapper;
public class ProcessInstanceQueryDto extends AbstractQueryDto {
private static final String SORT_BY_INSTANCE_ID_VALUE = "instanceId";
private static final String SORT_BY_DEFINITION_KEY_VALUE = "definitionKey";
private static final String SORT_BY_DEFINITION_ID_VALUE = "definitionId";
private static final String SORT_BY_TENANT_ID = "tenantId";
private static final String SORT_BY_BUSINESS_KEY = "businessKey";
private static final List VALID_SORT_BY_VALUES;
static {
VALID_SORT_BY_VALUES = new ArrayList();
VALID_SORT_BY_VALUES.add(SORT_BY_INSTANCE_ID_VALUE);
VALID_SORT_BY_VALUES.add(SORT_BY_DEFINITION_KEY_VALUE);
VALID_SORT_BY_VALUES.add(SORT_BY_DEFINITION_ID_VALUE);
VALID_SORT_BY_VALUES.add(SORT_BY_TENANT_ID);
VALID_SORT_BY_VALUES.add(SORT_BY_BUSINESS_KEY);
}
private String deploymentId;
private String processDefinitionKey;
private List processDefinitionKeys;
private List processDefinitionKeyNotIn;
private String businessKey;
private String businessKeyLike;
private String caseInstanceId;
private String processDefinitionId;
private String superProcessInstance;
private String subProcessInstance;
private String superCaseInstance;
private String subCaseInstance;
private Boolean active;
private Boolean suspended;
private Set processInstanceIds;
private Boolean withIncident;
private String incidentId;
private String incidentType;
private String incidentMessage;
private String incidentMessageLike;
private List tenantIds;
private Boolean withoutTenantId;
private List activityIds;
private Boolean rootProcessInstances;
private Boolean leafProcessInstances;
private Boolean isProcessDefinitionWithoutTenantId;
protected Boolean variableNamesIgnoreCase;
protected Boolean variableValuesIgnoreCase;
private List variables;
private List orQueries;
public ProcessInstanceQueryDto() {
}
public ProcessInstanceQueryDto(ObjectMapper objectMapper, MultivaluedMap queryParameters) {
super(objectMapper, queryParameters);
}
@CamundaQueryParam("orQueries")
public void setOrQueries(List orQueries) {
this.orQueries = orQueries;
}
public Set getProcessInstanceIds() {
return processInstanceIds;
}
@CamundaQueryParam(value = "processInstanceIds", converter = StringSetConverter.class)
public void setProcessInstanceIds(Set processInstanceIds) {
this.processInstanceIds = processInstanceIds;
}
public String getDeploymentId() {
return deploymentId;
}
@CamundaQueryParam("deploymentId")
public void setDeploymentId(String deploymentId) {
this.deploymentId = deploymentId;
}
public String getProcessDefinitionKey() {
return processDefinitionKey;
}
@CamundaQueryParam("processDefinitionKey")
public void setProcessDefinitionKey(String processDefinitionKey) {
this.processDefinitionKey = processDefinitionKey;
}
public List getProcessDefinitionKeys() {
return processDefinitionKeys;
}
@CamundaQueryParam(value = "processDefinitionKeyIn", converter = StringListConverter.class)
public void setProcessDefinitionKeyIn(List processDefinitionKeys) {
this.processDefinitionKeys = processDefinitionKeys;
}
public List getProcessDefinitionKeyNotIn() {
return processDefinitionKeyNotIn;
}
@CamundaQueryParam(value = "processDefinitionKeyNotIn", converter = StringListConverter.class)
public void setProcessDefinitionKeyNotIn(List processDefinitionKeys) {
this.processDefinitionKeyNotIn = processDefinitionKeys;
}
public String getBusinessKey() {
return businessKey;
}
@CamundaQueryParam("businessKey")
public void setBusinessKey(String businessKey) {
this.businessKey = businessKey;
}
public String getBusinessKeyLike() {
return businessKeyLike;
}
@CamundaQueryParam("businessKeyLike")
public void setBusinessKeyLike(String businessKeyLike) {
this.businessKeyLike = businessKeyLike;
}
public String getCaseInstanceId() {
return caseInstanceId;
}
@CamundaQueryParam("caseInstanceId")
public void setCaseInstanceId(String caseInstanceId) {
this.caseInstanceId = caseInstanceId;
}
public String getProcessDefinitionId() {
return processDefinitionId;
}
@CamundaQueryParam("processDefinitionId")
public void setProcessDefinitionId(String processDefinitionId) {
this.processDefinitionId = processDefinitionId;
}
public String getSuperProcessInstance() {
return superProcessInstance;
}
@CamundaQueryParam("superProcessInstance")
public void setSuperProcessInstance(String superProcessInstance) {
this.superProcessInstance = superProcessInstance;
}
public String getSubProcessInstance() {
return subProcessInstance;
}
@CamundaQueryParam("subProcessInstance")
public void setSubProcessInstance(String subProcessInstance) {
this.subProcessInstance = subProcessInstance;
}
public String getSuperCaseInstance() {
return superCaseInstance;
}
@CamundaQueryParam("superCaseInstance")
public void setSuperCaseInstance(String superCaseInstance) {
this.superCaseInstance = superCaseInstance;
}
public String getSubCaseInstance() {
return subCaseInstance;
}
@CamundaQueryParam("subCaseInstance")
public void setSubCaseInstance(String subCaseInstance) {
this.subCaseInstance = subCaseInstance;
}
public Boolean isActive() {
return active;
}
@CamundaQueryParam(value = "active", converter = BooleanConverter.class)
public void setActive(Boolean active) {
this.active = active;
}
public Boolean isSuspended() {
return suspended;
}
@CamundaQueryParam(value = "suspended", converter = BooleanConverter.class)
public void setSuspended(Boolean suspended) {
this.suspended = suspended;
}
public List getVariables() {
return variables;
}
@CamundaQueryParam(value = "variables", converter = VariableListConverter.class)
public void setVariables(List variables) {
this.variables = variables;
}
public Boolean isVariableNamesIgnoreCase() {
return variableNamesIgnoreCase;
}
@CamundaQueryParam(value = "variableNamesIgnoreCase", converter = BooleanConverter.class)
public void setVariableNamesIgnoreCase(Boolean variableNamesCaseInsensitive) {
this.variableNamesIgnoreCase = variableNamesCaseInsensitive;
}
public Boolean isVariableValuesIgnoreCase() {
return variableValuesIgnoreCase;
}
@CamundaQueryParam(value ="variableValuesIgnoreCase", converter = BooleanConverter.class)
public void setVariableValuesIgnoreCase(Boolean variableValuesCaseInsensitive) {
this.variableValuesIgnoreCase = variableValuesCaseInsensitive;
}
public Boolean isWithIncident() {
return withIncident;
}
@CamundaQueryParam(value = "withIncident", converter = BooleanConverter.class)
public void setWithIncident(Boolean withIncident) {
this.withIncident = withIncident;
}
public String getIncidentId() {
return incidentId;
}
@CamundaQueryParam(value = "incidentId")
public void setIncidentId(String incidentId) {
this.incidentId = incidentId;
}
public String getIncidentType() {
return incidentType;
}
@CamundaQueryParam(value = "incidentType")
public void setIncidentType(String incidentType) {
this.incidentType = incidentType;
}
public String getIncidentMessage() {
return incidentMessage;
}
@CamundaQueryParam(value = "incidentMessage")
public void setIncidentMessage(String incidentMessage) {
this.incidentMessage = incidentMessage;
}
public String getIncidentMessageLike() {
return incidentMessageLike;
}
@CamundaQueryParam(value = "incidentMessageLike")
public void setIncidentMessageLike(String incidentMessageLike) {
this.incidentMessageLike = incidentMessageLike;
}
public List getTenantIdIn() {
return tenantIds;
}
@CamundaQueryParam(value = "tenantIdIn", converter = StringListConverter.class)
public void setTenantIdIn(List tenantIds) {
this.tenantIds = tenantIds;
}
public Boolean isWithoutTenantId() {
return withoutTenantId;
}
@CamundaQueryParam(value = "withoutTenantId", converter = BooleanConverter.class)
public void setWithoutTenantId(Boolean withoutTenantId) {
this.withoutTenantId = withoutTenantId;
}
public List getActivityIds() {
return activityIds;
}
@CamundaQueryParam(value = "activityIdIn", converter = StringListConverter.class)
public void setActivityIdIn(List activityIds) {
this.activityIds = activityIds;
}
public Boolean isRootProcessInstances() {
return rootProcessInstances;
}
@CamundaQueryParam(value = "rootProcessInstances", converter = BooleanConverter.class)
public void setRootProcessInstances(Boolean rootProcessInstances) {
this.rootProcessInstances = rootProcessInstances;
}
public Boolean isLeafProcessInstances() {
return leafProcessInstances;
}
@CamundaQueryParam(value = "leafProcessInstances", converter = BooleanConverter.class)
public void setLeafProcessInstances(Boolean leafProcessInstances) {
this.leafProcessInstances = leafProcessInstances;
}
public Boolean isProcessDefinitionWithoutTenantId() {
return isProcessDefinitionWithoutTenantId;
}
@CamundaQueryParam(value = "processDefinitionWithoutTenantId", converter = BooleanConverter.class)
public void setProcessDefinitionWithoutTenantId(Boolean isProcessDefinitionWithoutTenantId) {
this.isProcessDefinitionWithoutTenantId = isProcessDefinitionWithoutTenantId;
}
@Override
protected boolean isValidSortByValue(String value) {
return VALID_SORT_BY_VALUES.contains(value);
}
@Override
protected ProcessInstanceQuery createNewQuery(ProcessEngine engine) {
return engine.getRuntimeService().createProcessInstanceQuery();
}
public List getOrQueries() {
return orQueries;
}
@Override
protected void applyFilters(ProcessInstanceQuery query) {
if (orQueries != null) {
for (ProcessInstanceQueryDto orQueryDto: orQueries) {
ProcessInstanceQueryImpl orQuery = new ProcessInstanceQueryImpl();
orQuery.setOrQueryActive();
orQueryDto.applyFilters(orQuery);
((ProcessInstanceQueryImpl) query).addOrQuery(orQuery);
}
}
if (processInstanceIds != null) {
query.processInstanceIds(processInstanceIds);
}
if (processDefinitionKey != null) {
query.processDefinitionKey(processDefinitionKey);
}
if (processDefinitionKeys != null && !processDefinitionKeys.isEmpty()) {
query.processDefinitionKeyIn(processDefinitionKeys.toArray(new String[processDefinitionKeys.size()]));
}
if (processDefinitionKeyNotIn != null && !processDefinitionKeyNotIn.isEmpty()) {
query.processDefinitionKeyNotIn(processDefinitionKeyNotIn.toArray(new String[processDefinitionKeyNotIn.size()]));
}
if (deploymentId != null) {
query.deploymentId(deploymentId);
}
if (businessKey != null) {
query.processInstanceBusinessKey(businessKey);
}
if (businessKeyLike != null) {
query.processInstanceBusinessKeyLike(businessKeyLike);
}
if(TRUE.equals(withIncident)) {
query.withIncident();
}
if (caseInstanceId != null) {
query.caseInstanceId(caseInstanceId);
}
if (processDefinitionId != null) {
query.processDefinitionId(processDefinitionId);
}
if (superProcessInstance != null) {
query.superProcessInstanceId(superProcessInstance);
}
if (subProcessInstance != null) {
query.subProcessInstanceId(subProcessInstance);
}
if (superCaseInstance != null) {
query.superCaseInstanceId(superCaseInstance);
}
if (subCaseInstance != null) {
query.subCaseInstanceId(subCaseInstance);
}
if (TRUE.equals(active)) {
query.active();
}
if (TRUE.equals(suspended)) {
query.suspended();
}
if (incidentId != null) {
query.incidentId(incidentId);
}
if (incidentType != null) {
query.incidentType(incidentType);
}
if (incidentMessage != null) {
query.incidentMessage(incidentMessage);
}
if (incidentMessageLike != null) {
query.incidentMessageLike(incidentMessageLike);
}
if (tenantIds != null && !tenantIds.isEmpty()) {
query.tenantIdIn(tenantIds.toArray(new String[tenantIds.size()]));
}
if (TRUE.equals(withoutTenantId)) {
query.withoutTenantId();
}
if (activityIds != null && !activityIds.isEmpty()) {
query.activityIdIn(activityIds.toArray(new String[activityIds.size()]));
}
if (TRUE.equals(rootProcessInstances)) {
query.rootProcessInstances();
}
if(TRUE.equals(leafProcessInstances)) {
query.leafProcessInstances();
}
if (TRUE.equals(isProcessDefinitionWithoutTenantId)) {
query.processDefinitionWithoutTenantId();
}
if(TRUE.equals(variableNamesIgnoreCase)) {
query.matchVariableNamesIgnoreCase();
}
if(TRUE.equals(variableValuesIgnoreCase)) {
query.matchVariableValuesIgnoreCase();
}
if (variables != null) {
for (VariableQueryParameterDto variableQueryParam : variables) {
String variableName = variableQueryParam.getName();
String op = variableQueryParam.getOperator();
Object variableValue = variableQueryParam.resolveValue(objectMapper);
if (op.equals(VariableQueryParameterDto.EQUALS_OPERATOR_NAME)) {
query.variableValueEquals(variableName, variableValue);
} else if (op.equals(VariableQueryParameterDto.GREATER_THAN_OPERATOR_NAME)) {
query.variableValueGreaterThan(variableName, variableValue);
} else if (op.equals(VariableQueryParameterDto.GREATER_THAN_OR_EQUALS_OPERATOR_NAME)) {
query.variableValueGreaterThanOrEqual(variableName, variableValue);
} else if (op.equals(VariableQueryParameterDto.LESS_THAN_OPERATOR_NAME)) {
query.variableValueLessThan(variableName, variableValue);
} else if (op.equals(VariableQueryParameterDto.LESS_THAN_OR_EQUALS_OPERATOR_NAME)) {
query.variableValueLessThanOrEqual(variableName, variableValue);
} else if (op.equals(VariableQueryParameterDto.NOT_EQUALS_OPERATOR_NAME)) {
query.variableValueNotEquals(variableName, variableValue);
} else if (op.equals(VariableQueryParameterDto.LIKE_OPERATOR_NAME)) {
query.variableValueLike(variableName, String.valueOf(variableValue));
} else {
throw new InvalidRequestException(Status.BAD_REQUEST, "Invalid variable comparator specified: " + op);
}
}
}
}
@Override
protected void applySortBy(ProcessInstanceQuery query, String sortBy, Map parameters, ProcessEngine engine) {
if (sortBy.equals(SORT_BY_INSTANCE_ID_VALUE)) {
query.orderByProcessInstanceId();
} else if (sortBy.equals(SORT_BY_DEFINITION_KEY_VALUE)) {
query.orderByProcessDefinitionKey();
} else if (sortBy.equals(SORT_BY_DEFINITION_ID_VALUE)) {
query.orderByProcessDefinitionId();
} else if (sortBy.equals(SORT_BY_TENANT_ID)) {
query.orderByTenantId();
} else if (sortBy.equals(SORT_BY_BUSINESS_KEY)) {
query.orderByBusinessKey();
}
}
}