org.apereo.cas.services.web.view

Class AbstractCasView

java.lang.Object

org.springframework.context.support.ApplicationObjectSupport

org.springframework.web.context.support.WebApplicationObjectSupport

org.springframework.web.servlet.view.AbstractView

org.apereo.cas.services.web.view.AbstractCasView

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.context.ApplicationContextAware, org.springframework.web.context.ServletContextAware, org.springframework.web.servlet.View

Direct Known Subclasses:

AbstractDelegatingCasView, AbstractSaml10ResponseView, Cas10ResponseView

public abstract class AbstractCasView
extends org.springframework.web.servlet.view.AbstractView

Abstract class to handle retrieving the Assertion from the model.

Since:

3.1

Field Summary

Fields

Modifier and Type	Field and Description
protected CasAttributeEncoder	casAttributeEncoder The attribute encoder instance.
protected org.slf4j.Logger	logger Logger instance.
protected ServicesManager	servicesManager The Services manager.
protected boolean	successResponse Indicate whether this view will be generating the success response or not.

Fields inherited from class org.springframework.web.servlet.view.AbstractView

DEFAULT_CONTENT_TYPE

Fields inherited from interface org.springframework.web.servlet.View

PATH_VARIABLES, RESPONSE_STATUS_ATTRIBUTE, SELECTED_CONTENT_TYPE

Constructor Summary

Constructors

Constructor and Description
AbstractCasView()

Method Summary

Modifier and Type	Method and Description
protected void	decideAttributeReleaseBasedOnServiceAttributePolicy(java.util.Map<java.lang.String,java.lang.Object> attributes, java.lang.String attributeValue, java.lang.String attributeName, RegisteredService service, boolean doesAttributePolicyAllow) Decide attribute release based on service attribute policy.
protected void	decideIfCredentialPasswordShouldBeReleasedAsAttribute(java.util.Map<java.lang.String,java.lang.Object> attributes, java.util.Map<java.lang.String,java.lang.Object> model, RegisteredService service) Decide if credential password should be released as attribute.
protected void	decideIfProxyGrantingTicketShouldBeReleasedAsAttribute(java.util.Map<java.lang.String,java.lang.Object> attributes, java.util.Map<java.lang.String,java.lang.Object> model, RegisteredService service) Decide if PGT should be released as attribute.
protected Assertion	getAssertionFrom(java.util.Map<java.lang.String,java.lang.Object> model) Gets the assertion from the model.
protected java.lang.String	getAuthenticationAttribute(java.util.Map<java.lang.String,java.lang.Object> model, java.lang.String attributeName) Gets an authentication attribute from the primary authentication object.
protected java.util.Map<java.lang.String,java.lang.Object>	getAuthenticationAttributes(java.util.Map<java.lang.String,java.lang.Object> model) Gets authentication attributes from the primary authentication object.
protected java.util.Map<java.lang.String,java.lang.Object>	getAuthenticationAttributesAsMultiValuedAttributes(java.util.Map<java.lang.String,java.lang.Object> model) Gets authentication attributes.
java.lang.String	getAuthenticationContextAttribute()
protected java.time.ZonedDateTime	getAuthenticationDate(java.util.Map<java.lang.String,java.lang.Object> model) Gets authentication date.
CasAttributeEncoder	getCasAttributeEncoder()
protected java.util.Collection<Authentication>	getChainedAuthentications(java.util.Map<java.lang.String,java.lang.Object> model) Gets chained authentications.
protected java.lang.String	getErrorCodeFrom(java.util.Map<java.lang.String,java.lang.Object> model) Gets error code from.
protected java.lang.String	getErrorDescriptionFrom(java.util.Map<java.lang.String,java.lang.Object> model) Gets error description from.
protected java.util.Map<java.lang.String,java.lang.Object>	getModelAttributes(java.util.Map<java.lang.String,java.lang.Object> model) Gets model attributes.
protected Authentication	getPrimaryAuthenticationFrom(java.util.Map<java.lang.String,java.lang.Object> model) Gets the authentication from the model.
protected Principal	getPrincipal(java.util.Map<java.lang.String,java.lang.Object> model) Gets the principal from the model.
protected java.util.Map<java.lang.String,java.lang.Object>	getPrincipalAttributesAsMultiValuedAttributes(java.util.Map<java.lang.String,java.lang.Object> model) Gets principal attributes.
protected java.lang.String	getProxyGrantingTicketId(java.util.Map<java.lang.String,java.lang.Object> model) Gets the PGT from the model.
protected java.lang.String	getProxyGrantingTicketIou(java.util.Map<java.lang.String,java.lang.Object> model) Gets the PGT-IOU from the model.
protected java.util.Optional<MultifactorAuthenticationProvider>	getSatisfiedMultifactorAuthenticationProvider(java.util.Map<java.lang.String,java.lang.Object> model) Gets satisfied multifactor authentication provider.
protected Service	getServiceFrom(java.util.Map<java.lang.String,java.lang.Object> model) Gets validated service from the model.
ServicesManager	getServicesManager()
protected boolean	isAssertionBackedByNewLogin(java.util.Map<java.lang.String,java.lang.Object> model) Is assertion backed by new login?
protected boolean	isRememberMeAuthentication(java.util.Map<java.lang.String,java.lang.Object> model) Is remember me authentication? looks at the authentication object to find RememberMeCredential.AUTHENTICATION_ATTRIBUTE_REMEMBER_ME and expects the assertion to also note a new login session.
protected void	putAllIntoModel(java.util.Map<java.lang.String,java.lang.Object> model, java.util.Map<java.lang.String,java.lang.Object> values) Put all into model.
protected void	putIntoModel(java.util.Map<java.lang.String,java.lang.Object> model, java.lang.String key, java.lang.Object value) Put into model.
void	setAuthenticationContextAttribute(java.lang.String authenticationContextAttribute)
void	setCasAttributeEncoder(CasAttributeEncoder casAttributeEncoder)
void	setServicesManager(ServicesManager servicesManager)
void	setSuccessResponse(boolean successResponse)

Methods inherited from class org.springframework.web.servlet.view.AbstractView

addStaticAttribute, createMergedOutputModel, createRequestContext, createTemporaryOutputStream, exposeModelAsRequestAttributes, generatesDownloadContent, getAttributesMap, getBeanName, getContentType, getRequestContextAttribute, getRequestToExpose, getStaticAttributes, isExposePathVariables, prepareResponse, render, renderMergedOutputModel, setAttributes, setAttributesCSV, setAttributesMap, setBeanName, setContentType, setExposeContextBeansAsAttributes, setExposedContextBeanNames, setExposePathVariables, setRequestContextAttribute, setResponseContentType, toString, writeToResponse

Methods inherited from class org.springframework.web.context.support.WebApplicationObjectSupport

getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, initServletContext, isContextRequired, setServletContext

Methods inherited from class org.springframework.context.support.ApplicationObjectSupport

getApplicationContext, getMessageSourceAccessor, initApplicationContext, requiredContextClass, setApplicationContext

Methods inherited from class java.lang.Object

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

Field Detail

successResponse

protected boolean successResponse

Indicate whether this view will be generating the success response or not. By default, the view is treated as a failure.

casAttributeEncoder

protected CasAttributeEncoder casAttributeEncoder

The attribute encoder instance.

servicesManager

protected ServicesManager servicesManager

The Services manager.

logger

protected transient org.slf4j.Logger logger

Logger instance.

Constructor Detail

AbstractCasView

public AbstractCasView()

Method Detail

getAssertionFrom

protected Assertion getAssertionFrom(java.util.Map<java.lang.String,java.lang.Object> model)

Gets the assertion from the model.

Parameters:

model - the model

Returns:

the assertion from

getErrorCodeFrom

protected java.lang.String getErrorCodeFrom(java.util.Map<java.lang.String,java.lang.Object> model)

Gets error code from.

Parameters:

model - the model

Returns:

the error code from

getErrorDescriptionFrom

protected java.lang.String getErrorDescriptionFrom(java.util.Map<java.lang.String,java.lang.Object> model)

Gets error description from.

Parameters:

model - the model

Returns:

the error description from

getProxyGrantingTicketId

protected java.lang.String getProxyGrantingTicketId(java.util.Map<java.lang.String,java.lang.Object> model)

Gets the PGT from the model.

Parameters:

model - the model

Returns:

the pgt id

getProxyGrantingTicketIou

protected java.lang.String getProxyGrantingTicketIou(java.util.Map<java.lang.String,java.lang.Object> model)

Gets the PGT-IOU from the model.

Parameters:

model - the model

Returns:

the pgt-iou id

getPrimaryAuthenticationFrom

protected Authentication getPrimaryAuthenticationFrom(java.util.Map<java.lang.String,java.lang.Object> model)

Gets the authentication from the model.

Parameters:

model - the model

Returns:

the assertion from

Since:

4.1.0

getModelAttributes

protected java.util.Map<java.lang.String,java.lang.Object> getModelAttributes(java.util.Map<java.lang.String,java.lang.Object> model)

Gets model attributes.

Parameters:

model - the model

Returns:

the model attributes

getAuthenticationAttributes

protected java.util.Map<java.lang.String,java.lang.Object> getAuthenticationAttributes(java.util.Map<java.lang.String,java.lang.Object> model)

Gets authentication attributes from the primary authentication object.

Parameters:

model - the model

Returns:

the authentication attribute

getAuthenticationAttribute

protected java.lang.String getAuthenticationAttribute(java.util.Map<java.lang.String,java.lang.Object> model,
                                                      java.lang.String attributeName)

Gets an authentication attribute from the primary authentication object.

Parameters:

model - the model

attributeName - the attribute name

Returns:

the authentication attribute

getPrincipal

protected Principal getPrincipal(java.util.Map<java.lang.String,java.lang.Object> model)

Gets the principal from the model.

Parameters:

model - the model

Returns:

the assertion from

Since:

4.1.0

getPrincipalAttributesAsMultiValuedAttributes

protected java.util.Map<java.lang.String,java.lang.Object> getPrincipalAttributesAsMultiValuedAttributes(java.util.Map<java.lang.String,java.lang.Object> model)

Gets principal attributes. Single-valued attributes are converted to a collection so the review can easily loop through all.

Parameters:

model - the model

Returns:

the attributes

Since:

4.1.0

See Also:

convertAttributeValuesToMultiValuedObjects(java.util.Map)

getAuthenticationAttributesAsMultiValuedAttributes

protected java.util.Map<java.lang.String,java.lang.Object> getAuthenticationAttributesAsMultiValuedAttributes(java.util.Map<java.lang.String,java.lang.Object> model)

Gets authentication attributes. Single-valued attributes are converted to a collection so the review can easily loop through all.

Parameters:

model - the model

Returns:

the attributes

Since:

4.1.0

See Also:

convertAttributeValuesToMultiValuedObjects(java.util.Map)

isRememberMeAuthentication

protected boolean isRememberMeAuthentication(java.util.Map<java.lang.String,java.lang.Object> model)

Is remember me authentication? looks at the authentication object to find RememberMeCredential.AUTHENTICATION_ATTRIBUTE_REMEMBER_ME and expects the assertion to also note a new login session.

Parameters:

model - the model

Returns:

true if remember-me, false if otherwise.

getSatisfiedMultifactorAuthenticationProvider

protected java.util.Optional<MultifactorAuthenticationProvider> getSatisfiedMultifactorAuthenticationProvider(java.util.Map<java.lang.String,java.lang.Object> model)

Gets satisfied multifactor authentication provider.

Parameters:

model - the model

Returns:

the satisfied multifactor authentication provider

isAssertionBackedByNewLogin

protected boolean isAssertionBackedByNewLogin(java.util.Map<java.lang.String,java.lang.Object> model)

Is assertion backed by new login?

Parameters:

model - the model

Returns:

true/false.

getAuthenticationDate

protected java.time.ZonedDateTime getAuthenticationDate(java.util.Map<java.lang.String,java.lang.Object> model)

Gets authentication date.

Parameters:

model - the model

Returns:

the authentication date

Since:

4.1.0

getServiceFrom

protected Service getServiceFrom(java.util.Map<java.lang.String,java.lang.Object> model)

Gets validated service from the model.

Parameters:

model - the model

Returns:

the validated service from

getChainedAuthentications

protected java.util.Collection<Authentication> getChainedAuthentications(java.util.Map<java.lang.String,java.lang.Object> model)

Gets chained authentications.

Parameters:

model - the model

Returns:

the chained authentications

decideIfCredentialPasswordShouldBeReleasedAsAttribute

protected void decideIfCredentialPasswordShouldBeReleasedAsAttribute(java.util.Map<java.lang.String,java.lang.Object> attributes,
                                                                     java.util.Map<java.lang.String,java.lang.Object> model,
                                                                     RegisteredService service)

Decide if credential password should be released as attribute. The credential must have been cached as an authentication attribute and the attribute release policy must be allowed to release the attribute.

Parameters:

attributes - the attributes

model - the model

service - the service

decideIfProxyGrantingTicketShouldBeReleasedAsAttribute

protected void decideIfProxyGrantingTicketShouldBeReleasedAsAttribute(java.util.Map<java.lang.String,java.lang.Object> attributes,
                                                                      java.util.Map<java.lang.String,java.lang.Object> model,
                                                                      RegisteredService service)

Decide if PGT should be released as attribute. The PGT must have been cached as an authentication attribute and the attribute release policy must be allowed to release the attribute.

Parameters:

attributes - the attributes

model - the model

service - the service

decideAttributeReleaseBasedOnServiceAttributePolicy

protected void decideAttributeReleaseBasedOnServiceAttributePolicy(java.util.Map<java.lang.String,java.lang.Object> attributes,
                                                                   java.lang.String attributeValue,
                                                                   java.lang.String attributeName,
                                                                   RegisteredService service,
                                                                   boolean doesAttributePolicyAllow)

Decide attribute release based on service attribute policy.

Parameters:

attributes - the attributes

attributeValue - the attribute value

attributeName - the attribute name

service - the service

doesAttributePolicyAllow - does attribute policy allow release of this attribute?

putIntoModel

protected void putIntoModel(java.util.Map<java.lang.String,java.lang.Object> model,
                            java.lang.String key,
                            java.lang.Object value)

Put into model.

Parameters:

model - the model

key - the key

value - the value

putAllIntoModel

protected void putAllIntoModel(java.util.Map<java.lang.String,java.lang.Object> model,
                               java.util.Map<java.lang.String,java.lang.Object> values)

Put all into model.

Parameters:

model - the model

values - the values

setServicesManager

public void setServicesManager(ServicesManager servicesManager)

setCasAttributeEncoder

public void setCasAttributeEncoder(CasAttributeEncoder casAttributeEncoder)

getCasAttributeEncoder

public CasAttributeEncoder getCasAttributeEncoder()

getServicesManager

public ServicesManager getServicesManager()

setSuccessResponse

public void setSuccessResponse(boolean successResponse)

getAuthenticationContextAttribute

public java.lang.String getAuthenticationContextAttribute()

setAuthenticationContextAttribute

public void setAuthenticationContextAttribute(java.lang.String authenticationContextAttribute)