org.forgerock.openidconnect.restlet

Class OpenIDConnectCheckSessionEndpoint

java.lang.Object

org.restlet.resource.Resource

org.restlet.resource.ServerResource

org.forgerock.openidconnect.restlet.OpenIDConnectCheckSessionEndpoint

public class OpenIDConnectCheckSessionEndpoint
extends org.restlet.resource.ServerResource

Handles requests to the OpenId Connect checkSession endpoint to retrieve the status of OpenId Connect user sessions.

Constructor Summary

Constructors

Constructor and Description
OpenIDConnectCheckSessionEndpoint(OAuth2RequestFactory requestFactory, OAuth2Representation representation, CheckSession checkSession, org.restlet.routing.Router router, ExceptionHandler exceptionHandler, BaseURLProviderFactory baseURLProviderFactory) Constructs a new OpenIDConnectCheckSessionEndpoint.

Method Summary

Modifier and Type	Method and Description
org.restlet.representation.Representation	checkSession() Handles GET requests to the OpenId Connect checkSession endpoint to retrieve the status of OpenId Connect user sessions.
org.restlet.representation.Representation	checkSession(org.restlet.representation.Representation entity) Handles POST requests to the OpenId Connect checkSession endpoint.
protected void	doCatch(Throwable throwable)
org.restlet.Context	getContext()
protected Map<String,Object>	getDataModel(OAuth2Request oAuth2Request)

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

OpenIDConnectCheckSessionEndpoint

@Inject
public OpenIDConnectCheckSessionEndpoint(OAuth2RequestFactory requestFactory,
                                                 OAuth2Representation representation,
                                                 CheckSession checkSession,
                                                 @Named(value="OAuth2Router")
                                                 org.restlet.routing.Router router,
                                                 ExceptionHandler exceptionHandler,
                                                 BaseURLProviderFactory baseURLProviderFactory)

Constructs a new OpenIDConnectCheckSessionEndpoint.

Parameters:

requestFactory - An instance of the OAuth2RequestFactory.

representation - An instance of the OAuth2Representation.

checkSession - An instance of the CheckSession.

router - An instance of the Router.

exceptionHandler - An instance of the ExceptionHandler.

baseURLProviderFactory - An instance of the BaseURLProviderFactory.

Method Detail

checkSession

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

Handles GET requests to the OpenId Connect checkSession endpoint to retrieve the status of OpenId Connect user sessions.

Returns:

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

Throws:

OAuth2RestletException - If an error occurs whilst ending the users session.

checkSession

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

Handles POST requests to the OpenId Connect checkSession endpoint.

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.

getDataModel

protected Map<String,Object> getDataModel(OAuth2Request oAuth2Request)
                                   throws UnauthorizedClientException,
                                          InvalidClientException,
                                          NotFoundException

Throws:

UnauthorizedClientException

InvalidClientException

NotFoundException

doCatch

protected void doCatch(Throwable throwable)

Overrides:

doCatch in class org.restlet.resource.ServerResource

getContext

public org.restlet.Context getContext()

Overrides:

getContext in class org.restlet.resource.Resource