org.apereo.cas.support.oauth.web.endpoints

Class OAuth20UserProfileControllerController

java.lang.Object

org.apereo.cas.support.oauth.web.endpoints.BaseOAuth20Controller

org.apereo.cas.support.oauth.web.endpoints.OAuth20UserProfileControllerController

public class OAuth20UserProfileControllerController
extends BaseOAuth20Controller

This controller returns a profile for the authenticated user (identifier + attributes), found with the access token.

Since:

3.5.0

Field Summary

Fields inherited from class org.apereo.cas.support.oauth.web.endpoints.BaseOAuth20Controller

accessTokenFactory, casProperties, principalFactory, scopeToAttributesFilter, servicesManager, ticketGrantingTicketCookieGenerator, ticketRegistry, validator, webApplicationServiceServiceFactory

Constructor Summary

Constructors

Constructor and Description

OAuth20UserProfileControllerController(org.apereo.cas.services.ServicesManager servicesManager, org.apereo.cas.ticket.registry.TicketRegistry ticketRegistry, OAuth20Validator validator, AccessTokenFactory accessTokenFactory, org.apereo.cas.authentication.principal.PrincipalFactory principalFactory, org.apereo.cas.authentication.principal.ServiceFactory<org.apereo.cas.authentication.principal.WebApplicationService> webApplicationServiceServiceFactory, OAuth20ProfileScopeToAttributesFilter scopeToAttributesFilter, org.apereo.cas.configuration.CasConfigurationProperties casProperties, org.apereo.cas.web.support.CookieRetrievingCookieGenerator cookieGenerator)

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	getAccessTokenFromRequest(javax.servlet.http.HttpServletRequest request) Gets access token from request.
org.springframework.http.ResponseEntity<java.lang.String>	handleRequest(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Handle request internal response entity.
protected java.util.Map<java.lang.String,java.lang.Object>	writeOutProfileResponse(org.apereo.cas.ticket.accesstoken.AccessToken accessToken) Write out profile response.

Methods inherited from class org.apereo.cas.support.oauth.web.endpoints.BaseOAuth20Controller

addTicketToRegistry, generateAccessToken

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OAuth20UserProfileControllerController

public OAuth20UserProfileControllerController(org.apereo.cas.services.ServicesManager servicesManager,
                                              org.apereo.cas.ticket.registry.TicketRegistry ticketRegistry,
                                              OAuth20Validator validator,
                                              AccessTokenFactory accessTokenFactory,
                                              org.apereo.cas.authentication.principal.PrincipalFactory principalFactory,
                                              org.apereo.cas.authentication.principal.ServiceFactory<org.apereo.cas.authentication.principal.WebApplicationService> webApplicationServiceServiceFactory,
                                              OAuth20ProfileScopeToAttributesFilter scopeToAttributesFilter,
                                              org.apereo.cas.configuration.CasConfigurationProperties casProperties,
                                              org.apereo.cas.web.support.CookieRetrievingCookieGenerator cookieGenerator)

Method Detail

handleRequest

@GetMapping(path="/oauth2.0/profile",
            produces="application/json")
public org.springframework.http.ResponseEntity<java.lang.String> handleRequest(javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                javax.servlet.http.HttpServletResponse response)
                                                                                                                                                         throws java.lang.Exception

Handle request internal response entity.

Parameters:

request - the request

response - the response

Returns:

the response entity

Throws:

java.lang.Exception - the exception

getAccessTokenFromRequest

protected java.lang.String getAccessTokenFromRequest(javax.servlet.http.HttpServletRequest request)

Gets access token from request.

Parameters:

request - the request

Returns:

the access token from request

writeOutProfileResponse

protected java.util.Map<java.lang.String,java.lang.Object> writeOutProfileResponse(org.apereo.cas.ticket.accesstoken.AccessToken accessToken)
                                                                            throws java.io.IOException

Write out profile response.

Parameters:

accessToken - the access token

Returns:

the linked multi value map

Throws:

java.io.IOException - the io exception