Package de.digitalcollections.iiif.model.auth

Class AccessCookieService

java.lang.Object

de.digitalcollections.iiif.model.Service

de.digitalcollections.iiif.model.auth.AccessCookieService

public class AccessCookieService
extends Service

The client uses this service to obtain a cookie that will be used when interacting with content such as images, and with the access token service.

There are several different interaction patterns in which the client will use this service, based on the user interface that must be rendered for the user, indicated by a profile URI. The client obtains the link to the access cookie service from a service block in a description of the protected resource.

See http://iiif.io/api/auth/1.0/#access-cookie-service

Field Summary

Fields

Modifier and Type	Field	Description
static String	CONTEXT

Constructor Summary

Constructors

Constructor	Description
AccessCookieService(String identifier, AuthPattern pattern)
AccessCookieService(URI identifier, AuthPattern pattern)	Create a new access cookie service from an (optional) identifier and an authentication pattern.

Method Summary

Modifier and Type	Method	Description
void	addService(AuthService first, AuthService... rest)
AuthPattern	getAuthPattern()
PropertyValue	getConfirmLabel()
String	getConfirmLabelString()
PropertyValue	getDescription()
String	getDescriptionString()
PropertyValue	getFailureDescription()
String	getFailureDescriptionString()
PropertyValue	getFailureHeader()
String	getFailureHeaderString()
PropertyValue	getHeader()
String	getHeaderString()
List<AuthService>	getServices()
void	setConfirmLabel(PropertyValue confirmLabel)
void	setConfirmLabel(String label)
void	setDescription(PropertyValue description)
void	setDescription(String description)
void	setFailureDescription(PropertyValue failureDescription)
void	setFailureDescription(String failureDescription)
void	setFailureHeader(PropertyValue failureHeader)
void	setFailureHeader(String failureHeader)
void	setHeader(PropertyValue header)
void	setHeader(String header)
void	setServices(List<AuthService> services)

Methods inherited from class de.digitalcollections.iiif.model.Service

addProfile, addProfile, getContext, getIdentifier, getLabel, getLabelString, getProfiles, setContext, setIdentifier, setLabel, setLabel, setProfiles

Methods inherited from class java.lang.Object

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

Field Detail

CONTEXT

public static final String CONTEXT

See Also:

Constant Field Values

Constructor Detail

AccessCookieService

public AccessCookieService(String identifier,
                           AuthPattern pattern)

AccessCookieService

public AccessCookieService(URI identifier,
                           AuthPattern pattern)
                    throws IllegalArgumentException

Create a new access cookie service from an (optional) identifier and an authentication pattern.

Parameters:

identifier - (optional) identifier

pattern - authentication pattern

Throws:

IllegalArgumentException - If the auth pattern is not "external" and no identifier is provided.

Method Detail

getAuthPattern

public AuthPattern getAuthPattern()

getConfirmLabel

public PropertyValue getConfirmLabel()

getConfirmLabelString

public String getConfirmLabelString()

setConfirmLabel

public void setConfirmLabel(PropertyValue confirmLabel)

setConfirmLabel

public void setConfirmLabel(String label)

getHeader

public PropertyValue getHeader()

getHeaderString

public String getHeaderString()

setHeader

public void setHeader(PropertyValue header)

setHeader

public void setHeader(String header)

getDescription

public PropertyValue getDescription()

getDescriptionString

public String getDescriptionString()

setDescription

public void setDescription(PropertyValue description)

setDescription

public void setDescription(String description)

getFailureHeader

public PropertyValue getFailureHeader()

getFailureHeaderString

public String getFailureHeaderString()

setFailureHeader

public void setFailureHeader(PropertyValue failureHeader)

setFailureHeader

public void setFailureHeader(String failureHeader)

getFailureDescription

public PropertyValue getFailureDescription()

getFailureDescriptionString

public String getFailureDescriptionString()

setFailureDescription

public void setFailureDescription(PropertyValue failureDescription)

setFailureDescription

public void setFailureDescription(String failureDescription)

getServices

public List<AuthService> getServices()

setServices

public void setServices(List<AuthService> services)

addService

public void addService(AuthService first,
                       AuthService... rest)