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

Class CollectionsResource

java.lang.Object

io.goobi.viewer.api.rest.v1.collections.CollectionsResource

@Path("/collections/{field}")
public class CollectionsResource
extends Object

REST resource for browsing collection hierarchies and retrieving collection metadata.

Author:

Florian Alpers

Constructor Summary

Constructors

Constructor	Description
CollectionsResource(String solrField, HttpServletRequest request)

Method Summary

Modifier and Type	Method	Description
List<String>	contentAssist(String input)
de.intranda.api.iiif.presentation.v2.Collection2	getAllCollections(String grouping, String ignoreString)
de.intranda.api.iiif.presentation.v2.Collection2	getCollection(String inCollectionName, String grouping, String ignoreString)

Methods inherited from class java.lang.Object

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

Constructor Details

CollectionsResource

public CollectionsResource(@PathParam("field")
 String solrField,
 @Context
 HttpServletRequest request)

Method Details

getAllCollections

@GET
@Produces("application/json")
public de.intranda.api.iiif.presentation.v2.Collection2 getAllCollections(@QueryParam("grouping")
 String grouping,
 @QueryParam("ignore")
 String ignoreString)
                                                                   throws PresentationException,
IndexUnreachableException,
de.unigoettingen.sub.commons.contentlib.exceptions.ContentLibException,
URISyntaxException,
ViewerConfigurationException

Throws:

PresentationException

IndexUnreachableException

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

URISyntaxException

ViewerConfigurationException

getCollection

@GET
@Path("/{collection}")
@Produces("application/json")
public de.intranda.api.iiif.presentation.v2.Collection2 getCollection(@PathParam("collection")
 String inCollectionName,
 @QueryParam("grouping")
 String grouping,
 @QueryParam("ignore")
 String ignoreString)
                                                               throws PresentationException,
IndexUnreachableException,
de.unigoettingen.sub.commons.contentlib.exceptions.ContentLibException,
URISyntaxException,
ViewerConfigurationException

Throws:

PresentationException

IndexUnreachableException

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

URISyntaxException

ViewerConfigurationException

contentAssist

@GET
@Path("/contentassist")
@Produces("application/json")
public List<String> contentAssist(@QueryParam("query")
 String input)
                           throws IndexUnreachableException,
de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException,
de.unigoettingen.sub.commons.contentlib.exceptions.ContentNotFoundException

Throws:

IndexUnreachableException

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

de.unigoettingen.sub.commons.contentlib.exceptions.ContentNotFoundException