Package org.opencastproject.distribution.aws.s3.endpoint

Class AwsS3DistributionRestService

java.lang.Object

org.opencastproject.rest.AbstractJobProducerEndpoint

org.opencastproject.distribution.aws.s3.endpoint.AwsS3DistributionRestService

@Path("/distribution/s3")
public class AwsS3DistributionRestService
extends AbstractJobProducerEndpoint

Rest endpoint for distributing files to AWS S3.

Field Summary

Fields

Modifier and Type	Field	Description
protected AwsS3DistributionService	service	The distribution service
protected ServiceRegistry	serviceRegistry	The service registry

Constructor Summary

Constructors

Constructor	Description
AwsS3DistributionRestService()

Method Summary

Modifier and Type	Method	Description
void	activate(org.osgi.service.component.ComponentContext cc)	OSGi activation callback
javax.ws.rs.core.Response	distribute(String mediaPackageXml, String channelId, String elementId, boolean checkAvailability)
javax.ws.rs.core.Response	distributeSync(String mediaPackageXml, String channelId, String elementId, boolean checkAvailability)
JobProducer	getService()	Returns the job producer that is backing this REST endpoint.
ServiceRegistry	getServiceRegistry()	Return the service registry.
javax.ws.rs.core.Response	retract(String mediaPackageXml, String channelId, String elementId)
javax.ws.rs.core.Response	retractSync(String mediaPackageXml, String channelId, String elementId)
void	setService(AwsS3DistributionService service)
protected void	setServiceRegistry(ServiceRegistry serviceRegistry)	Callback from the OSGi declarative services to set the service registry.

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 AwsS3DistributionService service

The distribution service

serviceRegistry

protected ServiceRegistry serviceRegistry

The service registry

Constructor Details

AwsS3DistributionRestService

public AwsS3DistributionRestService()

Method Details

activate

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

OSGi activation callback

Parameters:

cc - this component's context

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(AwsS3DistributionService service)

Parameters:

service - the service to set

distribute

@POST
@Path("/")
@Produces("text/xml")
public javax.ws.rs.core.Response distribute(@FormParam("mediapackage")
 String mediaPackageXml,
 @FormParam("channelId")
 String channelId,
 @FormParam("elementId")
 String elementId,
 @FormParam("checkAvailability") @DefaultValue("true")
 boolean checkAvailability)
                                     throws Exception

Throws:

Exception

distributeSync

@POST
@Path("/distributesync")
@Produces("text/xml")
public javax.ws.rs.core.Response distributeSync(@FormParam("mediapackage")
 String mediaPackageXml,
 @FormParam("channelId")
 String channelId,
 @FormParam("elementId")
 String elementId,
 @FormParam("checkAvailability") @DefaultValue("true")
 boolean checkAvailability)
                                         throws Exception

Throws:

Exception

retract

@POST
@Path("/retract")
@Produces("text/xml")
public javax.ws.rs.core.Response retract(@FormParam("mediapackage")
 String mediaPackageXml,
 @FormParam("channelId")
 String channelId,
 @FormParam("elementId")
 String elementId)
                                  throws Exception

Throws:

Exception

retractSync

@POST
@Path("/retractsync")
@Produces("text/xml")
public javax.ws.rs.core.Response retractSync(@FormParam("mediapackage")
 String mediaPackageXml,
 @FormParam("channelId")
 String channelId,
 @FormParam("elementId")
 String elementId)
                                      throws Exception

Throws:

Exception

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()