Package io.goobi.viewer.api.rest.resourcebuilders

Class SessionBookmarkResourceBuilder

java.lang.Object

io.goobi.viewer.api.rest.resourcebuilders.AbstractBookmarkResourceBuilder

io.goobi.viewer.api.rest.resourcebuilders.SessionBookmarkResourceBuilder

public class SessionBookmarkResourceBuilder
extends AbstractBookmarkResourceBuilder

REST resource builder for bookmark lists stored in the HTTP session. Provides bookmark list operations for unauthenticated users whose bookmarks are held transiently in the current session rather than persisted in the database.

Constructor Summary

Constructors

Constructor	Description
SessionBookmarkResourceBuilder(HttpSession session)

Method Summary

Modifier and Type	Method	Description
SuccessMessage	addBookmarkList()
SuccessMessage	addBookmarkList(String name)
SuccessMessage	addBookmarkToBookmarkList(Long id, String pi)	Adds an item with the given pi to the session stored bookmark list, creating a new bookmark list if needed.
SuccessMessage	addBookmarkToBookmarkList(Long id, String pi, String logId, String pageString)	Adds an item with the given pi, logid and page number to the session stored bookmark list, creating a new bookmark list if needed.
Integer	countSessionBookmarks()	Counts the items contained in the session store bookmark list and returns the number as plain integer.
de.intranda.api.iiif.presentation.v2.Collection2	createCollection(BookmarkList list, AbstractApiUrlManager urls)
SuccessMessage	deleteBookmarkFromBookmarkList(Long id, String pi)	Deletes the bookmark with the given pi from the session store bookmark list.
SuccessMessage	deleteBookmarkFromBookmarkList(Long id, String pi, String logId, String pageString)	Deletes the bookmark with the given pi, logid and page number from the session store bookmark list.
SuccessMessage	deleteBookmarkList(Long id)
SuccessMessage	deleteSessionBookmarkList()	Deletes the entry bookmark list from the session store.
List<BookmarkList>	getAllBookmarkLists()	Returns the session stored bookmark list, creating a new empty one if needed.
de.intranda.api.iiif.presentation.v2.Collection2	getAsCollection(Long id, AbstractApiUrlManager urls)
BookmarkList	getBookmarkListById(Long id)
String	getBookmarkListForMirador(Long id, AbstractApiUrlManager urls)	Returns the session stored bookmark list, creating a new empty one if needed.
BookmarkList	getSharedBookmarkList(String shareKey)
BookmarkList	getUserBookmarkListById(Long id)	Returns the bookmark list with the given id, provided it is owned by the user or it is public or shared to him.
Boolean	isInSessionBookmarkList(String pi)	Returns "true" if the object with the given IP is in the session store bookmark list, "false" otherwise.
Boolean	isInSessionBookmarkList(String pi, String logId, String pageString)	Returns "true" if the object with the given IP, logid and page number is in the session store bookmark list, "false" otherwise.
void	updateBookmarkList(BookmarkList list)

Methods inherited from class io.goobi.viewer.api.rest.resourcebuilders.AbstractBookmarkResourceBuilder

createCollection, getAllPublicBookmarkLists, getAsCollection, getPageOrder, getSharedBookmarkListForMirador

Methods inherited from class java.lang.Object

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

Constructor Details

SessionBookmarkResourceBuilder

public SessionBookmarkResourceBuilder(HttpSession session)

Method Details

getAllBookmarkLists

public List<BookmarkList> getAllBookmarkLists()
                                       throws DAOException,
IOException,
RestApiException

Returns the session stored bookmark list, creating a new empty one if needed.

Specified by:

getAllBookmarkLists in class AbstractBookmarkResourceBuilder

Returns:

a singleton list containing the session-stored bookmark list

Throws:

DAOException - if any.

IOException - if any.

RestApiException - if any.

getBookmarkListForMirador

public String getBookmarkListForMirador(Long id,
 AbstractApiUrlManager urls)
                                 throws DAOException,
IOException,
RestApiException,
ViewerConfigurationException,
IndexUnreachableException,
PresentationException

Returns the session stored bookmark list, creating a new empty one if needed.

Specified by:

getBookmarkListForMirador in class AbstractBookmarkResourceBuilder

Parameters:

id - ignored; session has only one bookmark list

urls - URL manager used to build application and API URLs

Returns:

the Mirador-compatible JSON representation of the session bookmark list, or an empty string if no list exists

Throws:

DAOException - if any.

IOException - if any.

RestApiException - if any.

ViewerConfigurationException - if any.

IndexUnreachableException - if any.

PresentationException - if any.

addBookmarkToBookmarkList

public SuccessMessage addBookmarkToBookmarkList(Long id,
 String pi)
                                         throws DAOException,
IOException,
RestApiException

Adds an item with the given pi to the session stored bookmark list, creating a new bookmark list if needed.

Specified by:

addBookmarkToBookmarkList in class AbstractBookmarkResourceBuilder

Parameters:

id - ignored; session has only one bookmark list

pi - persistent identifier of the record to bookmark

Returns:

a SuccessMessage indicating whether the bookmark was successfully added to the session list

Throws:

DAOException - if any.

IOException - if any.

RestApiException - if any.

addBookmarkToBookmarkList

public SuccessMessage addBookmarkToBookmarkList(Long id,
 String pi,
 String logId,
 String pageString)
                                         throws DAOException,
IOException,
RestApiException

Adds an item with the given pi, logid and page number to the session stored bookmark list, creating a new bookmark list if needed.

Specified by:

addBookmarkToBookmarkList in class AbstractBookmarkResourceBuilder

Parameters:

id - ignored; session has only one bookmark list

pi - persistent identifier of the record to bookmark

logId - structural element log ID, or "-" to indicate none

pageString - page order number as string, may be null

Returns:

a SuccessMessage indicating whether the bookmark was successfully added to the session list

Throws:

DAOException - if any.

IOException - if any.

RestApiException - if any.

deleteBookmarkFromBookmarkList

public SuccessMessage deleteBookmarkFromBookmarkList(Long id,
 String pi)
                                              throws DAOException,
IOException,
RestApiException

Deletes the bookmark with the given pi from the session store bookmark list. This operation returns an object with the property "success: false" if the operation failed (usually because the object wasn't in the bookmark list to begin with). Otherwise the return object contains "success: true"

Specified by:

deleteBookmarkFromBookmarkList in class AbstractBookmarkResourceBuilder

Parameters:

id - ignored; session has only one bookmark list

pi - persistent identifier of the record to remove

Returns:

an object containing the boolean property 'success', detailing whether the operation was successful

Throws:

DAOException - if any.

IOException - if any.

RestApiException - if any.

deleteBookmarkFromBookmarkList

public SuccessMessage deleteBookmarkFromBookmarkList(Long id,
 String pi,
 String logId,
 @PathParam("page")
 String pageString)
                                              throws DAOException,
IOException,
RestApiException

Deletes the bookmark with the given pi, logid and page number from the session store bookmark list. This operation returns an object with the property "success: false" if the operation failed (usually because the object wasn't in the bookmark list to begin with). Otherwise the return object contains "success: true"

Specified by:

deleteBookmarkFromBookmarkList in class AbstractBookmarkResourceBuilder

Parameters:

id - ignored; session has only one bookmark list

pi - persistent identifier of the record to remove

logId - structural element log ID, or "-" to indicate none

pageString - page order number as string, may be null

Returns:

an object containing the boolean property 'success', detailing whether the operation was successful

Throws:

DAOException - if any.

IOException - if any.

RestApiException - if any.

deleteSessionBookmarkList

public SuccessMessage deleteSessionBookmarkList()
                                         throws RestApiException

Deletes the entry bookmark list from the session store. Always returns an object with the property "success: true", unless an error occurs in which case an error status code and an error object is returned

Returns:

a SuccessMessage with success set to true if the session bookmark list was deleted successfully

Throws:

RestApiException - if any.

isInSessionBookmarkList

public Boolean isInSessionBookmarkList(String pi)
                                throws DAOException,
IOException,
RestApiException

Returns "true" if the object with the given IP is in the session store bookmark list, "false" otherwise.

Parameters:

pi - persistent identifier of the record to look up

Returns:

true if the record with the given PI is in the session bookmark list, false otherwise

Throws:

DAOException - if any.

IOException - if any.

RestApiException - if any.

isInSessionBookmarkList

public Boolean isInSessionBookmarkList(String pi,
 String logId,
 String pageString)
                                throws DAOException,
IOException,
RestApiException

Returns "true" if the object with the given IP, logid and page number is in the session store bookmark list, "false" otherwise.

Parameters:

pi - persistent identifier of the record to look up

logId - structural element log ID, or "-" to indicate none

pageString - page order number as string, may be null

Returns:

true if the specified item is in the session bookmark list, false otherwise

Throws:

DAOException - if any.

IOException - if any.

RestApiException - if any.

countSessionBookmarks

public Integer countSessionBookmarks()
                              throws RestApiException

Counts the items contained in the session store bookmark list and returns the number as plain integer. If no session store bookmark list exists, 0 is returned

Returns:

the number of items in the session bookmark list, or 0 if no list exists

Throws:

RestApiException - if any.

getUserBookmarkListById

public BookmarkList getUserBookmarkListById(Long id)
                                     throws DAOException,
IOException,
RestApiException

Returns the bookmark list with the given id, provided it is owned by the user or it is public or shared to him.

Parameters:

id - database ID of the requested bookmark list

Returns:

the publicly accessible BookmarkList with the given database ID

Throws:

DAOException - if any.

IOException - if any.

RestApiException - if any.

getSharedBookmarkList

public BookmarkList getSharedBookmarkList(String shareKey)
                                   throws DAOException,
RestApiException,
de.unigoettingen.sub.commons.contentlib.exceptions.ContentNotFoundException

Overrides:

getSharedBookmarkList in class AbstractBookmarkResourceBuilder

Parameters:

shareKey - the share key identifying the bookmark list

Returns:

BookmarkList that match shareKey

Throws:

DAOException - If an error occurred talking to the database

RestApiException - If no user session exists or if the user has no access to the requested list

de.unigoettingen.sub.commons.contentlib.exceptions.ContentNotFoundException - If no list with the given key was found

createCollection

public de.intranda.api.iiif.presentation.v2.Collection2 createCollection(BookmarkList list,
 AbstractApiUrlManager urls)

Specified by:

createCollection in class AbstractBookmarkResourceBuilder

addBookmarkList

public SuccessMessage addBookmarkList()
                               throws DAOException,
IOException,
RestApiException,
de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException

Specified by:

addBookmarkList in class AbstractBookmarkResourceBuilder

Throws:

DAOException

IOException

RestApiException

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

addBookmarkList

public SuccessMessage addBookmarkList(String name)
                               throws DAOException,
IOException,
RestApiException,
de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException

Specified by:

addBookmarkList in class AbstractBookmarkResourceBuilder

Throws:

DAOException

IOException

RestApiException

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

getBookmarkListById

public BookmarkList getBookmarkListById(Long id)
                                 throws DAOException,
IOException,
RestApiException

Specified by:

getBookmarkListById in class AbstractBookmarkResourceBuilder

Throws:

DAOException

IOException

RestApiException

updateBookmarkList

public void updateBookmarkList(BookmarkList list)
                        throws de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException

Specified by:

updateBookmarkList in class AbstractBookmarkResourceBuilder

Parameters:

list - the bookmark list to update

Throws:

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

deleteBookmarkList

public SuccessMessage deleteBookmarkList(Long id)
                                  throws DAOException,
IOException,
RestApiException,
de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException

Specified by:

deleteBookmarkList in class AbstractBookmarkResourceBuilder

Throws:

DAOException

IOException

RestApiException

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

getAsCollection

public de.intranda.api.iiif.presentation.v2.Collection2 getAsCollection(Long id,
 AbstractApiUrlManager urls)
                                                                 throws DAOException,
RestApiException,
IOException

Specified by:

getAsCollection in class AbstractBookmarkResourceBuilder

Throws:

DAOException

RestApiException

IOException