io.nflow.rest.v1.ResourceBase Maven / Gradle / Ivy
The newest version!
package io.nflow.rest.v1;
import static io.nflow.engine.workflow.instance.WorkflowInstanceAction.WorkflowActionType.externalChange;
import static io.nflow.rest.v1.ApiWorkflowInstanceInclude.actionStateVariables;
import static io.nflow.rest.v1.ApiWorkflowInstanceInclude.actions;
import static io.nflow.rest.v1.ApiWorkflowInstanceInclude.childWorkflows;
import static io.nflow.rest.v1.ApiWorkflowInstanceInclude.currentStateVariables;
import static java.lang.Boolean.parseBoolean;
import static java.net.HttpURLConnection.HTTP_BAD_REQUEST;
import static java.net.HttpURLConnection.HTTP_INTERNAL_ERROR;
import static java.net.HttpURLConnection.HTTP_NOT_FOUND;
import static java.util.Arrays.stream;
import static java.util.Collections.sort;
import static java.util.EnumSet.noneOf;
import static java.util.stream.Collectors.toSet;
import static org.apache.commons.lang3.StringUtils.defaultIfBlank;
import static org.apache.commons.lang3.StringUtils.isBlank;
import static org.apache.commons.lang3.StringUtils.isNotBlank;
import static org.apache.commons.lang3.StringUtils.trimToNull;
import static org.joda.time.DateTime.now;
import static org.springframework.util.StringUtils.hasText;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashSet;
import java.util.List;
import java.util.Map.Entry;
import java.util.Objects;
import java.util.Set;
import java.util.function.BiFunction;
import java.util.function.Supplier;
import java.util.stream.Stream;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import io.nflow.engine.internal.dao.WorkflowDefinitionDao;
import io.nflow.engine.internal.dao.WorkflowInstanceDao;
import io.nflow.engine.internal.workflow.StoredWorkflowDefinition;
import io.nflow.engine.service.NflowNotFoundException;
import io.nflow.engine.service.WorkflowDefinitionService;
import io.nflow.engine.service.WorkflowInstanceInclude;
import io.nflow.engine.service.WorkflowInstanceService;
import io.nflow.engine.workflow.definition.WorkflowDefinition;
import io.nflow.engine.workflow.instance.QueryWorkflowInstances;
import io.nflow.engine.workflow.instance.WorkflowInstance;
import io.nflow.engine.workflow.instance.WorkflowInstance.WorkflowInstanceStatus;
import io.nflow.engine.workflow.instance.WorkflowInstanceAction;
import io.nflow.engine.workflow.instance.WorkflowInstanceFactory;
import io.nflow.rest.v1.converter.ListWorkflowDefinitionConverter;
import io.nflow.rest.v1.converter.ListWorkflowInstanceConverter;
import io.nflow.rest.v1.msg.ErrorResponse;
import io.nflow.rest.v1.msg.ListWorkflowDefinitionResponse;
import io.nflow.rest.v1.msg.ListWorkflowInstanceResponse;
import io.nflow.rest.v1.msg.UpdateWorkflowInstanceRequest;
/**
* Common base class for REST API logic
*/
public abstract class ResourceBase {
protected static final String INCLUDES_PARAM_DESC = "Data to include for workflow instance.\n"
+ "* currentStateVariables: current stateVariables for worfklow\n"
+ "* actions: state transitions\n"
+ "* actionStateVariables: state variable changes for actions\n"
+ "* childWorkflows: map of created child workflow instance IDs by action ID\n";
protected static final String DEPRECATED_INCLUDE_PARAM_DESC = "Removed in the next major release, use `includes` instead. Data to include in workflow instance. Multiple values can be provided as comma separated string.\n"
+ "* currentStateVariables: current stateVariables for worfklow\n"
+ "* actions: state transitions\n"
+ "* actionStateVariables: state variable changes for actions\n"
+ "* childWorkflows: map of created child workflow instance IDs by action ID\n";
protected static final String QUERY_ARCHIVED_DEFAULT_STR = "false";
protected static final boolean QUERY_ARCHIVED_DEFAULT = parseBoolean(QUERY_ARCHIVED_DEFAULT_STR);
public List listWorkflowDefinitions(Collection types,
WorkflowDefinitionService workflowDefinitions, ListWorkflowDefinitionConverter converter,
WorkflowDefinitionDao workflowDefinitionDao) {
List definitions = workflowDefinitions.getWorkflowDefinitions();
Set reqTypes = new HashSet<>(types);
Set foundTypes = new HashSet<>();
List response = new ArrayList<>();
for (WorkflowDefinition definition : definitions) {
if (reqTypes.isEmpty() || reqTypes.contains(definition.getType())) {
foundTypes.add(definition.getType());
response.add(converter.convert(definition));
}
}
if (reqTypes.isEmpty() || foundTypes.size() < reqTypes.size()) {
reqTypes.removeAll(foundTypes);
List storedDefinitions = workflowDefinitionDao.queryStoredWorkflowDefinitions(reqTypes);
for (StoredWorkflowDefinition storedDefinition : storedDefinitions) {
if (!foundTypes.contains(storedDefinition.type)) {
response.add(converter.convert(storedDefinition));
}
}
}
sort(response);
return response;
}
public boolean updateWorkflowInstance(long id, UpdateWorkflowInstanceRequest req,
WorkflowInstanceFactory workflowInstanceFactory, WorkflowInstanceService workflowInstances,
WorkflowInstanceDao workflowInstanceDao) {
WorkflowInstance.Builder builder = workflowInstanceFactory.newWorkflowInstanceBuilder().setId(id)
.setNextActivation(req.nextActivationTime);
String msg = defaultIfBlank(req.actionDescription, "");
if (hasText(req.state)) {
builder.setState(req.state);
if (isBlank(req.actionDescription)) {
msg = "API changed state to " + req.state + ". ";
}
}
if (req.nextActivationTime != null && isBlank(req.actionDescription)) {
msg += "API changed nextActivationTime to " + req.nextActivationTime + ". ";
}
if (!req.stateVariables.isEmpty()) {
for (Entry entry : req.stateVariables.entrySet()) {
Object value = entry.getValue();
if (value instanceof String) {
builder.putStateVariable(entry.getKey(), (String) value);
} else {
builder.putStateVariable(entry.getKey(), value);
}
}
if (isBlank(req.actionDescription)) {
msg += "API updated state variables. ";
}
}
if (hasText(req.businessKey)) {
builder.setBusinessKey(req.businessKey);
if (isBlank(req.actionDescription)) {
msg = "API changed business key to " + req.businessKey + ". ";
}
}
if (msg.isEmpty()) {
return true;
}
WorkflowInstance instance = builder.setStateText(msg).build();
instance.getChangedStateVariables().forEach(workflowInstanceDao::checkStateVariableValueLength);
WorkflowInstanceAction action = new WorkflowInstanceAction.Builder(instance)
.setType(externalChange)
.setStateText(trimToNull(msg))
.setExecutionEnd(now())
.build();
return workflowInstances.updateWorkflowInstance(instance, action);
}
public Stream listWorkflowInstances(Set ids, Set types, Long parentWorkflowId,
Long parentActionId, Set states, Set statuses, String businessKey, String externalId,
String stateVariableKey, String stateVariableValue, Set includes, String include,
Long maxResults, Long maxActions, boolean queryArchive, WorkflowInstanceService workflowInstances,
ListWorkflowInstanceConverter listWorkflowConverter) {
Set propertyIncludes = resolveIncludes(includes, include);
QueryWorkflowInstances q = new QueryWorkflowInstances.Builder()
.addIds(ids.toArray(new Long[ids.size()]))
.addTypes(types.toArray(new String[types.size()]))
.setParentWorkflowId(parentWorkflowId)
.setParentActionId(parentActionId)
.addStates(states.toArray(new String[states.size()]))
.addStatuses(statuses.toArray(new WorkflowInstanceStatus[statuses.size()]))
.setBusinessKey(businessKey)
.setExternalId(externalId)
.setIncludeCurrentStateVariables(propertyIncludes.contains(currentStateVariables))
.setIncludeActions(propertyIncludes.contains(actions))
.setIncludeActionStateVariables(propertyIncludes.contains(actionStateVariables))
.setMaxResults(maxResults)
.setMaxActions(maxActions)
.setQueryArchive(queryArchive)
.setIncludeChildWorkflows(propertyIncludes.contains(childWorkflows))
.setStateVariable(stateVariableKey, stateVariableValue)
.build();
Stream instances = workflowInstances.listWorkflowInstancesAsStream(q);
return instances.map(instance -> listWorkflowConverter.convert(instance, propertyIncludes, queryArchive));
}
private Set resolveIncludes(Set includes, String include) {
Set allIncludes = noneOf(ApiWorkflowInstanceInclude.class);
if (includes != null) {
allIncludes.addAll(includes);
}
if (isNotBlank(include)) {
stream(include.split(","))
.map(ApiWorkflowInstanceInclude::fromValue)
.filter(Objects::nonNull)
.forEach(allIncludes::add);
}
return allIncludes;
}
public ListWorkflowInstanceResponse fetchWorkflowInstance(long id, Set apiIncludes, String include,
Long maxActions, boolean queryArchive, WorkflowInstanceService workflowInstances,
ListWorkflowInstanceConverter listWorkflowConverter) {
Set propertyIncludes = resolveIncludes(apiIncludes, include);
Set includes = propertyIncludes.stream()
.map(ApiWorkflowInstanceInclude::getInclude)
.collect(toSet());
WorkflowInstance instance = workflowInstances.getWorkflowInstance(id, includes, maxActions, queryArchive);
return listWorkflowConverter.convert(instance, propertyIncludes, queryArchive);
}
@SuppressFBWarnings(value = "ITC_INHERITANCE_TYPE_CHECKING", justification = "This is the way")
protected int resolveExceptionHttpStatus(Throwable t) {
if (t instanceof IllegalArgumentException) {
return HTTP_BAD_REQUEST;
} else if (t instanceof NflowNotFoundException) {
return HTTP_NOT_FOUND;
}
return HTTP_INTERNAL_ERROR;
}
protected T handleExceptions(Supplier response, BiFunction error) {
try {
return response.get();
} catch (Throwable t) {
int code = resolveExceptionHttpStatus(t);
return error.apply(code, new ErrorResponse(t.getMessage()));
}
}
}