Package org.opencastproject.series.remote

Class SeriesServiceRemoteImpl

java.lang.Object

org.opencastproject.serviceregistry.api.RemoteBase

org.opencastproject.series.remote.SeriesServiceRemoteImpl

All Implemented Interfaces:

org.opencastproject.series.api.SeriesService

@Path("/series")
public class SeriesServiceRemoteImpl
extends org.opencastproject.serviceregistry.api.RemoteBase
implements org.opencastproject.series.api.SeriesService

A proxy to a remote series service.

Nested Class Summary

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

org.opencastproject.serviceregistry.api.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)
boolean	deleteSeriesElement(String seriesID, String type)
void	deleteSeriesProperty(String seriesID, String propertyName)
List<org.opencastproject.series.api.Series>	getAllForAdministrativeRead(Date from, Optional<Date> to, int limit)
org.opencastproject.metadata.dublincore.DublinCoreCatalog	getSeries(String seriesID)
org.opencastproject.security.api.AccessControlList	getSeriesAccessControl(String seriesID)
javax.ws.rs.core.Response	getSeriesAccessControlListJson(String seriesID)
int	getSeriesCount()
com.entwinemedia.fn.data.Opt<byte[]>	getSeriesElementData(String seriesID, String type)
com.entwinemedia.fn.data.Opt<Map<String,byte[]>>	getSeriesElements(String seriesID)
javax.ws.rs.core.Response	getSeriesJSON(String seriesID)
Map<String,String>	getSeriesProperties(String seriesID)
String	getSeriesProperty(String seriesID, String propertyName)
void	setRemoteServiceManager(org.opencastproject.serviceregistry.api.ServiceRegistry remoteServiceManager)	Sets the remote service manager.
void	setTrustedHttpClient(org.opencastproject.security.api.TrustedHttpClient client)	Sets the trusted http client
boolean	updateAccessControl(String seriesID, org.opencastproject.security.api.AccessControlList accessControl)
boolean	updateAccessControl(String seriesID, org.opencastproject.security.api.AccessControlList accessControl, boolean overrideEpisodeAcl)
boolean	updateExtendedMetadata(String seriesId, String type, org.opencastproject.metadata.dublincore.DublinCoreCatalog dc)
org.opencastproject.metadata.dublincore.DublinCoreCatalog	updateSeries(org.opencastproject.metadata.dublincore.DublinCoreCatalog dc)
boolean	updateSeriesElement(String seriesID, String type, byte[] data)
void	updateSeriesProperty(String seriesID, String propertyName, String propertyValue)

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(org.opencastproject.security.api.TrustedHttpClient client)

Sets the trusted http client

Overrides:

setTrustedHttpClient in class org.opencastproject.serviceregistry.api.RemoteBase

Parameters:

client -

setRemoteServiceManager

public void setRemoteServiceManager(org.opencastproject.serviceregistry.api.ServiceRegistry remoteServiceManager)

Sets the remote service manager.

Overrides:

setRemoteServiceManager in class org.opencastproject.serviceregistry.api.RemoteBase

Parameters:

remoteServiceManager -

updateSeries

public org.opencastproject.metadata.dublincore.DublinCoreCatalog updateSeries(org.opencastproject.metadata.dublincore.DublinCoreCatalog dc)
                                                                       throws org.opencastproject.series.api.SeriesException,
org.opencastproject.security.api.UnauthorizedException

Specified by:

updateSeries in interface org.opencastproject.series.api.SeriesService

Throws:

org.opencastproject.series.api.SeriesException

org.opencastproject.security.api.UnauthorizedException

updateAccessControl

public boolean updateAccessControl(String seriesID,
 org.opencastproject.security.api.AccessControlList accessControl)
                            throws org.opencastproject.util.NotFoundException,
org.opencastproject.series.api.SeriesException,
org.opencastproject.security.api.UnauthorizedException

Specified by:

updateAccessControl in interface org.opencastproject.series.api.SeriesService

Throws:

org.opencastproject.util.NotFoundException

org.opencastproject.series.api.SeriesException

org.opencastproject.security.api.UnauthorizedException

updateAccessControl

public boolean updateAccessControl(String seriesID,
 org.opencastproject.security.api.AccessControlList accessControl,
 boolean overrideEpisodeAcl)
                            throws org.opencastproject.util.NotFoundException,
org.opencastproject.series.api.SeriesException,
org.opencastproject.security.api.UnauthorizedException

Specified by:

updateAccessControl in interface org.opencastproject.series.api.SeriesService

Throws:

org.opencastproject.util.NotFoundException

org.opencastproject.series.api.SeriesException

org.opencastproject.security.api.UnauthorizedException

deleteSeries

public void deleteSeries(String seriesID)
                  throws org.opencastproject.series.api.SeriesException,
org.opencastproject.util.NotFoundException,
org.opencastproject.security.api.UnauthorizedException

Specified by:

deleteSeries in interface org.opencastproject.series.api.SeriesService

Throws:

org.opencastproject.series.api.SeriesException

org.opencastproject.util.NotFoundException

org.opencastproject.security.api.UnauthorizedException

getSeriesJSON

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

Throws:

org.opencastproject.security.api.UnauthorizedException

getSeriesAccessControlListJson

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

getSeries

public org.opencastproject.metadata.dublincore.DublinCoreCatalog getSeries(String seriesID)
                                                                    throws org.opencastproject.series.api.SeriesException,
org.opencastproject.util.NotFoundException,
org.opencastproject.security.api.UnauthorizedException

Specified by:

getSeries in interface org.opencastproject.series.api.SeriesService

Throws:

org.opencastproject.series.api.SeriesException

org.opencastproject.util.NotFoundException

org.opencastproject.security.api.UnauthorizedException

getAllForAdministrativeRead

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

Specified by:

getAllForAdministrativeRead in interface org.opencastproject.series.api.SeriesService

Throws:

org.opencastproject.series.api.SeriesException

org.opencastproject.security.api.UnauthorizedException

getSeriesAccessControl

public org.opencastproject.security.api.AccessControlList getSeriesAccessControl(String seriesID)
                                                                          throws org.opencastproject.util.NotFoundException,
org.opencastproject.series.api.SeriesException

Specified by:

getSeriesAccessControl in interface org.opencastproject.series.api.SeriesService

Throws:

org.opencastproject.util.NotFoundException

org.opencastproject.series.api.SeriesException

getSeriesCount

public int getSeriesCount()
                   throws org.opencastproject.series.api.SeriesException

Specified by:

getSeriesCount in interface org.opencastproject.series.api.SeriesService

Throws:

org.opencastproject.series.api.SeriesException

getSeriesProperties

public Map<String,String> getSeriesProperties(String seriesID)
                                       throws org.opencastproject.series.api.SeriesException,
org.opencastproject.util.NotFoundException,
org.opencastproject.security.api.UnauthorizedException

Specified by:

getSeriesProperties in interface org.opencastproject.series.api.SeriesService

Throws:

org.opencastproject.series.api.SeriesException

org.opencastproject.util.NotFoundException

org.opencastproject.security.api.UnauthorizedException

getSeriesProperty

public String getSeriesProperty(String seriesID,
 String propertyName)
                         throws org.opencastproject.series.api.SeriesException,
org.opencastproject.util.NotFoundException,
org.opencastproject.security.api.UnauthorizedException

Specified by:

getSeriesProperty in interface org.opencastproject.series.api.SeriesService

Throws:

org.opencastproject.series.api.SeriesException

org.opencastproject.util.NotFoundException

org.opencastproject.security.api.UnauthorizedException

updateSeriesProperty

public void updateSeriesProperty(String seriesID,
 String propertyName,
 String propertyValue)
                          throws org.opencastproject.series.api.SeriesException,
org.opencastproject.util.NotFoundException,
org.opencastproject.security.api.UnauthorizedException

Specified by:

updateSeriesProperty in interface org.opencastproject.series.api.SeriesService

Throws:

org.opencastproject.series.api.SeriesException

org.opencastproject.util.NotFoundException

org.opencastproject.security.api.UnauthorizedException

deleteSeriesProperty

public void deleteSeriesProperty(String seriesID,
 String propertyName)
                          throws org.opencastproject.series.api.SeriesException,
org.opencastproject.util.NotFoundException,
org.opencastproject.security.api.UnauthorizedException

Specified by:

deleteSeriesProperty in interface org.opencastproject.series.api.SeriesService

Throws:

org.opencastproject.series.api.SeriesException

org.opencastproject.util.NotFoundException

org.opencastproject.security.api.UnauthorizedException

updateExtendedMetadata

public boolean updateExtendedMetadata(String seriesId,
 String type,
 org.opencastproject.metadata.dublincore.DublinCoreCatalog dc)
                               throws org.opencastproject.series.api.SeriesException

Specified by:

updateExtendedMetadata in interface org.opencastproject.series.api.SeriesService

Throws:

org.opencastproject.series.api.SeriesException

getSeriesElements

public com.entwinemedia.fn.data.Opt<Map<String,byte[]>> getSeriesElements(String seriesID)
                                                                   throws org.opencastproject.series.api.SeriesException

Specified by:

getSeriesElements in interface org.opencastproject.series.api.SeriesService

Throws:

org.opencastproject.series.api.SeriesException

getSeriesElementData

public com.entwinemedia.fn.data.Opt<byte[]> getSeriesElementData(String seriesID,
 String type)
                                                          throws org.opencastproject.series.api.SeriesException

Specified by:

getSeriesElementData in interface org.opencastproject.series.api.SeriesService

Throws:

org.opencastproject.series.api.SeriesException

updateSeriesElement

public boolean updateSeriesElement(String seriesID,
 String type,
 byte[] data)
                            throws org.opencastproject.series.api.SeriesException

Specified by:

updateSeriesElement in interface org.opencastproject.series.api.SeriesService

Throws:

org.opencastproject.series.api.SeriesException

deleteSeriesElement

public boolean deleteSeriesElement(String seriesID,
 String type)
                            throws org.opencastproject.series.api.SeriesException

Specified by:

deleteSeriesElement in interface org.opencastproject.series.api.SeriesService

Throws:

org.opencastproject.series.api.SeriesException