Package org.opencastproject.series.impl

Class SeriesServiceImpl

java.lang.Object

org.opencastproject.elasticsearch.index.rebuild.AbstractIndexProducer

org.opencastproject.series.impl.SeriesServiceImpl

All Implemented Interfaces:

IndexProducer, SeriesService

public class SeriesServiceImpl
extends AbstractIndexProducer
implements SeriesService

Implements SeriesService. Uses SeriesServiceDatabase for permanent storage and ElasticsearchIndex for searching.

Field Summary

Fields

Modifier and Type	Field	Description
protected OrganizationDirectoryService	orgDirectory	The organization directory
protected SeriesServiceDatabase	persistence	Persistent storage
protected SecurityService	securityService	The security service

Fields inherited from interface org.opencastproject.series.api.SeriesService

JOB_TYPE

Constructor Summary

Constructors

Constructor	Description
SeriesServiceImpl()

Method Summary

Modifier and Type	Method	Description
void	activate(org.osgi.service.component.ComponentContext cc)	Activates Series Service.
void	addMessageHandler(SeriesUpdateHandler handler)	OSGi callbacks for settings and removing handlers.
void	deleteSeries(String seriesID)	Removes series
boolean	deleteSeriesElement(String seriesId, String type)	Deletes an element from a series.
void	deleteSeriesProperty(String seriesID, String propertyName)
static boolean	equals(DublinCoreCatalog a, DublinCoreCatalog b)	Define equality on DublinCoreCatalogs.
static boolean	equals(AccessControlList a, AccessControlList b)	Define equality on AccessControlLists.
List<Series>	getAllForAdministrativeRead(Date from, Optional<Date> to, int limit)	Returns all series (including deleted ones!)
DublinCoreCatalog	getSeries(String seriesID)	Returns Dublin core representing series by series ID.
AccessControlList	getSeriesAccessControl(String seriesID)	Returns access control rules for series with given ID.
int	getSeriesCount()
Optional<byte[]>	getSeriesElementData(String seriesId, String type)	Returns the element data of the series with the given type.
Optional<Map<String,byte[]>>	getSeriesElements(String seriesId)	Returns all the elements of a series in a map.
Map<String,String>	getSeriesProperties(String seriesID)	Returns the properties for a series.
String	getSeriesProperty(String seriesID, String propertyName)	Get a series property.
IndexRebuildService.Service	getService()	Get the service that implements IndexProducer.
void	removeMessageHandler(SeriesUpdateHandler handler)
void	repopulate(IndexRebuildService.DataType type)	Re-add the data of this service to the index.
void	setAclServiceFactory(AclServiceFactory aclServiceFactory)
void	setElasticsearchIndex(ElasticsearchIndex index)	OSGi callbacks for setting the Elasticsearch index.
void	setOrgDirectory(OrganizationDirectoryService orgDirectory)	OSGi callback for setting the organization directory service.
void	setPersistence(SeriesServiceDatabase persistence)	OSGi callback for setting persistance.
void	setSecurityService(SecurityService securityService)	OSGi callback for setting the security service.
boolean	updateAccessControl(String seriesId, AccessControlList accessControl)	Updates access control rules for specified series.
boolean	updateAccessControl(String seriesId, AccessControlList accessControl, boolean overrideEpisodeAcl)	Updates access control rules for specified series.
boolean	updateExtendedMetadata(String seriesId, String type, DublinCoreCatalog dc)	Updates the extended metadata of a series from a Dublin Core catalog.
DublinCoreCatalog	updateSeries(DublinCoreCatalog dc)	Adds or updates series.
boolean	updateSeriesElement(String seriesId, String type, byte[] data)	Creates or updates an element of a series.
void	updateSeriesProperty(String seriesID, String propertyName, String propertyValue)	Update a series property or create a new one if it doesn't exist.

Methods inherited from class org.opencastproject.elasticsearch.index.rebuild.AbstractIndexProducer

logIndexRebuildBegin, logIndexRebuildBegin, logIndexRebuildError, logIndexRebuildError, logIndexRebuildError, logIndexRebuildProgress, logIndexRebuildProgress, logIndexRebuildProgress, logIndexRebuildProgress, logSkippingElement, logSkippingElement

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opencastproject.elasticsearch.index.rebuild.IndexProducer

dataTypeSupported, getSupportedDataTypes

Field Details

persistence

protected SeriesServiceDatabase persistence

Persistent storage

securityService

protected SecurityService securityService

The security service

orgDirectory

protected OrganizationDirectoryService orgDirectory

The organization directory

Constructor Details

SeriesServiceImpl

public SeriesServiceImpl()

Method Details

setPersistence

public void setPersistence(SeriesServiceDatabase persistence)

OSGi callback for setting persistance.

setSecurityService

public void setSecurityService(SecurityService securityService)

OSGi callback for setting the security service.

setOrgDirectory

public void setOrgDirectory(OrganizationDirectoryService orgDirectory)

OSGi callback for setting the organization directory service.

addMessageHandler

public void addMessageHandler(SeriesUpdateHandler handler)

OSGi callbacks for settings and removing handlers.

removeMessageHandler

public void removeMessageHandler(SeriesUpdateHandler handler)

setElasticsearchIndex

public void setElasticsearchIndex(ElasticsearchIndex index)

OSGi callbacks for setting the Elasticsearch index.

setAclServiceFactory

public void setAclServiceFactory(AclServiceFactory aclServiceFactory)

activate

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

Activates Series Service. Checks whether we are using synchronous or asynchronous indexing. If asynchronous is used, Executor service is set. If index is empty, persistent storage is queried if it contains any series. If that is the case, series are retrieved and indexed.

Throws:

Exception

updateSeries

public DublinCoreCatalog updateSeries(DublinCoreCatalog dc)
                               throws SeriesException,
UnauthorizedException

Description copied from interface: SeriesService

Adds or updates series. IllegalArgumentException is thrown if dc argument is null.

Specified by:

updateSeries in interface SeriesService

Parameters:

dc - DublinCoreCatalog representing series

Returns:

Dublin Core catalog of newly created series or null if series Dublin Core was just updated

Throws:

SeriesException - if adding or updating fails

UnauthorizedException - if the current user is not authorized to perform this action

updateAccessControl

public boolean updateAccessControl(String seriesId,
 AccessControlList accessControl)
                            throws NotFoundException,
SeriesException

Description copied from interface: SeriesService

Updates access control rules for specified series. Not specifying series ID or trying to update series with null value will throw IllegalArgumentException.

Specified by:

updateAccessControl in interface SeriesService

Parameters:

seriesId - series to be updated

accessControl - AccessControlList defining access control rules

Returns:

true if ACL was updated and false it if was created

Throws:

NotFoundException - if series with given ID cannot be found

SeriesException - if exception occurred

updateAccessControl

public boolean updateAccessControl(String seriesId,
 AccessControlList accessControl,
 boolean overrideEpisodeAcl)
                            throws NotFoundException,
SeriesException

Description copied from interface: SeriesService

Updates access control rules for specified series. Allows to set the override parameter that controls whether the episode ACLs of the contained media packages will be removed on update. Not specifying series ID or trying to update series with null value will throw IllegalArgumentException.

Specified by:

updateAccessControl in interface SeriesService

Parameters:

seriesId - series to be updated

accessControl - AccessControlList defining access control rules

overrideEpisodeAcl - Whether the new series acl should override the episode acl

Returns:

true if ACL was updated and false it if was created

Throws:

NotFoundException - if series with given ID cannot be found

SeriesException - if exception occurred

deleteSeries

public void deleteSeries(String seriesID)
                  throws SeriesException,
NotFoundException

Description copied from interface: SeriesService

Removes series

Specified by:

deleteSeries in interface SeriesService

Parameters:

seriesID - ID of the series to be removed

Throws:

SeriesException - if deleting fails

NotFoundException - if series with specified ID does not exist

getSeries

public DublinCoreCatalog getSeries(String seriesID)
                            throws SeriesException,
NotFoundException

Description copied from interface: SeriesService

Returns Dublin core representing series by series ID.

Specified by:

getSeries in interface SeriesService

Parameters:

seriesID - series to be retrieved

Returns:

DublinCoreCatalog representing series

Throws:

SeriesException - if retrieving fails

NotFoundException

getAllForAdministrativeRead

public List<Series> getAllForAdministrativeRead(Date from,
 Optional<Date> to,
 int limit)
                                         throws SeriesException,
UnauthorizedException

Description copied from interface: SeriesService

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 SeriesService

Throws:

SeriesException

UnauthorizedException

getSeriesAccessControl

public AccessControlList getSeriesAccessControl(String seriesID)
                                         throws NotFoundException,
SeriesException

Description copied from interface: SeriesService

Returns access control rules for series with given ID.

Specified by:

getSeriesAccessControl in interface SeriesService

Parameters:

seriesID - ID of the series for which access control rules will be retrieved

Returns:

AccessControlList defining access control rules

Throws:

NotFoundException - if series with given ID cannot be found

SeriesException - if exception occurred

getSeriesCount

public int getSeriesCount()
                   throws SeriesException

Specified by:

getSeriesCount in interface SeriesService

Throws:

SeriesException

getSeriesProperties

public Map<String,String> getSeriesProperties(String seriesID)
                                       throws SeriesException,
NotFoundException,
UnauthorizedException

Description copied from interface: SeriesService

Returns the properties for a series.

Specified by:

getSeriesProperties in interface SeriesService

Parameters:

seriesID - series to be retrieved

Returns:

representing series properties

Throws:

SeriesException - if retrieving fails

NotFoundException - Thrown if the series or property cannot be found.

UnauthorizedException - if the current user is not authorized to perform this action

getSeriesProperty

public String getSeriesProperty(String seriesID,
 String propertyName)
                         throws SeriesException,
NotFoundException,
UnauthorizedException

Description copied from interface: SeriesService

Get a series property.

Specified by:

getSeriesProperty in interface SeriesService

Parameters:

seriesID - The id of the series to get the property from.

propertyName - The name of the property to retrieve

Returns:

The string value of the property.

Throws:

SeriesException - Thrown for all other exceptions.

NotFoundException - Thrown if the series or property cannot be found.

UnauthorizedException - Thrown if the user is not able to read the series' properties.

updateSeriesProperty

public void updateSeriesProperty(String seriesID,
 String propertyName,
 String propertyValue)
                          throws SeriesException,
NotFoundException,
UnauthorizedException

Description copied from interface: SeriesService

Update a series property or create a new one if it doesn't exist.

Specified by:

updateSeriesProperty in interface SeriesService

Parameters:

seriesID - The series to attach the property to.

propertyName - The unique name of the series property

propertyValue - The value to assign the series property

Throws:

SeriesException - Thrown for all other exceptions.

NotFoundException - Thrown if the series or property cannot be found.

UnauthorizedException - Thrown if the user is not able to write the series' properties.

deleteSeriesProperty

public void deleteSeriesProperty(String seriesID,
 String propertyName)
                          throws SeriesException,
NotFoundException,
UnauthorizedException

Specified by:

deleteSeriesProperty in interface SeriesService

Parameters:

seriesID - The series to attach the property to.

propertyName - The unique name of the series property

Throws:

SeriesException - Thrown for all other exceptions.

NotFoundException - Thrown if the series or property cannot be found.

UnauthorizedException - Thrown if the user is not able to write the series' properties.

equals

public static boolean equals(DublinCoreCatalog a,
 DublinCoreCatalog b)

Define equality on DublinCoreCatalogs. Two DublinCores are considered equal if they have the same properties and if each property has the same values in the same order.

Note: As long as http://opencast.jira.com/browse/MH-8759 is not fixed, the encoding scheme of values is not considered.

Implementation Note: DublinCores should not be compared by their string serialization since the ordering of properties is not defined and cannot be guaranteed between serializations.

equals

public static boolean equals(AccessControlList a,
 AccessControlList b)

Define equality on AccessControlLists. Two AccessControlLists are considered equal if they contain the exact same entries no matter in which order.

getSeriesElements

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

Description copied from interface: SeriesService

Returns all the elements of a series in a map. The key of the map marks the element type. If the series does not contain any elements, an empty map is returned. If the series does not exist, Opt.none() is returned.

Specified by:

getSeriesElements in interface SeriesService

Parameters:

seriesId - the series identifier

Returns:

the map of elements

Throws:

SeriesException - if an error occurred during loading the series elements

getSeriesElementData

public Optional<byte[]> getSeriesElementData(String seriesId,
 String type)
                                      throws SeriesException

Description copied from interface: SeriesService

Returns the element data of the series with the given type. If the series or the element with the given type do not exist, Opt.none() is returned.

Specified by:

getSeriesElementData in interface SeriesService

Parameters:

seriesId - the series identifier

type - the element type

Returns:

the series element data

Throws:

SeriesException - if an error occurred during loading the series element

updateExtendedMetadata

public boolean updateExtendedMetadata(String seriesId,
 String type,
 DublinCoreCatalog dc)
                               throws SeriesException

Description copied from interface: SeriesService

Updates the extended metadata of a series from a Dublin Core catalog.

Specified by:

updateExtendedMetadata in interface SeriesService

Parameters:

seriesId - the series identifier

type - the type of dublin core catalog

dc - the dublin core catalog with extended metadata

Returns:

true if the extended metadata could be updated

Throws:

SeriesException - if an error occurred during updating of the extended metadata

updateSeriesElement

public boolean updateSeriesElement(String seriesId,
 String type,
 byte[] data)
                            throws SeriesException

Description copied from interface: SeriesService

Creates or updates an element of a series.

Specified by:

updateSeriesElement in interface SeriesService

Parameters:

seriesId - the series identifier

type - the type of the element

data - the data of the element

Returns:

true if the element could be created or updated

Throws:

SeriesException - if an error occurs while updating the element

deleteSeriesElement

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

Description copied from interface: SeriesService

Deletes an element from a series.

Specified by:

deleteSeriesElement in interface SeriesService

Parameters:

seriesId - the series identifier

type - the element type

Returns:

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

Throws:

SeriesException - if an error occurs while deleting the element

repopulate

public void repopulate(IndexRebuildService.DataType type)
                throws IndexRebuildException

Description copied from interface: IndexProducer

Re-add the data of this service to the index.

Specified by:

repopulate in interface IndexProducer

Parameters:

type - Limit the data added to the index. Use ALL to re-index all data.

Throws:

IndexRebuildException

getService

public IndexRebuildService.Service getService()

Description copied from interface: IndexProducer

Get the service that implements IndexProducer.

Specified by:

getService in interface IndexProducer

Returns:

service The service that implements IndexProducer.