Package org.opencastproject.ingest.endpoint

Class IngestRestService

java.lang.Object
org.opencastproject.rest.AbstractJobProducerEndpoint
org.opencastproject.ingest.endpoint.IngestRestService
@Path("/ingest") public class IngestRestService extends org.opencastproject.rest.AbstractJobProducerEndpoint
Creates and augments Opencast MediaPackages using the api. Stores media into the Working File Repository.

  • Field Details

    • DEFAULT_WORKFLOW_DEFINITION

      protected static final String DEFAULT_WORKFLOW_DEFINITION
      Key for the default workflow definition in config.properties
      See Also:

    • MAX_INGESTS_KEY

      protected static final String MAX_INGESTS_KEY
      Key for the default maximum number of ingests in config.properties
      See Also:

    • WORKFLOW_INSTANCE_ID_PARAM

      protected static final String WORKFLOW_INSTANCE_ID_PARAM
      The http request parameter used to provide the workflow instance id
      See Also:

    • WORKFLOW_DEFINITION_ID_PARAM

      protected static final String WORKFLOW_DEFINITION_ID_PARAM
      The http request parameter used to provide the workflow definition id
      See Also:

  • Constructor Details

    • IngestRestService

      public IngestRestService()

  • Method Details

    • getIngestLimit

      protected int getIngestLimit()
      Returns the maximum number of concurrent ingest operations or -1 if no limit is enforced.
      Returns:
      the maximum number of concurrent ingest operations
      See Also:

    • isIngestLimitEnabled

      protected boolean isIngestLimitEnabled()
      Returns true if a maximum number of concurrent ingest operations has been defined.
      Returns:
      true if there is a maximum number of concurrent ingests

    • activate

      public void activate(org.osgi.service.component.ComponentContext cc)
      Callback for activation of this component.

    • createMediaPackage

      @PUT @Produces("text/xml") @Path("createMediaPackageWithID/{id}") public javax.ws.rs.core.Response createMediaPackage(@PathParam("id") String mediaPackageId)

    • createMediaPackage

      @GET @Produces("text/xml") @Path("createMediaPackage") public javax.ws.rs.core.Response createMediaPackage()

    • discardMediaPackage

      @POST @Path("discardMediaPackage") public javax.ws.rs.core.Response discardMediaPackage(@FormParam("mediaPackage") String mpx)

    • addMediaPackageTrack

      @POST @Produces("text/xml") @Path("addTrack") public javax.ws.rs.core.Response addMediaPackageTrack(@FormParam("url") String url, @FormParam("flavor") String flavor, @FormParam("tags") String tags, @FormParam("mediaPackage") String mpx)

    • addMediaPackageTrack

      @POST @Produces("text/xml") @Consumes("multipart/form-data") @Path("addTrack") public javax.ws.rs.core.Response addMediaPackageTrack(@Context javax.servlet.http.HttpServletRequest request)

    • addMediaPackagePartialTrack

      @POST @Produces("text/xml") @Path("addPartialTrack") public javax.ws.rs.core.Response addMediaPackagePartialTrack(@FormParam("url") String url, @FormParam("flavor") String flavor, @FormParam("startTime") Long startTime, @FormParam("mediaPackage") String mpx)

    • addMediaPackagePartialTrack

      @POST @Produces("text/xml") @Consumes("multipart/form-data") @Path("addPartialTrack") public javax.ws.rs.core.Response addMediaPackagePartialTrack(@Context javax.servlet.http.HttpServletRequest request)

    • addMediaPackageCatalog

      @POST @Produces("text/xml") @Path("addCatalog") public javax.ws.rs.core.Response addMediaPackageCatalog(@FormParam("url") String url, @FormParam("flavor") String flavor, @FormParam("tags") String tags, @FormParam("mediaPackage") String mpx)

    • addMediaPackageCatalog

      @POST @Produces("text/xml") @Consumes("multipart/form-data") @Path("addCatalog") public javax.ws.rs.core.Response addMediaPackageCatalog(@Context javax.servlet.http.HttpServletRequest request)

    • addMediaPackageAttachment

      @POST @Produces("text/xml") @Path("addAttachment") public javax.ws.rs.core.Response addMediaPackageAttachment(@FormParam("url") String url, @FormParam("flavor") String flavor, @FormParam("tags") String tags, @FormParam("mediaPackage") String mpx)

    • addMediaPackageAttachment

      @POST @Produces("text/xml") @Consumes("multipart/form-data") @Path("addAttachment") public javax.ws.rs.core.Response addMediaPackageAttachment(@Context javax.servlet.http.HttpServletRequest request)

    • addMediaPackageElement

      protected javax.ws.rs.core.Response addMediaPackageElement(javax.servlet.http.HttpServletRequest request, org.opencastproject.mediapackage.MediaPackageElement.Type type)

    • addMediaPackage

      @POST @Produces("text/xml") @Consumes("multipart/form-data") @Path("addMediaPackage") public javax.ws.rs.core.Response addMediaPackage(@Context javax.servlet.http.HttpServletRequest request)

    • addMediaPackage

      @POST @Produces("text/xml") @Consumes("multipart/form-data") @Path("addMediaPackage/{wdID}") public javax.ws.rs.core.Response addMediaPackage(@Context javax.servlet.http.HttpServletRequest request, @PathParam("wdID") String wdID)

    • addZippedMediaPackage

      @POST @Path("addZippedMediaPackage/{workflowDefinitionId}") @Produces("text/xml") public javax.ws.rs.core.Response addZippedMediaPackage(@Context javax.servlet.http.HttpServletRequest request, @PathParam("workflowDefinitionId") String wdID, @QueryParam("id") String wiID)

    • addZippedMediaPackage

      @POST @Path("addZippedMediaPackage") @Produces("text/xml") public javax.ws.rs.core.Response addZippedMediaPackage(@Context javax.servlet.http.HttpServletRequest request)

    • ingest

      @POST @Produces("text/xml") @Path("ingest/{wdID}") public javax.ws.rs.core.Response ingest(@Context javax.servlet.http.HttpServletRequest request, @PathParam("wdID") String wdID)

    • ingest

      @POST @Produces("text/xml") @Path("ingest") public javax.ws.rs.core.Response ingest(@Context javax.servlet.http.HttpServletRequest request)

    • schedule

      @POST @Path("schedule") public javax.ws.rs.core.Response schedule(javax.ws.rs.core.MultivaluedMap<String,String> formData)

    • schedule

      @POST @Path("schedule/{wdID}") public javax.ws.rs.core.Response schedule(@PathParam("wdID") String wdID, javax.ws.rs.core.MultivaluedMap<String,String> formData)

    • addDCCatalog

      @POST @Produces("text/xml") @Path("addDCCatalog") public javax.ws.rs.core.Response addDCCatalog(@FormParam("mediaPackage") String mp, @FormParam("dublinCore") String dc, @FormParam("flavor") String flavor)
      Adds a dublinCore metadata catalog to the MediaPackage and returns the grown mediaPackage. JQuery Ajax functions doesn't support multipart/form-data encoding.
      Parameters:
      mp - MediaPackage
      dc - DublinCoreCatalog
      Returns:
      grown MediaPackage XML

    • 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

    • setHttpClient

      public void setHttpClient(org.opencastproject.security.api.TrustedHttpClient httpClient)
      Sets the trusted http client
      Parameters:
      httpClient - the http client