VideoEditorServiceEndpoint.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.videoeditor.endpoint;

import org.opencastproject.job.api.JaxbJobList;
import org.opencastproject.job.api.Job;
import org.opencastproject.job.api.JobProducer;
import org.opencastproject.rest.AbstractJobProducerEndpoint;
import org.opencastproject.serviceregistry.api.ServiceRegistry;
import org.opencastproject.smil.api.SmilService;
import org.opencastproject.smil.entity.api.Smil;
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.videoeditor.api.VideoEditorService;

import org.osgi.service.component.annotations.Component;
import org.osgi.service.component.annotations.Reference;
import org.osgi.service.jaxrs.whiteboard.propertytypes.JaxrsResource;

import java.util.List;

import javax.servlet.http.HttpServletResponse;
import javax.ws.rs.FormParam;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;

/**
 * VideoEditorService REST Endpoint.
 */
@Path("/videoeditor")
@RestService(
    name = "VideoEditorServiceEndpoint",
    title = "Video Editor Service REST Endpoint",
    abstractText = "Video Editor Service consumes a smil document and create corresponding video files.",
    notes = {"All paths above are relative to the REST endpoint base (something like http://your.server/videoeditor)"}
)
@Component(
    immediate = true,
    service = VideoEditorServiceEndpoint.class,
    property = {
        "service.description=Video Editor Service REST Endpoint",
        "opencast.service.type=org.opencastproject.videoeditor",
        "opencast.service.path=/videoeditor",
        "opencast.service.jobproducer=true"
    }
)
@JaxrsResource
public class VideoEditorServiceEndpoint extends AbstractJobProducerEndpoint {

  private ServiceRegistry serviceRegistry;
  private VideoEditorService videoEditorService;
  private SmilService smilService;

  @POST
  @Path("/process-smil")
  @Produces({MediaType.APPLICATION_XML})
  @RestQuery(
      name = "processsmil",
      description = "Create smil processing jobs.",
      returnDescription = "Smil processing jobs.",
      restParameters = {
          @RestParameter(
              name = "smil",
              type = RestParameter.Type.TEXT,
              description = "Smil document to process.",
              isRequired = true
          )
      },
      responses = {
          @RestResponse(
              description = "Smil processing jobs created successfully.",
              responseCode = HttpServletResponse.SC_OK
          ),
          @RestResponse(
              description = "Internal server error.",
              responseCode = HttpServletResponse.SC_INTERNAL_SERVER_ERROR
          )
      }
  )
  public Response processSmil(@FormParam("smil") String smilStr) {
    Smil smil;
    try {
      smil = smilService.fromXml(smilStr).getSmil();
      List<Job> jobs = videoEditorService.processSmil(smil);
      return Response.ok(new JaxbJobList(jobs)).build();
    } catch (Exception ex) {
      return Response.serverError().entity(ex.getMessage()).build();
    }
  }

  @Override
  public JobProducer getService() {
    if (videoEditorService instanceof JobProducer) {
      return (JobProducer) videoEditorService;
    } else {
      return null;
    }
  }

  @Override
  public ServiceRegistry getServiceRegistry() {
    return serviceRegistry;
  }

  @Reference
  public void setVideoEditorService(VideoEditorService videoEditorService) {
    this.videoEditorService = videoEditorService;
  }

  @Reference
  public void setServiceRegistry(ServiceRegistry serviceRegistry) {
    this.serviceRegistry = serviceRegistry;
  }

  @Reference
  public void setSmilService(SmilService smilService) {
    this.smilService = smilService;
  }
}