Package org.opencastproject.inspection.ffmpeg.endpoints

Class MediaInspectionRestEndpoint

java.lang.Object

org.opencastproject.rest.AbstractJobProducerEndpoint

org.opencastproject.inspection.ffmpeg.endpoints.MediaInspectionRestEndpoint

@Path("/inspection")
public class MediaInspectionRestEndpoint
extends AbstractJobProducerEndpoint

A service endpoint to expose the MediaInspectionService via REST.

Field Summary

Fields

Modifier and Type	Field	Description
protected MediaInspectionService	service	The inspection service
protected ServiceRegistry	serviceRegistry	The service registry

Constructor Summary

Constructors

Constructor	Description
MediaInspectionRestEndpoint()

Method Summary

Modifier and Type	Method	Description
void	activate(org.osgi.service.component.ComponentContext cc)	Callback from OSGi that is called when this service is activated.
protected void	checkNotNull(Object... services)	Checks if the service or services are available, if not it handles it by returning a 503 with a message
javax.ws.rs.core.Response	enrichTrack(String mediaPackageElement, boolean override, String options)
JobProducer	getService()	Returns the job producer that is backing this REST endpoint.
ServiceRegistry	getServiceRegistry()	Return the service registry.
javax.ws.rs.core.Response	inspectTrack(URI uri, String options)
void	setService(MediaInspectionService service)	Sets the inspection service
protected void	setServiceRegistry(ServiceRegistry serviceRegistry)	Callback from the OSGi declarative services to set the service registry.
void	unsetService(MediaInspectionService service)	Removes the inspection 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

service

protected MediaInspectionService service

The inspection service

serviceRegistry

protected ServiceRegistry serviceRegistry

The service registry

Constructor Details

MediaInspectionRestEndpoint

public MediaInspectionRestEndpoint()

Method Details

setServiceRegistry

protected void setServiceRegistry(ServiceRegistry serviceRegistry)

Callback from the OSGi declarative services to set the service registry.

Parameters:

serviceRegistry - the service registry

setService

public void setService(MediaInspectionService service)

Sets the inspection service

Parameters:

service - the inspection service

unsetService

public void unsetService(MediaInspectionService service)

Removes the inspection service

Parameters:

service -

activate

public void activate(org.osgi.service.component.ComponentContext cc)

Callback from OSGi that is called when this service is activated.

Parameters:

cc - OSGi component context

inspectTrack

@GET
@Produces("text/xml")
@Path("inspect")
public javax.ws.rs.core.Response inspectTrack(@QueryParam("uri")
 URI uri,
 @QueryParam("options")
 String options)

enrichTrack

@POST
@Produces("text/xml")
@Path("enrich")
public javax.ws.rs.core.Response enrichTrack(@FormParam("mediaPackageElement")
 String mediaPackageElement,
 @FormParam("override")
 boolean override,
 @FormParam("options")
 String options)

getService

public JobProducer getService()

Returns the job producer that is backing this REST endpoint.

Specified by:

getService in class AbstractJobProducerEndpoint

Returns:

the job producer

See Also:

• AbstractJobProducerEndpoint.getService()

getServiceRegistry

public ServiceRegistry getServiceRegistry()

Return the service registry.

Specified by:

getServiceRegistry in class AbstractJobProducerEndpoint

See Also:

• AbstractJobProducerEndpoint.getServiceRegistry()

checkNotNull

protected void checkNotNull(Object... services)

Checks if the service or services are available, if not it handles it by returning a 503 with a message

Parameters:

services - an array of services to check