Uses of Class
io.goobi.viewer.exceptions.RestApiException

Packages that use RestApiException

Package	Description
io.goobi.viewer.api.rest.exceptions	JAX-RS exception mappers that translate application and web exceptions into structured HTTP error responses for the REST API.
io.goobi.viewer.api.rest.model	Shared data transfer objects and helper classes used across REST API versions, including generic request parameters, response wrappers, and user-facing model facades.
io.goobi.viewer.api.rest.resourcebuilders	Builder classes that assemble REST response payloads for complex resources such as annotations, IIIF manifests, bibliographic text, table of contents, and bookmarks.
io.goobi.viewer.api.rest.v1.bookmarks	REST resources for managing bookmark lists in the v1 API, supporting both session-based and user-account-based bookmark collections.

Uses of RestApiException in io.goobi.viewer.api.rest.exceptions

Methods in io.goobi.viewer.api.rest.exceptions with parameters of type RestApiException

Modifier and Type	Method	Description
Response	RestApiExceptionMapper.toResponse(RestApiException exception)

Uses of RestApiException in io.goobi.viewer.api.rest.model

Constructors in io.goobi.viewer.api.rest.model with parameters of type RestApiException

Modifier	Constructor	Description
	ErrorMessage(RestApiException exception)	Creates a new ErrorMessage instance.

Uses of RestApiException in io.goobi.viewer.api.rest.resourcebuilders

Methods in io.goobi.viewer.api.rest.resourcebuilders that throw RestApiException

Modifier and Type	Method	Description
abstract SuccessMessage	AbstractBookmarkResourceBuilder.addBookmarkList()
abstract SuccessMessage	AbstractBookmarkResourceBuilder.addBookmarkList(String name)
SuccessMessage	SessionBookmarkResourceBuilder.addBookmarkList()
SuccessMessage	SessionBookmarkResourceBuilder.addBookmarkList(String name)
SuccessMessage	UserBookmarkResourceBuilder.addBookmarkList()	Adds a new BookmarkList with the given name to the current users bookmark lists.
SuccessMessage	UserBookmarkResourceBuilder.addBookmarkList(String name)	Adds a new BookmarkList with the given name to the current users bookmark lists.
abstract SuccessMessage	AbstractBookmarkResourceBuilder.addBookmarkToBookmarkList(Long id, String pi)
abstract SuccessMessage	AbstractBookmarkResourceBuilder.addBookmarkToBookmarkList(Long id, String pi, String logId, String pageString)
SuccessMessage	SessionBookmarkResourceBuilder.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	SessionBookmarkResourceBuilder.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.
SuccessMessage	UserBookmarkResourceBuilder.addBookmarkToBookmarkList(Long id, String pi)	Adds a new Bookmark with the given pi to the current users bookmark list with the given id.
SuccessMessage	UserBookmarkResourceBuilder.addBookmarkToBookmarkList(Long id, String pi, String logId, String pageString)	Adds a new Bookmark with the given pi, LOGID and page number to the current user's bookmark list with the given id.
SuccessMessage	UserBookmarkResourceBuilder.addUserBookmarkListFromSession(HttpSession session)	Adds the current session bookmark list to the current user bookmark lists under a newly generated name.
SuccessMessage	UserBookmarkResourceBuilder.addUserBookmarkListFromSession(String name, HttpSession session)	Adds the current session bookmark list to the current user's bookmark lists under the given name.
Integer	SessionBookmarkResourceBuilder.countSessionBookmarks()	Counts the items contained in the session store bookmark list and returns the number as plain integer.
Long	UserBookmarkResourceBuilder.countUserBookmarks(Long id)	Counts the items contained in the current user's bookmark list with the given id and returns the number as plain integer.
abstract SuccessMessage	AbstractBookmarkResourceBuilder.deleteBookmarkFromBookmarkList(Long id, String pi)
abstract SuccessMessage	AbstractBookmarkResourceBuilder.deleteBookmarkFromBookmarkList(Long id, String pi, String logId, String pageString)
SuccessMessage	SessionBookmarkResourceBuilder.deleteBookmarkFromBookmarkList(Long id, String pi)	Deletes the bookmark with the given pi from the session store bookmark list.
SuccessMessage	SessionBookmarkResourceBuilder.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	UserBookmarkResourceBuilder.deleteBookmarkFromBookmarkList(Long id, String pi)	Removes a Bookmark with the given pi from the current users bookmark list with the given id.
SuccessMessage	UserBookmarkResourceBuilder.deleteBookmarkFromBookmarkList(Long id, String pi, String logId, String pageString)	Removes a Bookmark with the given pi, logid and page number from the current users bookmark list with the given id.
abstract SuccessMessage	AbstractBookmarkResourceBuilder.deleteBookmarkList(Long id)
SuccessMessage	SessionBookmarkResourceBuilder.deleteBookmarkList(Long id)
SuccessMessage	UserBookmarkResourceBuilder.deleteBookmarkList(Long id)	Deletes the current user's bookmark list with the given id.
SuccessMessage	SessionBookmarkResourceBuilder.deleteSessionBookmarkList()	Deletes the entry bookmark list from the session store.
abstract List<BookmarkList>	AbstractBookmarkResourceBuilder.getAllBookmarkLists()
List<BookmarkList>	SessionBookmarkResourceBuilder.getAllBookmarkLists()	Returns the session stored bookmark list, creating a new empty one if needed.
List<BookmarkList>	UserBookmarkResourceBuilder.getAllBookmarkLists()	Returns all BookmarkList owned by the current user.
List<BookmarkList>	AbstractBookmarkResourceBuilder.getAllPublicBookmarkLists()	Returns all public bookmark lists.
abstract de.intranda.api.iiif.presentation.v2.Collection2	AbstractBookmarkResourceBuilder.getAsCollection(Long id, AbstractApiUrlManager urls)
de.intranda.api.iiif.presentation.v2.Collection2	SessionBookmarkResourceBuilder.getAsCollection(Long id, AbstractApiUrlManager urls)
de.intranda.api.iiif.presentation.v2.Collection2	UserBookmarkResourceBuilder.getAsCollection(Long id, AbstractApiUrlManager urls)	getAsCollection.
abstract BookmarkList	AbstractBookmarkResourceBuilder.getBookmarkListById(Long id)
BookmarkList	SessionBookmarkResourceBuilder.getBookmarkListById(Long id)
BookmarkList	UserBookmarkResourceBuilder.getBookmarkListById(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.
abstract String	AbstractBookmarkResourceBuilder.getBookmarkListForMirador(Long id, AbstractApiUrlManager urls)
String	SessionBookmarkResourceBuilder.getBookmarkListForMirador(Long id, AbstractApiUrlManager urls)	Returns the session stored bookmark list, creating a new empty one if needed.
String	UserBookmarkResourceBuilder.getBookmarkListForMirador(Long id, AbstractApiUrlManager urls)	Returns the user bookmark list with the given ID.
List<BookmarkList>	UserBookmarkResourceBuilder.getContainingUserBookmarkLists(String pi)	Returns the bookmark list containing the object with the given pi if is contained in any bookmark list of the current user.
List<BookmarkList>	UserBookmarkResourceBuilder.getContainingUserBookmarkLists(String pi, String logId, String pageString)	Returns the bookmark list containing the object with the given pi, logid and page number if is contained in any bookmark list of the current user.
BookmarkList	AbstractBookmarkResourceBuilder.getSharedBookmarkList(String shareKey)
BookmarkList	SessionBookmarkResourceBuilder.getSharedBookmarkList(String shareKey)
BookmarkList	SessionBookmarkResourceBuilder.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	SessionBookmarkResourceBuilder.isInSessionBookmarkList(String pi)	Returns "true" if the object with the given IP is in the session store bookmark list, "false" otherwise.
Boolean	SessionBookmarkResourceBuilder.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.

Uses of RestApiException in io.goobi.viewer.api.rest.v1.bookmarks

Methods in io.goobi.viewer.api.rest.v1.bookmarks that throw RestApiException

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