Package org.opencastproject.lifecyclemanagement.impl.persistence

Class LifeCycleDatabaseServiceImpl

java.lang.Object

org.opencastproject.lifecyclemanagement.impl.persistence.LifeCycleDatabaseServiceImpl

All Implemented Interfaces:

LifeCycleDatabaseService

public class LifeCycleDatabaseServiceImpl
extends Object
implements LifeCycleDatabaseService

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PERSISTENCE_UNIT	JPA persistence unit name
protected SecurityService	securityService	The security service

Constructor Summary

Constructors

Constructor	Description
LifeCycleDatabaseServiceImpl()

Method Summary

Modifier and Type	Method	Description
void	activate(org.osgi.service.component.ComponentContext cc)
LifeCyclePolicy	createLifeCyclePolicy(LifeCyclePolicy policy, String orgId)	Creates a single life cycle policy in the database.
LifeCycleTask	createLifeCycleTask(LifeCycleTask task, String orgId)	Creates a single life cycle task.
void	deleteAllLifeCyclePoliciesCreatedByConfig(String orgId)	Remove all life cycle policies that were created through configuration files from the database
boolean	deleteLifeCyclePolicy(LifeCyclePolicy policy, String orgId)	Removes a single life cycle policy in the database.
boolean	deleteLifeCycleTask(LifeCycleTask task, String orgId)	Removes a single life cycle task.
List<LifeCyclePolicy>	getActiveLifeCyclePolicies(String orgId)	Get currently active life cycle policies
List<LifeCyclePolicy>	getLifeCyclePolicies(int limit, int offset, SortCriterion sortCriterion)	Get several life cycle policies based on their order in the database
long	getLifeCyclePoliciesTotal(String orgId)	Get the total number of policies
LifeCyclePolicy	getLifeCyclePolicy(String id)	Gets a single life cycle policy in the current organization context by its identifier.
LifeCyclePolicy	getLifeCyclePolicy(String id, String orgId)	Gets a single life cycle policy by its identifier.
protected Function<javax.persistence.EntityManager,Optional<LifeCyclePolicy>>	getLifeCyclePolicyById(String id, String orgId)	Gets a life cycle policy by its ID, using the current organizational context.
LifeCycleTask	getLifeCycleTask(String id)	Gets a single life cycle task in the current organization context by its identifier.
protected Function<javax.persistence.EntityManager,Optional<LifeCycleTask>>	getLifeCycleTaskById(String id, String orgId)	Gets a life cycle task by its ID, using the current organizational context.
LifeCycleTask	getLifeCycleTaskByTargetId(String targetId)	Gets a single life cycle task in the current organization context by its target identifier.
List<LifeCycleTask>	getLifeCycleTasksWithStatus(Status status, String orgId)	Get several life cycle policies based on their status
void	setDBSessionFactory(DBSessionFactory dbSessionFactory)
void	setEntityManagerFactory(javax.persistence.EntityManagerFactory emf)	OSGi DI
void	setSecurityService(SecurityService securityService)	OSGi callback to set the security service.
boolean	updateLifeCyclePolicy(LifeCyclePolicy policy, String orgId)	Updates a single life cycle policy in the database.
boolean	updateLifeCycleTask(LifeCycleTask task, String orgId)	Updates a single life cycle task.

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

securityService

protected SecurityService securityService

The security service

Constructor Details

LifeCycleDatabaseServiceImpl

public LifeCycleDatabaseServiceImpl()

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)

getLifeCyclePolicy

public LifeCyclePolicy getLifeCyclePolicy(String id)
                                   throws NotFoundException,
LifeCycleDatabaseException

Gets a single life cycle policy in the current organization context by its identifier.

Specified by:

getLifeCyclePolicy in interface LifeCycleDatabaseService

Parameters:

id - the life cycle policy identifier

Returns:

the LifeCyclePolicy with the given identifier

Throws:

NotFoundException - if there is no life cycle policy with this identifier

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

See Also:

• LifeCycleDatabaseService.getLifeCyclePolicy(String)

getLifeCyclePolicy

public LifeCyclePolicy getLifeCyclePolicy(String id,
 String orgId)
                                   throws NotFoundException,
LifeCycleDatabaseException

Gets a single life cycle policy by its identifier.

Specified by:

getLifeCyclePolicy in interface LifeCycleDatabaseService

Parameters:

id - the life cycle policy identifier

orgId - the organisation identifier

Returns:

the LifeCyclePolicy with the given identifier

Throws:

NotFoundException - if there is no life cycle policy with this identifier

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

See Also:

• LifeCycleDatabaseService.getLifeCyclePolicy(String, String)

getLifeCyclePoliciesTotal

public long getLifeCyclePoliciesTotal(String orgId)
                               throws LifeCycleDatabaseException

Get the total number of policies

Specified by:

getLifeCyclePoliciesTotal in interface LifeCycleDatabaseService

Parameters:

orgId - the organisation identifier

Returns:

the total number of policies

Throws:

LifeCycleDatabaseException

See Also:

• LifeCycleDatabaseService.getLifeCyclePolicies(int, int, SortCriterion)

getLifeCyclePolicies

public List<LifeCyclePolicy> getLifeCyclePolicies(int limit,
 int offset,
 SortCriterion sortCriterion)
                                           throws LifeCycleDatabaseException

Get several life cycle policies based on their order in the database

Specified by:

getLifeCyclePolicies in interface LifeCycleDatabaseService

Parameters:

limit - Maximum amount of life cycle policys to return

offset - The index of the first result to return

Returns:

a list of LifeCyclePolicys

Throws:

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

See Also:

• LifeCycleDatabaseService.getLifeCyclePolicies(int, int, SortCriterion)

getActiveLifeCyclePolicies

public List<LifeCyclePolicy> getActiveLifeCyclePolicies(String orgId)
                                                 throws LifeCycleDatabaseException

Get currently active life cycle policies

Specified by:

getActiveLifeCyclePolicies in interface LifeCycleDatabaseService

Parameters:

orgId - the organisation identifier

Returns:

a list of LifeCyclePolicys

Throws:

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

See Also:

• LifeCycleDatabaseService.getActiveLifeCyclePolicies(String)

createLifeCyclePolicy

public LifeCyclePolicy createLifeCyclePolicy(LifeCyclePolicy policy,
 String orgId)
                                      throws LifeCycleDatabaseException

Creates a single life cycle policy in the database.

Specified by:

createLifeCyclePolicy in interface LifeCycleDatabaseService

Parameters:

policy - The LifeCyclePolicy

orgId - the organisation identifier

Returns:

The created LifeCyclePolicy

Throws:

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

See Also:

• LifeCycleDatabaseService.createLifeCyclePolicy(LifeCyclePolicy, String)

updateLifeCyclePolicy

public boolean updateLifeCyclePolicy(LifeCyclePolicy policy,
 String orgId)
                              throws LifeCycleDatabaseException

Updates a single life cycle policy in the database.

Specified by:

updateLifeCyclePolicy in interface LifeCycleDatabaseService

Parameters:

policy - The LifeCyclePolicy

orgId - the organisation identifier

Returns:

If the life cycle policy was successfully updated

Throws:

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

See Also:

• LifeCycleDatabaseService.updateLifeCyclePolicy(LifeCyclePolicy, String)

deleteLifeCyclePolicy

public boolean deleteLifeCyclePolicy(LifeCyclePolicy policy,
 String orgId)
                              throws LifeCycleDatabaseException

Removes a single life cycle policy in the database.

Specified by:

deleteLifeCyclePolicy in interface LifeCycleDatabaseService

Parameters:

policy - The LifeCyclePolicy

orgId - the organisation identifier

Returns:

If the life cycle policy was successfully updated

Throws:

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

See Also:

• LifeCycleDatabaseService.deleteLifeCyclePolicy(LifeCyclePolicy, String)

deleteAllLifeCyclePoliciesCreatedByConfig

public void deleteAllLifeCyclePoliciesCreatedByConfig(String orgId)
                                               throws LifeCycleDatabaseException

Remove all life cycle policies that were created through configuration files from the database

Specified by:

deleteAllLifeCyclePoliciesCreatedByConfig in interface LifeCycleDatabaseService

Parameters:

orgId -

Throws:

LifeCycleDatabaseException

See Also:

• LifeCycleDatabaseService.deleteLifeCyclePolicy(LifeCyclePolicy, String)

getLifeCycleTask

public LifeCycleTask getLifeCycleTask(String id)
                               throws NotFoundException,
LifeCycleDatabaseException

Gets a single life cycle task in the current organization context by its identifier.

Specified by:

getLifeCycleTask in interface LifeCycleDatabaseService

Parameters:

id - the life cycle task identifier

Returns:

the LifeCycleTask with the given identifier

Throws:

NotFoundException - if there is no life cycle task with this identifier

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

See Also:

• LifeCycleDatabaseService.getLifeCycleTask(String)

getLifeCycleTaskByTargetId

public LifeCycleTask getLifeCycleTaskByTargetId(String targetId)
                                         throws NotFoundException,
LifeCycleDatabaseException

Gets a single life cycle task in the current organization context by its target identifier.

Specified by:

getLifeCycleTaskByTargetId in interface LifeCycleDatabaseService

Parameters:

targetId - the id of the entity the task will act on

Returns:

the LifeCycleTask with the given identifier

Throws:

NotFoundException - if there is no life cycle task with this identifier

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

See Also:

• LifeCycleDatabaseService.getLifeCycleTaskByTargetId(String)

getLifeCycleTasksWithStatus

public List<LifeCycleTask> getLifeCycleTasksWithStatus(Status status,
 String orgId)
                                                throws LifeCycleDatabaseException

Get several life cycle policies based on their status

Specified by:

getLifeCycleTasksWithStatus in interface LifeCycleDatabaseService

Parameters:

status - The state the tasks should be in

orgId - the organisation identifier

Returns:

a list of LifeCycleTasks

Throws:

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

See Also:

• LifeCycleDatabaseService.getLifeCycleTasksWithStatus(Status, String)

createLifeCycleTask

public LifeCycleTask createLifeCycleTask(LifeCycleTask task,
 String orgId)
                                  throws LifeCycleDatabaseException

Creates a single life cycle task.

Specified by:

createLifeCycleTask in interface LifeCycleDatabaseService

Parameters:

task - The LifeCycleTask

orgId - the organisation identifier

Returns:

The created LifeCycleTask

Throws:

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

See Also:

• LifeCycleDatabaseService.createLifeCycleTask(LifeCycleTask, String)

updateLifeCycleTask

public boolean updateLifeCycleTask(LifeCycleTask task,
 String orgId)
                            throws LifeCycleDatabaseException

Updates a single life cycle task.

Specified by:

updateLifeCycleTask in interface LifeCycleDatabaseService

Parameters:

task - The LifeCycleTask

orgId - the organisation identifier

Returns:

If the life cycle task was successfully updated

Throws:

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

See Also:

• LifeCycleDatabaseService.updateLifeCycleTask(LifeCycleTask, String)

deleteLifeCycleTask

public boolean deleteLifeCycleTask(LifeCycleTask task,
 String orgId)
                            throws LifeCycleDatabaseException

Removes a single life cycle task.

Specified by:

deleteLifeCycleTask in interface LifeCycleDatabaseService

Parameters:

task - The LifeCycleTask

orgId - the organisation identifier

Returns:

If the life cycle task was successfully updated

Throws:

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

See Also:

• LifeCycleDatabaseService.deleteLifeCycleTask(LifeCycleTask, String)

getLifeCyclePolicyById

protected Function<javax.persistence.EntityManager,Optional<LifeCyclePolicy>> getLifeCyclePolicyById(String id,
 String orgId)

Gets a life cycle policy by its ID, using the current organizational context.

Parameters:

id - the policy identifier

orgId - the organisation identifier

Returns:

the policy in an optional

getLifeCycleTaskById

protected Function<javax.persistence.EntityManager,Optional<LifeCycleTask>> getLifeCycleTaskById(String id,
 String orgId)

Gets a life cycle task by its ID, using the current organizational context.

Parameters:

id - the task identifier

orgId - the organisation identifier

Returns:

the task in an optional