Package org.forgerock.oauth2.restlet

Class AuthorizeResource

java.lang.Object

org.restlet.resource.Resource

org.restlet.resource.ServerResource

org.forgerock.openam.rest.service.RouterContextResource

org.forgerock.oauth2.restlet.ConsentRequiredResource

org.forgerock.oauth2.restlet.AuthorizeResource

public class AuthorizeResource
extends ConsentRequiredResource

Handles requests to the OAuth2 authorize endpoint.

Since:

12.0.0

Field Summary

Fields inherited from class org.forgerock.oauth2.restlet.ConsentRequiredResource

baseURLProviderFactory, xuiState

Constructor Summary

Constructors

Constructor

Description

AuthorizeResource(OAuth2RequestFactory requestFactory, AuthorizationService authorizationService, ExceptionHandler exceptionHandler, OAuth2Representation representation, Set<AuthorizeRequestHook> hooks, XUIState xuiState, org.restlet.routing.Router router, BaseURLProviderFactory baseURLProviderFactory, RedirectUriResolver redirectUriResolver, ResourceOwnerSessionValidator resourceOwnerSessionValidator)

Constructs a new AuthorizeResource.

Method Summary

Modifier and Type	Method	Description
org.restlet.representation.Representation	authorize()	Handles GET requests to the OAuth2 authorize endpoint.
org.restlet.representation.Representation	authorize(org.restlet.representation.Representation entity)	Handles POST requests to the OAuth2 authorize endpoint.
protected void	doCatch(Throwable throwable)	Handles any exception that is thrown when processing a OAuth2 authorization request.

Methods inherited from class org.forgerock.oauth2.restlet.ConsentRequiredResource

getDataModel

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

getContext

Methods inherited from class org.restlet.resource.ServerResource

abort, commit, delete, delete, describeVariants, 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

Constructor Detail

AuthorizeResource

@Inject
public AuthorizeResource(OAuth2RequestFactory requestFactory,
                         AuthorizationService authorizationService,
                         ExceptionHandler exceptionHandler,
                         OAuth2Representation representation,
                         Set<AuthorizeRequestHook> hooks,
                         XUIState xuiState,
                         @Named("OAuth2Router")
                         org.restlet.routing.Router router,
                         BaseURLProviderFactory baseURLProviderFactory,
                         RedirectUriResolver redirectUriResolver,
                         ResourceOwnerSessionValidator resourceOwnerSessionValidator)

Constructs a new AuthorizeResource.

Parameters:

requestFactory - An instance of the OAuth2RequestFactory.

authorizationService - An instance of the AuthorizationService.

exceptionHandler - An instance of the ExceptionHandler.

representation - An instance of the OAuth2Representation.

Method Detail

authorize

@Get
public org.restlet.representation.Representation authorize()
                                                    throws OAuth2RestletException

Handles GET requests to the OAuth2 authorize endpoint.
This method will be called when a client has requested a resource owner grants it authorization to access a resource.

Returns:

The body to be sent in the response to the user agent.

Throws:

OAuth2RestletException - If a OAuth2 error occurs whilst processing the authorization request.

authorize

@Post
public org.restlet.representation.Representation authorize(org.restlet.representation.Representation entity)
                                                    throws OAuth2RestletException

Handles POST requests to the OAuth2 authorize endpoint.
This method will be called when a user has given their consent for an authorization request.

Parameters:

entity - The entity on the request.

Returns:

The body to be sent in the response to the user agent.

Throws:

OAuth2RestletException - If a OAuth2 error occurs whilst processing the authorization request.

doCatch

protected void doCatch(Throwable throwable)

Handles any exception that is thrown when processing a OAuth2 authorization request.

Overrides:

doCatch in class org.restlet.resource.ServerResource

Parameters:

throwable - The throwable.