Package org.opencastproject.distribution.api

Interface DistributionService

All Known Subinterfaces:

AwsS3DistributionService, DownloadDistributionService, StreamingDistributionService

All Known Implementing Classes:

AwsS3DistributionServiceImpl, AwsS3DistributionServiceRemoteImpl, DownloadDistributionServiceImpl, DownloadDistributionServiceRemoteImpl, StreamingDistributionServiceRemoteImpl, WowzaStreamingDistributionService

public interface DistributionService

Distributes elements from MediaPackages to distribution channels.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIG_KEY_STORE_TYPE
static final String	JOB_TYPE_PREFIX	A prefix used by distribution service implementations to indicate the types of distribution channels they manage.

Method Summary

Modifier and Type	Method	Description
Job	distribute(String channelId, MediaPackage mediapackage, String elementId)	Distribute a media package element.
List<MediaPackageElement>	distributeSync(String channelId, MediaPackage mediapackage, String elementId)	Distributes a media package element synchronously, bypassing the Opencast job system.
String	getDistributionType()	Returns the distribution type for this service.
Job	retract(String channelId, MediaPackage mediaPackage, String elementId)	Retract a media package element from the distribution channel.
List<MediaPackageElement>	retractSync(String channelId, MediaPackage mediaPackage, String elementId)	Retract a media package element from the distribution channel synchronously, bypassing the Opencast job system.

Field Details

JOB_TYPE_PREFIX

static final String JOB_TYPE_PREFIX

A prefix used by distribution service implementations to indicate the types of distribution channels they manage.

See Also:

• Constant Field Values

CONFIG_KEY_STORE_TYPE

static final String CONFIG_KEY_STORE_TYPE

See Also:

• Constant Field Values

Method Details

distribute

Job distribute(String channelId,
 MediaPackage mediapackage,
 String elementId)
        throws DistributionException

Distribute a media package element.

Parameters:

mediapackage - the media package

elementId - the element in the media package to distribute

Returns:

The job

Throws:

DistributionException - if there was a problem distributing the media

distributeSync

List<MediaPackageElement> distributeSync(String channelId,
 MediaPackage mediapackage,
 String elementId)
                                  throws DistributionException

Distributes a media package element synchronously, bypassing the Opencast job system.

Parameters:

mediapackage - the media package

elementId - the element in the media package to distribute

Returns:

list of distributed media package elements

Throws:

DistributionException - if there was a problem distributing the media

retract

Job retract(String channelId,
 MediaPackage mediaPackage,
 String elementId)
     throws DistributionException

Retract a media package element from the distribution channel.

Parameters:

mediaPackage - the media package

elementId - the media package element to retract

Throws:

DistributionException - if there was a problem retracting the mediapackage

retractSync

List<MediaPackageElement> retractSync(String channelId,
 MediaPackage mediaPackage,
 String elementId)
                               throws DistributionException

Retract a media package element from the distribution channel synchronously, bypassing the Opencast job system.

Parameters:

mediaPackage - the media package

elementId - the media package element to retract

Returns:

list of retracted media package elements

Throws:

DistributionException - if there was a problem retracting the mediapackage

getDistributionType

String getDistributionType()

Returns the distribution type for this service. This type should be unique within an Opencast instance, and is used to select where file distribution happens.

Returns:

The distribution type. A string like "download", or "streaming"