Package org.opencastproject.lifecyclemanagement.impl

Class LifeCycleServiceImpl

java.lang.Object

org.opencastproject.lifecyclemanagement.impl.LifeCycleServiceImpl

All Implemented Interfaces:

LifeCycleService

public class LifeCycleServiceImpl
extends Object
implements LifeCycleService

Field Summary

Fields

Modifier and Type	Field	Description
protected AuthorizationService	authorizationService	The authorization service
protected ElasticsearchIndex	index
protected IndexService	indexService
protected LifeCycleDatabaseService	persistence	Persistent storage
protected SecurityService	securityService	The security service

Constructor Summary

Constructors

Constructor	Description
LifeCycleServiceImpl()

Method Summary

Modifier and Type	Method	Description
void	activate(org.osgi.service.component.ComponentContext cc)
boolean	checkValidity(LifeCyclePolicy policy)	Checks if the given policy has all required fields filled in
LifeCyclePolicy	createLifeCyclePolicy(LifeCyclePolicy policy)	Creates a single life cycle policy in the database.
LifeCycleTask	createLifeCycleTask(LifeCycleTask task)	Creates a new life cycle task in the database
void	deleteAllLifeCyclePoliciesCreatedByConfig(String orgId)	Delete all policies created from configuration files from the database.
boolean	deleteLifeCyclePolicy(String id)	Deletes a life cycle policy from the database
boolean	deleteLifeCycleTask(String id)	Deletes a life cycle task from the database
List<Event>	filterForEvents(Map<String,Map<String,EventSearchQueryField<String>>> filters)	Get a list of *all* events based on a set of filters.
List<Event>	filterForEvents(Map<String,Map<String,EventSearchQueryField<String>>> filters, int limit, int offset)	Get a list of events based on a set of filters.
List<LifeCyclePolicy>	getActiveLifeCyclePolicies()	Get currently active life cycle policies
List<LifeCyclePolicy>	getLifeCyclePolicies(int limit, int offset, SortCriterion sortCriterion)	Get multiple life cycle policies from the database
long	getLifeCyclePoliciesTotal()	Get the total number of policies
LifeCyclePolicy	getLifeCyclePolicyById(String id)	Returns a life cycle policy from the database by its id
LifeCyclePolicy	getLifeCyclePolicyById(String id, String orgId)	Returns a life cycle policy from the database by its id
LifeCycleTask	getLifeCycleTaskById(String id)	Returns a life cycle task from the database by its id
LifeCycleTask	getLifeCycleTaskByTargetId(String targetId)	Returns a life cycle task from the database by its target identifier
List<LifeCycleTask>	getLifeCycleTasksWithStatus(Status status)	Get multiple life cycle tasks based on their status
void	setAuthorizationService(AuthorizationService authorizationService)
void	setElasticSearchIndex(ElasticsearchIndex index)
void	setIndexService(IndexService indexService)
void	setPersistence(LifeCycleDatabaseService persistence)
void	setSecurityService(SecurityService securityService)
boolean	updateLifeCyclePolicy(LifeCyclePolicy policy)	Updates a single life cycle policy in the database.
boolean	updateLifeCycleTask(LifeCycleTask task)	Updates a life cycle task

Methods inherited from class java.lang.Object

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

Field Details

persistence

protected LifeCycleDatabaseService persistence

Persistent storage

securityService

protected SecurityService securityService

The security service

authorizationService

protected AuthorizationService authorizationService

The authorization service

index

protected ElasticsearchIndex index

indexService

protected IndexService indexService

Constructor Details

LifeCycleServiceImpl

public LifeCycleServiceImpl()

Method Details

setPersistence

public void setPersistence(LifeCycleDatabaseService persistence)

setSecurityService

public void setSecurityService(SecurityService securityService)

setAuthorizationService

public void setAuthorizationService(AuthorizationService authorizationService)

setElasticSearchIndex

public void setElasticSearchIndex(ElasticsearchIndex index)

setIndexService

public void setIndexService(IndexService indexService)

activate

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

Throws:

Exception

getLifeCyclePolicyById

public LifeCyclePolicy getLifeCyclePolicyById(String id)
                                       throws NotFoundException,
LifeCycleServiceException,
UnauthorizedException

Returns a life cycle policy from the database by its id

Specified by:

getLifeCyclePolicyById in interface LifeCycleService

Parameters:

id - life cycle policy id

Returns:

The LifeCyclePolicy belonging to the id

Throws:

NotFoundException - If no life cycle policy with the given id could be found

LifeCycleServiceException - If something went wrong in the database service

UnauthorizedException - If the user does not have read access for the life cycle policy

See Also:

• LifeCycleService.getLifeCyclePolicyById(String)

getLifeCyclePolicyById

public LifeCyclePolicy getLifeCyclePolicyById(String id,
 String orgId)
                                       throws NotFoundException,
LifeCycleServiceException,
UnauthorizedException

Returns a life cycle policy from the database by its id

Specified by:

getLifeCyclePolicyById in interface LifeCycleService

Parameters:

id - life cycle policy id

orgId - life cycle policy organization

Returns:

The LifeCyclePolicy belonging to the id

Throws:

NotFoundException - If no life cycle policy with the given id could be found

LifeCycleServiceException - If something went wrong in the database service

UnauthorizedException - If the user does not have read access for the life cycle policy

See Also:

• LifeCycleService.getLifeCyclePolicyById(String)

getLifeCyclePoliciesTotal

public long getLifeCyclePoliciesTotal()
                               throws LifeCycleServiceException

Get the total number of policies

Specified by:

getLifeCyclePoliciesTotal in interface LifeCycleService

Returns:

the total number of policies

Throws:

LifeCycleServiceException - If something went wrong in the database service

See Also:

• LifeCycleService.getLifeCyclePoliciesTotal()

getLifeCyclePolicies

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

Get multiple life cycle policies from the database

Specified by:

getLifeCyclePolicies in interface LifeCycleService

Parameters:

limit - The maximum amount of life cycle policies to get with one request.

offset - The index of the first result to return.

sortCriterion - In what manner results should be sorted

Returns:

A list of LifeCyclePolicys

Throws:

LifeCycleServiceException - If something went wrong in the database service

See Also:

• LifeCycleService.getLifeCyclePolicies(int, int, SortCriterion)

getActiveLifeCyclePolicies

public List<LifeCyclePolicy> getActiveLifeCyclePolicies()
                                                 throws LifeCycleServiceException

Get currently active life cycle policies

Specified by:

getActiveLifeCyclePolicies in interface LifeCycleService

Returns:

A list of LifeCyclePolicys

Throws:

LifeCycleServiceException - If something went wrong in the database service

See Also:

• LifeCycleService.getActiveLifeCyclePolicies()

createLifeCyclePolicy

public LifeCyclePolicy createLifeCyclePolicy(LifeCyclePolicy policy)
                                      throws LifeCycleServiceException,
UnauthorizedException

Creates a single life cycle policy in the database.

Specified by:

createLifeCyclePolicy in interface LifeCycleService

Parameters:

policy - The LifeCyclePolicy to create

Returns:

The created LifeCyclePolicy

Throws:

LifeCycleServiceException - If something went wrong in the database service

UnauthorizedException - If the user does not have write access for an existing life cycle policy

See Also:

• LifeCycleService.createLifeCyclePolicy(LifeCyclePolicy)

updateLifeCyclePolicy

public boolean updateLifeCyclePolicy(LifeCyclePolicy policy)
                              throws NotFoundException,
LifeCycleServiceException,
UnauthorizedException,
IllegalArgumentException

Updates a single life cycle policy in the database.

Specified by:

updateLifeCyclePolicy in interface LifeCycleService

Parameters:

policy - The LifeCyclePolicy to create or update with

Returns:

The updated LifeCyclePolicy

Throws:

NotFoundException - If no life cycle policy with the given id could be found

LifeCycleServiceException - If something went wrong in the database service

UnauthorizedException - If the user does not have write access for an existing life cycle policy

IllegalArgumentException

See Also:

• LifeCycleService.updateLifeCyclePolicy(LifeCyclePolicy)

deleteLifeCyclePolicy

public boolean deleteLifeCyclePolicy(String id)
                              throws NotFoundException,
LifeCycleServiceException,
UnauthorizedException

Deletes a life cycle policy from the database

Specified by:

deleteLifeCyclePolicy in interface LifeCycleService

Parameters:

id - The life cycle policy identifier

Returns:

The removed LifeCyclePolicy

Throws:

NotFoundException - If no life cycle policy with the given id could be found

LifeCycleServiceException - If something went wrong in the database service

UnauthorizedException - If the user does not have write access for the life cycle policy

See Also:

• LifeCycleService.deleteLifeCyclePolicy(String)

deleteAllLifeCyclePoliciesCreatedByConfig

public void deleteAllLifeCyclePoliciesCreatedByConfig(String orgId)
                                               throws LifeCycleServiceException

Delete all policies created from configuration files from the database. Only to be called as admin from the policy scanner.

Specified by:

deleteAllLifeCyclePoliciesCreatedByConfig in interface LifeCycleService

Parameters:

orgId -

Throws:

LifeCycleServiceException - If something went wrong in the database service

See Also:

• LifeCycleService.deleteLifeCyclePolicy(String)

getLifeCycleTaskById

public LifeCycleTask getLifeCycleTaskById(String id)
                                   throws NotFoundException,
LifeCycleServiceException

Returns a life cycle task from the database by its id

Specified by:

getLifeCycleTaskById in interface LifeCycleService

Parameters:

id - life cycle task id

Returns:

The LifeCyclePolicy belonging to the id

Throws:

NotFoundException - If no life cycle task with the given id could be found

LifeCycleServiceException - If something went wrong in the database service

See Also:

• LifeCycleService.getLifeCycleTaskById(String)

getLifeCycleTaskByTargetId

public LifeCycleTask getLifeCycleTaskByTargetId(String targetId)
                                         throws NotFoundException,
LifeCycleServiceException

Returns a life cycle task from the database by its target identifier

Specified by:

getLifeCycleTaskByTargetId in interface LifeCycleService

Parameters:

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

Returns:

The LifeCyclePolicy belonging to the id

Throws:

NotFoundException - If no life cycle task with the given id could be found

LifeCycleServiceException - If something went wrong in the database service

See Also:

• LifeCycleService.getLifeCycleTaskByTargetId(String)

getLifeCycleTasksWithStatus

public List<LifeCycleTask> getLifeCycleTasksWithStatus(Status status)
                                                throws LifeCycleServiceException

Get multiple life cycle tasks based on their status

Specified by:

getLifeCycleTasksWithStatus in interface LifeCycleService

Parameters:

status - The state the tasks should be in

Returns:

A list of LifeCycleTasks

Throws:

LifeCycleServiceException - If something went wrong in the database service

See Also:

• LifeCycleService.getLifeCycleTasksWithStatus(Status)

createLifeCycleTask

public LifeCycleTask createLifeCycleTask(LifeCycleTask task)
                                  throws LifeCycleServiceException

Creates a new life cycle task in the database

Specified by:

createLifeCycleTask in interface LifeCycleService

Parameters:

task - The LifeCycleTask to create

Returns:

The created LifeCycleTask

Throws:

LifeCycleServiceException - If something went wrong in the database service

See Also:

• LifeCycleService.createLifeCycleTask(LifeCycleTask)

updateLifeCycleTask

public boolean updateLifeCycleTask(LifeCycleTask task)
                            throws NotFoundException,
LifeCycleServiceException,
IllegalArgumentException

Updates a life cycle task

Specified by:

updateLifeCycleTask in interface LifeCycleService

Parameters:

task - The LifeCycleTask to create or update with

Returns:

The updated LifeCycleTask

Throws:

NotFoundException - If no life cycle task with the given id could be found

LifeCycleServiceException - If something went wrong in the database service

IllegalArgumentException

See Also:

• LifeCycleService.updateLifeCycleTask(LifeCycleTask)

deleteLifeCycleTask

public boolean deleteLifeCycleTask(String id)
                            throws NotFoundException,
LifeCycleServiceException

Deletes a life cycle task from the database

Specified by:

deleteLifeCycleTask in interface LifeCycleService

Parameters:

id - The life cycle task identifier

Returns:

The removed LifeCycleTask

Throws:

NotFoundException - If no life cycle task with the given id could be found

LifeCycleServiceException - If something went wrong in the database service

See Also:

• LifeCycleService.deleteLifeCycleTask(String)

checkValidity

public boolean checkValidity(LifeCyclePolicy policy)

Checks if the given policy has all required fields filled in

Specified by:

checkValidity in interface LifeCycleService

Parameters:

policy - The lifecycle policy to be checked

Returns:

True if the policy fulfills the criteria set by the function, else false

See Also:

• LifeCycleService.checkValidity(LifeCyclePolicy)

filterForEvents

public List<Event> filterForEvents(Map<String,Map<String,EventSearchQueryField<String>>> filters,
 int limit,
 int offset)
                            throws SearchIndexException,
NotFoundException

Get a list of events based on a set of filters. Currently only runs on metadata. Events are returned from the index.

Specified by:

filterForEvents in interface LifeCycleService

Parameters:

filters - Key value pairs that the events must match.

Returns:

The list of events

Throws:

SearchIndexException - If something went wrong in the index service

NotFoundException - If a targetFilters object contains a metadata catalog flavor unknown to Opencast

See Also:

• LifeCycleService.filterForEvents(Map, int, int)

filterForEvents

public List<Event> filterForEvents(Map<String,Map<String,EventSearchQueryField<String>>> filters)
                            throws SearchIndexException,
NotFoundException

Get a list of *all* events based on a set of filters. Currently only runs on metadata. Events are returned from the index.

Specified by:

filterForEvents in interface LifeCycleService

Parameters:

filters - Key value pairs that the events must match.

Returns:

The list of all matching events

Throws:

SearchIndexException - If something went wrong in the index service

NotFoundException - If a targetFilters object contains a metadata catalog flavor unknown to Opencast

See Also:

• LifeCycleService.filterForEvents(Map)