TasksEndpoint.java
/*
* Licensed to The Apereo Foundation under one or more contributor license
* agreements. See the NOTICE file distributed with this work for additional
* information regarding copyright ownership.
*
*
* The Apereo Foundation licenses this file to you under the Educational
* Community 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://opensource.org/licenses/ecl2.txt
*
* 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.opencastproject.adminui.endpoint;
import static com.entwinemedia.fn.Stream.$;
import static com.entwinemedia.fn.data.Opt.nul;
import static com.entwinemedia.fn.data.json.Jsons.arr;
import static com.entwinemedia.fn.data.json.Jsons.f;
import static com.entwinemedia.fn.data.json.Jsons.obj;
import static com.entwinemedia.fn.data.json.Jsons.v;
import static javax.servlet.http.HttpServletResponse.SC_BAD_REQUEST;
import static javax.servlet.http.HttpServletResponse.SC_NOT_FOUND;
import static javax.servlet.http.HttpServletResponse.SC_OK;
import static org.opencastproject.index.service.util.RestUtils.okJson;
import static org.opencastproject.workflow.api.ConfiguredWorkflow.workflow;
import org.opencastproject.assetmanager.api.AssetManager;
import org.opencastproject.assetmanager.util.Workflows;
import org.opencastproject.util.NotFoundException;
import org.opencastproject.util.RestUtil;
import org.opencastproject.util.data.Option;
import org.opencastproject.util.doc.rest.RestParameter;
import org.opencastproject.util.doc.rest.RestQuery;
import org.opencastproject.util.doc.rest.RestResponse;
import org.opencastproject.util.doc.rest.RestService;
import org.opencastproject.workflow.api.ConfiguredWorkflow;
import org.opencastproject.workflow.api.WorkflowDatabaseException;
import org.opencastproject.workflow.api.WorkflowDefinition;
import org.opencastproject.workflow.api.WorkflowInstance;
import org.opencastproject.workflow.api.WorkflowService;
import com.entwinemedia.fn.Fn;
import com.entwinemedia.fn.data.json.JValue;
import com.google.gson.Gson;
import org.apache.commons.lang3.StringUtils;
import org.osgi.framework.BundleContext;
import org.osgi.service.component.annotations.Activate;
import org.osgi.service.component.annotations.Component;
import org.osgi.service.component.annotations.Reference;
import org.osgi.service.jaxrs.whiteboard.propertytypes.JaxrsResource;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
import javax.servlet.http.HttpServletResponse;
import javax.ws.rs.FormParam;
import javax.ws.rs.GET;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.QueryParam;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.Response.Status;
@Path("/admin-ng/tasks")
@RestService(name = "TasksService", title = "UI Tasks",
abstractText = "Provides resources and operations related to the tasks",
notes = { "All paths above are relative to the REST endpoint base (something like http://your.server/files)",
"If the service is down or not working it will return a status 503, this means the the underlying service is "
+ "not working and is either restarting or has failed",
"A status code 500 means a general failure has occurred which is not recoverable and was not anticipated. In "
+ "other words, there is a bug! You should file an error report with your server logs from the time when the "
+ "error occurred: <a href=\"https://github.com/opencast/opencast/issues\">Opencast Issue Tracker</a>",
"<strong>Important:</strong> "
+ "<em>This service is for exclusive use by the module admin-ui. Its API might change "
+ "anytime without prior notice. Any dependencies other than the admin UI will be strictly ignored. "
+ "DO NOT use this for integration of third-party applications.<em>"})
@Component(
immediate = true,
service = TasksEndpoint.class,
property = {
"service.description=Admin UI - Tasks facade Endpoint",
"opencast.service.type=org.opencastproject.adminui.endpoint.TasksEndpoint",
"opencast.service.path=/admin-ng/tasks"
}
)
@JaxrsResource
public class TasksEndpoint {
private static final Logger logger = LoggerFactory.getLogger(TasksEndpoint.class);
private WorkflowService workflowService;
private AssetManager assetManager;
/** OSGi callback for the workflow service. */
@Reference
public void setWorkflowService(WorkflowService workflowService) {
this.workflowService = workflowService;
}
/** OSGi callback to set the asset manager. */
@Reference
public void setAssetManager(AssetManager assetManager) {
this.assetManager = assetManager;
}
@Activate
protected void activate(BundleContext bundleContext) {
logger.info("Activate tasks endpoint");
}
@GET
@Path("processing.json")
@RestQuery(name = "getProcessing", description = "Returns all the data related to the processing tab in the new tasks modal as JSON", returnDescription = "All the data related to the tasks processing tab as JSON", restParameters = { @RestParameter(name = "tags", isRequired = false, description = "A comma separated list of tags to filter the workflow definitions", type = RestParameter.Type.STRING) }, responses = { @RestResponse(responseCode = SC_OK, description = "Returns all the data related to the tasks processing tab as JSON") })
public Response getProcessing(@QueryParam("tags") String tagsString) {
List<String> tags = RestUtil.splitCommaSeparatedParam(Option.option(tagsString)).value();
// This is the JSON Object which will be returned by this request
List<JValue> actions = new ArrayList<>();
try {
List<WorkflowDefinition> workflowsDefinitions = workflowService.listAvailableWorkflowDefinitions();
for (WorkflowDefinition wflDef : workflowsDefinitions) {
if (wflDef.containsTag(tags)) {
actions.add(obj(f("id", v(wflDef.getId())), f("title", v(nul(wflDef.getTitle()).getOr(""))),
f("description", v(nul(wflDef.getDescription()).getOr(""))),
f("configuration_panel", v(nul(wflDef.getConfigurationPanel()).getOr(""))),
f("configuration_panel_json", v(nul(wflDef.getConfigurationPanelJson()).getOr("")))));
}
}
} catch (WorkflowDatabaseException e) {
logger.error("Unable to get available workflow definitions", e);
return RestUtil.R.serverError();
}
return okJson(arr(actions));
}
@POST
@Path("/new")
@RestQuery(
name = "createNewTask",
description = "Creates a new task by the given metadata as JSON",
returnDescription = "The task identifiers",
restParameters = {
@RestParameter(name = "metadata", isRequired = true,
description = "The metadata as JSON.<p>Example:<p>"
+ "<code><pre>{\n"
+ " \"workflow\":\"republish-metadata\",\n"
+ " \"configuration\":{\n"
+ " \"ID-dual-stream-demo\":{\"workflowVar\":\"true\"},\n"
+ " \"ID-about-opencast\":{\"workflowVar\":\"true\"}\n"
+ " }\n"
+ "}</pre></code>", type = RestParameter.Type.TEXT) },
responses = {
@RestResponse(responseCode = HttpServletResponse.SC_CREATED, description = "Task sucessfully added"),
@RestResponse(responseCode = SC_NOT_FOUND, description = "If the workflow definition is not found"),
@RestResponse(responseCode = SC_BAD_REQUEST, description = "If the metadata is not set or couldn't be parsed") })
public Response createNewTask(@FormParam("metadata") String metadata) throws NotFoundException {
if (StringUtils.isBlank(metadata)) {
logger.warn("No metadata set");
return RestUtil.R.badRequest("No metadata set");
}
Gson gson = new Gson();
Map metadataJson;
try {
metadataJson = gson.fromJson(metadata, Map.class);
} catch (Exception e) {
logger.warn("Unable to parse metadata {}", metadata);
return RestUtil.R.badRequest("Unable to parse metadata");
}
String workflowId = (String) metadataJson.get("workflow");
if (StringUtils.isBlank(workflowId))
return RestUtil.R.badRequest("No workflow set");
Map<String, Map<String, String>> configuration = (Map<String, Map<String, String>>) metadataJson.get("configuration");
if (configuration == null) {
return RestUtil.R.badRequest("No events set");
}
WorkflowDefinition wfd;
try {
wfd = workflowService.getWorkflowDefinitionById(workflowId);
} catch (WorkflowDatabaseException e) {
logger.error("Unable to get workflow definition {}", workflowId, e);
return RestUtil.R.serverError();
}
final Workflows workflows = new Workflows(assetManager, workflowService);
final List<WorkflowInstance> instances = new ArrayList<>();
for (final Entry<String, Map<String, String>> entry : configuration.entrySet()) {
final ConfiguredWorkflow workflow = workflow(wfd, entry.getValue());
final Set<String> mpIds = Collections.singleton(entry.getKey());
final List<WorkflowInstance> partialResult = workflows.applyWorkflowToLatestVersion(mpIds, workflow);
if (partialResult.size() != 1) {
logger.warn("Couldn't start workflow for media package {}", entry.getKey());
return Response.status(Status.BAD_REQUEST).build();
}
instances.addAll(partialResult);
}
return Response.status(Status.CREATED).entity(gson.toJson($(instances).map(getWorkflowIds).toList())).build();
}
private static final Fn<WorkflowInstance, Long> getWorkflowIds = new Fn<WorkflowInstance, Long>() {
@Override
public Long apply(WorkflowInstance a) {
return a.getId();
}
};
}