de.digitalcollections.iiif.image.frontend.impl.springmvc.controller.v2

Class IIIFImageApiController

java.lang.Object

de.digitalcollections.iiif.image.frontend.impl.springmvc.controller.v2.IIIFImageApiController

@Controller(value="IIIFImageApiController-v2")
 @RequestMapping(value="/image/v2/")
public class IIIFImageApiController
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	VERSION

Constructor Summary

Constructors

Constructor and Description
IIIFImageApiController()

Method Summary

Modifier and Type	Method and Description
org.springframework.http.ResponseEntity<byte[]>	getImageRepresentation(String identifier, String region, String size, String rotation, String quality, String format, javax.servlet.http.HttpServletRequest request) see IIIF 2.0 The sequence of parameters in the URI is intended as a mnemonic for the order in which image manipulations are made against the full image content.
org.springframework.http.ResponseEntity<String>	getInfo(String identifier, javax.servlet.http.HttpServletRequest request) Specification see: http://iiif.io/api/image/2.0/#image-information
String	getInfoRedirect(String identifier)

Methods inherited from class java.lang.Object

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

Field Detail

VERSION

public static final String VERSION

See Also:

Constant Field Values

Constructor Detail

IIIFImageApiController

public IIIFImageApiController()

Method Detail

getImageRepresentation

@CrossOrigin(allowedHeaders="*",
             origins="*")
 @RequestMapping(value="{identifier}/{region}/{size}/{rotation}/{quality}.{format}")
public org.springframework.http.ResponseEntity<byte[]> getImageRepresentation(@PathVariable
                                                                                                                                                                                                                              String identifier,
                                                                                                                                                                                                                              @PathVariable
                                                                                                                                                                                                                              String region,
                                                                                                                                                                                                                              @PathVariable
                                                                                                                                                                                                                              String size,
                                                                                                                                                                                                                              @PathVariable
                                                                                                                                                                                                                              String rotation,
                                                                                                                                                                                                                              @PathVariable
                                                                                                                                                                                                                              String quality,
                                                                                                                                                                                                                              @PathVariable
                                                                                                                                                                                                                              String format,
                                                                                                                                                                                                                              javax.servlet.http.HttpServletRequest request)
                                                                                                                                                                                                                       throws ResolvingException,
                                                                                                                                                                                                                              UnsupportedFormatException,
                                                                                                                                                                                                                              UnsupportedOperationException,
                                                                                                                                                                                                                              IOException,
                                                                                                                                                                                                                              URISyntaxException,
                                                                                                                                                                                                                              InvalidParametersException,
                                                                                                                                                                                                                              TransformationException

see IIIF 2.0
The sequence of parameters in the URI is intended as a mnemonic for the order in which image manipulations are made against the full image content. This is important to consider when implementing the service because applying the same parameters in a different sequence will often result in a different image being delivered. The order is critical so that the application calling the service reliably receives the output it expects.
The parameters should be interpreted as if the the sequence of image manipulations were:
Region THEN Size THEN Rotation THEN Quality THEN Format
If the rotation parameter includes mirroring (“!”), the mirroring is applied before the rotation.

Parameters:

identifier - unique identifier of image

region - The region parameter defines the rectangular portion of the full image to be returned. Region can be specified by pixel coordinates, percentage or by the value “full”, which specifies that the entire image should be returned.

size - The size parameter determines the dimensions to which the extracted region is to be scaled.

rotation - The rotation parameter specifies mirroring and rotation. A leading exclamation mark (“!”) indicates that the image should be mirrored by reflection on the vertical axis before any rotation is applied. The numerical value represents the number of degrees of clockwise rotation, and may be any floating point number from 0 to 360.

quality - The quality parameter determines whether the image is delivered in color, grayscale or black and white.

format - The format of the returned image is expressed as an extension at the end of the URI.

request - http request

Returns:

the transformed image

Throws:

ResolvingException - if identifier can not be resolved to an image

UnsupportedFormatException - if target format is not supported

UnsupportedOperationException - if operation is not supported

IOException - if image can not be read

URISyntaxException - if uri for image is erroneous

InvalidParametersException - if parameters can not be parsed

TransformationException - if image can not be transformed

getInfo

@CrossOrigin(allowedHeaders="*",
             origins="*")
 @RequestMapping(value="{identifier}/info.json",
                method={GET,HEAD})
public org.springframework.http.ResponseEntity<String> getInfo(@PathVariable
                                                                                                                                                                                                              String identifier,
                                                                                                                                                                                                              javax.servlet.http.HttpServletRequest request)
                                                                                                                                                                                                       throws ResolvingException,
                                                                                                                                                                                                              UnsupportedFormatException,
                                                                                                                                                                                                              UnsupportedOperationException,
                                                                                                                                                                                                              UnsupportedEncodingException

Specification see: http://iiif.io/api/image/2.0/#image-information

Example response:

 {
   "@context": "http://library.stanford.edu/iiif/image-api/1.1/context.json",
   "@id": "http://iiif.example.com/prefix/1E34750D-38DB-4825-A38A-B60A345E591C",
   "width": 6000, "height": 4000
 }
 

Parameters:

identifier - - The identifier to obtain information for

request - servlet request

Returns:

The information in JSON notation

Throws:

ResolvingException - if identifier can not be resolved to an image

UnsupportedFormatException - if target format is not supported

UnsupportedOperationException

UnsupportedEncodingException

getInfoRedirect

@CrossOrigin(allowedHeaders="*",
             origins="*")
 @RequestMapping(value="{identifier}",
                method={GET,HEAD})
public String getInfoRedirect(@PathVariable
                                                                                                                                                                   String identifier)