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

Class BaseOAuth20Controller

java.lang.Object

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

Direct Known Subclasses:

OAuth20AccessTokenEndpointController, OAuth20AuthorizeEndpointController, OAuth20CallbackAuthorizeEndpointController, OAuth20UserProfileControllerController

@Controller
public abstract class BaseOAuth20Controller
extends java.lang.Object

This controller is the base controller for wrapping OAuth protocol in CAS.

Since:

3.5.0

Field Summary

Fields

Modifier and Type	Field and Description
protected AccessTokenFactory	accessTokenFactory The Access token factory.
protected org.apereo.cas.configuration.CasConfigurationProperties	casProperties Collection of CAS settings.
protected org.apereo.cas.authentication.principal.PrincipalFactory	principalFactory The Principal factory.
protected OAuth20ProfileScopeToAttributesFilter	scopeToAttributesFilter Convert profile scopes to attributes.
protected org.apereo.cas.services.ServicesManager	servicesManager Services manager.
protected org.apereo.cas.web.support.CookieRetrievingCookieGenerator	ticketGrantingTicketCookieGenerator Cookie retriever.
protected org.apereo.cas.ticket.registry.TicketRegistry	ticketRegistry The Ticket registry.
protected OAuth20Validator	validator The Validator.
protected org.apereo.cas.authentication.principal.ServiceFactory<org.apereo.cas.authentication.principal.WebApplicationService>	webApplicationServiceServiceFactory The Web application service service factory.

Constructor Summary

Constructors

Constructor and Description

BaseOAuth20Controller(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 ticketGrantingTicketCookieGenerator) Instantiates a new Base o auth 20 controller.

Method Summary

Modifier and Type	Method and Description
protected void	addTicketToRegistry(org.apereo.cas.ticket.OAuthToken ticket, org.apereo.cas.ticket.TicketGrantingTicket ticketGrantingTicket) Add ticket to registry.
protected org.apereo.cas.ticket.accesstoken.AccessToken	generateAccessToken(AccessTokenRequestDataHolder responseHolder) Generate an access token from a service and authentication.

Methods inherited from class java.lang.Object

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

Field Detail

casProperties

protected final org.apereo.cas.configuration.CasConfigurationProperties casProperties

Collection of CAS settings.

scopeToAttributesFilter

protected final OAuth20ProfileScopeToAttributesFilter scopeToAttributesFilter

Convert profile scopes to attributes.

servicesManager

protected final org.apereo.cas.services.ServicesManager servicesManager

Services manager.

ticketGrantingTicketCookieGenerator

protected final org.apereo.cas.web.support.CookieRetrievingCookieGenerator ticketGrantingTicketCookieGenerator

Cookie retriever.

ticketRegistry

protected final org.apereo.cas.ticket.registry.TicketRegistry ticketRegistry

The Ticket registry.

validator

protected final OAuth20Validator validator

The Validator.

accessTokenFactory

protected final AccessTokenFactory accessTokenFactory

The Access token factory.

principalFactory

protected final org.apereo.cas.authentication.principal.PrincipalFactory principalFactory

The Principal factory.

webApplicationServiceServiceFactory

protected final org.apereo.cas.authentication.principal.ServiceFactory<org.apereo.cas.authentication.principal.WebApplicationService> webApplicationServiceServiceFactory

The Web application service service factory.

Constructor Detail

BaseOAuth20Controller

public BaseOAuth20Controller(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 ticketGrantingTicketCookieGenerator)

Instantiates a new Base o auth 20 controller.

Parameters:

servicesManager - the services manager

ticketRegistry - the ticket registry

validator - the validator

accessTokenFactory - the access token factory

principalFactory - the principal factory

webApplicationServiceServiceFactory - the web application service service factory

scopeToAttributesFilter - the scope to attributes filter

casProperties - the cas properties

ticketGrantingTicketCookieGenerator - the ticket granting ticket cookie generator

Method Detail

generateAccessToken

protected org.apereo.cas.ticket.accesstoken.AccessToken generateAccessToken(AccessTokenRequestDataHolder responseHolder)

Generate an access token from a service and authentication.

Parameters:

responseHolder - the response holder

Returns:

an access token

addTicketToRegistry

protected void addTicketToRegistry(org.apereo.cas.ticket.OAuthToken ticket,
                                   org.apereo.cas.ticket.TicketGrantingTicket ticketGrantingTicket)

Add ticket to registry.

Parameters:

ticket - the ticket

ticketGrantingTicket - the ticket granting ticket