Package org.opencastproject.caption.impl

Class CaptionServiceImpl

java.lang.Object

org.opencastproject.job.api.AbstractJobProducer

org.opencastproject.caption.impl.CaptionServiceImpl

All Implemented Interfaces:

CaptionService, JobProducer, org.osgi.service.cm.ManagedService

public class CaptionServiceImpl
extends AbstractJobProducer
implements CaptionService, org.osgi.service.cm.ManagedService

Implementation of CaptionService. Uses ComponentContext to get all registered CaptionConverters. Converters are searched based on caption.format property. If there is no match for specified input or output format UnsupportedCaptionFormatException is thrown.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CAPTION_JOB_LOAD_KEY	The key to look for in the service configuration file to override the DEFAULT_CAPTION_JOB_LOAD
static final String	COLLECTION	The collection name
protected org.osgi.service.component.ComponentContext	componentContext	Component context needed for retrieving Converter Engines
static final float	DEFAULT_CAPTION_JOB_LOAD	The load introduced on the system by creating a caption job
protected OrganizationDirectoryService	organizationDirectoryService	The organization directory service
protected SecurityService	securityService	The security service
protected ServiceRegistry	serviceRegistry	Reference to remote service manager
protected UserDirectoryService	userDirectoryService	The user directory service
protected Workspace	workspace	Reference to 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.caption.api.CaptionService

JOB_TYPE

Constructor Summary

Constructors

Constructor	Description
CaptionServiceImpl()	Creates a new caption service.

Method Summary

Modifier and Type	Method	Description
void	activate(org.osgi.service.component.ComponentContext componentContext)	Activate this service implementation via the OSGI service component runtime.
protected MediaPackageElement	convert(Job job, MediaPackageElement input, String inputFormat, String outputFormat, String language)	Converts the captions and returns them in a new catalog.
Job	convert(MediaPackageElement input, String inputFormat, String outputFormat)	Converts captions from one format to another.
Job	convert(MediaPackageElement input, String inputFormat, String outputFormat, String language)	Converts captions from one format to another.
protected HashMap<String,CaptionConverter>	getAvailableCaptionConverters()	Returns all registered CaptionFormats.
protected CaptionConverter	getCaptionConverter(String formatName)	Returns specific CaptionConverter.
String[]	getLanguageList(MediaPackageElement input, String format)	Returns list of languages available in captions (if such information is stored).
protected OrganizationDirectoryService	getOrganizationDirectoryService()	Returns a reference to the organization directory service.
protected SecurityService	getSecurityService()	Returns a reference to the security service
protected ServiceRegistry	getServiceRegistry()	Returns a reference to the service registry.
protected UserDirectoryService	getUserDirectoryService()	Returns a reference to the user directory service
protected String	process(Job job)	Asks the overriding class to process the arguments using the given operation.
void	setOrganizationDirectoryService(OrganizationDirectoryService organizationDirectory)	Sets a reference to the organization directory service.
void	setSecurityService(SecurityService securityService)	Callback for setting the security service.
protected void	setServiceRegistry(ServiceRegistry serviceRegistry)	Setter for remote service manager via declarative activation
void	setUserDirectoryService(UserDirectoryService userDirectoryService)	Callback for setting the user directory service.
protected void	setWorkspace(Workspace workspace)	Setter for workspace via declarative activation
void	updated(Dictionary properties)

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

COLLECTION

public static final String COLLECTION

The collection name

See Also:

• Constant Field Values

DEFAULT_CAPTION_JOB_LOAD

public static final float DEFAULT_CAPTION_JOB_LOAD

The load introduced on the system by creating a caption job

See Also:

• Constant Field Values

CAPTION_JOB_LOAD_KEY

public static final String CAPTION_JOB_LOAD_KEY

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

See Also:

• Constant Field Values

workspace

protected Workspace workspace

Reference to workspace

serviceRegistry

protected ServiceRegistry serviceRegistry

Reference to remote service manager

securityService

protected SecurityService securityService

The security service

userDirectoryService

protected UserDirectoryService userDirectoryService

The user directory service

organizationDirectoryService

protected OrganizationDirectoryService organizationDirectoryService

The organization directory service

componentContext

protected org.osgi.service.component.ComponentContext componentContext

Component context needed for retrieving Converter Engines

Constructor Details

CaptionServiceImpl

public CaptionServiceImpl()

Creates a new caption service.

Method Details

activate

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

Activate this service implementation via the OSGI service component runtime.

Overrides:

activate in class AbstractJobProducer

Parameters:

componentContext - the component context

convert

public Job convert(MediaPackageElement input,
 String inputFormat,
 String outputFormat)
            throws UnsupportedCaptionFormatException,
CaptionConverterException,
MediaPackageException

Converts captions from one format to another. Language parameter is used for those formats that store information about language.

Specified by:

convert in interface CaptionService

Parameters:

input - MediaPackageElement containing captions

inputFormat - format of imported captions

outputFormat - format of exported captions

Throws:

UnsupportedCaptionFormatException - if there is no matching engine registered for given input or output

CaptionConverterException - if exception occurs while converting

MediaPackageException - if the catalog is invalid

See Also:

• CaptionService.convert(org.opencastproject.mediapackage.MediaPackageElement, java.lang.String, java.lang.String)

convert

public Job convert(MediaPackageElement input,
 String inputFormat,
 String outputFormat,
 String language)
            throws UnsupportedCaptionFormatException,
CaptionConverterException,
MediaPackageException

Converts captions from one format to another. Language parameter is used for those formats that store information about language.

Specified by:

convert in interface CaptionService

Parameters:

input - MediaPackageElement containing captions

inputFormat - format of imported captions

outputFormat - format of exported captions

language - language of captions

Throws:

UnsupportedCaptionFormatException - if there is no matching engine registered for given input or output

CaptionConverterException - if exception occurs while converting

MediaPackageException - if the catalog is invalid

See Also:

• CaptionService.convert(org.opencastproject.mediapackage.MediaPackageElement, java.lang.String, java.lang.String, java.lang.String)

convert

protected MediaPackageElement convert(Job job,
 MediaPackageElement input,
 String inputFormat,
 String outputFormat,
 String language)
                               throws UnsupportedCaptionFormatException,
CaptionConverterException,
MediaPackageException

Converts the captions and returns them in a new catalog.

Returns:

the converted catalog

Throws:

UnsupportedCaptionFormatException

CaptionConverterException

MediaPackageException

getLanguageList

public String[] getLanguageList(MediaPackageElement input,
 String format)
                         throws UnsupportedCaptionFormatException,
CaptionConverterException

Returns list of languages available in captions (if such information is stored).

Specified by:

getLanguageList in interface CaptionService

Parameters:

input - Catalog containing captions

format - captions' format

Returns:

Array of languages available in captions

Throws:

UnsupportedCaptionFormatException - if there is no matching engine registered for given input or output

CaptionConverterException - if parser encounters exception

getAvailableCaptionConverters

protected HashMap<String,CaptionConverter> getAvailableCaptionConverters()

Returns all registered CaptionFormats.

getCaptionConverter

protected CaptionConverter getCaptionConverter(String formatName)

Returns specific CaptionConverter. Registry is searched based on formatName, so in order for CaptionConverter to be found, it has to have caption.format property set with CaptionConverter format. If none is found, null is returned, if more than one is found then the first reference is returned.

Parameters:

formatName - name of the caption format

Returns:

CaptionConverter or null if none is found

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(Job)

setWorkspace

protected void setWorkspace(Workspace workspace)

Setter for workspace via declarative activation

setServiceRegistry

protected void setServiceRegistry(ServiceRegistry serviceRegistry)

Setter for remote service manager via declarative activation

setSecurityService

public void setSecurityService(SecurityService securityService)

Callback for setting the security service.

Parameters:

securityService - the securityService to set

setUserDirectoryService

public void setUserDirectoryService(UserDirectoryService userDirectoryService)

Callback for setting the user directory service.

Parameters:

userDirectoryService - the userDirectoryService to set

setOrganizationDirectoryService

public void setOrganizationDirectoryService(OrganizationDirectoryService organizationDirectory)

Sets a reference to the organization directory service.

Parameters:

organizationDirectory - the organization directory

getSecurityService

protected SecurityService getSecurityService()

Returns a reference to the security service

Specified by:

getSecurityService in class AbstractJobProducer

Returns:

the security service

See Also:

• AbstractJobProducer.getSecurityService()

getOrganizationDirectoryService

protected OrganizationDirectoryService getOrganizationDirectoryService()

Returns a reference to the organization directory service.

Specified by:

getOrganizationDirectoryService in class AbstractJobProducer

Returns:

the organization directory service

See Also:

• AbstractJobProducer.getOrganizationDirectoryService()

getUserDirectoryService

protected UserDirectoryService getUserDirectoryService()

Returns a reference to the user directory service

Specified by:

getUserDirectoryService in class AbstractJobProducer

Returns:

the user directory service

See Also:

• AbstractJobProducer.getUserDirectoryService()

getServiceRegistry

protected ServiceRegistry getServiceRegistry()

Returns a reference to the service registry.

Specified by:

getServiceRegistry in class AbstractJobProducer

Returns:

the service registry

See Also:

• AbstractJobProducer.getServiceRegistry()

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