Package org.apereo.cas.support.oauth.web.response.callback

Interface OAuth20AuthorizationResponseBuilder

All Superinterfaces:

org.springframework.core.Ordered

@Order
public interface OAuth20AuthorizationResponseBuilder
extends org.springframework.core.Ordered

This is OAuth20AuthorizationResponseBuilder that attempts to build the callback url with the access token, refresh token, etc as part of the authorization phase. Individual subclasses need to decide how to prepare the uri, and they are typically mapped to response types.

Since:

5.2.0

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Method Summary

Modifier and Type	Method	Description
org.springframework.web.servlet.ModelAndView	build(org.apereo.cas.support.oauth.services.OAuthRegisteredService registeredService, OAuth20ResponseModeTypes responseMode, String redirectUrl, Map<String,String> parameters)	Build response model and view.
org.springframework.web.servlet.ModelAndView	build(AccessTokenRequestContext holder)	Build.
default int	getOrder()
boolean	supports(OAuth20AuthorizationRequest context)	Supports request?
Optional<OAuth20AuthorizationRequest.OAuth20AuthorizationRequestBuilder>	toAuthorizationRequest(org.pac4j.core.context.WebContext context, org.apereo.cas.authentication.Authentication authentication, org.apereo.cas.authentication.principal.Service service, org.apereo.cas.support.oauth.services.OAuthRegisteredService registeredService)	To authorization request.

Method Details

build

org.springframework.web.servlet.ModelAndView build(org.apereo.cas.support.oauth.services.OAuthRegisteredService registeredService,
 OAuth20ResponseModeTypes responseMode,
 String redirectUrl,
 Map<String,String> parameters)
                                            throws Throwable

Build response model and view.

Parameters:

registeredService - the registered service

responseMode - the response mode

redirectUrl - the redirect url

parameters - the parameters

Returns:

the model and view

Throws:

Throwable - the throwable

build

org.springframework.web.servlet.ModelAndView build(AccessTokenRequestContext holder)
                                            throws Throwable

Build.

Parameters:

holder - the holder

Returns:

the view response

Throws:

Throwable - the throwable

supports

boolean supports(OAuth20AuthorizationRequest context)

Supports request?

Parameters:

context - the context

Returns:

true/false

getOrder

default int getOrder()

Specified by:

getOrder in interface org.springframework.core.Ordered

toAuthorizationRequest

Optional<OAuth20AuthorizationRequest.OAuth20AuthorizationRequestBuilder> toAuthorizationRequest(org.pac4j.core.context.WebContext context,
 org.apereo.cas.authentication.Authentication authentication,
 org.apereo.cas.authentication.principal.Service service,
 org.apereo.cas.support.oauth.services.OAuthRegisteredService registeredService)

To authorization request.

Parameters:

context - the context

authentication - the authentication

service - the service

registeredService - the registered service

Returns:

the o auth 20 authorization request