Package org.opencastproject.distribution.streaming.wowza

Class WowzaStreamingDistributionService

java.lang.Object

org.opencastproject.job.api.AbstractJobProducer

org.opencastproject.distribution.api.AbstractDistributionService

org.opencastproject.distribution.streaming.wowza.WowzaStreamingDistributionService

All Implemented Interfaces:

DistributionService, StreamingDistributionService, JobProducer

public class WowzaStreamingDistributionService
extends AbstractDistributionService
implements StreamingDistributionService

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
protected static final String	DEFAULT_SCHEME	Default scheme
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
protected static final String	SMIL_ORDER_KEY	The key in the properties file that specifies in which order the videos in the SMIL file should be stored
protected static final String	STREAMING_DIRECTORY_KEY	The key in the properties file that defines the streaming directory.
protected Map<String,URI>	streamingUrls
protected static final String	WOWZA_FORMATS_KEY	The key in the properties file that defines the streaming formats to distribute.
protected static final String	WOWZA_PORT_KEY	The tenant specific key in the properties file that defines the wowza port.
protected static final String	WOWZA_URL_KEY	The tenant-specific key in the properties file that defines the wowza url.

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

distributionChannel, 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
WowzaStreamingDistributionService()	Creates a new instance of the streaming distribution service.

Method Summary

Modifier and Type	Method	Description
void	activate(org.osgi.framework.BundleContext bundleContext, Map<String,Object> properties)
Job	distribute(String channelId, MediaPackage mediapackage, String elementId)	Distribute a media package element.
Job	distribute(String channelId, MediaPackage mediapackage, Set<String> elementIds)
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)	Distributes the given elements synchronously.
File	getDistributionDirectory()
String	getDistributionType()	Returns the distribution type for this service.
void	modified(org.osgi.framework.BundleContext bundleContext, Map<String,Object> properties)
protected String	process(Job job)	Asks the overriding class to process the arguments using the given operation.
boolean	publishToStreaming()	Checks if streaming is enabled for the current tenant.
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	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	setUserDirectoryService(UserDirectoryService userDirectoryService)	Callback for setting the user directory service.
void	setWorkspace(Workspace workspace)	Callback for the OSGi environment to set the workspace reference.

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

getOrganizationDirectoryService, getSecurityService, getServiceRegistry, getTrustedHttpClient, getUserDirectoryService, setTrustedHttpClient

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

acceptJob, activate, 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

STREAMING_DIRECTORY_KEY

protected static final String STREAMING_DIRECTORY_KEY

The key in the properties file that defines the streaming directory.

See Also:

• Constant Field Values

WOWZA_FORMATS_KEY

protected static final String WOWZA_FORMATS_KEY

The key in the properties file that defines the streaming formats to distribute.

See Also:

• Constant Field Values

WOWZA_URL_KEY

protected static final String WOWZA_URL_KEY

The tenant-specific key in the properties file that defines the wowza url.

See Also:

• Constant Field Values

WOWZA_PORT_KEY

protected static final String WOWZA_PORT_KEY

The tenant specific key in the properties file that defines the wowza port.

See Also:

• Constant Field Values

streamingUrls

protected Map<String,URI> streamingUrls

SMIL_ORDER_KEY

protected static final String SMIL_ORDER_KEY

The key in the properties file that specifies in which order the videos in the SMIL file should be stored

See Also:

• Constant Field Values

DEFAULT_SCHEME

protected static final String DEFAULT_SCHEME

Default scheme

See Also:

• Constant Field Values

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

WowzaStreamingDistributionService

public WowzaStreamingDistributionService()

Creates a new instance of the streaming distribution service.

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

public void activate(org.osgi.framework.BundleContext bundleContext,
 Map<String,Object> properties)
              throws org.osgi.service.component.ComponentException,
org.osgi.service.cm.ConfigurationException

Throws:

org.osgi.service.component.ComponentException

org.osgi.service.cm.ConfigurationException

modified

public void modified(org.osgi.framework.BundleContext bundleContext,
 Map<String,Object> properties)
              throws org.osgi.service.component.ComponentException,
org.osgi.service.cm.ConfigurationException

Throws:

org.osgi.service.component.ComponentException

org.osgi.service.cm.ConfigurationException

publishToStreaming

public boolean publishToStreaming()

Description copied from interface: StreamingDistributionService

Checks if streaming is enabled for the current tenant.

Specified by:

publishToStreaming in interface StreamingDistributionService

Returns:

whether streaming is enabled for the current tenant

distribute

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

Specified by:

distribute in interface StreamingDistributionService

Throws:

DistributionException

See Also:

• StreamingDistributionService.distribute(java.lang.String, org.opencastproject.mediapackage.MediaPackage, java.util.Set)

distribute

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

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

See Also:

• DistributionService.distribute(String, org.opencastproject.mediapackage.MediaPackage, String)

retract

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

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

See Also:

• java.lang.String)

retract

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

Specified by:

retract in interface StreamingDistributionService

Throws:

DistributionException

See Also:

• StreamingDistributionService.retract(java.lang.String, org.opencastproject.mediapackage.MediaPackage, java.util.Set)

distributeSync

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

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

distributeSync

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

Description copied from interface: StreamingDistributionService

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 StreamingDistributionService

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 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: StreamingDistributionService

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 StreamingDistributionService

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.

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)

getDistributionDirectory

public File getDistributionDirectory()

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