Package org.opencastproject.job.api

Class AbstractJobProducer

java.lang.Object

org.opencastproject.job.api.AbstractJobProducer

All Implemented Interfaces:

JobProducer

Direct Known Subclasses:

AbstractCoverImageService, AbstractDistributionService, AmberscriptTranscriptionService, AnimateServiceImpl, AssetManagerJobProducer, CaptionServiceImpl, ComposerServiceImpl, ConfigurablePublicationServiceImpl, CropServiceImpl, ExecuteServiceImpl, GoogleSpeechTranscriptionService, IBMWatsonTranscriptionService, IngestDownloadServiceImpl, IngestServiceImpl, MediaInspectionServiceImpl, MicrosoftAzureTranscriptionService, OaiPmhPublicationServiceImpl, OsgiAbstractJobProducer, SearchServiceImpl, SilenceDetectionServiceImpl, SoxServiceImpl, SpeechToTextServiceImpl, TextAnalyzerServiceImpl, TimelinePreviewsServiceImpl, VideoEditorServiceImpl, VideoGridServiceImpl, VideoSegmenterServiceImpl, WaveformServiceImpl, YouTubeV3PublicationServiceImpl

public abstract class AbstractJobProducer
extends Object
implements JobProducer

This class serves as a convenience for services that implement the JobProducer api to deal with handling long running, asynchronous operations.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACCEPT_JOB_LOADS_EXCEEDING_PROPERTY	The key to look for in the service configuration file to override the DEFAULT_ACCEPT_JOB_LOADS_EXCEEDING
protected boolean	acceptJobLoadsExeedingMaxLoad	Whether to accept a job whose load exceeds the host’s max load
static final boolean	DEFAULT_ACCEPT_JOB_LOADS_EXCEEDING	The default value whether to accept a job whose load exceeds the host’s max load
protected ExecutorService	executor	To enable threading when dispatching jobs
protected String	jobType	The types of job that this producer can handle

Constructor Summary

Constructors

Constructor	Description
AbstractJobProducer(String jobType)	Creates a new abstract job producer for jobs of the given type.

Method Summary

Modifier and Type	Method	Description
void	acceptJob(Job job)	Asks the job producer to handle the given job using the provided operation and list of arguments.
void	activate(org.osgi.service.component.ComponentContext cc)	OSGI activate method.
long	countJobs(Job.Status status)	Get the number of jobs in a current status on all nodes.
protected void	finallyUpdateJob(Job job)	Private utility to update and optionally fail job, called from a finally block.
String	getJobType()	The type of jobs that this producer creates.
protected abstract OrganizationDirectoryService	getOrganizationDirectoryService()	Returns a reference to the organization directory service.
protected abstract SecurityService	getSecurityService()	Returns a reference to the security service
protected abstract ServiceRegistry	getServiceRegistry()	Returns a reference to the service registry.
protected abstract UserDirectoryService	getUserDirectoryService()	Returns a reference to the user directory service
Incidents	incident()	Shorthand for getServiceRegistry().incident()
boolean	isReadyToAccept(Job job)	Whether the job can be accepted.
boolean	isReadyToAcceptJobs(String operation)	Whether new jobs can be accepted in general.
protected abstract String	process(Job job)	Asks the overriding class to process the arguments using the given operation.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_ACCEPT_JOB_LOADS_EXCEEDING

public static final boolean DEFAULT_ACCEPT_JOB_LOADS_EXCEEDING

The default value whether to accept a job whose load exceeds the host’s max load

See Also:

• Constant Field Values

ACCEPT_JOB_LOADS_EXCEEDING_PROPERTY

public static final String ACCEPT_JOB_LOADS_EXCEEDING_PROPERTY

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

See Also:

• Constant Field Values

acceptJobLoadsExeedingMaxLoad

protected boolean acceptJobLoadsExeedingMaxLoad

Whether to accept a job whose load exceeds the host’s max load

jobType

protected String jobType

The types of job that this producer can handle

executor

protected ExecutorService executor

To enable threading when dispatching jobs

Constructor Details

AbstractJobProducer

public AbstractJobProducer(String jobType)

Creates a new abstract job producer for jobs of the given type.

Parameters:

jobType - the job type

Method Details

activate

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

OSGI activate method.

Parameters:

cc - OSGI component context

getJobType

public String getJobType()

The type of jobs that this producer creates.

Specified by:

getJobType in interface JobProducer

Returns:

the job type

See Also:

• JobProducer.getJobType()

countJobs

public long countJobs(Job.Status status)
               throws ServiceRegistryException

Get the number of jobs in a current status on all nodes.

Specified by:

countJobs in interface JobProducer

Returns:

Number of jobs in this state

Throws:

ServiceRegistryException - if an error occurs while communicating with the backing data source

See Also:

• JobProducer.countJobs(org.opencastproject.job.api.Job.Status)

acceptJob

public void acceptJob(Job job)
               throws ServiceRegistryException

Asks the job producer to handle the given job using the provided operation and list of arguments. The implementation of this method must be asynchronous if the processing takes more than a few seconds.

Specified by:

acceptJob in interface JobProducer

Parameters:

job - the job being dispatched

Throws:

ServiceRegistryException - if the producer was unable to start work as requested

See Also:

• JobProducer.acceptJob(org.opencastproject.job.api.Job)

isReadyToAcceptJobs

public boolean isReadyToAcceptJobs(String operation)
                            throws ServiceRegistryException

Whether new jobs can be accepted in general.

Specified by:

isReadyToAcceptJobs in interface JobProducer

Parameters:

operation - operation

Returns:

whether the service is ready to accept jobs

Throws:

ServiceRegistryException - if the producer was unable to start work as requested

See Also:

• JobProducer.isReadyToAcceptJobs(String)

isReadyToAccept

public boolean isReadyToAccept(Job job)
                        throws ServiceRegistryException,
UndispatchableJobException

Whether the job can be accepted.

Specified by:

isReadyToAccept in interface JobProducer

Parameters:

job - the job being dispatched

Returns:

whether the service is ready to accept the job

Throws:

ServiceRegistryException - if the producer was unable to start work as requested

UndispatchableJobException - if the job will never be accepted because it is unacceptable

See Also:

• JobProducer.isReadyToAccept(org.opencastproject.job.api.Job)

finallyUpdateJob

protected void finallyUpdateJob(Job job)

Private utility to update and optionally fail job, called from a finally block.

Parameters:

job - to be updated, may be null

incident

public Incidents incident()

Shorthand for getServiceRegistry().incident()

getServiceRegistry

protected abstract ServiceRegistry getServiceRegistry()

Returns a reference to the service registry.

Returns:

the service registry

getSecurityService

protected abstract SecurityService getSecurityService()

Returns a reference to the security service

Returns:

the security service

getUserDirectoryService

protected abstract UserDirectoryService getUserDirectoryService()

Returns a reference to the user directory service

Returns:

the user directory service

getOrganizationDirectoryService

protected abstract OrganizationDirectoryService getOrganizationDirectoryService()

Returns a reference to the organization directory service.

Returns:

the organization directory service

process

protected abstract 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.

Parameters:

job - the job to process

Returns:

the operation result

Throws:

Exception