Class InformationResource

java.lang.Object

is.galia.resource.AbstractResource

is.galia.resource.AbstractImageResource

is.galia.resource.deepzoom.InformationResource

All Implemented Interfaces:

Resource

public class InformationResource
extends AbstractImageResource
implements Resource

Handles requests for DZI image descriptions.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_URI_PATH	Path that will be used if not overridden by Key.DEEPZOOM_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
void	doGET()	Must be overridden by implementations that support GET.
void	doInit()	Initialization method, called after all necessary setters have been called but before any request handler method (like AbstractResource.doGET() etc.)
Identifier	getIdentifier()	Returns the identifier of the source image, which may be a filename, an object store key, or something else.
protected String	getIdentifierPathComponent()	Returns the first path argument, which is always an identifier.
protected org.slf4j.Logger	getLogger()
protected MetaIdentifier	getMetaIdentifier()	Returns the decoded meta-identifier path component of the URI, which may include page number or other information.
protected Reference	getPublicReference(MetaIdentifier newMetaIdentifier)	Variant of AbstractResource.getPublicReference() that replaces the identifier path component's meta-identifier if an identifier path component is available.
Set<Route>	getRoutes()	Part of the Resource contract.
static String	getURIPath()

Methods inherited from class is.galia.resource.AbstractImageResource

authorize, authorizeBeforeAccess, 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, 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.DEEPZOOM_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

getPublicReference

protected Reference getPublicReference(MetaIdentifier newMetaIdentifier)

Description copied from class: AbstractImageResource

Variant of AbstractResource.getPublicReference() that replaces the identifier path component's meta-identifier if an identifier path component is available.

Specified by:

getPublicReference in class AbstractImageResource

Parameters:

newMetaIdentifier - Meta-identifier.

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.

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.

Specified by:

doInit in interface Resource

Throws:

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

doGET

public void doGET()
           throws Exception

Description copied from class: AbstractResource

Must be overridden by implementations that support GET.

Overrides must not call super.

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()

getURIPath

public static String getURIPath()

Returns:

URI path prefix without trailing slash.

getIdentifier

public Identifier getIdentifier()

Description copied from class: AbstractImageResource

Returns the identifier of the source image, which may be a filename, an object store key, or something else.

Specified by:

getIdentifier in class AbstractImageResource

Returns:

The identifier of the source image.

getIdentifierPathComponent

protected String getIdentifierPathComponent()

Returns the first path argument, which is always an identifier.

The result is not decoded and may be a meta-identifier. If so, it is not usable without additional processing.

Returns:

Identifier, or null if no path arguments are available.

getMetaIdentifier

protected MetaIdentifier getMetaIdentifier()

Description copied from class: AbstractImageResource

Returns the decoded meta-identifier path component of the URI, which may include page number or other information. (This may not be the path component that the client supplies or sees.)

Specified by:

getMetaIdentifier in class AbstractImageResource

Returns:

Instance corresponding to the first path argument, or null if no path arguments are available.

See Also:

• AbstractImageResource.getIdentifier()