Package io.goobi.viewer.api.rest.v2.auth

Class AuthorizationFlowResource

java.lang.Object

io.goobi.viewer.api.rest.v2.auth.AuthorizationFlowResource

@Path("/auth")
public class AuthorizationFlowResource
extends Object

REST resource handling IIIF Access Control Service authorization flows and probe requests.

Constructor Summary

Constructors

Constructor	Description
AuthorizationFlowResource(HttpServletRequest request)

Method Summary

Modifier and Type	Method	Description
Response	accessTokenService(String messageId, String origin)	Token service.
String	generateCookie()
de.intranda.api.iiif.auth.v2.AuthProbeService2	getServiceDescription()	For testing purposes.
Response	handleProbePreflight(String pi, int order, String origin)
Response	handleProbePreflight(String pi, String filename, String origin)
Response	handleProbePreflightRecordResource(String pi, String privilege, String origin)	Probe pre-flight endpoint for general record related resources.
Response	handleProbePreflightStructureResource(String pi, String logId, String privilege, String origin)	Probe pre-flight endpoint for general record related resources.
Response	loginService(String origin)	Access (login) service.
Response	logout()
Response	probeRecordResource(String pi, String privilege, String origin)	Probe service endpoint for general record related resources.
Response	probeRecordStructureResource(String pi, String logId, String privilege, String origin)	Probe service endpoint for general record related resources.
Response	probeResource(String pi, int order, String origin)	Probe service endpoint (page PDF).
Response	probeResource(String pi, String origin)	Probe service endpoint (METS resolver).
Response	probeResource(String pi, String filename, String origin)	Probe service endpoint (image and text).

Methods inherited from class java.lang.Object

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

Constructor Details

AuthorizationFlowResource

public AuthorizationFlowResource(@Context
 HttpServletRequest request)

Method Details

getServiceDescription

@GET
@Produces("application/json")
public de.intranda.api.iiif.auth.v2.AuthProbeService2 getServiceDescription()

For testing purposes.

Returns:

AuthProbeService2

loginService

@GET
@Path("/login")
@Produces("text/html")
public Response loginService(@QueryParam("origin")
 String origin)

Access (login) service.

Parameters:

origin - Mandatory origin parameter from the client

Returns:

Response

accessTokenService

@GET
@Path("/token")
@Produces("text/html")
public Response accessTokenService(@QueryParam("messageId")
 String messageId,
 @QueryParam("origin")
 String origin)
                            throws com.fasterxml.jackson.core.JsonProcessingException

Token service. Issues a bearer token, if conditions are met.

Parameters:

messageId - Client-generated message ID; Must be included in the response

origin - Mandatory origin parameter from the client

Returns:

Response

Throws:

com.fasterxml.jackson.core.JsonProcessingException

handleProbePreflight

@OPTIONS
@Path("/probe/{pi}/{filename}")
@Produces("application/json")
public Response handleProbePreflight(@PathParam("pi")
 String pi,
 @PathParam("filename")
 String filename,
 @HeaderParam("Origin")
 String origin)

Parameters:

pi - Record identifier

filename - Content file name

origin - Client origin

Returns:

Response

probeResource

@GET
@Path("/probe/{pi}/{filename}")
@Produces("application/json")
public Response probeResource(@PathParam("pi")
 String pi,
 @PathParam("filename")
 String filename,
 @HeaderParam("Origin")
 String origin)
                       throws com.fasterxml.jackson.core.JsonProcessingException

Probe service endpoint (image and text). The session will probably be different here from previous login/token queries.

Parameters:

pi - record identifier

filename - name of the content file to check access for

origin - value of the HTTP Origin header from the client request

Returns:

Response

Throws:

com.fasterxml.jackson.core.JsonProcessingException

handleProbePreflight

@OPTIONS
@Path("/probe/pdf/{pi}/{page}")
@Produces("application/json")
public Response handleProbePreflight(@PathParam("pi")
 String pi,
 @PathParam("order")
 int order,
 @HeaderParam("Origin")
 String origin)

Parameters:

pi - Record identifier

order - Page number

origin - Client origin

Returns:

Response

probeResource

@GET
@Path("/probe/pdf/{pi}/{page}")
@Produces("application/json")
public Response probeResource(@PathParam("pi")
 String pi,
 @PathParam("order")
 int order,
 @HeaderParam("Origin")
 String origin)
                       throws com.fasterxml.jackson.core.JsonProcessingException

Probe service endpoint (page PDF). The session will probably be different here from previous login/token queries.

Parameters:

pi - Record identifier

order - Page number

origin - HTTP Origin header value for CORS

Returns:

Response

Throws:

com.fasterxml.jackson.core.JsonProcessingException

probeResource

@GET
@Path("/probe/resolver/{pi}")
@Produces("application/json")
public Response probeResource(@PathParam("pi")
 String pi,
 @HeaderParam("Origin")
 String origin)
                       throws com.fasterxml.jackson.core.JsonProcessingException

Probe service endpoint (METS resolver). The session will probably be different here from previous login/token queries.

Parameters:

pi - Record identifier

origin - Client origin

Returns:

Response

Throws:

com.fasterxml.jackson.core.JsonProcessingException

handleProbePreflightRecordResource

@OPTIONS
@Path("/probe/{pi}/privilege/{privilege}")
@Produces("application/json")
public Response handleProbePreflightRecordResource(@PathParam("pi")
 String pi,
 @PathParam("privilege")
 String privilege,
 @HeaderParam("Origin")
 String origin)

Probe pre-flight endpoint for general record related resources.

Parameters:

pi - Record identifier

privilege - name of the privilege to check

origin - Client origin

Returns:

Response

probeRecordResource

@GET
@Path("/probe/{pi}/privilege/{privilege}")
@Produces("application/json")
public Response probeRecordResource(@PathParam("pi")
 String pi,
 @PathParam("privilege")
 String privilege,
 @HeaderParam("Origin")
 String origin)
                             throws com.fasterxml.jackson.core.JsonProcessingException

Probe service endpoint for general record related resources.

Parameters:

pi - Record identifier

privilege - The privilege to check

origin - Client origin

Returns:

Response

Throws:

com.fasterxml.jackson.core.JsonProcessingException

handleProbePreflightStructureResource

@OPTIONS
@Path("/probe/{pi}/section/{logid}/privilege/{privilege}")
@Produces("application/json")
public Response handleProbePreflightStructureResource(@PathParam("pi")
 String pi,
 @PathParam("logid")
 String logId,
 @PathParam("privilege")
 String privilege,
 @HeaderParam("Origin")
 String origin)

Probe pre-flight endpoint for general record related resources.

Parameters:

pi - Record identifier

logId - structure log id

privilege - privilege to check

origin - Client origin

Returns:

Response

probeRecordStructureResource

@GET
@Path("/probe/{pi}/section/{logid}/privilege/{privilege}")
@Produces("application/json")
public Response probeRecordStructureResource(@PathParam("pi")
 String pi,
 @PathParam("logid")
 String logId,
 @PathParam("privilege")
 String privilege,
 @HeaderParam("Origin")
 String origin)
                                      throws com.fasterxml.jackson.core.JsonProcessingException

Probe service endpoint for general record related resources.

Parameters:

pi - Record identifier

logId - LOGID

privilege - The privilege to check

origin - Client origin

Returns:

Response

Throws:

com.fasterxml.jackson.core.JsonProcessingException

logout

@GET
@Path("/logout")
@Produces("application/json")
public Response logout()

generateCookie

public String generateCookie()

Returns:

Cookie as string