Package org.opencastproject.workflow.impl

Class WorkflowServiceImpl

java.lang.Object

org.opencastproject.elasticsearch.index.rebuild.AbstractIndexProducer

org.opencastproject.workflow.impl.WorkflowServiceImpl

All Implemented Interfaces:

IndexProducer, JobProducer, WorkflowService

public class WorkflowServiceImpl
extends AbstractIndexProducer
implements WorkflowService, JobProducer

Implements WorkflowService with in-memory data structures to hold WorkflowOperations and WorkflowInstances. WorkflowOperationHandlers are looked up in the OSGi service registry based on the "workflow.operation" property. If the WorkflowOperationHandler's "workflow.operation" service registration property matches WorkflowOperation.getName(), then the factory returns a WorkflowOperationRunner to handle that operation. This allows for custom runners to be added or modified without affecting the workflow service itself.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WorkflowServiceImpl.HandlerRegistration	A tuple of a workflow operation handler and the name of the operation it handles

Field Summary

Fields

Modifier and Type	Field	Description
protected AssetManager	assetManager	The asset manager
protected AuthorizationService	authorizationService	The authorization service
protected org.osgi.service.component.ComponentContext	componentContext	Remove references to the component context once felix scr 1.2 becomes available
static final String	ERROR_RESOLUTION_HANDLER_ID	Error resolution handler id constant
protected ThreadPoolExecutor	executorService	The thread pool to use for firing listeners and handling dispatched jobs
protected OrganizationDirectoryService	organizationDirectoryService	The organization directory service
protected WorkflowServiceDatabase	persistence	Persistent storage
protected SecurityService	securityService	The security service
protected SeriesService	seriesService	The series service
protected ServiceRegistry	serviceRegistry	The service registry
protected UserDirectoryService	userDirectoryService	The user directory service
protected Workspace	workspace	The workspace

Fields inherited from interface org.opencastproject.workflow.api.WorkflowService

JOB_TYPE, WORKFLOW_OPERATION_PROPERTY

Constructor Summary

Constructors

Constructor	Description
WorkflowServiceImpl()	Constructs a new workflow service impl, with a priority-sorted map of metadata services

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 componentContext)	Activate this service implementation via the OSGI service component runtime.
protected void	addMetadataService(MediaPackageMetadataService service)	Callback to set the metadata service
protected void	addWorkflowDefinitionScanner(WorkflowDefinitionScanner scanner)	Callback to set the workflow definition scanner
void	addWorkflowListener(WorkflowListener listener)	Adds a workflow listener to be notified when workflows are updated.
protected boolean	assertMediaPackagePermission(String mediaPackageId, String action)
protected void	assertPermission(WorkflowInstance workflow, String action, String workflowOrgId)	Asserts that the current user has permission to take the provided action on a workflow instance.
void	cleanupWorkflowInstances(int buffer, WorkflowInstance.WorkflowState state)	Starts a cleanup of workflow instances with a given lifetime and a specific state
long	countJobs(Job.Status status)	Get the number of jobs in a current status on all nodes.
long	countWorkflowInstances()	Gets the total number of workflows that have been created to date.
long	countWorkflowInstances(WorkflowInstance.WorkflowState state)	Gets the total number of workflows that have been created to date and that match the workflow state which might be null.
protected void	fireListeners(WorkflowInstance oldWorkflowInstance, WorkflowInstance newWorkflowInstance)	Fires the workflow listeners on workflow updates.
String	getJobType()	The type of jobs that this producer creates.
Set<WorkflowServiceImpl.HandlerRegistration>	getRegisteredHandlers()	Gets the currently registered workflow operation handlers.
Optional<WorkflowInstance>	getRunningWorkflowInstanceByMediaPackage(String mediaPackageId, String action)	Returns the WorkflowInstance currently running on the given mediaPackage
IndexRebuildService.Service	getService()	Get the service that implements IndexProducer.
ServiceRegistry	getServiceRegistry()
WorkflowInstance	getWorkflowById(long id)	Gets a WorkflowInstance by its ID.
WorkflowDefinition	getWorkflowDefinitionById(String id)	Returns the WorkflowDefinition identified by name.
List<WorkflowInstance>	getWorkflowInstancesByMediaPackage(String mediaPackageId)	Returns all workflows associated with the given mediapackage Current user needs permission to the mediapackage
protected WorkflowOperationHandler	getWorkflowOperationHandler(String operationId)
Map<String,Map<String,String>>	getWorkflowStateMappings()
protected WorkflowInstance	handleOperationException(WorkflowInstance workflow, WorkflowOperationInstance currentOperation)	Callback for workflow operations that were throwing an exception.
protected WorkflowInstance	handleOperationResult(WorkflowInstance workflow, WorkflowOperationResult result)	Callback for workflow operation handlers that executed and finished without exception.
boolean	isReadyToAccept(Job job)	Whether the job can be accepted.
boolean	isReadyToAcceptJobs(String operation)	Whether new jobs can be accepted in general.
boolean	isRunnable(WorkflowDefinition workflowDefinition)
protected List<String>	listAvailableOperationNames()	Lists the names of each workflow operation.
List<WorkflowDefinition>	listAvailableWorkflowDefinitions()	Gets the list of available workflow definitions.
boolean	mediaPackageHasActiveWorkflows(String mediaPackageId)	Checks if there is at least one workflow currently running on the given mediapackage
protected void	populateMediaPackageMetadata(MediaPackage mp)	Reads the available metadata from the dublin core catalog (if there is one) and updates the mediapackage.
protected String	process(Job job)	Processes the workflow job.
void	remove(long workflowInstanceId)	Permanently removes a workflow instance.
void	remove(long workflowInstanceId, boolean force)	Permanently removes a workflow instance.
protected void	removeMetadataService(MediaPackageMetadataService service)	Callback to remove a mediapackage metadata service.
void	removeWorkflowListener(WorkflowListener listener)	Removes a workflow listener.
void	repopulate(IndexRebuildService.DataType type)	Re-add the data of this service to the index.
WorkflowInstance	resume(long id)	Resumes a suspended workflow instance.
WorkflowInstance	resume(long workflowInstanceId, Map<String,String> properties)	Resumes a suspended workflow instance, applying new properties to the workflow.
protected Job	runWorkflow(WorkflowInstance workflow)	Executes the workflow.
protected WorkflowOperationInstance	runWorkflowOperation(WorkflowInstance workflow, Map<String,String> properties)	Executes the workflow's current operation.
protected WorkflowOperationHandler	selectOperationHandler(WorkflowOperationInstance operation)	Does a lookup of available operation handlers for the given workflow operation.
void	setAssetManager(AssetManager assetManager)	Sets the asset manager
void	setAuthorizationService(AuthorizationService authorizationService)	Callback for setting the authorization service.
void	setIndex(ElasticsearchIndex index)	Callback to set the Admin UI index.
void	setOrganizationDirectoryService(OrganizationDirectoryService organizationDirectory)	Sets a reference to the organization directory service.
void	setPersistence(WorkflowServiceDatabase persistence)	Callback to set the workflow database
protected void	setProfilesReadyIndicator(ReadinessIndicator unused)	Dummy callback for osgi
void	setSecurityService(SecurityService securityService)	Callback for setting the security service.
void	setSeriesService(SeriesService seriesService)	Sets the series service
protected void	setServiceRegistry(ServiceRegistry registry)	Callback for the OSGi environment to register with the ServiceRegistry.
void	setUserDirectoryService(UserDirectoryService userDirectoryService)	Callback for setting the user directory service
protected void	setWorkspace(Workspace workspace)	Callback for the OSGi environment to register with the Workspace.
WorkflowInstance	start(WorkflowDefinition workflowDefinition, MediaPackage mediaPackage)	Creates a new workflow instance and starts the workflow.
WorkflowInstance	start(WorkflowDefinition workflowDefinition, MediaPackage sourceMediaPackage, Long parentWorkflowId, Map<String,String> originalProperties)	Creates a new workflow instance and starts the workflow.
WorkflowInstance	start(WorkflowDefinition workflowDefinition, MediaPackage mediaPackage, Map<String,String> properties)	Creates a new workflow instance and starts the workflow.
WorkflowInstance	stop(long workflowInstanceId)	Stops a running workflow instance.
WorkflowInstance	suspend(long workflowInstanceId)	Temporarily suspends a started workflow instance.
void	update(WorkflowInstance workflowInstance)	Updates the given workflow instance with regard to the media package, the properties and the operations involved.
protected WorkflowInstance	updateConfiguration(WorkflowInstance instance, Map<String,String> properties)
boolean	userHasActiveWorkflows(String userId)	Checks if there is at least one workflow currently running started by the given user

Methods inherited from class org.opencastproject.elasticsearch.index.rebuild.AbstractIndexProducer

logIndexRebuildBegin, logIndexRebuildBegin, logIndexRebuildError, logIndexRebuildError, logIndexRebuildError, logIndexRebuildProgress, logIndexRebuildProgress, logIndexRebuildProgress, logIndexRebuildProgress, logSkippingElement, logSkippingElement

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opencastproject.elasticsearch.index.rebuild.IndexProducer

dataTypeSupported, getSupportedDataTypes

Field Details

ERROR_RESOLUTION_HANDLER_ID

public static final String ERROR_RESOLUTION_HANDLER_ID

Error resolution handler id constant

See Also:

• Constant Field Values

componentContext

protected org.osgi.service.component.ComponentContext componentContext

Remove references to the component context once felix scr 1.2 becomes available

persistence

protected WorkflowServiceDatabase persistence

Persistent storage

executorService

protected ThreadPoolExecutor executorService

The thread pool to use for firing listeners and handling dispatched jobs

workspace

protected Workspace workspace

The workspace

serviceRegistry

protected ServiceRegistry serviceRegistry

The service registry

securityService

protected SecurityService securityService

The security service

authorizationService

protected AuthorizationService authorizationService

The authorization service

userDirectoryService

protected UserDirectoryService userDirectoryService

The user directory service

organizationDirectoryService

protected OrganizationDirectoryService organizationDirectoryService

The organization directory service

seriesService

protected SeriesService seriesService

The series service

assetManager

protected AssetManager assetManager

The asset manager

Constructor Details

WorkflowServiceImpl

public WorkflowServiceImpl()

Constructs a new workflow service impl, with a priority-sorted map of metadata services

Method Details

activate

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

Activate this service implementation via the OSGI service component runtime.

Parameters:

componentContext - the component context

addWorkflowListener

public void addWorkflowListener(WorkflowListener listener)

Adds a workflow listener to be notified when workflows are updated.

Specified by:

addWorkflowListener in interface WorkflowService

Parameters:

listener - the workflow listener to add

See Also:

• WorkflowService.addWorkflowListener(org.opencastproject.workflow.api.WorkflowListener)

removeWorkflowListener

public void removeWorkflowListener(WorkflowListener listener)

Removes a workflow listener.

Specified by:

removeWorkflowListener in interface WorkflowService

Parameters:

listener - the workflow listener to remove

See Also:

• WorkflowService.removeWorkflowListener(org.opencastproject.workflow.api.WorkflowListener)

fireListeners

protected void fireListeners(WorkflowInstance oldWorkflowInstance,
 WorkflowInstance newWorkflowInstance)

Fires the workflow listeners on workflow updates.

listAvailableWorkflowDefinitions

public List<WorkflowDefinition> listAvailableWorkflowDefinitions()

Gets the list of available workflow definitions. In order to be "available", a workflow definition must be registered and must have registered workflow operation handlers for each of the workflow definition's operations.

Specified by:

listAvailableWorkflowDefinitions in interface WorkflowService

Returns:

The list of currently available workflow definitions, sorted by title

See Also:

• WorkflowService.listAvailableWorkflowDefinitions()

isRunnable

public boolean isRunnable(WorkflowDefinition workflowDefinition)

getRegisteredHandlers

public Set<WorkflowServiceImpl.HandlerRegistration> getRegisteredHandlers()

Gets the currently registered workflow operation handlers.

Returns:

All currently registered handlers

getWorkflowOperationHandler

protected WorkflowOperationHandler getWorkflowOperationHandler(String operationId)

listAvailableOperationNames

protected List<String> listAvailableOperationNames()

Lists the names of each workflow operation. Operation names are availalbe for use if there is a registered WorkflowOperationHandler with an equal WorkflowService.WORKFLOW_OPERATION_PROPERTY property.

Returns:

The List of available workflow operation names

getWorkflowById

public WorkflowInstance getWorkflowById(long id)
                                 throws NotFoundException,
UnauthorizedException

Gets a WorkflowInstance by its ID.

Specified by:

getWorkflowById in interface WorkflowService

Returns:

the workflow instance

Throws:

NotFoundException - if there is no workflow instance with this identifier

UnauthorizedException - if the current user does not have read permissions on the workflow instance's mediapackage.

See Also:

• WorkflowService.getWorkflowById(long)

start

public WorkflowInstance start(WorkflowDefinition workflowDefinition,
 MediaPackage mediaPackage)
                       throws WorkflowDatabaseException,
UnauthorizedException,
WorkflowParsingException

Creates a new workflow instance and starts the workflow.

Specified by:

start in interface WorkflowService

Parameters:

workflowDefinition - the workflow definition

mediaPackage - the mediapackage to process

Returns:

The new workflow instance

Throws:

WorkflowDatabaseException - if there is a problem storing the workflow instance in persistence

WorkflowParsingException - if there is a problem parsing or serializing workflow entities

UnauthorizedException

See Also:

• WorkflowService.start(org.opencastproject.workflow.api.WorkflowDefinition, org.opencastproject.mediapackage.MediaPackage)

start

public WorkflowInstance start(WorkflowDefinition workflowDefinition,
 MediaPackage mediaPackage,
 Map<String,String> properties)
                       throws WorkflowDatabaseException,
UnauthorizedException,
WorkflowParsingException

Creates a new workflow instance and starts the workflow.

Specified by:

start in interface WorkflowService

Parameters:

workflowDefinition - the workflow definition

mediaPackage - the mediapackage to process

properties - any properties to apply to the workflow definition

Returns:

The new workflow instance

Throws:

WorkflowDatabaseException - if there is a problem storing the workflow instance in persistence

WorkflowParsingException - if there is a problem parsing or serializing workflow entities

UnauthorizedException

See Also:

• WorkflowService.start(org.opencastproject.workflow.api.WorkflowDefinition, org.opencastproject.mediapackage.MediaPackage)

start

public WorkflowInstance start(WorkflowDefinition workflowDefinition,
 MediaPackage sourceMediaPackage,
 Long parentWorkflowId,
 Map<String,String> originalProperties)
                       throws WorkflowDatabaseException,
NotFoundException,
UnauthorizedException,
WorkflowParsingException,
IllegalStateException

Creates a new workflow instance and starts the workflow.

Specified by:

start in interface WorkflowService

Parameters:

workflowDefinition - the workflow definition

sourceMediaPackage - the mediapackage to process

parentWorkflowId - An existing workflow to associate with the new workflow instance

originalProperties - any properties to apply to the workflow definition

Returns:

The new workflow instance

Throws:

WorkflowDatabaseException - if there is a problem storing the workflow instance in persistence

NotFoundException - if the parent workflow does not exist

UnauthorizedException - if the current user does not have Permissions.Action.WRITE on the media package.

WorkflowParsingException - if there is a problem parsing or serializing workflow entities

IllegalStateException - if there is currently a workflow active on the media package

See Also:

• WorkflowService.start(org.opencastproject.workflow.api.WorkflowDefinition, org.opencastproject.mediapackage.MediaPackage, Long, java.util.Map)

updateConfiguration

protected WorkflowInstance updateConfiguration(WorkflowInstance instance,
 Map<String,String> properties)

selectOperationHandler

protected WorkflowOperationHandler selectOperationHandler(WorkflowOperationInstance operation)

Does a lookup of available operation handlers for the given workflow operation.

Parameters:

operation - the operation definition

Returns:

the handler or null

runWorkflow

protected Job runWorkflow(WorkflowInstance workflow)
                   throws WorkflowException,
UnauthorizedException

Executes the workflow.

Parameters:

workflow - the workflow instance

Throws:

WorkflowException - if there is a problem processing the workflow

UnauthorizedException

runWorkflowOperation

protected WorkflowOperationInstance runWorkflowOperation(WorkflowInstance workflow,
 Map<String,String> properties)
                                                  throws WorkflowException,
UnauthorizedException

Executes the workflow's current operation.

Parameters:

workflow - the workflow

properties - the properties that are passed in on resume

Returns:

the processed workflow operation

Throws:

WorkflowException - if there is a problem processing the workflow

UnauthorizedException

getWorkflowDefinitionById

public WorkflowDefinition getWorkflowDefinitionById(String id)
                                             throws NotFoundException

Returns the WorkflowDefinition identified by name.

Specified by:

getWorkflowDefinitionById in interface WorkflowService

Parameters:

id - the workflow definition id

Returns:

the workflow

Throws:

NotFoundException - if there is no registered workflow definition with this identifier

See Also:

• WorkflowService.getWorkflowDefinitionById(String)

stop

public WorkflowInstance stop(long workflowInstanceId)
                      throws WorkflowException,
NotFoundException,
UnauthorizedException

Stops a running workflow instance.

Specified by:

stop in interface WorkflowService

Parameters:

workflowInstanceId - the workflow instance identifier

Returns:

the workflow instance

Throws:

WorkflowException - if there is a problem processing the workflow

NotFoundException - if no running workflow with this identifier exists

UnauthorizedException - if the current user does not have read permissions on the workflow instance's mediapackage.

See Also:

• WorkflowService.stop(long)

remove

public void remove(long workflowInstanceId)
            throws WorkflowDatabaseException,
NotFoundException,
UnauthorizedException,
WorkflowParsingException,
WorkflowStateException

Permanently removes a workflow instance. Only workflow instances with state WorkflowInstance.WorkflowState.SUCCEEDED, WorkflowInstance.WorkflowState.STOPPED or WorkflowInstance.WorkflowState.FAILED may be removed.

Specified by:

remove in interface WorkflowService

Parameters:

workflowInstanceId - the workflow instance identifier

Throws:

WorkflowDatabaseException - if there is a problem writing to the database

NotFoundException - if no workflow instance with the given identifier could be found

UnauthorizedException - if the current user does not have write permissions on the workflow instance

WorkflowStateException - if the workflow instance is in a disallowed state

WorkflowParsingException

See Also:

• WorkflowService.remove(long)

remove

public void remove(long workflowInstanceId,
 boolean force)
            throws WorkflowDatabaseException,
NotFoundException,
UnauthorizedException,
WorkflowStateException

Permanently removes a workflow instance. Option to remove a workflow instance regardless of its status.

Specified by:

remove in interface WorkflowService

Parameters:

workflowInstanceId - the workflow instance identifier

force - remove the workflow instance no matter the status

Throws:

WorkflowDatabaseException - if there is a problem writing to the database

NotFoundException - if no workflow instance with the given identifier could be found

UnauthorizedException - if the current user does not have write permissions on the workflow instance

WorkflowStateException - if the workflow instance is in a disallowed state

See Also:

• WorkflowService.remove(long,boolean)

suspend

public WorkflowInstance suspend(long workflowInstanceId)
                         throws WorkflowException,
NotFoundException,
UnauthorizedException

Temporarily suspends a started workflow instance.

Specified by:

suspend in interface WorkflowService

Parameters:

workflowInstanceId - the workflow instance identifier

Returns:

the workflow instance

Throws:

WorkflowException - if there is a problem processing the workflow

NotFoundException - if no running workflow with this identifier exists

UnauthorizedException - if the current user does not have read permissions on the workflow instance's mediapackage.

See Also:

• WorkflowService.suspend(long)

resume

public WorkflowInstance resume(long id)
                        throws WorkflowException,
NotFoundException,
IllegalStateException,
UnauthorizedException

Resumes a suspended workflow instance.

Specified by:

resume in interface WorkflowService

Parameters:

id - the workflow instance identifier

Returns:

the workflow instance

Throws:

WorkflowException - if there is a problem processing the workflow

NotFoundException - if no paused workflow with this identifier exists

IllegalStateException - if the workflow with this identifier is not in the paused state

UnauthorizedException - if the current user does not have read permissions on the workflow instance's mediapackage.

See Also:

• WorkflowService.resume(long)

resume

public WorkflowInstance resume(long workflowInstanceId,
 Map<String,String> properties)
                        throws WorkflowException,
NotFoundException,
IllegalStateException,
UnauthorizedException

Resumes a suspended workflow instance, applying new properties to the workflow.

Specified by:

resume in interface WorkflowService

Parameters:

workflowInstanceId - the workflow to resume

properties - the properties to apply to the resumed workflow

Returns:

the workflow instance

Throws:

WorkflowException - if there is a problem processing the workflow

NotFoundException - if no workflow with this identifier exists

IllegalStateException - if the workflow with this identifier is not in the paused state

UnauthorizedException - if the current user does not have read permissions on the workflow instance's mediapackage.

See Also:

• WorkflowService.resume(long, Map)

assertPermission

protected void assertPermission(WorkflowInstance workflow,
 String action,
 String workflowOrgId)
                         throws UnauthorizedException

Asserts that the current user has permission to take the provided action on a workflow instance.

Parameters:

workflow - the workflow instance

action - the action to ensure is permitted

Throws:

UnauthorizedException - if the action is not authorized

assertMediaPackagePermission

protected boolean assertMediaPackagePermission(String mediaPackageId,
 String action)

update

public void update(WorkflowInstance workflowInstance)
            throws WorkflowDatabaseException,
UnauthorizedException

Updates the given workflow instance with regard to the media package, the properties and the operations involved.

Specified by:

update in interface WorkflowService

Parameters:

workflowInstance - the workflow instance

Throws:

WorkflowDatabaseException - if there is a database problem processing the workflow

UnauthorizedException - if the current user does not have read permissions on the workflow instance's mediapackage.

See Also:

• WorkflowService.update(org.opencastproject.workflow.api.WorkflowInstance)

countWorkflowInstances

public long countWorkflowInstances()
                            throws WorkflowDatabaseException

Gets the total number of workflows that have been created to date.

Specified by:

countWorkflowInstances in interface WorkflowService

Returns:

The number of workflow instances, regardless of their state

Throws:

WorkflowDatabaseException - if there is a problem accessing the workflow instances in persistence

See Also:

• WorkflowService.countWorkflowInstances()

countWorkflowInstances

public long countWorkflowInstances(WorkflowInstance.WorkflowState state)
                            throws WorkflowDatabaseException

Gets the total number of workflows that have been created to date and that match the workflow state which might be null.

Specified by:

countWorkflowInstances in interface WorkflowService

Parameters:

state - the workflow state

Returns:

The number of workflow instances, regardless of their state

Throws:

WorkflowDatabaseException - if there is a problem accessing the workflow instances in persistence

See Also:

• WorkflowService.countWorkflowInstances(org.opencastproject.workflow.api.WorkflowInstance.WorkflowState)

getWorkflowInstancesByMediaPackage

public List<WorkflowInstance> getWorkflowInstancesByMediaPackage(String mediaPackageId)
                                                          throws WorkflowDatabaseException,
UnauthorizedException

Returns all workflows associated with the given mediapackage Current user needs permission to the mediapackage

Specified by:

getWorkflowInstancesByMediaPackage in interface WorkflowService

Parameters:

mediaPackageId - the identifier of the mediapackage

Returns:

a List of WorkflowInstance

Throws:

WorkflowDatabaseException

UnauthorizedException

See Also:

• WorkflowService.getWorkflowInstancesByMediaPackage(String)

getRunningWorkflowInstanceByMediaPackage

public Optional<WorkflowInstance> getRunningWorkflowInstanceByMediaPackage(String mediaPackageId,
 String action)
                                                                    throws WorkflowException,
UnauthorizedException,
WorkflowDatabaseException

Returns the WorkflowInstance currently running on the given mediaPackage

Specified by:

getRunningWorkflowInstanceByMediaPackage in interface WorkflowService

Parameters:

mediaPackageId - the identifier of the mediaPackage

action - necessary permissions for the workflowInstance

Returns:

An Optional containing the currently running WorkflowInstance

Throws:

WorkflowException

UnauthorizedException

WorkflowDatabaseException

See Also:

• WorkflowService.getRunningWorkflowInstanceByMediaPackage(String, String)

mediaPackageHasActiveWorkflows

public boolean mediaPackageHasActiveWorkflows(String mediaPackageId)
                                       throws WorkflowDatabaseException

Checks if there is at least one workflow currently running on the given mediapackage

Specified by:

mediaPackageHasActiveWorkflows in interface WorkflowService

Parameters:

mediaPackageId - the identifier of the mediapackage

Returns:

Whether there is a workflow active on the mediapackage

Throws:

WorkflowDatabaseException

See Also:

• WorkflowService.mediaPackageHasActiveWorkflows(String)

userHasActiveWorkflows

public boolean userHasActiveWorkflows(String userId)
                               throws WorkflowDatabaseException

Checks if there is at least one workflow currently running started by the given user

Specified by:

userHasActiveWorkflows in interface WorkflowService

Parameters:

userId - the identifier of the user

Returns:

Whether there is a workflow active started by the user

Throws:

WorkflowDatabaseException

See Also:

• WorkflowService.userHasActiveWorkflows(String)

handleOperationException

protected WorkflowInstance handleOperationException(WorkflowInstance workflow,
 WorkflowOperationInstance currentOperation)

Callback for workflow operations that were throwing an exception. This implementation assumes that the operation worker has already adjusted the current operation's state appropriately.

Parameters:

workflow - the workflow instance

currentOperation - the current workflow operation

Returns:

the workflow instance

handleOperationResult

protected WorkflowInstance handleOperationResult(WorkflowInstance workflow,
 WorkflowOperationResult result)
                                          throws WorkflowDatabaseException

Callback for workflow operation handlers that executed and finished without exception. This implementation assumes that the operation worker has already adjusted the current operation's state appropriately.

Parameters:

workflow - the workflow instance

result - the workflow operation result

Returns:

the workflow instance

Throws:

WorkflowDatabaseException - if updating the workflow fails

populateMediaPackageMetadata

protected void populateMediaPackageMetadata(MediaPackage mp)

Reads the available metadata from the dublin core catalog (if there is one) and updates the mediapackage.

Parameters:

mp - the media package

isReadyToAcceptJobs

public boolean isReadyToAcceptJobs(String operation)

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

See Also:

• JobProducer.isReadyToAcceptJobs(String)

isReadyToAccept

public boolean isReadyToAccept(Job job)
                        throws UndispatchableJobException

Whether the job can be accepted. If we are already running the maximum number of workflows, don't accept another START_WORKFLOW job

Specified by:

isReadyToAccept in interface JobProducer

Parameters:

job - the job being dispatched

Returns:

whether the service is ready to accept the job

Throws:

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

See Also:

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

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:

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

process

protected String process(Job job)
                  throws Exception

Processes the workflow job.

Parameters:

job - the job

Returns:

the job payload

Throws:

Exception - if job processing fails

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)

setProfilesReadyIndicator

protected void setProfilesReadyIndicator(ReadinessIndicator unused)

Dummy callback for osgi

Parameters:

unused - the unused ReadinessIndicator

setWorkspace

protected void setWorkspace(Workspace workspace)

Callback for the OSGi environment to register with the Workspace.

Parameters:

workspace - the workspace

setServiceRegistry

protected void setServiceRegistry(ServiceRegistry registry)

Callback for the OSGi environment to register with the ServiceRegistry.

Parameters:

registry - the service registry

getServiceRegistry

public ServiceRegistry getServiceRegistry()

setSecurityService

public void setSecurityService(SecurityService securityService)

Callback for setting the security service.

Parameters:

securityService - the securityService to set

setAuthorizationService

public void setAuthorizationService(AuthorizationService authorizationService)

Callback for setting the authorization service.

Parameters:

authorizationService - the authorizationService 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

setSeriesService

public void setSeriesService(SeriesService seriesService)

Sets the series service

Parameters:

seriesService - the seriesService to set

setAssetManager

public void setAssetManager(AssetManager assetManager)

Sets the asset manager

Parameters:

assetManager - the assetManager to set

addMetadataService

protected void addMetadataService(MediaPackageMetadataService service)

Callback to set the metadata service

Parameters:

service - the metadata service

removeMetadataService

protected void removeMetadataService(MediaPackageMetadataService service)

Callback to remove a mediapackage metadata service.

Parameters:

service - the mediapackage metadata service to remove

addWorkflowDefinitionScanner

protected void addWorkflowDefinitionScanner(WorkflowDefinitionScanner scanner)

Callback to set the workflow definition scanner

Parameters:

scanner - the workflow definition scanner

setIndex

public void setIndex(ElasticsearchIndex index)

Callback to set the Admin UI index.

Parameters:

index - the admin UI index.

setPersistence

public void setPersistence(WorkflowServiceDatabase persistence)

Callback to set the workflow database

Parameters:

persistence - the workflow database

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

cleanupWorkflowInstances

public void cleanupWorkflowInstances(int buffer,
 WorkflowInstance.WorkflowState state)
                              throws UnauthorizedException,
WorkflowDatabaseException

Description copied from interface: WorkflowService

Starts a cleanup of workflow instances with a given lifetime and a specific state

Specified by:

cleanupWorkflowInstances in interface WorkflowService

Parameters:

buffer - minimum lifetime of the workflow instances

state - state of the workflow instances

Throws:

UnauthorizedException

WorkflowDatabaseException

getWorkflowStateMappings

public Map<String,Map<String,String>> getWorkflowStateMappings()

Specified by:

getWorkflowStateMappings in interface WorkflowService

Returns:

All configured workflow state mappings

repopulate

public void repopulate(IndexRebuildService.DataType type)
                throws IndexRebuildException

Description copied from interface: IndexProducer

Re-add the data of this service to the index.

Specified by:

repopulate in interface IndexProducer

Parameters:

type - Limit the data added to the index. Use ALL to re-index all data.

Throws:

IndexRebuildException

getService

public IndexRebuildService.Service getService()

Description copied from interface: IndexProducer

Get the service that implements IndexProducer.

Specified by:

getService in interface IndexProducer

Returns:

service The service that implements IndexProducer.