Package org.forgerock.openidconnect.restlet

Class UserInfo

  • public class UserInfo
extends org.restlet.resource.ServerResource
    Handles requests to the OpenId Connect userinfo endpoint for retrieving information about the user who granted the authorization for the token.
    Since:
    11.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 getUserInfo​(org.restlet.representation.Representation body)
      Handles GET and POST requests to the OpenId Connect userinfo endpoint for retrieving information about the user who granted the authorization for the token.

      • 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

      • UserInfo

        @Inject
public UserInfo​(OAuth2RequestFactory requestFactory,
                UserInfoService userInfoService,
                ExceptionHandler exceptionHandler)
        Constructs a new UserInfo.
        Parameters:
        requestFactory - An instance of the OAuth2RequestFactory.
        userInfoService - An instance of the UserInfoService.
        exceptionHandler - An instance of the ExceptionHandler.

    • Method Detail

      • getUserInfo

        @Get
@Post("form:json")
public org.restlet.representation.Representation getUserInfo​(org.restlet.representation.Representation body)
                                                      throws OAuth2RestletException
        Handles GET and POST requests to the OpenId Connect userinfo endpoint for retrieving information about the user who granted the authorization for the token.
        Returns:
        The representation of the user's information.
        Throws:
        OAuth2RestletException - If an error occurs whilst retrieving the user's information.

      • 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.