Package org.opencastproject.inspection.ffmpeg

Class MediaInspectionServiceImpl

java.lang.Object

org.opencastproject.job.api.AbstractJobProducer

org.opencastproject.inspection.ffmpeg.MediaInspectionServiceImpl

All Implemented Interfaces:

MediaInspectionService, JobProducer

public class MediaInspectionServiceImpl
extends AbstractJobProducer
implements MediaInspectionService

Inspects media via ffprobe.

Field Summary

Fields

Modifier and Type	Field	Description
static final float	DEFAULT_ENRICH_JOB_LOAD	The load introduced on the system by creating an enrich job
static final float	DEFAULT_INSPECT_JOB_LOAD	The load introduced on the system by creating an inspect job
static final String	ENRICH_JOB_LOAD_KEY	The key to look for in the service configuration file to override the DEFAULT_ENRICH_JOB_LOAD
static final String	INSPECT_JOB_LOAD_KEY	The key to look for in the service configuration file to override the DEFAULT_INSPECT_JOB_LOAD

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.inspection.api.MediaInspectionService

JOB_TYPE

Constructor Summary

Constructors

Constructor	Description
MediaInspectionServiceImpl()	Creates a new media inspection service instance.

Method Summary

Modifier and Type	Method	Description
void	activate(org.osgi.service.component.ComponentContext cc)	OSGI activate method.
Job	enrich(MediaPackageElement element, boolean override)	Equip an existing media package element with automatically generated metadata
Job	enrich(MediaPackageElement element, boolean override, Map<String,String> options)	Equip an existing media package element with automatically generated metadata
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
Job	inspect(URI uri)	Inspect a track based on a given uri to the track and put the gathered data into the track
Job	inspect(URI uri, Map<String,String> options)	Inspect a track based on a given uri to the track and put the gathered data into the track
void	modified(org.osgi.service.component.ComponentContext cc)
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 jobManager)
void	setUserDirectoryService(UserDirectoryService userDirectoryService)	Callback for setting the user directory service.
protected void	setWorkspace(Workspace workspace)

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

DEFAULT_INSPECT_JOB_LOAD

public static final float DEFAULT_INSPECT_JOB_LOAD

The load introduced on the system by creating an inspect job

See Also:

• Constant Field Values

DEFAULT_ENRICH_JOB_LOAD

public static final float DEFAULT_ENRICH_JOB_LOAD

The load introduced on the system by creating an enrich job

See Also:

• Constant Field Values

INSPECT_JOB_LOAD_KEY

public static final String INSPECT_JOB_LOAD_KEY

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

See Also:

• Constant Field Values

ENRICH_JOB_LOAD_KEY

public static final String ENRICH_JOB_LOAD_KEY

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

See Also:

• Constant Field Values

Constructor Details

MediaInspectionServiceImpl

public MediaInspectionServiceImpl()

Creates a new media inspection service instance.

Method Details

activate

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

Description copied from class: AbstractJobProducer

OSGI activate method.

Overrides:

activate in class AbstractJobProducer

Parameters:

cc - OSGI component context

modified

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

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)

inspect

public Job inspect(URI uri)
            throws MediaInspectionException

Inspect a track based on a given uri to the track and put the gathered data into the track

Specified by:

inspect in interface MediaInspectionService

Parameters:

uri - the uri to a track in a media package

Returns:

the receipt of this job, that can be used to check the current status of inspect method and retrieve track with added metadata when done

Throws:

MediaInspectionException - if there is a failure during media package update

See Also:

• MediaInspectionService.inspect(java.net.URI)

inspect

public Job inspect(URI uri,
 Map<String,String> options)
            throws MediaInspectionException

Inspect a track based on a given uri to the track and put the gathered data into the track

Specified by:

inspect in interface MediaInspectionService

Parameters:

uri - the uri to a track in a media package

options - Options in form of key/value pairs that are passed to the Media Inspection Service implementation. Those options may be implementation specific. The implementation is supposed to raise an exception in case unsupported options are encountered. Value may not be null.

Returns:

the receipt of this job, that can be used to check the current status of inspect method and retrieve track with added metadata when done

Throws:

MediaInspectionException - if there is a failure during media package update

See Also:

• MediaInspectionService.inspect(java.net.URI, java.util.Map)

enrich

public Job enrich(MediaPackageElement element,
 boolean override)
           throws MediaInspectionException,
MediaPackageException

Equip an existing media package element with automatically generated metadata

Specified by:

enrich in interface MediaInspectionService

Parameters:

element - The original media package element that will be inspected

override - In case of conflict between existing and automatically obtained metadata this switch selects preference. False..The original metadata will be kept, True..The new metadata will be used.

Returns:

the receipt of this job, that can be used to check the current status of enrich method and retrieve enriched element when done

Throws:

MediaInspectionException - if there is a failure during media package update

MediaPackageException - if the element is invalid

See Also:

• MediaInspectionService.enrich(org.opencastproject.mediapackage.MediaPackageElement, boolean)

enrich

public Job enrich(MediaPackageElement element,
 boolean override,
 Map<String,String> options)
           throws MediaInspectionException,
MediaPackageException

Equip an existing media package element with automatically generated metadata

Specified by:

enrich in interface MediaInspectionService

Parameters:

element - The original media package element that will be inspected

override - In case of conflict between existing and automatically obtained metadata this switch selects preference. False..The original metadata will be kept, True..The new metadata will be used.

options - Options in form of key/value pairs that are passed to the MediaInspectionService implementation. Those options may be implementation specific. The implementation is supposed to raise an exception in case unsupported options are encountered. Value may not be null.

Returns:

the receipt of this job, that can be used to check the current status of enrich method and retrieve enriched element when done

Throws:

MediaInspectionException - if there is a failure during media package update

MediaPackageException - if the element is invalid

See Also:

• MediaInspectionService.enrich(org.opencastproject.mediapackage.MediaPackageElement, boolean, java.util.Map)

setWorkspace

protected void setWorkspace(Workspace workspace)

setServiceRegistry

protected void setServiceRegistry(ServiceRegistry jobManager)

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

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

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

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