Package io.goobi.viewer.api.rest.v1.bookmarks

Class BookmarkResource

java.lang.Object

io.goobi.viewer.api.rest.v1.bookmarks.BookmarkResource

@Path("/bookmarks")
public class BookmarkResource
extends Object

Author:

florian

Constructor Summary

Constructors

Constructor	Description
BookmarkResource(jakarta.servlet.http.HttpServletRequest servletRequest, jakarta.servlet.http.HttpServletResponse servletResponse)

Method Summary

Modifier and Type	Method	Description
SuccessMessage	addBookmarkList(BookmarkList list)
BookmarkList	addItemToBookmarkList(Long id, Bookmark item)
SuccessMessage	deleteBookmarkItem(Long listId, Long bookmarkId)
SuccessMessage	deleteBookmarkList(Long id)
Bookmark	getBookmarkItem(Long listId, Long bookmarkId)
BookmarkList	getBookmarkList(Long id)
de.intranda.api.iiif.presentation.v2.Collection2	getBookmarkListAsIIIFCollection(Long id)
String	getBookmarkListAsRSS(Long id, String language, Integer maxHits)
Channel	getBookmarkListAsRSSJson(Long id, String language, Integer maxHits)
String	getBookmarkListForMirador(Long id)
List<BookmarkList>	getOwnedBookmarkLists()
List<BookmarkList>	getPublicBookmarkLists()
de.intranda.api.iiif.presentation.v2.Collection2	getSharedBookmarkListAsCollection(String key)
String	getSharedBookmarkListAsRSS(String key, String language, Integer maxHits)
Channel	getSharedBookmarkListAsRSSJson(String key, String language, Integer maxHits)
BookmarkList	getSharedBookmarkListByKey(String key)
String	getSharedBookmarkListForMirador(String key)
BookmarkList	patchBookmarkList(Long id, BookmarkList list)

Methods inherited from class java.lang.Object

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

Constructor Details

BookmarkResource

public BookmarkResource(@Context
 jakarta.servlet.http.HttpServletRequest servletRequest,
 @Context
 jakarta.servlet.http.HttpServletResponse servletResponse)

Method Details

getOwnedBookmarkLists

@GET
@Produces("application/json")
public List<BookmarkList> getOwnedBookmarkLists()
                                         throws DAOException,
IOException,
RestApiException

Throws:

DAOException

IOException

RestApiException

addBookmarkList

@POST
@Consumes("application/json")
@Produces("application/json")
public SuccessMessage addBookmarkList(BookmarkList list)
                               throws DAOException,
IOException,
RestApiException,
de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException

Throws:

DAOException

IOException

RestApiException

de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException

getBookmarkList

@GET
@Path("/{listId}")
@Produces("application/json")
public BookmarkList getBookmarkList(@PathParam("listId")
 Long id)
                             throws DAOException,
IOException,
RestApiException

Throws:

DAOException

IOException

RestApiException

patchBookmarkList

@PATCH
@Path("/{listId}")
@Produces("application/json")
public BookmarkList patchBookmarkList(@PathParam("listId")
 Long id,
 BookmarkList list)
                               throws DAOException,
IOException,
RestApiException,
de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException

Throws:

DAOException

IOException

RestApiException

de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException

deleteBookmarkList

@DELETE
@Path("/{listId}")
@Produces("application/json")
public SuccessMessage deleteBookmarkList(@PathParam("listId")
 Long id)
                                  throws DAOException,
IOException,
RestApiException,
de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException

Throws:

DAOException

IOException

RestApiException

de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException

addItemToBookmarkList

@POST
@Path("/{listId}")
@Consumes("application/json")
@Produces("application/json")
public BookmarkList addItemToBookmarkList(@PathParam("listId")
 Long id,
 Bookmark item)
                                   throws DAOException,
IOException,
RestApiException

Throws:

DAOException

IOException

RestApiException

getBookmarkItem

@GET
@Path("/{listId}/items/{bookmarkId}")
@Produces("application/json")
public Bookmark getBookmarkItem(@PathParam("listId")
 Long listId,
 @PathParam("bookmarkId")
 Long bookmarkId)
                         throws RestApiException,
DAOException,
IOException

Throws:

RestApiException

DAOException

IOException

deleteBookmarkItem

@DELETE
@Path("/{listId}/items/{bookmarkId}")
@Produces("application/json")
public SuccessMessage deleteBookmarkItem(@PathParam("listId")
 Long listId,
 @PathParam("bookmarkId")
 Long bookmarkId)
                                  throws RestApiException,
DAOException,
IOException

Throws:

RestApiException

DAOException

IOException

getBookmarkListAsIIIFCollection

@GET
@Path("/{listId}/collection.json")
@Produces("application/json")
public de.intranda.api.iiif.presentation.v2.Collection2 getBookmarkListAsIIIFCollection(@PathParam("listId")
 Long id)
                                                                                 throws DAOException,
IOException,
RestApiException

Throws:

DAOException

IOException

RestApiException

getBookmarkListForMirador

@GET
@Path("/{listId}/mirador.json")
@Produces("application/json")
public String getBookmarkListForMirador(@PathParam("listId")
 Long id)
                                 throws DAOException,
IOException,
RestApiException,
ViewerConfigurationException,
IndexUnreachableException,
PresentationException

Throws:

DAOException

IOException

RestApiException

ViewerConfigurationException

IndexUnreachableException

PresentationException

getBookmarkListAsRSS

@GET
@Path("/{listId}/rss.xml")
@Produces("text/xml")
public String getBookmarkListAsRSS(@PathParam("listId")
 Long id,
 @QueryParam("lang")
 String language,
 @QueryParam("max")
 Integer maxHits)
                            throws DAOException,
IOException,
RestApiException,
de.unigoettingen.sub.commons.contentlib.exceptions.ContentLibException

Throws:

DAOException

IOException

RestApiException

de.unigoettingen.sub.commons.contentlib.exceptions.ContentLibException

getBookmarkListAsRSSJson

@GET
@Path("/{listId}/rss.json")
@Produces("application/json")
public Channel getBookmarkListAsRSSJson(@PathParam("listId")
 Long id,
 @QueryParam("lang")
 String language,
 @QueryParam("max")
 Integer maxHits)
                                 throws DAOException,
IOException,
RestApiException,
de.unigoettingen.sub.commons.contentlib.exceptions.ContentLibException

Throws:

DAOException

IOException

RestApiException

de.unigoettingen.sub.commons.contentlib.exceptions.ContentLibException

getPublicBookmarkLists

@GET
@Path("/public")
@Produces("application/json")
public List<BookmarkList> getPublicBookmarkLists()
                                          throws DAOException,
IOException,
RestApiException

Throws:

DAOException

IOException

RestApiException

getSharedBookmarkListByKey

@GET
@Path("/shared/{key}")
@Produces("application/json")
public BookmarkList getSharedBookmarkListByKey(@PathParam("key")
 String key)
                                        throws DAOException,
RestApiException,
de.unigoettingen.sub.commons.contentlib.exceptions.ContentLibException

Throws:

DAOException

RestApiException

de.unigoettingen.sub.commons.contentlib.exceptions.ContentLibException

getSharedBookmarkListForMirador

@GET
@Path("/shared/{key}/mirador.json")
@Produces("application/json")
public String getSharedBookmarkListForMirador(@PathParam("key")
 String key)
                                       throws DAOException,
ViewerConfigurationException,
IndexUnreachableException,
PresentationException,
de.unigoettingen.sub.commons.contentlib.exceptions.ContentLibException

Throws:

DAOException

ViewerConfigurationException

IndexUnreachableException

PresentationException

de.unigoettingen.sub.commons.contentlib.exceptions.ContentLibException

getSharedBookmarkListAsCollection

@GET
@Path("/shared/{key}/collection.json")
@Produces("application/json")
public de.intranda.api.iiif.presentation.v2.Collection2 getSharedBookmarkListAsCollection(@PathParam("key")
 String key)
                                                                                   throws DAOException,
de.unigoettingen.sub.commons.contentlib.exceptions.ContentLibException

Throws:

DAOException

de.unigoettingen.sub.commons.contentlib.exceptions.ContentLibException

getSharedBookmarkListAsRSSJson

@GET
@Path("/shared/{key}/rss.json")
@Produces("application/json")
public Channel getSharedBookmarkListAsRSSJson(@PathParam("key")
 String key,
 @QueryParam("lang")
 String language,
 @QueryParam("max")
 Integer maxHits)
                                       throws DAOException,
RestApiException,
de.unigoettingen.sub.commons.contentlib.exceptions.ContentLibException

Throws:

DAOException

RestApiException

de.unigoettingen.sub.commons.contentlib.exceptions.ContentLibException

getSharedBookmarkListAsRSS

@GET
@Path("/shared/{key}/rss.xml")
@Produces("text/xml")
public String getSharedBookmarkListAsRSS(@PathParam("key")
 String key,
 @QueryParam("lang")
 String language,
 @QueryParam("max")
 Integer maxHits)
                                  throws DAOException,
RestApiException,
de.unigoettingen.sub.commons.contentlib.exceptions.ContentLibException

Throws:

DAOException

RestApiException

de.unigoettingen.sub.commons.contentlib.exceptions.ContentLibException