Package org.opencastproject.workflow.api

Interface WorkflowService

All Known Implementing Classes:

WorkflowServiceImpl, WorkflowServiceRemoteImpl

public interface WorkflowService

Manages WorkflowDefinitions and WorkflowInstances.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JOB_TYPE	Identifier for workflow jobs
static final String	WORKFLOW_OPERATION_PROPERTY	The service registration property we use to identify which workflow operation a WorkflowOperationHandler should handle.

Method Summary

Modifier and Type	Method	Description
void	addWorkflowListener(WorkflowListener listener)	Adds a workflow listener to be notified when workflows are updated.
void	cleanupWorkflowInstances(int lifetime, WorkflowInstance.WorkflowState state)	Starts a cleanup of workflow instances with a given lifetime and a specific state
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.
Optional<WorkflowInstance>	getRunningWorkflowInstanceByMediaPackage(String mediaPackageId, String action)	Returns the WorkflowInstance currently running on the given mediaPackage
WorkflowInstance	getWorkflowById(long workflowId)	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
Map<String,Map<String,String>>	getWorkflowStateMappings()
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
void	remove(long workflowInstanceId)	Permanently removes a workflow instance.
void	remove(long workflowInstanceId, boolean force)	Permanently removes a workflow instance.
void	removeWorkflowListener(WorkflowListener listener)	Removes a workflow listener.
WorkflowInstance	resume(long workflowInstanceId)	Resumes a suspended workflow instance.
WorkflowInstance	resume(long workflowInstanceId, Map<String,String> properties)	Resumes a suspended workflow instance, applying new properties to the workflow.
WorkflowInstance	start(WorkflowDefinition workflowDefinition, MediaPackage mediaPackage)	Creates a new workflow instance and starts the workflow.
WorkflowInstance	start(WorkflowDefinition workflowDefinition, MediaPackage mediaPackage, Long parentWorkflowId, Map<String,String> properties)	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.
boolean	userHasActiveWorkflows(String userId)	Checks if there is at least one workflow currently running started by the given user

Field Details

WORKFLOW_OPERATION_PROPERTY

static final String WORKFLOW_OPERATION_PROPERTY

The service registration property we use to identify which workflow operation a WorkflowOperationHandler should handle.

See Also:

• Constant Field Values

JOB_TYPE

static final String JOB_TYPE

Identifier for workflow jobs

See Also:

• Constant Field Values

Method Details

addWorkflowListener

void addWorkflowListener(WorkflowListener listener)

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

Parameters:

listener - the workflow listener to add

removeWorkflowListener

void removeWorkflowListener(WorkflowListener listener)

Removes a workflow listener.

Parameters:

listener - the workflow listener to remove

getWorkflowDefinitionById

WorkflowDefinition getWorkflowDefinitionById(String id)
                                      throws WorkflowDatabaseException,
NotFoundException

Returns the WorkflowDefinition identified by name.

Parameters:

id - the workflow definition id

Returns:

the workflow

Throws:

WorkflowDatabaseException - if there is a problem accessing the workflow definition

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

getWorkflowById

WorkflowInstance getWorkflowById(long workflowId)
                          throws WorkflowDatabaseException,
NotFoundException,
UnauthorizedException

Gets a WorkflowInstance by its ID.

Returns:

the workflow instance

Throws:

WorkflowDatabaseException - if there is a problem accessing the workflow instance from persistence

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.

start

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

Creates a new workflow instance and starts the workflow.

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

start

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

Creates a new workflow instance and starts the workflow.

Parameters:

workflowDefinition - the workflow definition

mediaPackage - the mediapackage to process

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

properties - any properties to apply to the workflow definition

Returns:

The new workflow instance

Throws:

NotFoundException - if the parent workflow does not exist

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

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

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

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

start

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

Creates a new workflow instance and starts the workflow.

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

countWorkflowInstances

long countWorkflowInstances()
                     throws WorkflowDatabaseException

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

Returns:

The number of workflow instances, regardless of their state

Throws:

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

countWorkflowInstances

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.

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

stop

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

Stops a running workflow instance.

Parameters:

workflowInstanceId - the workflow instance identifier

Returns:

the workflow instance

Throws:

NotFoundException - if no running workflow with this identifier exists

WorkflowException - if there is a problem processing the workflow

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

remove

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

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

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

remove

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

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

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

WorkflowParsingException

suspend

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

Temporarily suspends a started workflow instance.

Parameters:

workflowInstanceId - the workflow instance identifier

Returns:

the workflow instance

Throws:

NotFoundException - if no running workflow with this identifier exists

WorkflowException - if there is a problem processing the workflow

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

resume

WorkflowInstance resume(long workflowInstanceId)
                 throws NotFoundException,
WorkflowException,
IllegalStateException,
UnauthorizedException

Resumes a suspended workflow instance.

Parameters:

workflowInstanceId - the workflow instance identifier

Returns:

the workflow instance

Throws:

NotFoundException - if no paused workflow with this identifier exists

WorkflowException - if there is a problem processing the workflow

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.

resume

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

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

Parameters:

workflowInstanceId - the workflow to resume

properties - the properties to apply to the resumed workflow

Returns:

the workflow instance

Throws:

NotFoundException - if no workflow with this identifier exists

WorkflowException - if there is a problem processing the workflow

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.

update

void update(WorkflowInstance workflowInstance)
     throws WorkflowDatabaseException,
UnauthorizedException

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

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.

listAvailableWorkflowDefinitions

List<WorkflowDefinition> listAvailableWorkflowDefinitions()
                                                   throws WorkflowDatabaseException

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.

Returns:

The list of currently available workflow definitions, sorted by title

Throws:

WorkflowDatabaseException - if there is a problem storing the registered workflow definitions

cleanupWorkflowInstances

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

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

Parameters:

lifetime - minimum lifetime of the workflow instances

state - state of the workflow instances

Throws:

WorkflowDatabaseException

UnauthorizedException

getWorkflowStateMappings

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

Returns:

All configured workflow state mappings

mediaPackageHasActiveWorkflows

boolean mediaPackageHasActiveWorkflows(String mediaPackageId)
                                throws WorkflowDatabaseException

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

Parameters:

mediaPackageId - the identifier of the mediapackage

Returns:

Whether there is a workflow active on the mediapackage

Throws:

WorkflowDatabaseException

userHasActiveWorkflows

boolean userHasActiveWorkflows(String userId)
                        throws WorkflowDatabaseException

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

Parameters:

userId - the identifier of the user

Returns:

Whether there is a workflow active started by the user

Throws:

WorkflowDatabaseException

getWorkflowInstancesByMediaPackage

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

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

Parameters:

mediaPackageId - the identifier of the mediapackage

Returns:

a List of WorkflowInstance

Throws:

WorkflowDatabaseException

UnauthorizedException

getRunningWorkflowInstanceByMediaPackage

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

Returns the WorkflowInstance currently running on the given mediaPackage

Parameters:

mediaPackageId - the identifier of the mediaPackage

action - necessary permissions for the workflowInstance

Returns:

An Optional containing the currently running WorkflowInstance

Throws:

WorkflowException

WorkflowDatabaseException

UnauthorizedException