Package org.forgerock.oauth2.restlet

Class TokenEndpointResource

  • public class TokenEndpointResource
extends org.restlet.resource.ServerResource
    Handles requests to the OAuth2 token endpoint for requesting access tokens.
    Since:
    12.0.0

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void doCatch​(Throwable throwable)
      Handles any exception that is thrown when processing a OAuth2 authorization request.
      org.restlet.representation.Representation token​(org.restlet.representation.Representation entity)
      Handles POST requests to the OAuth2 token endpoint for the access token grant types (i.e. authorization_code, client credentials, password).

      • 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, getContext, 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

    • Constructor Detail

      • TokenEndpointResource

        @Inject
public TokenEndpointResource​(OAuth2RequestFactory requestFactory,
                             AccessTokenService accessTokenService,
                             ExceptionHandler exceptionHandler,
                             Set<TokenRequestHook> hooks,
                             JacksonRepresentationFactory jacksonRepresentationFactory)
        Constructs a new instance of the TokenEndpointResource.
        Parameters:
        requestFactory - An instance of the OAuth2RequestFactory.
        accessTokenService - An instance of the AccessTokenService.
        exceptionHandler - An instance of the ExceptionHandler.
        jacksonRepresentationFactory - The factory to use for JacksonRepresentation instances.

    • Method Detail

      • token

        @Post
public org.restlet.representation.Representation token​(org.restlet.representation.Representation entity)
                                                throws OAuth2RestletException
        Handles POST requests to the OAuth2 token endpoint for the access token grant types (i.e. authorization_code, client credentials, password).
        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 refresh token 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.