com.centurylink.mdw.service.rest.Activities Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of mdw-services Show documentation
Show all versions of mdw-services Show documentation
MDW is a workflow framework specializing in microservice orchestration
/*
* Copyright (C) 2017 CenturyLink, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* 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 com.centurylink.mdw.service.rest;
import com.centurylink.mdw.common.service.Query;
import com.centurylink.mdw.common.service.ServiceException;
import com.centurylink.mdw.common.service.types.StatusMessage;
import com.centurylink.mdw.model.*;
import com.centurylink.mdw.model.user.Role;
import com.centurylink.mdw.model.user.UserAction;
import com.centurylink.mdw.model.user.UserAction.Action;
import com.centurylink.mdw.model.user.UserAction.Entity;
import com.centurylink.mdw.model.workflow.Process;
import com.centurylink.mdw.model.workflow.*;
import com.centurylink.mdw.service.data.process.HierarchyCache;
import com.centurylink.mdw.service.data.process.ProcessCache;
import com.centurylink.mdw.services.ServiceLocator;
import com.centurylink.mdw.services.WorkflowServices;
import com.centurylink.mdw.services.rest.JsonRestService;
import com.centurylink.mdw.util.log.ActivityLog;
import com.centurylink.mdw.util.log.ActivityLogLine;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.json.JSONArray;
import org.json.JSONException;
import org.json.JSONObject;
import javax.ws.rs.Path;
import java.io.IOException;
import java.text.ParseException;
import java.time.Instant;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.TreeMap;
@Path("/Activities")
@Api("Runtime activity")
public class Activities extends JsonRestService implements JsonExportable {
@Override
protected Entity getEntity(String path, Object content, Map headers) {
return Entity.Activity;
}
@Override
public List getRoles(String path) {
List roles = super.getRoles(path);
roles.add(Role.PROCESS_EXECUTION);
return roles;
}
private WorkflowServices getWorkflowServices() {
return ServiceLocator.getWorkflowServices();
}
/**
* Retrieve activity instance(s).
*/
@Override
@Path("/{instanceId}")
@ApiOperation(value = "Retrieve an activity, query many activity instances, or perform special queries",
notes = "If instanceId and special are not present, returns a page of activities that meet query criteria.",
response = ActivityInstance.class, responseContainer = "List")
public JSONObject get(String path, Map headers)
throws ServiceException, JSONException {
try {
String segOne = getSegment(path, 1);
if (segOne != null) {
try {
long instanceId = Long.parseLong(segOne);
if ("log".equals(getSegment(path, 2))) {
ActivityLog log = getWorkflowServices().getActivityLog(instanceId);
if (log == null)
throw new ServiceException(ServiceException.NOT_FOUND, "Log not found for activity: " + instanceId);
return log.getJson();
}
else{
return getWorkflowServices().getActivity(instanceId).getJson();
}
}
catch (NumberFormatException ex) {
// path must be special
Query query = getQuery(path, headers);
if (segOne.equals("definitions")) {
if ("e2e".equals(getSegment(path, 2))) {
String pkg = getSegment(path, 3);
String proc = getSegment(path, 4);
if (proc != null) {
// process asset path
return getDefinitionE2e(pkg + "/" + proc);
}
throw new ServiceException(ServiceException.BAD_REQUEST, "Bad path: " + path);
}
else {
return getDefinitions(query);
}
}
else if (segOne.equals("tops")) {
return getTops(query).getJson();
}
else if (segOne.equals("breakdown")) {
return getBreakdown(query).getJson();
}
else if (segOne.equals("e2e")) {
String masterRequestId = getSegment(path, 2);
if (masterRequestId == null)
throw new ServiceException(ServiceException.BAD_REQUEST, "Missing masterRequestId");
long processInstanceId = query.getLongFilter("processInstanceId");
if (processInstanceId == -1) {
return getE2e(masterRequestId);
}
else {
ProcessInstance processInstance = getWorkflowServices().getProcess(processInstanceId);
return getWorkflowServices().getActivityHierarchy(processInstance).getJson(2);
}
}
else {
throw new ServiceException(ServiceException.BAD_REQUEST, "Unsupported path segment: " + segOne);
}
}
}
else {
Query query = getQuery(path, headers);
return getWorkflowServices().getActivities(query).getJson();
}
}
catch (ServiceException ex) {
throw ex;
}
catch (Exception ex) {
throw new ServiceException(ex.getMessage(), ex);
}
}
/**
* Take {action} on activity which has {activityInstanceId}.
* {completionCode} can be provided if none provided then it is treated as null.
* Post http://localhost:8080/mdw/Services/Activities/40337/Proceed/sequential
* Payload "{}"
*/
@Override
@Path("/{instanceId}/{action}/{completionCode}")
@ApiOperation(value = "Take action on activity whose activity Instance ID is activityInstanceId, " +
"if completionCode is defined then take completionCode path", response = StatusMessage.class)
public JSONObject post(String path, JSONObject content, Map headers)
throws ServiceException, JSONException {
Map parameters = getParameters(headers);
String instId = getSegment(path, 1);
if (instId == null)
instId = parameters.get("activityInstanceId");
if (instId == null)
throw new ServiceException("Missing parameter: activityInstanceId");
try {
Long activityInstanceId = Long.parseLong(instId);
String action = getSegment(path, 2);
if (action == null)
action = parameters.get("action");
if (action == null)
throw new ServiceException("Missing parameter: action");
String completionCode = getSegment(path, 3);
if (completionCode == null)
completionCode = parameters.get("completionCode");
actionActivity(activityInstanceId, action,completionCode, getAuthUser(headers));
return null;
}
catch (NumberFormatException ex) {
throw new ServiceException(ServiceException.BAD_REQUEST, "Bad path: " + path);
}
}
@Override
public Jsonable toExportJson(Query query, JSONObject json) throws JSONException {
try {
String path = query.getPath();
if (json.has(ActivityList.ACTIVITY_INSTANCES)) {
return new ActivityList(ActivityList.ACTIVITY_INSTANCES, json);
}
else if ("Activities/breakdown".equals(path)) {
return new JsonListMap<>(json, ActivityAggregate.class);
}
else if (path != null && path.startsWith("Activities/") && path.endsWith("/log")) {
JSONObject listObj = new JSONObject();
listObj.put("Activity Log", json.getJSONArray("logLines"));
return new JsonList<>(listObj, ActivityLogLine.class);
}
else {
throw new JSONException("Unsupported export type for query: " + query);
}
}
catch (ParseException ex) {
throw new JSONException(ex);
}
}
@Override
public String getExportName() { return "Activities"; }
@Override
protected Long getEntityId(String path, Object content, Map headers) {
String activityInstanceId = getSegment(path, 1);
Long id;
try {
id = new Long(activityInstanceId);
}
catch (NumberFormatException e) {
id = 0L;
}
return id;
}
@Override
protected Action getAction(String path, Object content, Map headers) {
String action = getSegment(path, 2);
return UserAction.getAction(action);
}
@Path("/definitions")
public JSONObject getDefinitions(Query query) throws ServiceException {
ActivityList activityVOs = ServiceLocator.getDesignServices().getActivityDefinitions(query);
JSONArray jsonActivities = new JSONArray();
for (ActivityInstance activityInstance : activityVOs.getActivities()) {
jsonActivities.put(activityInstance.getJson());
}
return activityVOs.getJson();
}
@Path("/tops")
public JsonArray getTops(Query query) throws ServiceException {
List list = getWorkflowServices().getTopActivities(query);
JSONArray actArr = new JSONArray();
int ct = 0;
ActivityAggregate other = null;
long otherTot = 0;
for (ActivityAggregate actCount : list) {
if (ct >= query.getMax()) {
if (other == null) {
other = new ActivityAggregate(0);
other.setName("Other");
}
otherTot += actCount.getValue();
} else {
actArr.put(actCount.getJson());
}
ct++;
}
if (other != null) {
other.setValue(otherTot);
actArr.put(other.getJson());
}
return new JsonArray(actArr);
}
@Path("/breakdown")
public JsonListMap getBreakdown(Query query) throws ServiceException {
TreeMap> instMap = getWorkflowServices().getActivityBreakdown(query);
LinkedHashMap> listMap = new LinkedHashMap<>();
for (Instant instant : instMap.keySet()) {
List actCounts = instMap.get(instant);
listMap.put(Query.getString(instant), actCounts);
}
return new JsonListMap<>(listMap);
}
@Path("/{instanceId}/{action}")
public void actionActivity(Long instanceId, String action, String result, String authUser) throws ServiceException {
WorkflowServices workflowServices = ServiceLocator.getWorkflowServices();
workflowServices.actionActivity(instanceId, action, result, authUser);
}
@Path("/e2e/{masterRequestId}")
public JSONObject getE2e(String masterRequestId) throws ServiceException {
WorkflowServices workflowServices = ServiceLocator.getWorkflowServices();
ProcessInstance masterProcessInstance = workflowServices.getMasterProcess(masterRequestId);
// retrieve full
masterProcessInstance = workflowServices.getProcess(masterProcessInstance.getId());
return workflowServices.getActivityHierarchy(masterProcessInstance).getJson(2);
}
@Path("/definitions/e2e/{package}/{process}")
public JSONObject getDefinitionE2e(String assetPath) throws ServiceException {
Process process = ProcessCache.getProcess(assetPath);
if (process == null)
throw new ServiceException(ServiceException.NOT_FOUND, "Process not found: " + assetPath);
try {
Linked hierarchy = HierarchyCache.getActivityHierarchy(process.getId());
if (hierarchy == null)
throw new ServiceException(ServiceException.NOT_FOUND, "Activities not found: " + process.getId());
return hierarchy.getJson(2);
} catch (IOException ex) {
throw new ServiceException(ServiceException.INTERNAL_ERROR, "Error loading hierarchy for " + assetPath, ex);
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy