Package org.opencastproject.workflow.api

Class WorkflowServiceDatabaseImpl

java.lang.Object

org.opencastproject.workflow.api.WorkflowServiceDatabaseImpl

All Implemented Interfaces:

WorkflowServiceDatabase

public class WorkflowServiceDatabaseImpl
extends Object
implements WorkflowServiceDatabase

Implements WorkflowServiceDatabase. Defines permanent storage for workflow.

Field Summary

Fields

Modifier and Type	Field	Description
protected DBSession	db
protected DBSessionFactory	dbSessionFactory
protected javax.persistence.EntityManagerFactory	emf	Factory used to create EntityManagers for transactions
static final String	PERSISTENCE_UNIT	JPA persistence unit name
protected SecurityService	securityService	The security service

Constructor Summary

Constructors

Constructor	Description
WorkflowServiceDatabaseImpl()

Method Summary

Modifier and Type	Method	Description
void	activate(org.osgi.service.component.ComponentContext cc)	Creates EntityManagerFactory using persistence provider and properties passed via OSGi.
int	countMediaPackages()	Returns the number of events workflows have been run on.
long	countWorkflows(WorkflowInstance.WorkflowState state)	Gets the amount of workflow instances.
List<WorkflowInstance>	getRunningWorkflowInstancesByMediaPackage(String mediaPackageId)	Gets all workflow instances that are currently running on the mediapackage.
WorkflowInstance	getWorkflow(long workflowId)	Gets a single workflow by its identifier.
WorkflowInstance	getWorkflow(long workflowId, String orgId)	Gets a single workflow by its identifier
List<WorkflowIndexData>	getWorkflowIndexData(int limit, int offset)	Gets workflow index data for all events.
List<WorkflowInstance>	getWorkflowInstances(int limit, int offset)	Gets workflow instances for current organization.
List<WorkflowInstance>	getWorkflowInstancesByMediaPackage(String mediaPackageId)	Gets all workflow instances for a mediapackage.
List<WorkflowInstance>	getWorkflowInstancesForCleanup(WorkflowInstance.WorkflowState state, Date dateCreated)	Gets all workflow instances previous to the specified date
boolean	mediaPackageHasActiveWorkflows(String mediaPackageId)	Returns true if the media package with the given identifier currently has a workflow running on it.
void	removeFromDatabase(WorkflowInstance instance)	Removes a single workflow.
void	setDBSessionFactory(DBSessionFactory dbSessionFactory)
void	setEntityManagerFactory(javax.persistence.EntityManagerFactory emf)	OSGi DI
void	setSecurityService(SecurityService securityService)	OSGi callback to set the security service.
void	updateInDatabase(WorkflowInstance instance)	Updates a single workflow.
boolean	userHasActiveWorkflows(String userId)	Returns true there are still workflows running that were created by the user with the given identifier.

Methods inherited from class java.lang.Object

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

Field Details

PERSISTENCE_UNIT

public static final String PERSISTENCE_UNIT

JPA persistence unit name

See Also:

• Constant Field Values

emf

protected javax.persistence.EntityManagerFactory emf

Factory used to create EntityManagers for transactions

dbSessionFactory

protected DBSessionFactory dbSessionFactory

db

protected DBSession db

securityService

protected SecurityService securityService

The security service

Constructor Details

WorkflowServiceDatabaseImpl

public WorkflowServiceDatabaseImpl()

Method Details

setEntityManagerFactory

public void setEntityManagerFactory(javax.persistence.EntityManagerFactory emf)

OSGi DI

setDBSessionFactory

public void setDBSessionFactory(DBSessionFactory dbSessionFactory)

setSecurityService

public void setSecurityService(SecurityService securityService)

OSGi callback to set the security service.

Parameters:

securityService - the securityService to set

activate

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

Creates EntityManagerFactory using persistence provider and properties passed via OSGi.

Parameters:

cc -

getWorkflow

public WorkflowInstance getWorkflow(long workflowId)
                             throws NotFoundException,
WorkflowDatabaseException

Gets a single workflow by its identifier.

Specified by:

getWorkflow in interface WorkflowServiceDatabase

Parameters:

workflowId - the series identifier

Returns:

the WorkflowInstance for this workflow

Throws:

NotFoundException - if there is no workflow with this identifier

WorkflowDatabaseException - if there is a problem communicating with the underlying data store

See Also:

• WorkflowServiceDatabase.getWorkflow(long)

getWorkflow

public WorkflowInstance getWorkflow(long workflowId,
 String orgId)
                             throws NotFoundException,
WorkflowDatabaseException

Description copied from interface: WorkflowServiceDatabase

Gets a single workflow by its identifier

Specified by:

getWorkflow in interface WorkflowServiceDatabase

Parameters:

workflowId - the series identifier

Returns:

the WorkflowInstance for this workflow

Throws:

NotFoundException - if there is no workflow with this identifier

WorkflowDatabaseException - if there is a problem communicating with the underlying data store

getWorkflowInstances

public List<WorkflowInstance> getWorkflowInstances(int limit,
 int offset)
                                            throws WorkflowDatabaseException

Gets workflow instances for current organization.

Specified by:

getWorkflowInstances in interface WorkflowServiceDatabase

Parameters:

limit - max number of workflows to be returned

offset - only return workflows from this point onwards

Returns:

list of all WorkflowInstances

Throws:

WorkflowDatabaseException - if there is a problem communicating with the underlying data store

See Also:

• WorkflowServiceDatabase.getWorkflowInstances(int limit, int offset)

getWorkflowInstancesForCleanup

public List<WorkflowInstance> getWorkflowInstancesForCleanup(WorkflowInstance.WorkflowState state,
 Date dateCreated)
                                                      throws WorkflowDatabaseException

Gets all workflow instances previous to the specified date

Specified by:

getWorkflowInstancesForCleanup in interface WorkflowServiceDatabase

Parameters:

state - Only returns workflows currently in the given state

dateCreated - Only returns workflows created prior to the given date

Returns:

list of the WorkflowInstances

Throws:

WorkflowDatabaseException

See Also:

• WorkflowServiceDatabase.getWorkflowInstancesForCleanup(WorkflowInstance.WorkflowState state, Date dateCreated)

countWorkflows

public long countWorkflows(WorkflowInstance.WorkflowState state)
                    throws WorkflowDatabaseException

Gets the amount of workflow instances.

Specified by:

countWorkflows in interface WorkflowServiceDatabase

Parameters:

state - Only counts workflows currently in the given state

Returns:

Amount of workflow instances

Throws:

WorkflowDatabaseException

See Also:

• WorkflowServiceDatabase.countWorkflows(WorkflowInstance.WorkflowState state)

getWorkflowIndexData

public List<WorkflowIndexData> getWorkflowIndexData(int limit,
 int offset)
                                             throws WorkflowDatabaseException

Gets workflow index data for all events. Selects only workflow id, state, mediapackage id and organization id

Specified by:

getWorkflowIndexData in interface WorkflowServiceDatabase

Parameters:

limit - max number of data objects to be returned

offset - only return data from this point onwards

Returns:

list of WorkflowIndexDatas

Throws:

WorkflowDatabaseException - if there is a problem communicating with the underlying data store

See Also:

• WorkflowServiceDatabase.getWorkflowIndexData(int limit, int offset)

countMediaPackages

public int countMediaPackages()
                       throws WorkflowDatabaseException

Returns the number of events workflows have been run on.

Specified by:

countMediaPackages in interface WorkflowServiceDatabase

Returns:

the number of latest workflows

Throws:

WorkflowDatabaseException - if there is a problem communicating with the underlying data store

See Also:

• WorkflowServiceDatabase.countMediaPackages()

getWorkflowInstancesByMediaPackage

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

Gets all workflow instances for a mediapackage.

Specified by:

getWorkflowInstancesByMediaPackage in interface WorkflowServiceDatabase

Parameters:

mediaPackageId - the media package id

Returns:

list of all WorkflowInstances for the given mediapackage id

Throws:

WorkflowDatabaseException - if there is a problem communicating with the underlying data store

See Also:

• WorkflowServiceDatabase.getWorkflowInstancesByMediaPackage(String mediaPackageId)

getRunningWorkflowInstancesByMediaPackage

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

Gets all workflow instances that are currently running on the mediapackage.

Specified by:

getRunningWorkflowInstancesByMediaPackage in interface WorkflowServiceDatabase

Parameters:

mediaPackageId - the mediapackage id

Returns:

list of all WorkflowInstances for the given mediapackage id

Throws:

WorkflowDatabaseException - if there is a problem communicating with the underlying data store

See Also:

• WorkflowServiceDatabase.getRunningWorkflowInstancesByMediaPackage(String mediaPackageId)

mediaPackageHasActiveWorkflows

public boolean mediaPackageHasActiveWorkflows(String mediaPackageId)
                                       throws WorkflowDatabaseException

Returns true if the media package with the given identifier currently has a workflow running on it.

Specified by:

mediaPackageHasActiveWorkflows in interface WorkflowServiceDatabase

Parameters:

mediaPackageId - the media package identifier

Returns:

true, if a workflow is running; false otherwise

Throws:

WorkflowDatabaseException - if there is a problem communicating with the underlying data store

See Also:

• WorkflowServiceDatabase.mediaPackageHasActiveWorkflows(String mediaPackageId)

userHasActiveWorkflows

public boolean userHasActiveWorkflows(String userId)
                               throws WorkflowDatabaseException

Returns true there are still workflows running that were created by the user with the given identifier.

Specified by:

userHasActiveWorkflows in interface WorkflowServiceDatabase

Parameters:

userId - the user identifier

Returns:

true, if a workflow is running; false otherwise

Throws:

WorkflowDatabaseException - if there is a problem communicating with the underlying data store

See Also:

• WorkflowServiceDatabase.userHasActiveWorkflows(String mediaPackageId)

updateInDatabase

public void updateInDatabase(WorkflowInstance instance)
                      throws WorkflowDatabaseException

Updates a single workflow.

Specified by:

updateInDatabase in interface WorkflowServiceDatabase

Parameters:

instance - the workflow instance

Throws:

WorkflowDatabaseException - if there is a problem communicating with the underlying data store

See Also:

• WorkflowServiceDatabase.updateInDatabase(WorkflowInstance instance)

removeFromDatabase

public void removeFromDatabase(WorkflowInstance instance)
                        throws WorkflowDatabaseException

Removes a single workflow.

Specified by:

removeFromDatabase in interface WorkflowServiceDatabase

Parameters:

instance - the workflow instance

Throws:

WorkflowDatabaseException - if there is a problem communicating with the underlying data store

See Also:

• WorkflowServiceDatabase.removeFromDatabase(WorkflowInstance instance)