Package org.opencastproject.timelinepreviews.endpoint

Class TimelinePreviewsRestEndpoint

java.lang.Object
org.opencastproject.rest.AbstractJobProducerEndpoint
org.opencastproject.timelinepreviews.endpoint.TimelinePreviewsRestEndpoint
@Path("/timelinepreviews") public class TimelinePreviewsRestEndpoint extends org.opencastproject.rest.AbstractJobProducerEndpoint
The REST endpoint for the TimelinePreviewsService service

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected String
    docs
    The rest docs
    protected org.opencastproject.timelinepreviews.api.TimelinePreviewsService
    service
    The timeline previews service
    protected org.opencastproject.serviceregistry.api.ServiceRegistry
    serviceRegistry
    The service registry

  • Constructor Summary

    Constructors
    Constructor
    Description
    TimelinePreviewsRestEndpoint()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    javax.ws.rs.core.Response
    createTimelinePreviews(String trackAsXml, int imageCount)
    Generates timeline preview images for a track.
    String
    getDocs()
     
    org.opencastproject.job.api.JobProducer
    getService()
     
    org.opencastproject.serviceregistry.api.ServiceRegistry
    getServiceRegistry()
     
    protected void
    setServiceRegistry(org.opencastproject.serviceregistry.api.ServiceRegistry serviceRegistry)
    Callback from the OSGi declarative services to set the service registry.
    protected void
    setTimelinePreviewsService(org.opencastproject.timelinepreviews.api.TimelinePreviewsService timelinePreviewsService)
    Sets the timeline previews service

    Methods inherited from class org.opencastproject.rest.AbstractJobProducerEndpoint

    checkHeartbeat, dispatchJob

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • docs

      protected String docs
      The rest docs

    • service

      protected org.opencastproject.timelinepreviews.api.TimelinePreviewsService service
      The timeline previews service

    • serviceRegistry

      protected org.opencastproject.serviceregistry.api.ServiceRegistry serviceRegistry
      The service registry

  • Constructor Details

    • TimelinePreviewsRestEndpoint

      public TimelinePreviewsRestEndpoint()

  • Method Details

    • setServiceRegistry

      protected void setServiceRegistry(org.opencastproject.serviceregistry.api.ServiceRegistry serviceRegistry)
      Callback from the OSGi declarative services to set the service registry.
      Parameters:
      serviceRegistry - the service registry

    • setTimelinePreviewsService

      protected void setTimelinePreviewsService(org.opencastproject.timelinepreviews.api.TimelinePreviewsService timelinePreviewsService)
      Sets the timeline previews service
      Parameters:
      timelinePreviewsService - the timeline previews service

    • createTimelinePreviews

      @POST @Path("/create") @Produces("text/xml") public javax.ws.rs.core.Response createTimelinePreviews(@FormParam("track") String trackAsXml, @FormParam("imageCount") int imageCount) throws Exception
      Generates timeline preview images for a track.
      Parameters:
      trackAsXml - the track xml to create preview images for
      Returns:
      the job in the body of a JAX-RS response
      Throws:
      Exception

    • getDocs

      @GET @Produces("text/html") @Path("docs") public String getDocs()

    • getService

      public org.opencastproject.job.api.JobProducer getService()
      Specified by:
      getService in class org.opencastproject.rest.AbstractJobProducerEndpoint

    • getServiceRegistry

      public org.opencastproject.serviceregistry.api.ServiceRegistry getServiceRegistry()
      Specified by:
      getServiceRegistry in class org.opencastproject.rest.AbstractJobProducerEndpoint