Package org.forgerock.openidconnect.restlet

Class EndSession

  • public class EndSession
extends org.restlet.resource.ServerResource
    Handles requests to the OpenId Connect end session endpoint for ending OpenId Connect user sessions.
    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 endSession()
      Handles GET requests to the OpenId Connect end session endpoint for ending OpenId Connect user sessions.

      • 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

      • EndSession

        @Inject
public EndSession​(OAuth2RequestFactory requestFactory,
                  OpenIDConnectEndSession openIDConnectEndSession,
                  ExceptionHandler exceptionHandler,
                  ClientRegistrationStore clientRegistrationStore)
        Constructs a new EndSession.
        Parameters:
        requestFactory - An instance of the OAuth2RequestFactory.
        openIDConnectEndSession - An instance of the OpenIDConnectEndSession.
        exceptionHandler - An instance of the ExceptionHandler.

    • Method Detail

      • endSession

        @Get
public org.restlet.representation.Representation endSession()
                                                     throws OAuth2RestletException
        Handles GET requests to the OpenId Connect end session endpoint for ending OpenId Connect user sessions.
        Returns:
        The OpenId Connect token of the session that has ended.
        Throws:
        OAuth2RestletException - If an error occurs whilst ending the users session.

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