Package org.opencastproject.series.impl.persistence

Class SeriesServiceDatabaseImpl

java.lang.Object

org.opencastproject.series.impl.persistence.SeriesServiceDatabaseImpl

All Implemented Interfaces:

SeriesServiceDatabase

public class SeriesServiceDatabaseImpl
extends Object
implements SeriesServiceDatabase

Implements SeriesServiceDatabase. Defines permanent storage for series.

Field Summary

Fields

Modifier and Type	Field	Description
protected org.opencastproject.db.DBSession	db
protected org.opencastproject.db.DBSessionFactory	dbSessionFactory
protected org.opencastproject.metadata.dublincore.DublinCoreCatalogService	dcService	Dublin core service for serializing and deserializing Dublin cores
protected javax.persistence.EntityManagerFactory	emf	Factory used to create EntityManagers for transactions
static final String	PERSISTENCE_UNIT	JPA persistence unit name
protected org.opencastproject.security.api.SecurityService	securityService	The security service

Constructor Summary

Constructors

Constructor	Description
SeriesServiceDatabaseImpl()

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	countSeries()
void	deleteSeries(String seriesId)	Removes series from persistent storage.
boolean	deleteSeriesElement(String seriesId, String type)	Deletes an element of a given type from a series
void	deleteSeriesProperty(String seriesId, String propertyName)	Removes the series property from persistent storage.
boolean	existsSeriesElement(String seriesId, String type)	Returns true if the series with the given identifier contains an element with the given type.
org.opencastproject.security.api.AccessControlList	getAccessControlList(String seriesId)	Retrieves ACL for series with given ID.
List<org.opencastproject.series.api.Series>	getAllForAdministrativeRead(Date from, Optional<Date> to, int limit)	Returns all series (including deleted ones!)
List<SeriesEntity>	getAllSeries()	Returns all series in persistent storage.
protected Function<javax.persistence.EntityManager,Optional<SeriesEntity>>	getPotentiallyDeletedSeriesEntity(String id)	Gets a potentially deleted series by its ID, using the current organizational context.
org.opencastproject.metadata.dublincore.DublinCoreCatalog	getSeries(String seriesId)	Gets a single series by its identifier.
Optional<byte[]>	getSeriesElement(String seriesId, String type)	Returns the data of a series element.
Optional<Map<String,byte[]>>	getSeriesElements(String seriesId)	Returns all elements of a series or an empty map if the series does not contain any elements.
protected Function<javax.persistence.EntityManager,Optional<SeriesEntity>>	getSeriesEntity(String id)	Gets a series by its ID, using the current organizational context.
Map<String,String>	getSeriesProperties(String seriesId)	Get the properties for particular series
String	getSeriesProperty(String seriesId, String propertyName)	Get a series property if it exists
void	setDBSessionFactory(org.opencastproject.db.DBSessionFactory dbSessionFactory)
void	setDublinCoreService(org.opencastproject.metadata.dublincore.DublinCoreCatalogService dcService)	OSGi callback to set dublin core catalog service.
void	setEntityManagerFactory(javax.persistence.EntityManagerFactory emf)	OSGi DI
void	setSecurityService(org.opencastproject.security.api.SecurityService securityService)	OSGi callback to set the security service.
org.opencastproject.metadata.dublincore.DublinCoreCatalog	storeSeries(org.opencastproject.metadata.dublincore.DublinCoreCatalog dc)	Store (or update) series.
boolean	storeSeriesAccessControl(String seriesId, org.opencastproject.security.api.AccessControlList accessControl)	Store access control associated with specified series.
boolean	storeSeriesElement(String seriesId, String type, byte[] data)	Adds or updates a series element in the series service database.
void	updateSeriesProperty(String seriesId, String propertyName, String propertyValue)	Updates a series' property.

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 org.opencastproject.db.DBSessionFactory dbSessionFactory

db

protected org.opencastproject.db.DBSession db

dcService

protected org.opencastproject.metadata.dublincore.DublinCoreCatalogService dcService

Dublin core service for serializing and deserializing Dublin cores

securityService

protected org.opencastproject.security.api.SecurityService securityService

The security service

Constructor Details

SeriesServiceDatabaseImpl

public SeriesServiceDatabaseImpl()

Method Details

setEntityManagerFactory

public void setEntityManagerFactory(javax.persistence.EntityManagerFactory emf)

OSGi DI

setDBSessionFactory

public void setDBSessionFactory(org.opencastproject.db.DBSessionFactory dbSessionFactory)

activate

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

Creates EntityManagerFactory using persistence provider and properties passed via OSGi.

Parameters:

cc -

setSecurityService

public void setSecurityService(org.opencastproject.security.api.SecurityService securityService)

OSGi callback to set the security service.

Parameters:

securityService - the securityService to set

setDublinCoreService

public void setDublinCoreService(org.opencastproject.metadata.dublincore.DublinCoreCatalogService dcService)

OSGi callback to set dublin core catalog service.

Parameters:

dcService - DublinCoreCatalogService object

deleteSeries

public void deleteSeries(String seriesId)
                  throws SeriesServiceDatabaseException,
org.opencastproject.util.NotFoundException

Description copied from interface: SeriesServiceDatabase

Removes series from persistent storage.

Specified by:

deleteSeries in interface SeriesServiceDatabase

Parameters:

seriesId - ID of the series to be removed

Throws:

SeriesServiceDatabaseException - if exception occurs

org.opencastproject.util.NotFoundException - if series with specified ID is not found

deleteSeriesProperty

public void deleteSeriesProperty(String seriesId,
 String propertyName)
                          throws SeriesServiceDatabaseException,
org.opencastproject.util.NotFoundException

Description copied from interface: SeriesServiceDatabase

Removes the series property from persistent storage.

Specified by:

deleteSeriesProperty in interface SeriesServiceDatabase

Parameters:

seriesId - ID of the series to be removed.

propertyName - The unique name of the property to delete.

Throws:

SeriesServiceDatabaseException - if exception occurs

org.opencastproject.util.NotFoundException - if series with specified ID is not found or if there is no property with the property name

getAllSeries

public List<SeriesEntity> getAllSeries()
                                throws SeriesServiceDatabaseException

Description copied from interface: SeriesServiceDatabase

Returns all series in persistent storage.

Specified by:

getAllSeries in interface SeriesServiceDatabase

Returns:

Tuple array representing stored series

Throws:

SeriesServiceDatabaseException - if exception occurs

getAccessControlList

public org.opencastproject.security.api.AccessControlList getAccessControlList(String seriesId)
                                                                        throws org.opencastproject.util.NotFoundException,
SeriesServiceDatabaseException

Description copied from interface: SeriesServiceDatabase

Retrieves ACL for series with given ID.

Specified by:

getAccessControlList in interface SeriesServiceDatabase

Parameters:

seriesId - series for which ACL will be retrieved

Returns:

AccessControlList of series or null if series does not have ACL associated with it

Throws:

org.opencastproject.util.NotFoundException - if series with given ID does not exist

SeriesServiceDatabaseException - if exception occurred

storeSeries

public org.opencastproject.metadata.dublincore.DublinCoreCatalog storeSeries(org.opencastproject.metadata.dublincore.DublinCoreCatalog dc)
                                                                      throws SeriesServiceDatabaseException,
org.opencastproject.security.api.UnauthorizedException

Description copied from interface: SeriesServiceDatabase

Store (or update) series.

Specified by:

storeSeries in interface SeriesServiceDatabase

Parameters:

dc - DublinCoreCatalog representing series

Returns:

Dublin Core catalog representing newly created series or null if series Dublin Core was updated

Throws:

SeriesServiceDatabaseException - if exception occurs

org.opencastproject.security.api.UnauthorizedException - if the current user is not authorized to perform this action

getSeries

public org.opencastproject.metadata.dublincore.DublinCoreCatalog getSeries(String seriesId)
                                                                    throws org.opencastproject.util.NotFoundException,
SeriesServiceDatabaseException

Gets a single series by its identifier.

Specified by:

getSeries in interface SeriesServiceDatabase

Parameters:

seriesId - the series identifier

Returns:

the dublin core catalog for this series

Throws:

org.opencastproject.util.NotFoundException - if there is no series with this identifier

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

See Also:

• SeriesServiceDatabase.getSeries(java.lang.String)

getAllForAdministrativeRead

public List<org.opencastproject.series.api.Series> getAllForAdministrativeRead(Date from,
 Optional<Date> to,
 int limit)
                                                                        throws SeriesServiceDatabaseException,
org.opencastproject.security.api.UnauthorizedException

Description copied from interface: SeriesServiceDatabase

Returns all series (including deleted ones!) that have been modified in the given date range from (inclusive) -- to (exclusive). At most limit many series are returned. ACLs/permissions are NOT checked as this is only intended to be used in an administrative context.

Specified by:

getAllForAdministrativeRead in interface SeriesServiceDatabase

Throws:

SeriesServiceDatabaseException

org.opencastproject.security.api.UnauthorizedException

getSeriesProperties

public Map<String,String> getSeriesProperties(String seriesId)
                                       throws org.opencastproject.util.NotFoundException,
SeriesServiceDatabaseException

Get the properties for particular series

Specified by:

getSeriesProperties in interface SeriesServiceDatabase

Parameters:

seriesId - The unique series id to retrieve the properties for.

Returns:

A Map of the properties names and values.

Throws:

org.opencastproject.util.NotFoundException - Thrown if the series can't be found.

SeriesServiceDatabaseException - If exception occurred

See Also:

• SeriesServiceDatabase.getSeriesProperties(java.lang.String)

getSeriesProperty

public String getSeriesProperty(String seriesId,
 String propertyName)
                         throws org.opencastproject.util.NotFoundException,
SeriesServiceDatabaseException

Get a series property if it exists

Specified by:

getSeriesProperty in interface SeriesServiceDatabase

Parameters:

seriesId - The id used to get the series.

propertyName - The unique name for the property.

Returns:

The property value

Throws:

org.opencastproject.util.NotFoundException - Thrown if the series or the property doesn't exist.

SeriesServiceDatabaseException - Thrown for all other Exceptions.

See Also:

• SeriesServiceDatabase.getSeriesProperty(java.lang.String, java.lang.String)

storeSeriesAccessControl

public boolean storeSeriesAccessControl(String seriesId,
 org.opencastproject.security.api.AccessControlList accessControl)
                                 throws org.opencastproject.util.NotFoundException,
SeriesServiceDatabaseException

Description copied from interface: SeriesServiceDatabase

Store access control associated with specified series. IllegalArgumentException is thrown if accessControl parameter is null.

Specified by:

storeSeriesAccessControl in interface SeriesServiceDatabase

Parameters:

seriesId - ID of series to associate access control with

accessControl - AccessControlList representing access control rules for specified series

Returns:

true if update happened, false if there was no previous entry

Throws:

org.opencastproject.util.NotFoundException - if series with specified ID does not exist

SeriesServiceDatabaseException - if exception occurred

countSeries

public int countSeries()
                throws SeriesServiceDatabaseException

Specified by:

countSeries in interface SeriesServiceDatabase

Throws:

SeriesServiceDatabaseException

updateSeriesProperty

public void updateSeriesProperty(String seriesId,
 String propertyName,
 String propertyValue)
                          throws org.opencastproject.util.NotFoundException,
SeriesServiceDatabaseException

Description copied from interface: SeriesServiceDatabase

Updates a series' property.

Specified by:

updateSeriesProperty in interface SeriesServiceDatabase

Parameters:

seriesId - The id of the series to add or update the property for.

propertyName - A unique name for the property.

propertyValue - The value for the property.

Throws:

org.opencastproject.util.NotFoundException - Thrown if the series cannot be found.

SeriesServiceDatabaseException - Thrown if another exception occurred

getSeriesEntity

protected Function<javax.persistence.EntityManager,Optional<SeriesEntity>> getSeriesEntity(String id)

Gets a series by its ID, using the current organizational context.

Parameters:

id - the series identifier

Returns:

the series entity, or null if not found or if the series is deleted.

getPotentiallyDeletedSeriesEntity

protected Function<javax.persistence.EntityManager,Optional<SeriesEntity>> getPotentiallyDeletedSeriesEntity(String id)

Gets a potentially deleted series by its ID, using the current organizational context.

Parameters:

id - the series identifier

Returns:

the series entity, or null if not found

storeSeriesElement

public boolean storeSeriesElement(String seriesId,
 String type,
 byte[] data)
                           throws SeriesServiceDatabaseException

Description copied from interface: SeriesServiceDatabase

Adds or updates a series element in the series service database.

Specified by:

storeSeriesElement in interface SeriesServiceDatabase

Parameters:

seriesId - the series identifier

type - the element type

data - the element data

Returns:

true if the element could be added/updated; false if no such series exists

Throws:

SeriesServiceDatabaseException - if an error occurs while saving the element in the database

deleteSeriesElement

public boolean deleteSeriesElement(String seriesId,
 String type)
                            throws SeriesServiceDatabaseException

Description copied from interface: SeriesServiceDatabase

Deletes an element of a given type from a series

Specified by:

deleteSeriesElement in interface SeriesServiceDatabase

Parameters:

seriesId - the series identifier

type - the element type

Returns:

true if the element could be deleted; false if no such series/element exists

Throws:

SeriesServiceDatabaseException - if an error occurs while removing the element from the database

getSeriesElement

public Optional<byte[]> getSeriesElement(String seriesId,
 String type)
                                  throws SeriesServiceDatabaseException

Description copied from interface: SeriesServiceDatabase

Returns the data of a series element.

Specified by:

getSeriesElement in interface SeriesServiceDatabase

Parameters:

seriesId - the series identifier

type - the element type

Returns:

the element data or Opt.none() if no such series/element exists

Throws:

SeriesServiceDatabaseException - if an error occurs while retrieving the element from the database

getSeriesElements

public Optional<Map<String,byte[]>> getSeriesElements(String seriesId)
                                               throws SeriesServiceDatabaseException

Description copied from interface: SeriesServiceDatabase

Returns all elements of a series or an empty map if the series does not contain any elements. The key of the map marks the element type.

Specified by:

getSeriesElements in interface SeriesServiceDatabase

Parameters:

seriesId - the series identifier

Returns:

a map of series elements or Opt.none() if no such series exists

Throws:

SeriesServiceDatabaseException - if an error occurs while retrieving the element from the database

existsSeriesElement

public boolean existsSeriesElement(String seriesId,
 String type)
                            throws SeriesServiceDatabaseException

Description copied from interface: SeriesServiceDatabase

Returns true if the series with the given identifier contains an element with the given type.

Specified by:

existsSeriesElement in interface SeriesServiceDatabase

Parameters:

seriesId - the series identifier

type - the element type

Returns:

true, if the element exits; false otherwise

Throws:

SeriesServiceDatabaseException - if there was an error while checking if the element exits