org.apereo.cas.web

Class AbstractServiceValidateController

java.lang.Object

org.apereo.cas.web.AbstractDelegateController

org.apereo.cas.web.AbstractServiceValidateController

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

Direct Known Subclasses:

LegacyValidateController, ProxyValidateController, ServiceValidateController, V3ServiceValidateController

public abstract class AbstractServiceValidateController
extends org.apereo.cas.web.AbstractDelegateController

Process the /validate , /serviceValidate , and /proxyValidate URL requests.

Obtain the Service Ticket and Service information and present them to the CAS validation services. Receive back an Assertion containing the user Principal and (possibly) a chain of Proxy Principals. Store the Assertion in the Model and chain to a View to generate the appropriate response (CAS 1, CAS 2 XML, SAML, ...).

Since:

3.0.0

Field Summary

Fields inherited from class org.apereo.cas.web.AbstractDelegateController

applicationContext

Constructor Summary

Constructors

Constructor and Description
AbstractServiceValidateController() Instantiates a new Service validate controller.

Method Summary

Modifier and Type	Method and Description
protected java.util.Map<java.lang.String,?>	augmentSuccessViewModelObjects(org.apereo.cas.validation.Assertion assertion) Augment success view model objects.
boolean	canHandle(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
org.springframework.web.servlet.View	getFailureView() Return the failureView.
protected org.apereo.cas.authentication.Credential	getServiceCredentialsFromRequest(org.apereo.cas.authentication.principal.WebApplicationService service, javax.servlet.http.HttpServletRequest request) Overrideable method to determine which credentials to use to grant a proxy granting ticket.
org.springframework.web.servlet.View	getSuccessView() Return the successView.
protected org.springframework.web.servlet.ModelAndView	handleRequestInternal(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected org.springframework.web.servlet.ModelAndView	handleTicketValidation(javax.servlet.http.HttpServletRequest request, org.apereo.cas.authentication.principal.WebApplicationService service, java.lang.String serviceTicketId) Handle ticket validation model and view.
protected void	initBinder(javax.servlet.http.HttpServletRequest request, org.springframework.web.bind.ServletRequestDataBinder binder) Inits the binder with the required fields.
protected void	onSuccessfulValidation(java.lang.String serviceTicketId, org.apereo.cas.validation.Assertion assertion) Triggered on successful validation events.
void	setArgumentExtractor(org.apereo.cas.web.support.ArgumentExtractor argumentExtractor)
void	setAuthenticationContextValidator(org.apereo.cas.authentication.AuthenticationContextValidator authenticationContextValidator)
void	setAuthenticationSystemSupport(org.apereo.cas.authentication.AuthenticationSystemSupport authenticationSystemSupport)
void	setAuthnContextAttribute(java.lang.String authnContextAttribute)
void	setCentralAuthenticationService(org.apereo.cas.CentralAuthenticationService centralAuthenticationService)
void	setFailureView(org.springframework.web.servlet.View failureView)
void	setJsonView(org.springframework.web.servlet.View jsonView)
void	setMultifactorTriggerSelectionStrategy(org.apereo.cas.authentication.MultifactorTriggerSelectionStrategy strategy)
void	setProxyHandler(org.apereo.cas.ticket.proxy.ProxyHandler proxyHandler)
void	setServicesManager(org.apereo.cas.services.ServicesManager servicesManager) Sets the services manager.
void	setSuccessView(org.springframework.web.servlet.View successView)
void	setValidationSpecification(org.apereo.cas.validation.ValidationSpecification validationSpecificationClass)
protected org.apache.commons.lang3.tuple.Pair<java.lang.Boolean,java.util.Optional<org.apereo.cas.services.MultifactorAuthenticationProvider>>	validateAuthenticationContext(org.apereo.cas.validation.Assertion assertion, javax.servlet.http.HttpServletRequest request) Validate authentication context pair.

Methods inherited from class org.apereo.cas.web.AbstractDelegateController

setApplicationContext

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractServiceValidateController

public AbstractServiceValidateController()

Instantiates a new Service validate controller.

Method Detail

getServiceCredentialsFromRequest

protected org.apereo.cas.authentication.Credential getServiceCredentialsFromRequest(org.apereo.cas.authentication.principal.WebApplicationService service,
                                                                                    javax.servlet.http.HttpServletRequest request)

Overrideable method to determine which credentials to use to grant a proxy granting ticket. Default is to use the pgtUrl.

Parameters:

service - the webapp service requesting proxy

request - the HttpServletRequest object.

Returns:

the credentials or null if there was an error or no credentials provided.

validateAuthenticationContext

protected org.apache.commons.lang3.tuple.Pair<java.lang.Boolean,java.util.Optional<org.apereo.cas.services.MultifactorAuthenticationProvider>> validateAuthenticationContext(org.apereo.cas.validation.Assertion assertion,
                                                                                                                                                                             javax.servlet.http.HttpServletRequest request)

Validate authentication context pair.

Parameters:

assertion - the assertion

request - the request

Returns:

the pair

initBinder

protected void initBinder(javax.servlet.http.HttpServletRequest request,
                          org.springframework.web.bind.ServletRequestDataBinder binder)

Inits the binder with the required fields. renew is required.

Parameters:

request - the request

binder - the binder

handleRequestInternal

protected org.springframework.web.servlet.ModelAndView handleRequestInternal(javax.servlet.http.HttpServletRequest request,
                                                                             javax.servlet.http.HttpServletResponse response)
                                                                      throws java.lang.Exception

Specified by:

handleRequestInternal in class org.apereo.cas.web.AbstractDelegateController

Throws:

java.lang.Exception

handleTicketValidation

protected org.springframework.web.servlet.ModelAndView handleTicketValidation(javax.servlet.http.HttpServletRequest request,
                                                                              org.apereo.cas.authentication.principal.WebApplicationService service,
                                                                              java.lang.String serviceTicketId)

Handle ticket validation model and view.

Parameters:

request - the request

service - the service

serviceTicketId - the service ticket id

Returns:

the model and view

onSuccessfulValidation

protected void onSuccessfulValidation(java.lang.String serviceTicketId,
                                      org.apereo.cas.validation.Assertion assertion)

Triggered on successful validation events. Extensions are to use this as hook to plug in behavior.

Parameters:

serviceTicketId - the service ticket id

assertion - the assertion

augmentSuccessViewModelObjects

protected java.util.Map<java.lang.String,?> augmentSuccessViewModelObjects(org.apereo.cas.validation.Assertion assertion)

Augment success view model objects. Provides a way for extension of this controller to dynamically populate the model object with attributes that describe a custom nature of the validation protocol.

Parameters:

assertion - the assertion

Returns:

map of objects each keyed to a name

canHandle

public boolean canHandle(javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response)

Specified by:

canHandle in class org.apereo.cas.web.AbstractDelegateController

setCentralAuthenticationService

public void setCentralAuthenticationService(org.apereo.cas.CentralAuthenticationService centralAuthenticationService)

Parameters:

centralAuthenticationService - The centralAuthenticationService to set.

setArgumentExtractor

public void setArgumentExtractor(org.apereo.cas.web.support.ArgumentExtractor argumentExtractor)

setMultifactorTriggerSelectionStrategy

public void setMultifactorTriggerSelectionStrategy(org.apereo.cas.authentication.MultifactorTriggerSelectionStrategy strategy)

setValidationSpecification

public void setValidationSpecification(org.apereo.cas.validation.ValidationSpecification validationSpecificationClass)

Parameters:

validationSpecificationClass - The authenticationSpecificationClass to set.

setFailureView

public void setFailureView(org.springframework.web.servlet.View failureView)

Parameters:

failureView - The failureView to set.

getFailureView

public org.springframework.web.servlet.View getFailureView()

Return the failureView.

Returns:

the failureView

setSuccessView

public void setSuccessView(org.springframework.web.servlet.View successView)

Parameters:

successView - The successView to set.

getSuccessView

public org.springframework.web.servlet.View getSuccessView()

Return the successView.

Returns:

the successView

setProxyHandler

public void setProxyHandler(org.apereo.cas.ticket.proxy.ProxyHandler proxyHandler)

Parameters:

proxyHandler - The proxyHandler to set.

setServicesManager

public void setServicesManager(org.apereo.cas.services.ServicesManager servicesManager)

Sets the services manager.

Parameters:

servicesManager - the new services manager

setAuthenticationSystemSupport

public void setAuthenticationSystemSupport(org.apereo.cas.authentication.AuthenticationSystemSupport authenticationSystemSupport)

setAuthenticationContextValidator

public void setAuthenticationContextValidator(org.apereo.cas.authentication.AuthenticationContextValidator authenticationContextValidator)

setJsonView

public void setJsonView(org.springframework.web.servlet.View jsonView)

setAuthnContextAttribute

public void setAuthnContextAttribute(java.lang.String authnContextAttribute)