MediaInspectionRestEndpoint.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.inspection.ffmpeg.endpoints;
import org.opencastproject.inspection.api.MediaInspectionService;
import org.opencastproject.inspection.api.util.Options;
import org.opencastproject.job.api.JaxbJob;
import org.opencastproject.job.api.Job;
import org.opencastproject.job.api.JobProducer;
import org.opencastproject.mediapackage.MediaPackageElementParser;
import org.opencastproject.rest.AbstractJobProducerEndpoint;
import org.opencastproject.serviceregistry.api.ServiceRegistry;
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.osgi.service.component.ComponentContext;
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.component.annotations.ReferenceCardinality;
import org.osgi.service.component.annotations.ReferencePolicy;
import org.osgi.service.jaxrs.whiteboard.propertytypes.JaxrsResource;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.net.URI;
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.Produces;
import javax.ws.rs.QueryParam;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
/**
* A service endpoint to expose the {@link MediaInspectionService} via REST.
*/
@Path("/inspection")
@RestService(name = "mediainspection", title = "Media Inspection Service", abstractText = "This service extracts technical metadata from media files.", 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>" })
@Component(
property = {
"service.description=Media Inspection REST Endpoint",
"opencast.service.type=org.opencastproject.inspection",
"opencast.service.path=/inspection",
"opencast.service.jobproducer=true"
},
immediate = true,
service = { MediaInspectionRestEndpoint.class }
)
@JaxrsResource
public class MediaInspectionRestEndpoint extends AbstractJobProducerEndpoint {
/** The logger */
private static final Logger logger = LoggerFactory.getLogger(MediaInspectionRestEndpoint.class);
/** The inspection service */
protected MediaInspectionService service;
/** The service registry */
protected ServiceRegistry serviceRegistry = null;
/**
* Callback from the OSGi declarative services to set the service registry.
*
* @param serviceRegistry
* the service registry
*/
@Reference
protected void setServiceRegistry(ServiceRegistry serviceRegistry) {
this.serviceRegistry = serviceRegistry;
}
/**
* Sets the inspection service
*
* @param service
* the inspection service
*/
@Reference(cardinality = ReferenceCardinality.OPTIONAL, policy = ReferencePolicy.DYNAMIC)
public void setService(MediaInspectionService service) {
this.service = service;
}
/**
* Removes the inspection service
*
* @param service
*/
public void unsetService(MediaInspectionService service) {
if (this.service == service) {
this.service = null;
}
}
/**
* Callback from OSGi that is called when this service is activated.
*
* @param cc
* OSGi component context
*/
@Activate
public void activate(ComponentContext cc) {
// String serviceUrl = (String) cc.getProperties().get(RestConstants.SERVICE_PATH_PROPERTY);
}
@GET
@Produces(MediaType.TEXT_XML)
@Path("inspect")
@RestQuery(name = "inspect", description = "Analyze a given media file",
restParameters = {
@RestParameter(description = "Location of the media file.", isRequired = false, name = "uri", type = RestParameter.Type.STRING),
@RestParameter(description = "Options passed to media inspection service", isRequired = false, name = "options", type = RestParameter.Type.STRING) },
responses = {
@RestResponse(description = "XML encoded receipt is returned.", responseCode = HttpServletResponse.SC_OK),
@RestResponse(description = "Service unavailabe or not currently present", responseCode = HttpServletResponse.SC_SERVICE_UNAVAILABLE),
@RestResponse(description = "Problem retrieving media file or invalid media file or URL.", responseCode = HttpServletResponse.SC_INTERNAL_SERVER_ERROR) },
returnDescription = "Returns a receipt to check on the status and outcome of the job")
public Response inspectTrack(@QueryParam("uri") URI uri, @QueryParam("options") String options) {
checkNotNull(service);
try {
Job job = service.inspect(uri, Options.fromJson(options));
return Response.ok(new JaxbJob(job)).build();
} catch (Exception e) {
logger.info("Unable to inspect track {}: {}", uri, e.getMessage());
return Response.serverError().build();
}
}
@POST
@Produces(MediaType.TEXT_XML)
@Path("enrich")
@RestQuery(name = "enrich", description = "Analyze and add missing metadata of a given media file",
restParameters = {
@RestParameter(description = "MediaPackage Element, that should be enriched with metadata ", isRequired = true, name = "mediaPackageElement", type = RestParameter.Type.TEXT),
@RestParameter(description = "Should the existing metadata values remain", isRequired = true, name = "override", type = RestParameter.Type.BOOLEAN),
@RestParameter(description = "Options passed to media inspection service", isRequired = false, name = "options", type = RestParameter.Type.STRING) },
responses = {
@RestResponse(description = "XML encoded receipt is returned.", responseCode = HttpServletResponse.SC_OK),
@RestResponse(description = "Service unavailabe or not currently present", responseCode = HttpServletResponse.SC_SERVICE_UNAVAILABLE),
@RestResponse(description = "Problem retrieving media file or invalid media file or URL.", responseCode = HttpServletResponse.SC_INTERNAL_SERVER_ERROR) },
returnDescription = "Return a receipt to check on the status and outcome of the job")
public Response enrichTrack(@FormParam("mediaPackageElement") String mediaPackageElement,
@FormParam("override") boolean override, @FormParam("options") String options) {
checkNotNull(service);
try {
Job job = service.enrich(MediaPackageElementParser.getFromXml(mediaPackageElement), override,
Options.fromJson(options));
return Response.ok(new JaxbJob(job)).build();
} catch (Exception e) {
logger.info("Unable to enrich track {}: {}", mediaPackageElement, e.getMessage());
return Response.serverError().build();
}
}
/**
* {@inheritDoc}
*
* @see org.opencastproject.rest.AbstractJobProducerEndpoint#getService()
*/
@Override
public JobProducer getService() {
if (service instanceof JobProducer)
return (JobProducer) service;
else
return null;
}
/**
* {@inheritDoc}
*
* @see org.opencastproject.rest.AbstractJobProducerEndpoint#getServiceRegistry()
*/
@Override
public ServiceRegistry getServiceRegistry() {
return serviceRegistry;
}
/**
* Checks if the service or services are available, if not it handles it by returning a 503 with a message
*
* @param services
* an array of services to check
*/
protected void checkNotNull(Object... services) {
if (services != null) {
for (Object object : services) {
if (object == null) {
throw new javax.ws.rs.WebApplicationException(javax.ws.rs.core.Response.Status.SERVICE_UNAVAILABLE);
}
}
}
}
}