Package org.opencastproject.adminui.endpoint

Class SeriesEndpoint

java.lang.Object

org.opencastproject.adminui.endpoint.SeriesEndpoint

@Path("/admin-ng/series")
public class SeriesEndpoint
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EVENTSFILTER_ONLYSERIESWITHWRITEACCESS_KEY
static final String	SERIES_HASEVENTS_DELETE_ALLOW_KEY
static final String	SERIESTAB_ONLYSERIESWITHWRITEACCESS_KEY
static final String	THEME_KEY
static final Pattern	TOBIRA_CONFIG

Constructor Summary

Constructors

Constructor	Description
SeriesEndpoint()

Method Summary

Modifier and Type	Method	Description
protected void	activate(org.osgi.service.component.ComponentContext cc, Map<String,Object> properties)
javax.ws.rs.core.Response	applyAclToSeries(String seriesId, String acl, boolean override)
javax.ws.rs.core.Response	createNewSeries(String metadata)
javax.ws.rs.core.Response	deleteMultipleSeries(String seriesIdsContent)
javax.ws.rs.core.Response	deleteSeries(String id)
javax.ws.rs.core.Response	deleteSeriesProperty(String seriesId, String propertyName)
javax.ws.rs.core.Response	deleteSeriesTheme(String seriesID)
javax.ws.rs.core.Response	getNewMetadata()
javax.ws.rs.core.Response	getNewThemes()
Boolean	getOnlySeriesWithWriteAccessEventsFilter()
Boolean	getOnlySeriesWithWriteAccessSeriesTab()
javax.ws.rs.core.Response	getSeries(String filter, String sort, int offset, int limit)
javax.ws.rs.core.Response	getSeriesAccessInformation(String seriesId)
javax.ws.rs.core.Response	getSeriesEvents(String seriesId)
javax.ws.rs.core.Response	getSeriesHostPages(String seriesId)
javax.ws.rs.core.Response	getSeriesMetadata(String series)
javax.ws.rs.core.Response	getSeriesOptions()
javax.ws.rs.core.Response	getSeriesPropertiesAsJson(String seriesId)
javax.ws.rs.core.Response	getSeriesProperty(String seriesId, String propertyName)
javax.ws.rs.core.Response	getSeriesTheme(String seriesId)
javax.ws.rs.core.Response	getTobiraPage(String path)
Map<String,String>	getUserSeriesByAccess(boolean writeAccess)	Search all user series with write or read-only permissions.
void	modified(Map<String,Object> properties)	OSGi callback if properties file is present
javax.ws.rs.core.Response	removeSeriesTobiraPath(String seriesId, String currentPath)
void	setAclServiceFactory(AclServiceFactory aclServiceFactory)	OSGi callback for the acl service factory
void	setAdminUIConfiguration(AdminUIConfiguration adminUIConfiguration)	OSGi DI.
void	setIndex(ElasticsearchIndex index)	OSGi callback for the search index.
void	setIndexService(IndexService indexService)	OSGi DI.
void	setListProvidersService(ListProvidersService listProvidersService)	OSGi callback for the list provider service
void	setSecurityService(SecurityService securityService)	OSGi callback for the security service
void	setSeriesService(SeriesService seriesService)	OSGi callback for the series service.
void	setUserDirectoryService(UserDirectoryService userDirectoryService)	Sets the user directory service
javax.ws.rs.core.Response	updateSeriesMetadata(String seriesID, String metadataJSON)
javax.ws.rs.core.Response	updateSeriesProperty(String seriesId, String name, String value)
javax.ws.rs.core.Response	updateSeriesTheme(String seriesID, long themeId)
javax.ws.rs.core.Response	updateSeriesTobiraPath(String seriesId, String pathComponents, String currentPath, String targetPath)

Methods inherited from class java.lang.Object

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

Field Details

THEME_KEY

public static final String THEME_KEY

See Also:

• Constant Field Values

SERIES_HASEVENTS_DELETE_ALLOW_KEY

public static final String SERIES_HASEVENTS_DELETE_ALLOW_KEY

See Also:

• Constant Field Values

SERIESTAB_ONLYSERIESWITHWRITEACCESS_KEY

public static final String SERIESTAB_ONLYSERIESWITHWRITEACCESS_KEY

See Also:

• Constant Field Values

EVENTSFILTER_ONLYSERIESWITHWRITEACCESS_KEY

public static final String EVENTSFILTER_ONLYSERIESWITHWRITEACCESS_KEY

See Also:

• Constant Field Values

TOBIRA_CONFIG

public static final Pattern TOBIRA_CONFIG

Constructor Details

SeriesEndpoint

public SeriesEndpoint()

Method Details

setSeriesService

public void setSeriesService(SeriesService seriesService)

OSGi callback for the series service.

setIndex

public void setIndex(ElasticsearchIndex index)

OSGi callback for the search index.

setIndexService

public void setIndexService(IndexService indexService)

OSGi DI.

setListProvidersService

public void setListProvidersService(ListProvidersService listProvidersService)

OSGi callback for the list provider service

setSecurityService

public void setSecurityService(SecurityService securityService)

OSGi callback for the security service

setAclServiceFactory

public void setAclServiceFactory(AclServiceFactory aclServiceFactory)

OSGi callback for the acl service factory

setAdminUIConfiguration

public void setAdminUIConfiguration(AdminUIConfiguration adminUIConfiguration)

OSGi DI.

setUserDirectoryService

public void setUserDirectoryService(UserDirectoryService userDirectoryService)

Sets the user directory service

activate

protected void activate(org.osgi.service.component.ComponentContext cc,
 Map<String,Object> properties)

modified

public void modified(Map<String,Object> properties)

OSGi callback if properties file is present

getSeriesAccessInformation

@GET
@Path("{seriesId}/access.json")
@Produces("application/json")
public javax.ws.rs.core.Response getSeriesAccessInformation(@PathParam("seriesId")
 String seriesId)
                                                     throws NotFoundException

Throws:

NotFoundException

getSeriesMetadata

@GET
@Produces("application/json")
@Path("{seriesId}/metadata.json")
public javax.ws.rs.core.Response getSeriesMetadata(@PathParam("seriesId")
 String series)
                                            throws UnauthorizedException,
NotFoundException,
SearchIndexException

Throws:

UnauthorizedException

NotFoundException

SearchIndexException

updateSeriesMetadata

@PUT
@Path("{seriesId}/metadata")
public javax.ws.rs.core.Response updateSeriesMetadata(@PathParam("seriesId")
 String seriesID,
 @FormParam("metadata")
 String metadataJSON)
                                               throws UnauthorizedException,
NotFoundException,
SearchIndexException

Throws:

UnauthorizedException

NotFoundException

SearchIndexException

getNewMetadata

@GET
@Path("new/metadata")
public javax.ws.rs.core.Response getNewMetadata()

getNewThemes

@GET
@Path("new/themes")
public javax.ws.rs.core.Response getNewThemes()

getTobiraPage

@GET
@Path("new/tobira/page")
@Produces("application/json")
public javax.ws.rs.core.Response getTobiraPage(@QueryParam("path")
 String path)
                                        throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

createNewSeries

@POST
@Path("new")
public javax.ws.rs.core.Response createNewSeries(@FormParam("metadata")
 String metadata)
                                          throws UnauthorizedException

Throws:

UnauthorizedException

deleteSeries

@DELETE
@Path("{seriesId}")
@Produces("application/json")
public javax.ws.rs.core.Response deleteSeries(@PathParam("seriesId")
 String id)
                                       throws NotFoundException

Throws:

NotFoundException

deleteMultipleSeries

@POST
@Path("deleteSeries")
@Produces("application/json")
public javax.ws.rs.core.Response deleteMultipleSeries(String seriesIdsContent)
                                               throws NotFoundException

Throws:

NotFoundException

getSeries

@GET
@Produces("application/json")
@Path("series.json")
public javax.ws.rs.core.Response getSeries(@QueryParam("filter")
 String filter,
 @QueryParam("sort")
 String sort,
 @QueryParam("offset")
 int offset,
 @QueryParam("limit")
 int limit)
                                    throws UnauthorizedException

Throws:

UnauthorizedException

getUserSeriesByAccess

public Map<String,String> getUserSeriesByAccess(boolean writeAccess)

Search all user series with write or read-only permissions.

Parameters:

writeAccess - true: write access false: read-only access

Returns:

user series with write or read-only access, depending on the parameter

getSeriesPropertiesAsJson

@GET
@Produces("application/json")
@Path("{id}/properties")
public javax.ws.rs.core.Response getSeriesPropertiesAsJson(@PathParam("id")
 String seriesId)
                                                    throws UnauthorizedException,
NotFoundException

Throws:

UnauthorizedException

NotFoundException

getSeriesProperty

@GET
@Produces("application/json")
@Path("{seriesId}/property/{propertyName}.json")
public javax.ws.rs.core.Response getSeriesProperty(@PathParam("seriesId")
 String seriesId,
 @PathParam("propertyName")
 String propertyName)
                                            throws UnauthorizedException,
NotFoundException

Throws:

UnauthorizedException

NotFoundException

updateSeriesProperty

@POST
@Path("/{seriesId}/property")
public javax.ws.rs.core.Response updateSeriesProperty(@PathParam("seriesId")
 String seriesId,
 @FormParam("name")
 String name,
 @FormParam("value")
 String value)
                                               throws UnauthorizedException

Throws:

UnauthorizedException

deleteSeriesProperty

@DELETE
@Path("{seriesId}/property/{propertyName}")
public javax.ws.rs.core.Response deleteSeriesProperty(@PathParam("seriesId")
 String seriesId,
 @PathParam("propertyName")
 String propertyName)
                                               throws UnauthorizedException,
NotFoundException

Throws:

UnauthorizedException

NotFoundException

getSeriesTheme

@GET
@Produces("application/json")
@Path("{seriesId}/theme.json")
public javax.ws.rs.core.Response getSeriesTheme(@PathParam("seriesId")
 String seriesId)

updateSeriesTheme

@PUT
@Path("{seriesId}/theme")
public javax.ws.rs.core.Response updateSeriesTheme(@PathParam("seriesId")
 String seriesID,
 @FormParam("themeId")
 long themeId)
                                            throws UnauthorizedException,
NotFoundException

Throws:

UnauthorizedException

NotFoundException

deleteSeriesTheme

@DELETE
@Path("{seriesId}/theme")
public javax.ws.rs.core.Response deleteSeriesTheme(@PathParam("seriesId")
 String seriesID)
                                            throws UnauthorizedException,
NotFoundException

Throws:

UnauthorizedException

NotFoundException

getSeriesHostPages

@GET
@Path("{seriesId}/tobira/pages")
public javax.ws.rs.core.Response getSeriesHostPages(@PathParam("seriesId")
 String seriesId)

updateSeriesTobiraPath

@POST
@Path("{seriesId}/tobira/path")
public javax.ws.rs.core.Response updateSeriesTobiraPath(@PathParam("seriesId")
 String seriesId,
 @FormParam("pathComponents")
 String pathComponents,
 @FormParam("currentPath")
 String currentPath,
 @FormParam("targetPath")
 String targetPath)
                                                 throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

removeSeriesTobiraPath

@DELETE
@Path("{seriesId}/tobira/{currentPath}")
public javax.ws.rs.core.Response removeSeriesTobiraPath(@PathParam("seriesId")
 String seriesId,
 @PathParam("currentPath")
 String currentPath)
                                                 throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

applyAclToSeries

@POST
@Path("/{seriesId}/access")
public javax.ws.rs.core.Response applyAclToSeries(@PathParam("seriesId")
 String seriesId,
 @FormParam("acl")
 String acl,
 @DefaultValue("false") @FormParam("override")
 boolean override)
                                           throws SearchIndexException

Throws:

SearchIndexException

getSeriesEvents

@GET
@Path("{seriesId}/hasEvents.json")
@Produces("application/json")
public javax.ws.rs.core.Response getSeriesEvents(@PathParam("seriesId")
 String seriesId)
                                          throws Exception

Throws:

Exception

getSeriesOptions

@GET
@Path("configuration.json")
@Produces("application/json")
public javax.ws.rs.core.Response getSeriesOptions()

getOnlySeriesWithWriteAccessSeriesTab

public Boolean getOnlySeriesWithWriteAccessSeriesTab()

getOnlySeriesWithWriteAccessEventsFilter

public Boolean getOnlySeriesWithWriteAccessEventsFilter()