Package org.opencastproject.distribution.api

Interface DownloadDistributionService

All Superinterfaces:

DistributionService

All Known Subinterfaces:

AwsS3DistributionService

All Known Implementing Classes:

AwsS3DistributionServiceImpl, AwsS3DistributionServiceRemoteImpl, DownloadDistributionServiceImpl, DownloadDistributionServiceRemoteImpl

public interface DownloadDistributionService
extends DistributionService

Distributes elements from MediaPackages to distribution channels.

Field Summary

Fields inherited from interface org.opencastproject.distribution.api.DistributionService

CONFIG_KEY_STORE_TYPE, JOB_TYPE_PREFIX

Method Summary

Modifier and Type	Method	Description
Job	distribute(String channelId, MediaPackage mediapackage, String elementId, boolean checkAvailability)
Job	distribute(String channelId, MediaPackage mediapackage, Set<String> elementIds, boolean checkAvailability)
Job	distribute(String pubChannelId, MediaPackage mediaPackage, Set<String> downloadIds, boolean checkAvailability, boolean preserveReference)
List<MediaPackageElement>	distributeSync(String channelId, MediaPackage mediapackage, Set<String> elementIds, boolean checkAvailability)	Distributes the given elements synchronously.
Job	retract(String channelId, MediaPackage mediaPackage, Set<String> elementIds)
List<MediaPackageElement>	retractSync(String channelId, MediaPackage mediaPackage, Set<String> elementIds)	Retracts the given elements synchronously.

Methods inherited from interface org.opencastproject.distribution.api.DistributionService

distribute, distributeSync, getDistributionType, retract, retractSync

Method Details

distribute

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

Throws:

DistributionException

MediaPackageException

distribute

Job distribute(String channelId,
 MediaPackage mediapackage,
 Set<String> elementIds,
 boolean checkAvailability)
        throws DistributionException,
MediaPackageException

Throws:

DistributionException

MediaPackageException

distribute

Job distribute(String pubChannelId,
 MediaPackage mediaPackage,
 Set<String> downloadIds,
 boolean checkAvailability,
 boolean preserveReference)
        throws DistributionException,
MediaPackageException

Throws:

DistributionException

MediaPackageException

retract

Job retract(String channelId,
 MediaPackage mediaPackage,
 Set<String> elementIds)
     throws DistributionException

Throws:

DistributionException

distributeSync

List<MediaPackageElement> distributeSync(String channelId,
 MediaPackage mediapackage,
 Set<String> elementIds,
 boolean checkAvailability)
                                  throws DistributionException

Distributes the given elements synchronously. This should be used rarely since load balancing will be unavailable. However, since the dispatching logic is bypassed, synchronous execution is much faster. It is useful in interactive scenarios where you synchronously wait for job execution anyway and you don't want to make the user waiting for too long.

Parameters:

channelId - The channel to retract from.

mediapackage - A media package holding the elements to retract.

elementIds - The IDs of the elements to retract.

checkAvailability - Whether to check if the distributed elements are available through their URI.

Returns:

The distributed elements.

Throws:

DistributionException - In case distribution fails.

retractSync

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

Retracts the given elements synchronously. This should be used rarely since load balancing will be unavailable. However, since the dispatching logic is bypassed, synchronous execution is much faster. It is useful in interactive scenarios where you synchronously wait for job execution anyway and you don't want to make the user waiting for too long.

Parameters:

channelId - The channel to retract from.

mediaPackage - A media package holding the elements to retract.

elementIds - The IDs of the elements to retract.

Returns:

The retracted elements.

Throws:

DistributionException - In case retraction fails.