Package org.opencastproject.search.impl.persistence

Class SearchServiceDatabaseImpl

java.lang.Object

org.opencastproject.search.impl.persistence.SearchServiceDatabaseImpl

All Implemented Interfaces:

SearchServiceDatabase

public class SearchServiceDatabaseImpl
extends Object
implements SearchServiceDatabase

Implements SearchServiceDatabase. 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 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
SearchServiceDatabaseImpl()

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 mediapackages in persistent storage, including deleted entries.
void	deleteMediaPackage(String mediaPackageId, Date deletionDate)	Removes media package from persistent storage.
org.opencastproject.security.api.AccessControlList	getAccessControlList(String mediaPackageId)	Retrieves ACL for episode with given ID.
Collection<org.apache.commons.lang3.tuple.Pair<String,org.opencastproject.security.api.AccessControlList>>	getAccessControlLists(String seriesId, String... excludeIds)	Retrieves ACLs for series with given ID.
Stream<org.opencastproject.util.data.Tuple<org.opencastproject.mediapackage.MediaPackage,String>>	getAllMediaPackages(int pagesize, int offset)	Returns all search entries in persistent storage.
Date	getDeletionDate(String mediaPackageId)	Returns the deletion date from the selected media package.
org.opencastproject.mediapackage.MediaPackage	getMediaPackage(String mediaPackageId)	Gets a single media package by its identifier.
Date	getModificationDate(String mediaPackageId)	Returns the modification date from the selected media package.
String	getOrganizationId(String mediaPackageId)	Returns the organization id of the selected media package
Collection<org.apache.commons.lang3.tuple.Pair<org.opencastproject.security.api.Organization,org.opencastproject.mediapackage.MediaPackage>>	getSeries(String seriesId)	Gets media packages from a specific series
boolean	isAvailable(String mediaPackageId)	Checks if a mediapackage is available.
void	setDBSessionFactory(org.opencastproject.db.DBSessionFactory dbSessionFactory)
void	setEntityManagerFactory(javax.persistence.EntityManagerFactory emf)	OSGi DI
void	setSecurityService(org.opencastproject.security.api.SecurityService securityService)	OSGi callback to set the security service.
void	storeMediaPackage(org.opencastproject.mediapackage.MediaPackage mediaPackage, org.opencastproject.security.api.AccessControlList acl, Date now)	Store (or update) media package.

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

securityService

protected org.opencastproject.security.api.SecurityService securityService

The security service

Constructor Details

SearchServiceDatabaseImpl

public SearchServiceDatabaseImpl()

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)
              throws SearchServiceDatabaseException

Creates EntityManagerFactory using persistence provider and properties passed via OSGi.

Parameters:

cc -

Throws:

SearchServiceDatabaseException

setSecurityService

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

OSGi callback to set the security service.

Parameters:

securityService - the securityService to set

deleteMediaPackage

public void deleteMediaPackage(String mediaPackageId,
 Date deletionDate)
                        throws SearchServiceDatabaseException,
org.opencastproject.util.NotFoundException,
org.opencastproject.security.api.UnauthorizedException

Removes media package from persistent storage.

Specified by:

deleteMediaPackage in interface SearchServiceDatabase

Parameters:

mediaPackageId - id of the media package to be removed

deletionDate - the deletion date to set

Throws:

SearchServiceDatabaseException - if exception occurs

org.opencastproject.util.NotFoundException - if media package with specified id is not found

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

See Also:

• SearchServiceDatabase.deleteMediaPackage(String, Date)

countMediaPackages

public int countMediaPackages()
                       throws SearchServiceDatabaseException

Returns the number of mediapackages in persistent storage, including deleted entries.

Specified by:

countMediaPackages in interface SearchServiceDatabase

Returns:

the number of mediapackages in storage

Throws:

SearchServiceDatabaseException - if an error occurs

See Also:

• SearchServiceDatabase.countMediaPackages()

getAllMediaPackages

public Stream<org.opencastproject.util.data.Tuple<org.opencastproject.mediapackage.MediaPackage,String>> getAllMediaPackages(int pagesize,
 int offset)
                                                                                                                      throws SearchServiceDatabaseException

Returns all search entries in persistent storage.

Specified by:

getAllMediaPackages in interface SearchServiceDatabase

Parameters:

pagesize - the number of results to get from the database at once

offset - the offset into the full result list to fetch

Returns:

Tuple array of mediapackage-orgid pairs representing stored media packages

Throws:

SearchServiceDatabaseException - if exception occurs

See Also:

• SearchServiceDatabase.getAllMediaPackages(int, int)

getAccessControlList

public org.opencastproject.security.api.AccessControlList getAccessControlList(String mediaPackageId)
                                                                        throws org.opencastproject.util.NotFoundException,
SearchServiceDatabaseException

Retrieves ACL for episode with given ID.

Specified by:

getAccessControlList in interface SearchServiceDatabase

Parameters:

mediaPackageId - media package for which ACL will be retrieved

Returns:

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

Throws:

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

SearchServiceDatabaseException - if exception occurred

See Also:

• SearchServiceDatabase.getAccessControlList(String)

getAccessControlLists

public Collection<org.apache.commons.lang3.tuple.Pair<String,org.opencastproject.security.api.AccessControlList>> getAccessControlLists(String seriesId,
 String... excludeIds)
                                                                                                                                 throws SearchServiceDatabaseException

Retrieves ACLs for series with given ID.

Specified by:

getAccessControlLists in interface SearchServiceDatabase

Parameters:

seriesId - series identifier for which ACL will be retrieved

excludeIds - list of media package identifier to exclude from the list

Returns:

Collection of pairs of media package id and its AccessControlList of media packages from the series

Throws:

SearchServiceDatabaseException - if exception occurred

See Also:

• SearchServiceDatabase.getAccessControlLists(String, String...)

getSeries

public Collection<org.apache.commons.lang3.tuple.Pair<org.opencastproject.security.api.Organization,org.opencastproject.mediapackage.MediaPackage>> getSeries(String seriesId)
                                                                                                                                                       throws SearchServiceDatabaseException

Gets media packages from a specific series

Specified by:

getSeries in interface SearchServiceDatabase

Parameters:

seriesId - the series identifier

Returns:

collection of media packages

Throws:

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

See Also:

• SearchServiceDatabase.getSeries(String)

storeMediaPackage

public void storeMediaPackage(org.opencastproject.mediapackage.MediaPackage mediaPackage,
 org.opencastproject.security.api.AccessControlList acl,
 Date now)
                       throws SearchServiceDatabaseException,
org.opencastproject.security.api.UnauthorizedException

Store (or update) media package.

Specified by:

storeMediaPackage in interface SearchServiceDatabase

Parameters:

mediaPackage - MediaPackage to store

acl - the acl of the media package

now - the store date

Throws:

SearchServiceDatabaseException - if exception occurs

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

See Also:

• SearchServiceDatabase.storeMediaPackage(MediaPackage, AccessControlList, Date)

getMediaPackage

public org.opencastproject.mediapackage.MediaPackage getMediaPackage(String mediaPackageId)
                                                              throws org.opencastproject.util.NotFoundException,
SearchServiceDatabaseException,
org.opencastproject.security.api.UnauthorizedException

Gets a single media package by its identifier.

Specified by:

getMediaPackage in interface SearchServiceDatabase

Parameters:

mediaPackageId - the media package identifier

Returns:

the media package

Throws:

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

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

org.opencastproject.security.api.UnauthorizedException

See Also:

• SearchServiceDatabase.getMediaPackage(String)

getModificationDate

public Date getModificationDate(String mediaPackageId)
                         throws org.opencastproject.util.NotFoundException,
SearchServiceDatabaseException

Returns the modification date from the selected media package.

Specified by:

getModificationDate in interface SearchServiceDatabase

Parameters:

mediaPackageId - the media package id to select

Returns:

the modification date

Throws:

org.opencastproject.util.NotFoundException - if media package with specified id and version does not exist

SearchServiceDatabaseException - if an error occurs

See Also:

• SearchServiceDatabase.getModificationDate(String)

getDeletionDate

public Date getDeletionDate(String mediaPackageId)
                     throws org.opencastproject.util.NotFoundException,
SearchServiceDatabaseException

Returns the deletion date from the selected media package.

Specified by:

getDeletionDate in interface SearchServiceDatabase

Parameters:

mediaPackageId - the media package id to select

Returns:

the deletion date

Throws:

org.opencastproject.util.NotFoundException - if media package with specified id does not exist

SearchServiceDatabaseException - if an error occurs

See Also:

• SearchServiceDatabase.getDeletionDate(String)

isAvailable

public boolean isAvailable(String mediaPackageId)
                    throws SearchServiceDatabaseException

Checks if a mediapackage is available.

Specified by:

isAvailable in interface SearchServiceDatabase

Parameters:

mediaPackageId - The ID of the MediaPackage for which the availability is to be checked

Returns:

True if two conditions are met: The mediapackage exists in the database and the deletion date is not set

Throws:

SearchServiceDatabaseException - if an exception occurs

See Also:

• SearchServiceDatabase.isAvailable(String)

getOrganizationId

public String getOrganizationId(String mediaPackageId)
                         throws org.opencastproject.util.NotFoundException,
SearchServiceDatabaseException

Returns the organization id of the selected media package

Specified by:

getOrganizationId in interface SearchServiceDatabase

Parameters:

mediaPackageId - the media package id to select

Returns:

the organization id

Throws:

org.opencastproject.util.NotFoundException - if media package with specified id and version does not exist

SearchServiceDatabaseException - if an error occurs

See Also:

• SearchServiceDatabase.getOrganizationId(String)