Package org.opencastproject.distribution.download

Class DownloadDistributionServiceImpl

java.lang.Object

org.opencastproject.job.api.AbstractJobProducer

org.opencastproject.distribution.api.AbstractDistributionService

org.opencastproject.distribution.download.DownloadDistributionServiceImpl

All Implemented Interfaces:

DistributionService, DownloadDistributionService, JobProducer, org.osgi.service.cm.ManagedService

public class DownloadDistributionServiceImpl
extends AbstractDistributionService
implements DistributionService, DownloadDistributionService, org.osgi.service.cm.ManagedService

Distributes media to the local media delivery directory.

Field Summary

Fields

Modifier and Type	Field	Description
static final float	DEFAULT_DISTRIBUTE_JOB_LOAD	The load on the system introduced by creating a distribute job
static final float	DEFAULT_RETRACT_JOB_LOAD	The load on the system introduced by creating a retract job
static final String	DISTRIBUTE_JOB_LOAD_KEY	The key to look for in the service configuration file to override the DEFAULT_DISTRIBUTE_JOB_LOAD
static final String	JOB_TYPE	Receipt type
static final String	RETRACT_JOB_LOAD_KEY	The key to look for in the service configuration file to override the DEFAULT_RETRACT_JOB_LOAD

Fields inherited from class org.opencastproject.distribution.api.AbstractDistributionService

distributionChannel, distributionDirectory, organizationDirectoryService, securityService, serviceRegistry, serviceUrl, trustedHttpClient, userDirectoryService, workspace

Fields inherited from class org.opencastproject.job.api.AbstractJobProducer

ACCEPT_JOB_LOADS_EXCEEDING_PROPERTY, acceptJobLoadsExeedingMaxLoad, DEFAULT_ACCEPT_JOB_LOADS_EXCEEDING, executor, jobType

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

CONFIG_KEY_STORE_TYPE, JOB_TYPE_PREFIX

Constructor Summary

Constructors

Constructor	Description
DownloadDistributionServiceImpl()	Creates a new instance of the download distribution service.

Method Summary

Modifier and Type	Method	Description
void	activate(org.osgi.service.component.ComponentContext cc)	Activate method for this OSGi service implementation.
Track	checkDistributeHLSElement(Track element, boolean checkAvailability)
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)
MediaPackageElement	distributeElement(String channelId, MediaPackage mediapackage, MediaPackageElement element, boolean checkAvailability, boolean preserveReference)	Distribute a Mediapackage element to the download distribution service.
MediaPackageElement[]	distributeElements(String channelId, MediaPackage mediapackage, Set<String> elementIds, boolean checkAvailability)	Distribute Mediapackage elements to the download distribution service.
MediaPackageElement[]	distributeElements(String channelId, MediaPackage mediapackage, Set<String> elementIds, boolean checkAvailability, boolean preserveReference)	Distribute Mediapackage elements to the download distribution service.
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.
List<MediaPackageElement>	distributeSync(String channelId, MediaPackage mediapackage, Set<String> elementIds, boolean checkAvailability, boolean preserveReference)
protected File	getDistributionFile(String channelId, MediaPackage mp, MediaPackageElement element)	Gets the destination file to copy the contents of a mediapackage element.
String	getDistributionType()	Returns the distribution type for this service.
protected URI	getDistributionUri(String channelId, String mediaPackageId, MediaPackageElement element)	Gets the URI for the element to be distributed.
protected File	getMediaPackageDirectory(String channelId, MediaPackage mp)	Gets the directory containing the distributed files for this mediapackage.
protected String	process(Job job)	Asks the overriding class to process the arguments using the given operation.
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)
protected MediaPackageElement	retractElement(String channelId, MediaPackage mediapackage, MediaPackageElement element)	Retract a media package element from the distribution channel.
protected MediaPackageElement[]	retractElements(String channelId, MediaPackage mediapackage, Set<String> elementIds)	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.
List<MediaPackageElement>	retractSync(String channelId, MediaPackage mediapackage, Set<String> elementIds)	Retracts the given elements synchronously.
void	setOrganizationDirectoryService(OrganizationDirectoryService organizationDirectoryService)	Sets a reference to the organization directory service.
void	setSecurityService(SecurityService securityService)	Callback for setting the security service.
void	setServiceRegistry(ServiceRegistry serviceRegistry)	Callback for the OSGi environment to set the service registry reference.
void	setTrustedHttpClient(TrustedHttpClient trustedHttpClient)	Callback for the OSGi environment to set the trusted http clientreference.
Track	setUpHLSElementforDistribution(String channelId, MediaPackage mediapackage, Track element, boolean preserveReference)
void	setUserDirectoryService(UserDirectoryService userDirectoryService)	Callback for setting the user directory service.
void	setWorkspace(Workspace workspace)	Callback for the OSGi environment to set the workspace reference.
void	updated(Dictionary properties)

Methods inherited from class org.opencastproject.distribution.api.AbstractDistributionService

getOrganizationDirectoryService, getSecurityService, getServiceRegistry, getTrustedHttpClient, getUserDirectoryService

Methods inherited from class org.opencastproject.job.api.AbstractJobProducer

acceptJob, countJobs, finallyUpdateJob, getJobType, incident, isReadyToAccept, isReadyToAcceptJobs

Methods inherited from class java.lang.Object

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

Field Details

JOB_TYPE

public static final String JOB_TYPE

Receipt type

See Also:

• Constant Field Values

DEFAULT_DISTRIBUTE_JOB_LOAD

public static final float DEFAULT_DISTRIBUTE_JOB_LOAD

The load on the system introduced by creating a distribute job

See Also:

• Constant Field Values

DEFAULT_RETRACT_JOB_LOAD

public static final float DEFAULT_RETRACT_JOB_LOAD

The load on the system introduced by creating a retract job

See Also:

• Constant Field Values

DISTRIBUTE_JOB_LOAD_KEY

public static final String DISTRIBUTE_JOB_LOAD_KEY

The key to look for in the service configuration file to override the DEFAULT_DISTRIBUTE_JOB_LOAD

See Also:

• Constant Field Values

RETRACT_JOB_LOAD_KEY

public static final String RETRACT_JOB_LOAD_KEY

The key to look for in the service configuration file to override the DEFAULT_RETRACT_JOB_LOAD

See Also:

• Constant Field Values

Constructor Details

DownloadDistributionServiceImpl

public DownloadDistributionServiceImpl()

Creates a new instance of the download distribution service.

Method Details

activate

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

Activate method for this OSGi service implementation.

Overrides:

activate in class AbstractJobProducer

Parameters:

cc - the OSGi component context

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"

distribute

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

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

MediaPackageException - if there was a problem with the mediapackage element

distribute

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

Specified by:

distribute in interface DownloadDistributionService

Throws:

DistributionException

MediaPackageException

distribute

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

Specified by:

distribute in interface DownloadDistributionService

Throws:

DistributionException

MediaPackageException

distribute

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

Specified by:

distribute in interface DownloadDistributionService

Throws:

DistributionException

MediaPackageException

distributeElements

public MediaPackageElement[] distributeElements(String channelId,
 MediaPackage mediapackage,
 Set<String> elementIds,
 boolean checkAvailability)
                                         throws DistributionException

Distribute Mediapackage elements to the download distribution service.

Parameters:

channelId - # The id of the publication channel to be distributed to.

mediapackage - The media package that contains the elements to be distributed.

elementIds - The ids of the elements that should be distributed contained within the media package.

checkAvailability - Check the availability of the distributed element via http.

Returns:

A reference to the MediaPackageElements that have been distributed.

Throws:

DistributionException - Thrown if the parent directory of the MediaPackageElement cannot be created, if the MediaPackageElement cannot be copied or another unexpected exception occurs.

distributeElements

public MediaPackageElement[] distributeElements(String channelId,
 MediaPackage mediapackage,
 Set<String> elementIds,
 boolean checkAvailability,
 boolean preserveReference)
                                         throws DistributionException

Distribute Mediapackage elements to the download distribution service.

Parameters:

channelId - # The id of the publication channel to be distributed to.

mediapackage - The media package that contains the elements to be distributed.

elementIds - The ids of the elements that should be distributed contained within the media package.

checkAvailability - Check the availability of the distributed element via http.

preserveReference - copy actual Reference to the new distributed element

Returns:

A reference to the MediaPackageElements that have been distributed.

Throws:

DistributionException - Thrown if the parent directory of the MediaPackageElement cannot be created, if the MediaPackageElement cannot be copied or another unexpected exception occurs.

distributeElement

public MediaPackageElement distributeElement(String channelId,
 MediaPackage mediapackage,
 MediaPackageElement element,
 boolean checkAvailability,
 boolean preserveReference)
                                      throws DistributionException

Distribute a Mediapackage element to the download distribution service.

Parameters:

channelId - # The id of the publication channel to be distributed to.

mediapackage - The media package that contains the element to be distributed.

element - The the element that should be distributed contained within the media package.

checkAvailability - Check the availability of the distributed element via http.

preserveReference - Copy existing Track-Reference to the new distributed Track

Returns:

A reference to the MediaPackageElement that has been distributed.

Throws:

DistributionException - Thrown if the parent directory of the MediaPackageElement cannot be created, if the MediaPackageElement cannot be copied or another unexpected exception occurs.

setUpHLSElementforDistribution

public Track setUpHLSElementforDistribution(String channelId,
 MediaPackage mediapackage,
 Track element,
 boolean preserveReference)
                                     throws DistributionException

Throws:

DistributionException

checkDistributeHLSElement

public Track checkDistributeHLSElement(Track element,
 boolean checkAvailability)
                                throws DistributionException

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,
 boolean preserveReference)
                                         throws DistributionException,
MediaPackageException

Throws:

DistributionException

MediaPackageException

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,
MediaPackageException

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

MediaPackageException

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.

retractElements

protected MediaPackageElement[] retractElements(String channelId,
 MediaPackage mediapackage,
 Set<String> elementIds)
                                         throws DistributionException

Retract a media package element from the distribution channel. The retracted element must not necessarily be the one given as parameter elementId. Instead, the element's distribution URI will be calculated. This way you are able to retract elements by providing the "original" element here.

Parameters:

channelId - the channel id

mediapackage - the mediapackage

elementIds - the element identifiers

Returns:

the retracted element or null if the element was not retracted

Throws:

DistributionException - in case of an error

retractElement

protected MediaPackageElement retractElement(String channelId,
 MediaPackage mediapackage,
 MediaPackageElement element)
                                      throws DistributionException

Retract a media package element from the distribution channel. The retracted element must not necessarily be the one given as parameter elementId. Instead, the element's distribution URI will be calculated. This way you are able to retract elements by providing the "original" element here.

Parameters:

channelId - the channel id

mediapackage - the mediapackage

element - the element

Returns:

the retracted element or null if the element was not retracted

Throws:

DistributionException - in case of an error

process

protected String process(Job job)
                  throws Exception

Asks the overriding class to process the arguments using the given operation. The result will be added to the associated job as the payload.

Specified by:

process in class AbstractJobProducer

Parameters:

job - the job to process

Returns:

the operation result

Throws:

Exception

See Also:

• AbstractJobProducer.process(org.opencastproject.job.api.Job)

getDistributionFile

protected File getDistributionFile(String channelId,
 MediaPackage mp,
 MediaPackageElement element)

Gets the destination file to copy the contents of a mediapackage element.

Returns:

The file to copy the content to

getMediaPackageDirectory

protected File getMediaPackageDirectory(String channelId,
 MediaPackage mp)

Gets the directory containing the distributed files for this mediapackage.

Returns:

the filesystem directory

getDistributionUri

protected URI getDistributionUri(String channelId,
 String mediaPackageId,
 MediaPackageElement element)
                          throws URISyntaxException

Gets the URI for the element to be distributed.

Parameters:

mediaPackageId - the mediapackage identifier

element - The mediapackage element being distributed

Returns:

The resulting URI after distribution

Throws:

URISyntaxException - if the concrete implementation tries to create a malformed uri

updated

public void updated(Dictionary properties)
             throws org.osgi.service.cm.ConfigurationException

Specified by:

updated in interface org.osgi.service.cm.ManagedService

Throws:

org.osgi.service.cm.ConfigurationException

setWorkspace

public void setWorkspace(Workspace workspace)

Description copied from class: AbstractDistributionService

Callback for the OSGi environment to set the workspace reference.

Overrides:

setWorkspace in class AbstractDistributionService

Parameters:

workspace - the workspace

setServiceRegistry

public void setServiceRegistry(ServiceRegistry serviceRegistry)

Description copied from class: AbstractDistributionService

Callback for the OSGi environment to set the service registry reference.

Overrides:

setServiceRegistry in class AbstractDistributionService

Parameters:

serviceRegistry - the service registry

setSecurityService

public void setSecurityService(SecurityService securityService)

Description copied from class: AbstractDistributionService

Callback for setting the security service.

Overrides:

setSecurityService in class AbstractDistributionService

Parameters:

securityService - the securityService to set

setUserDirectoryService

public void setUserDirectoryService(UserDirectoryService userDirectoryService)

Description copied from class: AbstractDistributionService

Callback for setting the user directory service.

Overrides:

setUserDirectoryService in class AbstractDistributionService

Parameters:

userDirectoryService - the userDirectoryService to set

setOrganizationDirectoryService

public void setOrganizationDirectoryService(OrganizationDirectoryService organizationDirectoryService)

Description copied from class: AbstractDistributionService

Sets a reference to the organization directory service.

Overrides:

setOrganizationDirectoryService in class AbstractDistributionService

Parameters:

organizationDirectoryService - the organization directory

setTrustedHttpClient

public void setTrustedHttpClient(TrustedHttpClient trustedHttpClient)

Description copied from class: AbstractDistributionService

Callback for the OSGi environment to set the trusted http clientreference.

Overrides:

setTrustedHttpClient in class AbstractDistributionService

Parameters:

trustedHttpClient - the trusted http client