Class InformationResource

java.lang.Object

is.galia.resource.AbstractResource

is.galia.resource.AbstractImageResource

is.galia.resource.iiif.IIIFResource

is.galia.resource.iiif.v3.InformationResource

All Implemented Interfaces:

Resource

public class InformationResource
extends IIIFResource
implements Resource

Handles IIIF Image API 3.x information requests.

See Also:

• Image Information Requests

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_URI_PATH	Path that will be used if not overridden by Key.IIIF_3_ENDPOINT_PATH in the application configuration.

Fields inherited from class is.galia.resource.AbstractResource

PUBLIC_IDENTIFIER_HEADER

Constructor Summary

Constructors

Constructor	Description
InformationResource()

Method Summary

Modifier and Type	Method	Description
protected boolean	authorize()	Uses an Authorizer to determine how to respond to the request.
protected boolean	authorizeBeforeAccess()	Uses an Authorizer to determine how to respond to the request.
void	doGET()	Writes a JSON-serialized information instance to the response.
void	doInit()	Initialization method, called after all necessary setters have been called but before any request handler method (like AbstractResource.doGET() etc.)
protected org.slf4j.Logger	getLogger()
Set<Route>	getRoutes()	Part of the Resource contract.
static String	getURIPath()

Methods inherited from class is.galia.resource.iiif.IIIFResource

constrainSizeToMaxPixels, getIdentifier, getIdentifierPathComponent, getMetaIdentifier, getPublicIdentifier, getPublicReference, handleAuthInfoForInfoRequest, setLastModifiedHeader, validateScale

Methods inherited from class is.galia.resource.AbstractImageResource

getPageIndex, handleAuthInfo, isBypassingCache, isBypassingCacheRead, redirectToNormalizedScaleConstraint

Methods inherited from class is.galia.resource.AbstractResource

authenticateUsingBasic, decodePathComponent, destroy, doDELETE, doHEAD, doOPTIONS, doPATCH, doPOST, doPUT, getCanonicalClientIPAddress, getCommonTemplateVars, getDelegate, getLocalBasePath, getPreferredMediaTypes, getPublicReference, getPublicRootReference, getRepresentationDisposition, getRequest, getRequestContext, getResponse, negotiateContentType, setRequest, setResponse

Methods inherited from class java.lang.Object

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

Methods inherited from interface is.galia.resource.Resource

destroy, doDELETE, doHEAD, doInit, doOPTIONS, doPATCH, doPOST, doPUT, getRequest, getResponse, setRequest, setResponse

Field Details

DEFAULT_URI_PATH

public static final String DEFAULT_URI_PATH

Path that will be used if not overridden by Key.IIIF_3_ENDPOINT_PATH in the application configuration.

See Also:

• Constant Field Values

Constructor Details

InformationResource

public InformationResource()

Method Details

getLogger

protected org.slf4j.Logger getLogger()

Specified by:

getLogger in class AbstractResource

getRoutes

public Set<Route> getRoutes()

Description copied from class: AbstractResource

Part of the Resource contract.

Specified by:

getRoutes in interface Resource

Specified by:

getRoutes in class AbstractResource

Returns:

All routes to which the instance responds.

doGET

public void doGET()
           throws Exception

Writes a JSON-serialized information instance to the response.

Specified by:

doGET in interface Resource

Overrides:

doGET in class AbstractResource

Throws:

Exception - upon any error. This may be a ResourceException to enable a custom status.

See Also:

• AbstractResource.doGET()

authorize

protected boolean authorize()
                     throws IOException,
ResourceException

Description copied from class: AbstractImageResource

Uses an Authorizer to determine how to respond to the request. The response is modified if necessary.

The authorization system supports simple boolean authorization which maps to the HTTP 200 and 403 statuses.

Authorization can simultaneously be used in the context of the IIIF Authentication API, where it works a little differently. Here, HTTP 401 is returned instead of 403, and the response body does include image information. (See Interaction with Access-Controlled Resources. This means that IIIF information endpoints should swallow any ResourceExceptions with HTTP 401 status.

Overrides:

authorize in class AbstractImageResource

Returns:

Whether authorization was successful. false indicates a redirect, and client code should abort.

Throws:

IOException - if there was an I/O error while checking authorization.

ResourceException - if authorization resulted in an HTTP 400-level response.

authorizeBeforeAccess

protected boolean authorizeBeforeAccess()
                                 throws IOException,
ResourceException

Description copied from class: AbstractImageResource

Uses an Authorizer to determine how to respond to the request. The response is modified if necessary.

The authorization system supports simple boolean authorization which maps to the HTTP 200 and 403 statuses.

Authorization can simultaneously be used in the context of the IIIF Authentication API, where it works a little differently. Here, HTTP 401 is returned instead of 403, and the response body does include image information. (See Interaction with Access-Controlled Resources. This means that IIIF information endpoints should swallow any ResourceExceptions with HTTP 401 status.

Overrides:

authorizeBeforeAccess in class AbstractImageResource

Returns:

Whether authorization was successful. false indicates a redirect, and client code should abort.

Throws:

IOException - if there was an I/O error while checking authorization.

ResourceException - if authorization resulted in an HTTP 400-level response.

getURIPath

public static String getURIPath()

Returns:

URI path prefix without trailing slash.

doInit

public void doInit()
            throws Exception

Description copied from class: AbstractResource

Initialization method, called after all necessary setters have been called but before any request handler method (like AbstractResource.doGET() etc.)

If an implementation class has anything to do with image identifiers, it should add the request identifier to the request context.

Overrides must call super.

Overrides:

doInit in class IIIFResource

Throws:

Exception - upon any error. This may be a ResourceException to enable a custom status.