Package org.opencastproject.workflow.remote

Class WorkflowServiceRemoteImpl

java.lang.Object

org.opencastproject.serviceregistry.api.RemoteBase

org.opencastproject.workflow.remote.WorkflowServiceRemoteImpl

All Implemented Interfaces:

WorkflowService

public class WorkflowServiceRemoteImpl
extends RemoteBase
implements WorkflowService

An implementation of the workflow service that communicates with a remote workflow service via HTTP.

Nested Class Summary

Nested classes/interfaces inherited from class org.opencastproject.serviceregistry.api.RemoteBase

RemoteBase.HttpClientClosingInputStream

Field Summary

Fields inherited from class org.opencastproject.serviceregistry.api.RemoteBase

client, remoteServiceManager, serviceType

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

JOB_TYPE, WORKFLOW_OPERATION_PROPERTY

Constructor Summary

Constructors

Constructor	Description
WorkflowServiceRemoteImpl()

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 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
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.
void	setRemoteServiceManager(ServiceRegistry remoteServiceManager)	Sets the remote service manager.
void	setTrustedHttpClient(TrustedHttpClient client)	Sets the trusted http client
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

Methods inherited from class org.opencastproject.serviceregistry.api.RemoteBase

closeConnection, elementsFromHttpResponse, getResponse, getResponse, runRequest

Methods inherited from class java.lang.Object

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

Constructor Details

WorkflowServiceRemoteImpl

public WorkflowServiceRemoteImpl()

Method Details

setTrustedHttpClient

public void setTrustedHttpClient(TrustedHttpClient client)

Sets the trusted http client

Overrides:

setTrustedHttpClient in class RemoteBase

Parameters:

client -

setRemoteServiceManager

public void setRemoteServiceManager(ServiceRegistry remoteServiceManager)

Sets the remote service manager.

Overrides:

setRemoteServiceManager in class RemoteBase

Parameters:

remoteServiceManager -

getWorkflowDefinitionById

public WorkflowDefinition getWorkflowDefinitionById(String id)
                                             throws WorkflowDatabaseException,
NotFoundException

Returns the WorkflowDefinition identified by name.

Specified by:

getWorkflowDefinitionById in interface WorkflowService

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

See Also:

• WorkflowService.getWorkflowDefinitionById(java.lang.String)

getWorkflowById

public WorkflowInstance getWorkflowById(long id)
                                 throws WorkflowDatabaseException,
NotFoundException

Gets a WorkflowInstance by its ID.

Specified by:

getWorkflowById in interface WorkflowService

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

See Also:

• WorkflowService.getWorkflowById(long)

getWorkflowInstancesByMediaPackage

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

Description copied from interface: WorkflowService

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

getRunningWorkflowInstanceByMediaPackage

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

Description copied from interface: WorkflowService

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

mediaPackageHasActiveWorkflows

public boolean mediaPackageHasActiveWorkflows(String mediaPackageId)
                                       throws WorkflowDatabaseException

Description copied from interface: WorkflowService

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

userHasActiveWorkflows

public boolean userHasActiveWorkflows(String userId)
                               throws WorkflowDatabaseException

Description copied from interface: WorkflowService

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

start

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

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

See Also:

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

start

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

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

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:

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

NotFoundException - if the parent workflow does not exist

See Also:

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

start

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

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

See Also:

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

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)

stop

public WorkflowInstance stop(long workflowInstanceId)
                      throws WorkflowDatabaseException,
NotFoundException

Stops a running workflow instance.

Specified by:

stop in interface WorkflowService

Parameters:

workflowInstanceId - the workflow instance identifier

Returns:

the workflow instance

Throws:

NotFoundException - if no running workflow with this identifier exists

WorkflowDatabaseException

See Also:

• WorkflowService.stop(long)

suspend

public WorkflowInstance suspend(long workflowInstanceId)
                         throws WorkflowDatabaseException,
NotFoundException

Temporarily suspends a started workflow instance.

Specified by:

suspend in interface WorkflowService

Parameters:

workflowInstanceId - the workflow instance identifier

Returns:

the workflow instance

Throws:

NotFoundException - if no running workflow with this identifier exists

WorkflowDatabaseException

See Also:

• WorkflowService.suspend(long)

resume

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

Resumes a suspended workflow instance.

Specified by:

resume in interface WorkflowService

Parameters:

workflowInstanceId - the workflow instance identifier

Returns:

the workflow instance

Throws:

NotFoundException - if no paused workflow with this identifier exists

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

WorkflowException - if there is a problem processing the workflow

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

See Also:

• WorkflowService.resume(long)

resume

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

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:

NotFoundException - if no workflow with this identifier exists

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

WorkflowException - if there is a problem processing the workflow

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

See Also:

• WorkflowService.resume(long, java.util.Map)

update

public void update(WorkflowInstance workflowInstance)
            throws WorkflowDatabaseException

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

See Also:

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

remove

public void remove(long workflowInstanceId)
            throws WorkflowDatabaseException,
NotFoundException

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

See Also:

• WorkflowService.remove(long)

remove

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

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

See Also:

• WorkflowService.remove(long, boolean)

listAvailableWorkflowDefinitions

public 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.

Specified by:

listAvailableWorkflowDefinitions in interface WorkflowService

Returns:

The list of currently available workflow definitions, sorted by title

Throws:

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

See Also:

• WorkflowService.listAvailableWorkflowDefinitions()

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)

cleanupWorkflowInstances

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

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:

lifetime - minimum lifetime of the workflow instances

state - state of the workflow instances

Throws:

WorkflowDatabaseException

UnauthorizedException

getWorkflowStateMappings

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

Specified by:

getWorkflowStateMappings in interface WorkflowService

Returns:

All configured workflow state mappings