Package org.forgerock.oauth2.restlet

Class ConsentRequiredResource

java.lang.Object

org.restlet.resource.Resource

org.restlet.resource.ServerResource

org.forgerock.openam.rest.service.RouterContextResource

org.forgerock.oauth2.restlet.ConsentRequiredResource

Direct Known Subclasses:

AuthorizeResource, DeviceCodeVerificationResource

public abstract class ConsentRequiredResource
extends RouterContextResource

Handles requests to the OAuth2 authorize endpoint that require consent from the user.

Since:

12.0.0

Field Summary

Fields

Modifier and Type	Field	Description
protected BaseURLProviderFactory	baseURLProviderFactory
protected XUIState	xuiState

Constructor Summary

Constructors

Constructor	Description
ConsentRequiredResource(org.restlet.routing.Router router, BaseURLProviderFactory baseURLProviderFactory, XUIState xuiState, ResourceOwnerSessionValidator resourceOwnerSessionValidator)

Method Summary

Modifier and Type	Method	Description
protected Map<String,Object>	getDataModel(ResourceOwnerConsentRequired consentRequired, OAuth2Request request)	Gets the data model to use when rendering the error page.

Methods inherited from class org.forgerock.openam.rest.service.RouterContextResource

getContext

Methods inherited from class org.restlet.resource.ServerResource

abort, commit, delete, delete, describeVariants, doCatch, doConditionalHandle, doError, doHandle, doHandle, doHandle, doNegotiatedHandle, get, get, getAnnotation, getAnnotation, getAnnotations, getAttribute, getDescription, getInfo, getInfo, getName, getOnSent, getPreferredVariant, getRole, getVariants, getVariants, handle, hasAnnotations, head, head, isAnnotated, isAutoCommitting, isCommitted, isConditional, isExisting, isInRole, isNegotiated, options, options, patch, patch, post, post, put, put, redirectPermanent, redirectPermanent, redirectSeeOther, redirectSeeOther, redirectTemporary, redirectTemporary, setAllowedMethods, setAnnotated, setAttribute, setAutoCommitting, setChallengeRequests, setCommitted, setConditional, setCookieSettings, setDescription, setDimensions, setExisting, setLocationRef, setLocationRef, setName, setNegotiated, setOnSent, setProxyChallengeRequests, setServerInfo, setStatus, setStatus, setStatus, setStatus, updateAllowedMethods, updateDimensions

Methods inherited from class org.restlet.resource.Resource

doError, doInit, doRelease, getAllowedMethods, getApplication, getChallengeRequests, getChallengeResponse, getClientInfo, getConditions, getConnegService, getConverterService, getCookies, getCookieSettings, getDimensions, getHostRef, getLocationRef, getLogger, getMatrix, getMatrixValue, getMaxForwards, getMetadataService, getMethod, getOriginalRef, getProtocol, getProxyChallengeRequests, getProxyChallengeResponse, getQuery, getQueryValue, getRanges, getReference, getReferrerRef, getRequest, getRequestAttributes, getRequestCacheDirectives, getRequestEntity, getResponse, getResponseAttributes, getResponseCacheDirectives, getResponseEntity, getRootRef, getServerInfo, getStatus, getStatusService, init, isConfidential, isLoggable, release, setApplication, setQueryValue, setRequest, setResponse, toBoolean, toByte, toDouble, toFloat, toInteger, toLong, toObject, toRepresentation, toRepresentation, toRepresentation, toShort, toString

Methods inherited from class java.lang.Object

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

Field Detail

xuiState

protected final XUIState xuiState

baseURLProviderFactory

protected final BaseURLProviderFactory baseURLProviderFactory

Constructor Detail

ConsentRequiredResource

public ConsentRequiredResource(org.restlet.routing.Router router,
                               BaseURLProviderFactory baseURLProviderFactory,
                               XUIState xuiState,
                               ResourceOwnerSessionValidator resourceOwnerSessionValidator)

Method Detail

getDataModel

protected Map<String,Object> getDataModel(ResourceOwnerConsentRequired consentRequired,
                                                OAuth2Request request)

Gets the data model to use when rendering the error page.

Parameters:

consentRequired - The details for requesting consent.

request - The OAuth2 request.

Returns:

The data model.