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 -
Method Summary
Modifier and TypeMethodDescriptiondistribute(String channelId, MediaPackage mediapackage, String elementId) Distribute a media package element.distributeSync(String channelId, MediaPackage mediapackage, String elementId) Distributes a media package element synchronously, bypassing the Opencast job system.Returns the distribution type for this service.retract(String channelId, MediaPackage mediaPackage, String elementId) Retract a media package element from the distribution channel.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
A prefix used by distribution service implementations to indicate the types of distribution channels they manage.- See Also:
-
CONFIG_KEY_STORE_TYPE
- See Also:
-
-
Method Details
-
distribute
Job distribute(String channelId, MediaPackage mediapackage, String elementId) throws DistributionException, MediaPackageException Distribute a media package element.- Parameters:
mediapackage- the media packageelementId- the element in the media package to distribute- Returns:
- The job
- Throws:
DistributionException- if there was a problem distributing the mediaMediaPackageException- if there was a problem with the mediapackage element
-
distributeSync
List<MediaPackageElement> distributeSync(String channelId, MediaPackage mediapackage, String elementId) throws DistributionException, MediaPackageException Distributes a media package element synchronously, bypassing the Opencast job system.- Parameters:
mediapackage- the media packageelementId- the element in the media package to distribute- Returns:
- list of distributed media package elements
- Throws:
DistributionException- if there was a problem distributing the mediaMediaPackageException- if there was a problem with the mediapackage element
-
retract
Job retract(String channelId, MediaPackage mediaPackage, String elementId) throws DistributionException Retract a media package element from the distribution channel.- Parameters:
mediaPackage- the media packageelementId- 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, MediaPackageException Retract a media package element from the distribution channel synchronously, bypassing the Opencast job system.- Parameters:
mediaPackage- the media packageelementId- the media package element to retract- Returns:
- list of retracted media package elements
- Throws:
DistributionException- if there was a problem retracting the mediapackageMediaPackageException
-
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"
-