Package org.opencastproject.series.remote

Class SeriesServiceRemoteImpl

java.lang.Object

org.opencastproject.serviceregistry.api.RemoteBase

org.opencastproject.series.remote.SeriesServiceRemoteImpl

All Implemented Interfaces:

SeriesService

@Path("/series")
public class SeriesServiceRemoteImpl
extends RemoteBase
implements SeriesService

A proxy to a remote series service.

Nested Class Summary

Nested classes/interfaces inherited from class org.opencastproject.serviceregistry.api.RemoteBase

RemoteBase.HttpClientClosingInputStream

Field Summary

Fields inherited from class org.opencastproject.serviceregistry.api.RemoteBase

client, elementsFromHttpResponse, remoteServiceManager, serviceType

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

JOB_TYPE

Constructor Summary

Constructors

Constructor	Description
SeriesServiceRemoteImpl()

Method Summary

Modifier and Type	Method	Description
void	deleteSeries(String seriesID)	Removes series
boolean	deleteSeriesElement(String seriesID, String type)	Deletes an element from a series.
void	deleteSeriesProperty(String seriesID, String propertyName)
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.
javax.ws.rs.core.Response	getSeriesAccessControlListJson(String seriesID)
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.
javax.ws.rs.core.Response	getSeriesJSON(String seriesID)
Map<String,String>	getSeriesProperties(String seriesID)	Returns the properties for a series.
String	getSeriesProperty(String seriesID, String propertyName)	Get a series property.
void	setRemoteServiceManager(ServiceRegistry remoteServiceManager)	Sets the remote service manager.
void	setTrustedHttpClient(TrustedHttpClient client)	Sets the trusted http client
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.serviceregistry.api.RemoteBase

closeConnection, getResponse, getResponse, runRequest

Methods inherited from class java.lang.Object

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

Constructor Details

SeriesServiceRemoteImpl

public SeriesServiceRemoteImpl()

Method Details

setTrustedHttpClient

public void setTrustedHttpClient(TrustedHttpClient client)

Sets the trusted http client

Overrides:

setTrustedHttpClient in class RemoteBase

Parameters:

client -

setRemoteServiceManager

public void setRemoteServiceManager(ServiceRegistry remoteServiceManager)

Sets the remote service manager.

Overrides:

setRemoteServiceManager in class RemoteBase

Parameters:

remoteServiceManager -

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,
UnauthorizedException

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

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

updateAccessControl

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

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

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

deleteSeries

public void deleteSeries(String seriesID)
                  throws SeriesException,
NotFoundException,
UnauthorizedException

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

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

getSeriesJSON

@GET
@Produces("application/json")
@Path("{seriesID:.+}.json")
public javax.ws.rs.core.Response getSeriesJSON(@PathParam("seriesID")
 String seriesID)
                                        throws UnauthorizedException

Throws:

UnauthorizedException

getSeriesAccessControlListJson

@GET
@Produces("application/json")
@Path("/{seriesID:.+}/acl.json")
public javax.ws.rs.core.Response getSeriesAccessControlListJson(@PathParam("seriesID")
 String seriesID)

getSeries

public DublinCoreCatalog getSeries(String seriesID)
                            throws SeriesException,
NotFoundException,
UnauthorizedException

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

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

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.

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

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

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