Package org.opencastproject.playlists

Class PlaylistRestService

java.lang.Object

org.opencastproject.playlists.PlaylistRestService

@Path("/playlists")
public class PlaylistRestService
extends Object

A REST endpoint for the PlaylistService

Field Summary

Fields

Modifier and Type	Field	Description
protected AuthorizationService	authorizationService	The authorization service
static final String	SAMPLE_PLAYLIST_ENTRIES_JSON
static final String	SAMPLE_PLAYLIST_ENTRIES_XML
static final String	SAMPLE_PLAYLIST_JSON
static final String	SAMPLE_PLAYLIST_XML
protected SearchService	searchService	The search service

Constructor Summary

Constructors

Constructor	Description
PlaylistRestService()

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	addEntry(String playlistId, Long entryId)
javax.ws.rs.core.Response	addEntry(String playlistId, String contentId, PlaylistEntryType type)
javax.ws.rs.core.Response	createAsJson(String playlistText)
javax.ws.rs.core.Response	createAsXml(String playlistText)
javax.ws.rs.core.Response	getPlaylistAsJson(String id, boolean withPublications)
javax.ws.rs.core.Response	getPlaylistAsXml(String id, boolean withPublications)
javax.ws.rs.core.Response	getPlaylistsAsJson(int limit, int offset, String sort)
javax.ws.rs.core.Response	getPlaylistsAsXml(int limit, int offset, String sort)
Playlist	parseJsonToPlaylist(String json)	While jackson takes care of automatically converting JAXB to JSON when returning from a request, getting it to parse JSON to JAXB when accepting a request is not that automatic.
javax.ws.rs.core.Response	remove(String id)
void	setAuthorizationService(AuthorizationService authorizationService)
protected void	setSearchService(SearchService searchService)
void	setService(PlaylistService service)	Sets the playlist service
javax.ws.rs.core.Response	updateAsJson(String id, String playlistText)
javax.ws.rs.core.Response	updateAsXml(String id, String playlistText)

Methods inherited from class java.lang.Object

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

Field Details

SAMPLE_PLAYLIST_JSON

public static final String SAMPLE_PLAYLIST_JSON

See Also:

• Constant Field Values

SAMPLE_PLAYLIST_ENTRIES_JSON

public static final String SAMPLE_PLAYLIST_ENTRIES_JSON

See Also:

• Constant Field Values

SAMPLE_PLAYLIST_XML

public static final String SAMPLE_PLAYLIST_XML

See Also:

• Constant Field Values

SAMPLE_PLAYLIST_ENTRIES_XML

public static final String SAMPLE_PLAYLIST_ENTRIES_XML

See Also:

• Constant Field Values

searchService

protected SearchService searchService

The search service

authorizationService

protected AuthorizationService authorizationService

The authorization service

Constructor Details

PlaylistRestService

public PlaylistRestService()

Method Details

setService

public void setService(PlaylistService service)

Sets the playlist service

Parameters:

service - the playlist service instance

setSearchService

protected void setSearchService(SearchService searchService)

setAuthorizationService

public void setAuthorizationService(AuthorizationService authorizationService)

getPlaylistAsJson

@GET
@Produces("application/json")
@Path("{id}.json")
public javax.ws.rs.core.Response getPlaylistAsJson(@PathParam("id")
 String id,
 @FormParam("withPublications")
 boolean withPublications)
                                            throws NotFoundException,
UnauthorizedException

Throws:

NotFoundException

UnauthorizedException

getPlaylistAsXml

@GET
@Produces("application/xml")
@Path("{id}.xml")
public javax.ws.rs.core.Response getPlaylistAsXml(@PathParam("id")
 String id,
 @FormParam("withPublications")
 boolean withPublications)
                                           throws NotFoundException,
UnauthorizedException

Throws:

NotFoundException

UnauthorizedException

getPlaylistsAsJson

@GET
@Produces("application/json")
@Path("playlists.json")
public javax.ws.rs.core.Response getPlaylistsAsJson(@FormParam("limit")
 int limit,
 @FormParam("offset")
 int offset,
 @FormParam("sort")
 String sort)
                                             throws NotFoundException

Throws:

NotFoundException

getPlaylistsAsXml

@GET
@Produces("application/xml")
@Path("playlists.xml")
public javax.ws.rs.core.Response getPlaylistsAsXml(@FormParam("limit")
 int limit,
 @FormParam("offset")
 int offset,
 @FormParam("sort")
 String sort)
                                            throws NotFoundException

Throws:

NotFoundException

createAsJson

@POST
@Produces("application/json")
@Path("new.json")
public javax.ws.rs.core.Response createAsJson(@FormParam("playlist")
 String playlistText)
                                       throws UnauthorizedException

Throws:

UnauthorizedException

createAsXml

@POST
@Produces("application/xml")
@Path("new.xml")
public javax.ws.rs.core.Response createAsXml(@FormParam("playlist")
 String playlistText)
                                      throws UnauthorizedException

Throws:

UnauthorizedException

updateAsJson

@PUT
@Produces("application/json")
@Path("{id}.json")
public javax.ws.rs.core.Response updateAsJson(@PathParam("id")
 String id,
 @FormParam("playlist")
 String playlistText)
                                       throws UnauthorizedException

Throws:

UnauthorizedException

updateAsXml

@PUT
@Produces("application/xml")
@Path("{id}.xml")
public javax.ws.rs.core.Response updateAsXml(@PathParam("id")
 String id,
 @FormParam("playlist")
 String playlistText)
                                      throws UnauthorizedException

Throws:

UnauthorizedException

remove

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

Throws:

NotFoundException

UnauthorizedException

addEntry

@POST
@Produces("application/json")
@Path("{id}/entries/new")
public javax.ws.rs.core.Response addEntry(@PathParam("id")
 String playlistId,
 @FormParam("contentId")
 String contentId,
 @FormParam("type")
 PlaylistEntryType type)
                                   throws NotFoundException,
UnauthorizedException

Throws:

NotFoundException

UnauthorizedException

addEntry

@POST
@Produces("application/json")
@Path("{id}/entries/{entryId}")
public javax.ws.rs.core.Response addEntry(@PathParam("id")
 String playlistId,
 @PathParam("entryId")
 Long entryId)
                                   throws NotFoundException,
UnauthorizedException

Throws:

NotFoundException

UnauthorizedException

parseJsonToPlaylist

public Playlist parseJsonToPlaylist(String json)
                             throws org.json.simple.parser.ParseException,
IOException

While jackson takes care of automatically converting JAXB to JSON when returning from a request, getting it to parse JSON to JAXB when accepting a request is not that automatic. This functions takes care of that.

Parameters:

json - Valid JSON as a string

Returns:

A Playlist containing the information from the JSON

Throws:

org.json.simple.parser.ParseException

IOException