Package org.opencastproject.transcription.ibmwatson

Class IBMWatsonTranscriptionService

java.lang.Object

org.opencastproject.job.api.AbstractJobProducer

org.opencastproject.transcription.ibmwatson.IBMWatsonTranscriptionService

All Implemented Interfaces:

JobProducer, TranscriptionService

public class IBMWatsonTranscriptionService
extends AbstractJobProducer
implements TranscriptionService

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	IBMWatsonTranscriptionService.JobEvent
static interface	IBMWatsonTranscriptionService.RecognitionJobStatus

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADMIN_URL_PROPERTY
static final String	CLEANUP_RESULTS_DAYS_CONFIG
static final String	COMPLETION_CHECK_BUFFER_CONFIG
static final float	DEFAULT_START_TRANSCRIPTION_JOB_LOAD	The load introduced on the system by creating a transcription job
static final String	DEFAULT_WF_DEF
static final String	DISPATCH_WORKFLOW_INTERVAL_CONFIG
static final String	ENABLED_CONFIG	Service configuration options
static final String	IBM_WATSON_API_KEY_CONFIG
static final String	IBM_WATSON_MODEL_CONFIG
static final String	IBM_WATSON_PSW_CONFIG
static final String	IBM_WATSON_SERVICE_URL_CONFIG
static final String	IBM_WATSON_USER_CONFIG
static final String	MAX_ATTEMPTS_CONFIG
static final String	MAX_PROCESSING_TIME_CONFIG
static final String	NOTIFICATION_EMAIL_CONFIG
static final String	RETRY_WORKLFOW_CONFIG
static final String	START_TRANSCRIPTION_JOB_LOAD_KEY	The key to look for in the service configuration file to override the default h=job load
static final String	WORKFLOW_CONFIG

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

ACCEPT_JOB_LOADS_EXCEEDING_PROPERTY, acceptJobLoadsExeedingMaxLoad, DEFAULT_ACCEPT_JOB_LOADS_EXCEEDING, executor, jobType

Constructor Summary

Constructors

Constructor	Description
IBMWatsonTranscriptionService()

Method Summary

Modifier and Type	Method	Description
void	activate(org.osgi.service.component.ComponentContext cc)	OSGI activate method.
MediaPackageElement	getGeneratedTranscription(String mpId, String jobId, MediaPackageElement.Type type)
String	getLanguage()
protected OrganizationDirectoryService	getOrganizationDirectoryService()	Returns a reference to the organization directory service.
Map<String,Object>	getReturnValues(String mpId, String jobId)
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
boolean	isCallbackAlreadyRegistered()
boolean	isEnabled()	Allow transcription service to be disabled via config Utility to verify service is active
protected org.apache.http.impl.client.CloseableHttpClient	makeHttpClient()
protected String	process(Job job)	Asks the overriding class to process the arguments using the given operation.
protected void	retryOrError(String jobId, String mpId, String errorMsg)
void	setAssetManager(AssetManager service)
void	setDatabase(TranscriptionDatabase service)
void	setOrganizationDirectoryService(OrganizationDirectoryService organizationDirectoryService)
void	setSecurityService(SecurityService securityService)
void	setServiceRegistry(ServiceRegistry serviceRegistry)
void	setSmtpService(SmtpService service)
void	setUserDirectoryService(UserDirectoryService userDirectoryService)
void	setWorkflowService(WorkflowService service)
void	setWorkingFileRepository(WorkingFileRepository wfr)
void	setWorkspace(Workspace ws)
Job	startTranscription(String mpId, Track track)
Job	startTranscription(String mpId, Track track, String... args)
void	transcriptionDone(String mpId, Object obj)
void	transcriptionError(String mpId, Object obj)

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_WF_DEF

public static final String DEFAULT_WF_DEF

See Also:

• Constant Field Values

ADMIN_URL_PROPERTY

public static final String ADMIN_URL_PROPERTY

See Also:

• Constant Field Values

DEFAULT_START_TRANSCRIPTION_JOB_LOAD

public static final float DEFAULT_START_TRANSCRIPTION_JOB_LOAD

The load introduced on the system by creating a transcription job

See Also:

• Constant Field Values

START_TRANSCRIPTION_JOB_LOAD_KEY

public static final String START_TRANSCRIPTION_JOB_LOAD_KEY

The key to look for in the service configuration file to override the default h=job load

See Also:

• Constant Field Values

ENABLED_CONFIG

public static final String ENABLED_CONFIG

Service configuration options

See Also:

• Constant Field Values

IBM_WATSON_SERVICE_URL_CONFIG

public static final String IBM_WATSON_SERVICE_URL_CONFIG

See Also:

• Constant Field Values

IBM_WATSON_USER_CONFIG

public static final String IBM_WATSON_USER_CONFIG

See Also:

• Constant Field Values

IBM_WATSON_PSW_CONFIG

public static final String IBM_WATSON_PSW_CONFIG

See Also:

• Constant Field Values

IBM_WATSON_API_KEY_CONFIG

public static final String IBM_WATSON_API_KEY_CONFIG

See Also:

• Constant Field Values

IBM_WATSON_MODEL_CONFIG

public static final String IBM_WATSON_MODEL_CONFIG

See Also:

• Constant Field Values

WORKFLOW_CONFIG

public static final String WORKFLOW_CONFIG

See Also:

• Constant Field Values

DISPATCH_WORKFLOW_INTERVAL_CONFIG

public static final String DISPATCH_WORKFLOW_INTERVAL_CONFIG

See Also:

• Constant Field Values

COMPLETION_CHECK_BUFFER_CONFIG

public static final String COMPLETION_CHECK_BUFFER_CONFIG

See Also:

• Constant Field Values

MAX_PROCESSING_TIME_CONFIG

public static final String MAX_PROCESSING_TIME_CONFIG

See Also:

• Constant Field Values

NOTIFICATION_EMAIL_CONFIG

public static final String NOTIFICATION_EMAIL_CONFIG

See Also:

• Constant Field Values

CLEANUP_RESULTS_DAYS_CONFIG

public static final String CLEANUP_RESULTS_DAYS_CONFIG

See Also:

• Constant Field Values

MAX_ATTEMPTS_CONFIG

public static final String MAX_ATTEMPTS_CONFIG

See Also:

• Constant Field Values

RETRY_WORKLFOW_CONFIG

public static final String RETRY_WORKLFOW_CONFIG

See Also:

• Constant Field Values

Constructor Details

IBMWatsonTranscriptionService

public IBMWatsonTranscriptionService()

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

startTranscription

public Job startTranscription(String mpId,
 Track track)
                       throws TranscriptionServiceException

Specified by:

startTranscription in interface TranscriptionService

Throws:

TranscriptionServiceException

startTranscription

public Job startTranscription(String mpId,
 Track track,
 String... args)

Specified by:

startTranscription in interface TranscriptionService

transcriptionDone

public void transcriptionDone(String mpId,
 Object obj)
                       throws TranscriptionServiceException

Specified by:

transcriptionDone in interface TranscriptionService

Throws:

TranscriptionServiceException

transcriptionError

public void transcriptionError(String mpId,
 Object obj)
                        throws TranscriptionServiceException

Specified by:

transcriptionError in interface TranscriptionService

Throws:

TranscriptionServiceException

getLanguage

public String getLanguage()

Specified by:

getLanguage in interface TranscriptionService

getReturnValues

public Map<String,Object> getReturnValues(String mpId,
 String jobId)
                                   throws TranscriptionServiceException

Specified by:

getReturnValues in interface TranscriptionService

Throws:

TranscriptionServiceException

process

protected String process(Job job)
                  throws Exception

Description copied from class: AbstractJobProducer

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

getGeneratedTranscription

public MediaPackageElement getGeneratedTranscription(String mpId,
 String jobId,
 MediaPackageElement.Type type)
                                              throws TranscriptionServiceException

Specified by:

getGeneratedTranscription in interface TranscriptionService

Throws:

TranscriptionServiceException

makeHttpClient

protected org.apache.http.impl.client.CloseableHttpClient makeHttpClient()

retryOrError

protected void retryOrError(String jobId,
 String mpId,
 String errorMsg)
                     throws TranscriptionDatabaseException

Throws:

TranscriptionDatabaseException

isCallbackAlreadyRegistered

public boolean isCallbackAlreadyRegistered()

setServiceRegistry

public void setServiceRegistry(ServiceRegistry serviceRegistry)

setSecurityService

public void setSecurityService(SecurityService securityService)

setUserDirectoryService

public void setUserDirectoryService(UserDirectoryService userDirectoryService)

setOrganizationDirectoryService

public void setOrganizationDirectoryService(OrganizationDirectoryService organizationDirectoryService)

setSmtpService

public void setSmtpService(SmtpService service)

setWorkspace

public void setWorkspace(Workspace ws)

setWorkingFileRepository

public void setWorkingFileRepository(WorkingFileRepository wfr)

setDatabase

public void setDatabase(TranscriptionDatabase service)

setAssetManager

public void setAssetManager(AssetManager service)

setWorkflowService

public void setWorkflowService(WorkflowService service)

getServiceRegistry

protected ServiceRegistry getServiceRegistry()

Description copied from class: AbstractJobProducer

Returns a reference to the service registry.

Specified by:

getServiceRegistry in class AbstractJobProducer

Returns:

the service registry

getSecurityService

protected SecurityService getSecurityService()

Description copied from class: AbstractJobProducer

Returns a reference to the security service

Specified by:

getSecurityService in class AbstractJobProducer

Returns:

the security service

getUserDirectoryService

protected UserDirectoryService getUserDirectoryService()

Description copied from class: AbstractJobProducer

Returns a reference to the user directory service

Specified by:

getUserDirectoryService in class AbstractJobProducer

Returns:

the user directory service

getOrganizationDirectoryService

protected OrganizationDirectoryService getOrganizationDirectoryService()

Description copied from class: AbstractJobProducer

Returns a reference to the organization directory service.

Specified by:

getOrganizationDirectoryService in class AbstractJobProducer

Returns:

the organization directory service

isEnabled

public boolean isEnabled()

Allow transcription service to be disabled via config Utility to verify service is active

Returns:

true if service is enabled, false if service should be skipped