org.apereo.cas.support.oauth.web.response.accesstoken.ext

Class AccessTokenAuthorizationCodeGrantRequestExtractor

java.lang.Object

org.apereo.cas.support.oauth.web.response.accesstoken.ext.BaseAccessTokenGrantRequestExtractor

org.apereo.cas.support.oauth.web.response.accesstoken.ext.AccessTokenAuthorizationCodeGrantRequestExtractor

Direct Known Subclasses:

AccessTokenRefreshTokenGrantRequestExtractor

public class AccessTokenAuthorizationCodeGrantRequestExtractor
extends BaseAccessTokenGrantRequestExtractor

This is AccessTokenAuthorizationCodeGrantRequestExtractor.

Since:

5.1.0

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apereo.cas.authentication.principal.ServiceFactory<org.apereo.cas.authentication.principal.WebApplicationService>	webApplicationServiceServiceFactory Service factory instance.

Fields inherited from class org.apereo.cas.support.oauth.web.response.accesstoken.ext.BaseAccessTokenGrantRequestExtractor

centralAuthenticationService, oAuthProperties, servicesManager, ticketRegistry

Constructor Summary

Constructors

Constructor and Description

AccessTokenAuthorizationCodeGrantRequestExtractor(org.apereo.cas.services.ServicesManager servicesManager, org.apereo.cas.ticket.registry.TicketRegistry ticketRegistry, org.apereo.cas.CentralAuthenticationService centralAuthenticationService, org.apereo.cas.configuration.model.support.oauth.OAuthProperties oAuthProperties, org.apereo.cas.authentication.principal.ServiceFactory<org.apereo.cas.authentication.principal.WebApplicationService> webApplicationServiceServiceFactory)

Method Summary

Modifier and Type	Method and Description
AccessTokenRequestDataHolder	extract(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Extract access token request for grant.
OAuth20GrantTypes	getGrantType() Gets grant type.
protected java.lang.String	getOAuthParameter(javax.servlet.http.HttpServletRequest request) Gets o auth parameter.
protected java.lang.String	getOAuthParameterName()
protected org.apereo.cas.support.oauth.services.OAuthRegisteredService	getOAuthRegisteredServiceBy(javax.servlet.http.HttpServletRequest request) Gets oauth registered service from the request.
protected org.apereo.cas.ticket.OAuthToken	getOAuthTokenFromRequest(javax.servlet.http.HttpServletRequest request) Return the OAuth token.
protected java.lang.String	getRegisteredServiceIdentifierFromRequest(javax.servlet.http.HttpServletRequest request) Gets registered service identifier from request.
protected boolean	isAllowedToGenerateRefreshToken() Is allowed to generate refresh token ?
boolean	supports(javax.servlet.http.HttpServletRequest context) Supports the grant type?

Methods inherited from class java.lang.Object

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

Field Detail

webApplicationServiceServiceFactory

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

Service factory instance.

Constructor Detail

AccessTokenAuthorizationCodeGrantRequestExtractor

public AccessTokenAuthorizationCodeGrantRequestExtractor(org.apereo.cas.services.ServicesManager servicesManager,
                                                         org.apereo.cas.ticket.registry.TicketRegistry ticketRegistry,
                                                         org.apereo.cas.CentralAuthenticationService centralAuthenticationService,
                                                         org.apereo.cas.configuration.model.support.oauth.OAuthProperties oAuthProperties,
                                                         org.apereo.cas.authentication.principal.ServiceFactory<org.apereo.cas.authentication.principal.WebApplicationService> webApplicationServiceServiceFactory)

Method Detail

extract

public AccessTokenRequestDataHolder extract(javax.servlet.http.HttpServletRequest request,
                                            javax.servlet.http.HttpServletResponse response)

Description copied from class: BaseAccessTokenGrantRequestExtractor

Extract access token request for grant.

Specified by:

extract in class BaseAccessTokenGrantRequestExtractor

Parameters:

request - the request

response - the response

Returns:

the access token request data holder

getRegisteredServiceIdentifierFromRequest

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

Gets registered service identifier from request.

Parameters:

request - the request

Returns:

the registered service identifier from request

isAllowedToGenerateRefreshToken

protected boolean isAllowedToGenerateRefreshToken()

Is allowed to generate refresh token ?

Returns:

the boolean

getOAuthParameterName

protected java.lang.String getOAuthParameterName()

getOAuthParameter

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

Gets o auth parameter.

Parameters:

request - the request

Returns:

the o auth parameter

getOAuthTokenFromRequest

protected org.apereo.cas.ticket.OAuthToken getOAuthTokenFromRequest(javax.servlet.http.HttpServletRequest request)

Return the OAuth token.

Parameters:

request - the request

Returns:

the OAuth token

supports

public boolean supports(javax.servlet.http.HttpServletRequest context)

Supports the grant type?

Specified by:

supports in class BaseAccessTokenGrantRequestExtractor

Parameters:

context - the context

Returns:

true/false

getGrantType

public OAuth20GrantTypes getGrantType()

Description copied from class: BaseAccessTokenGrantRequestExtractor

Gets grant type.

Specified by:

getGrantType in class BaseAccessTokenGrantRequestExtractor

Returns:

the grant type

getOAuthRegisteredServiceBy

protected org.apereo.cas.support.oauth.services.OAuthRegisteredService getOAuthRegisteredServiceBy(javax.servlet.http.HttpServletRequest request)

Gets oauth registered service from the request. Implementation attempts to locate the redirect uri from request and check with service registry to find a matching oauth service.

Parameters:

request - the request

Returns:

the registered service