Package org.opencastproject.distribution.download.remote

Class DownloadDistributionServiceRemoteImpl

java.lang.Object

org.opencastproject.serviceregistry.api.RemoteBase

org.opencastproject.distribution.download.remote.DownloadDistributionServiceRemoteImpl

All Implemented Interfaces:

DistributionService, DownloadDistributionService

public class DownloadDistributionServiceRemoteImpl
extends RemoteBase
implements DistributionService, DownloadDistributionService

A remote distribution service invoker.

Nested Class Summary

Nested classes/interfaces inherited from class org.opencastproject.serviceregistry.api.RemoteBase

RemoteBase.HttpClientClosingInputStream

Field Summary

Fields inherited from class org.opencastproject.serviceregistry.api.RemoteBase

client, elementsFromHttpResponse, remoteServiceManager, serviceType

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

CONFIG_KEY_STORE_TYPE, JOB_TYPE_PREFIX

Constructor Summary

Constructors

Constructor	Description
DownloadDistributionServiceRemoteImpl()

Method Summary

Modifier and Type	Method	Description
protected void	activate(org.osgi.service.component.ComponentContext cc)	activates the component
Job	distribute(String channelId, MediaPackage mediaPackage, String elementId)	Distribute a media package element.
Job	distribute(String channelId, MediaPackage mediaPackage, String elementId, boolean checkAvailability)
Job	distribute(String channelId, MediaPackage mediaPackage, Set<String> elementIds, boolean checkAvailability)
Job	distribute(String channelId, MediaPackage mediaPackage, Set<String> elementIds, boolean checkAvailability, boolean preserveReference)
List<MediaPackageElement>	distributeSync(String channelId, MediaPackage mediapackage, String elementId)	Distributes a media package element synchronously, bypassing the Opencast job system.
List<MediaPackageElement>	distributeSync(String channelId, MediaPackage mediapackage, Set<String> elementIds, boolean checkAvailability)	Distributes the given elements synchronously.
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.
Job	retract(String channelId, MediaPackage mediaPackage, Set<String> elementIds)
List<MediaPackageElement>	retractSync(String channelId, MediaPackage mediaPackage, String elementId)	Retract a media package element from the distribution channel synchronously, bypassing the Opencast job system.
List<MediaPackageElement>	retractSync(String channelId, MediaPackage mediaPackage, Set<String> elementIds)	Retracts the given elements synchronously.
void	setRemoteServiceManager(ServiceRegistry serviceRegistry)	Sets the remote service manager.
void	setTrustedHttpClient(TrustedHttpClient trustedHttpClient)	Sets the trusted http client

Methods inherited from class org.opencastproject.serviceregistry.api.RemoteBase

closeConnection, getResponse, getResponse, runRequest

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DownloadDistributionServiceRemoteImpl

public DownloadDistributionServiceRemoteImpl()

Method Details

getDistributionType

public String getDistributionType()

Description copied from interface: DistributionService

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.

Specified by:

getDistributionType in interface DistributionService

Returns:

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

activate

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

activates the component

distribute

public Job distribute(String channelId,
 MediaPackage mediaPackage,
 String elementId)
               throws DistributionException

Description copied from interface: DistributionService

Distribute a media package element.

Specified by:

distribute in interface DistributionService

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

distribute

public Job distribute(String channelId,
 MediaPackage mediaPackage,
 String elementId,
 boolean checkAvailability)
               throws DistributionException

Specified by:

distribute in interface DownloadDistributionService

Throws:

DistributionException

distribute

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

Specified by:

distribute in interface DownloadDistributionService

Throws:

DistributionException

distribute

public Job distribute(String channelId,
 MediaPackage mediaPackage,
 Set<String> elementIds,
 boolean checkAvailability,
 boolean preserveReference)
               throws DistributionException

Specified by:

distribute in interface DownloadDistributionService

Throws:

DistributionException

retract

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

Description copied from interface: DistributionService

Retract a media package element from the distribution channel.

Specified by:

retract in interface DistributionService

Parameters:

mediaPackage - the media package

elementId - the media package element to retract

Throws:

DistributionException - if there was a problem retracting the mediapackage

retract

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

Specified by:

retract in interface DownloadDistributionService

Throws:

DistributionException

distributeSync

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

Description copied from interface: DistributionService

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

Specified by:

distributeSync in interface DistributionService

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

MediaPackageException - if there was a problem with the mediapackage element

distributeSync

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

Description copied from interface: DownloadDistributionService

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.

Specified by:

distributeSync in interface DownloadDistributionService

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

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

Description copied from interface: DistributionService

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

Specified by:

retractSync in interface DistributionService

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

retractSync

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

Description copied from interface: DownloadDistributionService

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.

Specified by:

retractSync in interface DownloadDistributionService

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.

setTrustedHttpClient

public void setTrustedHttpClient(TrustedHttpClient trustedHttpClient)

Description copied from class: RemoteBase

Sets the trusted http client

Overrides:

setTrustedHttpClient in class RemoteBase

Parameters:

trustedHttpClient -

setRemoteServiceManager

public void setRemoteServiceManager(ServiceRegistry serviceRegistry)

Description copied from class: RemoteBase

Sets the remote service manager.

Overrides:

setRemoteServiceManager in class RemoteBase

Parameters:

serviceRegistry -