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

Class OAuth20AuthorizeEndpointController

java.lang.Object

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

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

public class OAuth20AuthorizeEndpointController
extends BaseOAuth20Controller

This controller is in charge of responding to the authorize call in OAuth v2 protocol. This url is protected by a CAS authentication. It returns an OAuth code or directly an access token.

Since:

3.5.0

Field Summary

Fields

Modifier and Type	Field and Description
protected OAuth20CasAuthenticationBuilder	authenticationBuilder The Authentication builder.
protected ConsentApprovalViewResolver	consentApprovalViewResolver The Consent approval view resolver.
protected java.util.Set<OAuth20AuthorizationResponseBuilder>	oauthAuthorizationResponseBuilders Collection of response builders.
protected OAuthCodeFactory	oAuthCodeFactory The code factory instance.
protected java.util.Set<OAuth20AuthorizationRequestValidator>	oauthRequestValidators Collection of request validators.
protected org.apereo.cas.audit.AuditableExecution	registeredServiceAccessStrategyEnforcer Access strategy enforcer.

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

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

Constructor Summary

Constructors

Constructor and Description

OAuth20AuthorizeEndpointController(org.apereo.cas.services.ServicesManager servicesManager, org.apereo.cas.ticket.registry.TicketRegistry ticketRegistry, AccessTokenFactory accessTokenFactory, org.apereo.cas.authentication.principal.PrincipalFactory principalFactory, org.apereo.cas.authentication.principal.ServiceFactory<org.apereo.cas.authentication.principal.WebApplicationService> webApplicationServiceServiceFactory, OAuthCodeFactory oAuthCodeFactory, ConsentApprovalViewResolver consentApprovalViewResolver, OAuth20ProfileScopeToAttributesFilter scopeToAttributesFilter, org.apereo.cas.configuration.CasConfigurationProperties casProperties, org.apereo.cas.web.support.CookieRetrievingCookieGenerator ticketGrantingTicketCookieGenerator, OAuth20CasAuthenticationBuilder authenticationBuilder, java.util.Set<OAuth20AuthorizationResponseBuilder> oauthAuthorizationResponseBuilders, java.util.Set<OAuth20AuthorizationRequestValidator> oauthRequestValidators, org.apereo.cas.audit.AuditableExecution registeredServiceAccessStrategyEnforcer)

Method Summary

Modifier and Type	Method and Description
protected org.springframework.web.servlet.View	buildAuthorizationForRequest(org.apereo.cas.support.oauth.services.OAuthRegisteredService registeredService, org.pac4j.core.context.J2EContext context, java.lang.String clientId, org.apereo.cas.authentication.principal.Service service, org.apereo.cas.authentication.Authentication authentication) Build callback url for request string.
protected org.apereo.cas.support.oauth.services.OAuthRegisteredService	getRegisteredServiceByClientId(java.lang.String clientId) Gets registered service by client id.
org.springframework.web.servlet.ModelAndView	handleRequest(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Handle request via GET.
org.springframework.web.servlet.ModelAndView	handleRequestPost(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Handle request post.
protected org.springframework.web.servlet.ModelAndView	redirectToCallbackRedirectUrl(org.pac4j.core.profile.ProfileManager manager, org.apereo.cas.support.oauth.services.OAuthRegisteredService registeredService, org.pac4j.core.context.J2EContext context, java.lang.String clientId) Redirect to callback redirect url model and view.

Methods inherited from class java.lang.Object

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

Field Detail

oAuthCodeFactory

protected final OAuthCodeFactory oAuthCodeFactory

The code factory instance.

consentApprovalViewResolver

protected final ConsentApprovalViewResolver consentApprovalViewResolver

The Consent approval view resolver.

authenticationBuilder

protected final OAuth20CasAuthenticationBuilder authenticationBuilder

The Authentication builder.

oauthAuthorizationResponseBuilders

protected final java.util.Set<OAuth20AuthorizationResponseBuilder> oauthAuthorizationResponseBuilders

Collection of response builders.

oauthRequestValidators

protected final java.util.Set<OAuth20AuthorizationRequestValidator> oauthRequestValidators

Collection of request validators.

registeredServiceAccessStrategyEnforcer

protected final org.apereo.cas.audit.AuditableExecution registeredServiceAccessStrategyEnforcer

Access strategy enforcer.

Constructor Detail

OAuth20AuthorizeEndpointController

public OAuth20AuthorizeEndpointController(org.apereo.cas.services.ServicesManager servicesManager,
                                          org.apereo.cas.ticket.registry.TicketRegistry ticketRegistry,
                                          AccessTokenFactory accessTokenFactory,
                                          org.apereo.cas.authentication.principal.PrincipalFactory principalFactory,
                                          org.apereo.cas.authentication.principal.ServiceFactory<org.apereo.cas.authentication.principal.WebApplicationService> webApplicationServiceServiceFactory,
                                          OAuthCodeFactory oAuthCodeFactory,
                                          ConsentApprovalViewResolver consentApprovalViewResolver,
                                          OAuth20ProfileScopeToAttributesFilter scopeToAttributesFilter,
                                          org.apereo.cas.configuration.CasConfigurationProperties casProperties,
                                          org.apereo.cas.web.support.CookieRetrievingCookieGenerator ticketGrantingTicketCookieGenerator,
                                          OAuth20CasAuthenticationBuilder authenticationBuilder,
                                          java.util.Set<OAuth20AuthorizationResponseBuilder> oauthAuthorizationResponseBuilders,
                                          java.util.Set<OAuth20AuthorizationRequestValidator> oauthRequestValidators,
                                          org.apereo.cas.audit.AuditableExecution registeredServiceAccessStrategyEnforcer)

Method Detail

handleRequest

@GetMapping(path="/oauth2.0/authorize")
public org.springframework.web.servlet.ModelAndView handleRequest(javax.servlet.http.HttpServletRequest request,
                                                                                                           javax.servlet.http.HttpServletResponse response)
                                                                                                    throws java.lang.Exception

Handle request via GET.

Parameters:

request - the request

response - the response

Returns:

the model and view

Throws:

java.lang.Exception - the exception

handleRequestPost

@PostMapping(path="/oauth2.0/authorize")
public org.springframework.web.servlet.ModelAndView handleRequestPost(javax.servlet.http.HttpServletRequest request,
                                                                                                                javax.servlet.http.HttpServletResponse response)
                                                                                                         throws java.lang.Exception

Handle request post.

Parameters:

request - the request

response - the response

Returns:

the model and view

Throws:

java.lang.Exception - the exception

getRegisteredServiceByClientId

protected org.apereo.cas.support.oauth.services.OAuthRegisteredService getRegisteredServiceByClientId(java.lang.String clientId)

Gets registered service by client id.

Parameters:

clientId - the client id

Returns:

the registered service by client id

redirectToCallbackRedirectUrl

protected org.springframework.web.servlet.ModelAndView redirectToCallbackRedirectUrl(org.pac4j.core.profile.ProfileManager manager,
                                                                                     org.apereo.cas.support.oauth.services.OAuthRegisteredService registeredService,
                                                                                     org.pac4j.core.context.J2EContext context,
                                                                                     java.lang.String clientId)

Redirect to callback redirect url model and view.

Parameters:

manager - the manager

registeredService - the registered service

context - the context

clientId - the client id

Returns:

the model and view

buildAuthorizationForRequest

protected org.springframework.web.servlet.View buildAuthorizationForRequest(org.apereo.cas.support.oauth.services.OAuthRegisteredService registeredService,
                                                                            org.pac4j.core.context.J2EContext context,
                                                                            java.lang.String clientId,
                                                                            org.apereo.cas.authentication.principal.Service service,
                                                                            org.apereo.cas.authentication.Authentication authentication)

Build callback url for request string.

Parameters:

registeredService - the registered service

context - the context

clientId - the client id

service - the service

authentication - the authentication

Returns:

the string