org.apereo.cas.web.view.json

Class Cas30JsonResponseView

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

org.apereo.cas.services.web.view.AbstractDelegatingCasView

org.apereo.cas.web.view.Cas20ResponseView

org.apereo.cas.web.view.Cas30ResponseView

org.apereo.cas.web.view.json.Cas30JsonResponseView

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

public class Cas30JsonResponseView
extends Cas30ResponseView

Renders the model prepared by CAS in JSON format. Automatically sets the response type and formats the output for pretty printing. The class relies on MappingJackson2JsonView to handle most of the model processing and as such, does not do anything special. It is meant and kept to provide a facility for adopters so that the JSON view can be augmented easily in overlays.

Since:

4.2

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTRIBUTE_NAME_MODEL_SERVICE_RESPONSE Attribute name in the final model representing the service response.

Fields inherited from class org.apereo.cas.web.view.Cas20ResponseView

authenticationRequestServiceSelectionStrategies

Fields inherited from class org.apereo.cas.services.web.view.AbstractDelegatingCasView

view

Fields inherited from class org.apereo.cas.services.web.view.AbstractCasView

authenticationAttributeReleasePolicy, authenticationContextAttribute, protocolAttributeEncoder, servicesManager, successResponse

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

DEFAULT_CONTENT_TYPE

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

logger

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

PATH_VARIABLES, RESPONSE_STATUS_ATTRIBUTE, SELECTED_CONTENT_TYPE

Constructor Summary

Constructors

Constructor and Description
Cas30JsonResponseView(boolean successResponse, org.apereo.cas.authentication.ProtocolAttributeEncoder protocolAttributeEncoder, org.apereo.cas.services.ServicesManager servicesManager, java.lang.String authenticationContextAttribute, boolean releaseProtocolAttributes, org.apereo.cas.authentication.AuthenticationAttributeReleasePolicy authenticationAttributeReleasePolicy, org.apereo.cas.authentication.AuthenticationServiceSelectionPlan serviceSelectionStrategy, org.apereo.cas.validation.CasProtocolAttributesRenderer attributesRenderer)
Cas30JsonResponseView(boolean successResponse, org.apereo.cas.authentication.ProtocolAttributeEncoder protocolAttributeEncoder, org.apereo.cas.services.ServicesManager servicesManager, java.lang.String authenticationContextAttribute, org.springframework.web.servlet.View delegatedView, boolean releaseProtocolAttributes, org.apereo.cas.authentication.AuthenticationAttributeReleasePolicy authenticationAttributeReleasePolicy, org.apereo.cas.authentication.AuthenticationServiceSelectionPlan serviceSelectionStrategy, org.apereo.cas.validation.CasProtocolAttributesRenderer attributesRenderer)

Method Summary

Modifier and Type	Method and Description
protected void	prepareMergedOutputModel(java.util.Map<java.lang.String,java.lang.Object> model, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)

Methods inherited from class org.apereo.cas.web.view.Cas30ResponseView

getCasPrincipalAttributes, getCasProtocolAuthenticationAttributes, putCasResponseAttributesIntoModel

Methods inherited from class org.apereo.cas.services.web.view.AbstractDelegatingCasView

getView, renderMergedOutputModel

Methods inherited from class org.apereo.cas.services.web.view.AbstractCasView

decideAttributeReleaseBasedOnServiceAttributePolicy, decideIfCredentialPasswordShouldBeReleasedAsAttribute, decideIfProxyGrantingTicketShouldBeReleasedAsAttribute, getAssertionFrom, getAuthenticationAttribute, getAuthenticationAttributeReleasePolicy, getAuthenticationAttributes, getAuthenticationAttributesAsMultiValuedAttributes, getAuthenticationContextAttribute, getAuthenticationDate, getChainedAuthentications, getErrorCodeFrom, getErrorDescriptionFrom, getModelAttributes, getPrimaryAuthenticationFrom, getPrincipal, getPrincipalAttributesAsMultiValuedAttributes, getProtocolAttributeEncoder, getProxyGrantingTicketId, getProxyGrantingTicketIou, getSatisfiedMultifactorAuthenticationProviderId, getServiceFrom, getServicesManager, isAssertionBackedByNewLogin, isRememberMeAuthentication, isSuccessResponse, putAllIntoModel, putIntoModel

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, 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

ATTRIBUTE_NAME_MODEL_SERVICE_RESPONSE

public static final java.lang.String ATTRIBUTE_NAME_MODEL_SERVICE_RESPONSE

Attribute name in the final model representing the service response.

See Also:

Constant Field Values

Constructor Detail

Cas30JsonResponseView

public Cas30JsonResponseView(boolean successResponse,
                             org.apereo.cas.authentication.ProtocolAttributeEncoder protocolAttributeEncoder,
                             org.apereo.cas.services.ServicesManager servicesManager,
                             java.lang.String authenticationContextAttribute,
                             org.springframework.web.servlet.View delegatedView,
                             boolean releaseProtocolAttributes,
                             org.apereo.cas.authentication.AuthenticationAttributeReleasePolicy authenticationAttributeReleasePolicy,
                             org.apereo.cas.authentication.AuthenticationServiceSelectionPlan serviceSelectionStrategy,
                             org.apereo.cas.validation.CasProtocolAttributesRenderer attributesRenderer)

Cas30JsonResponseView

public Cas30JsonResponseView(boolean successResponse,
                             org.apereo.cas.authentication.ProtocolAttributeEncoder protocolAttributeEncoder,
                             org.apereo.cas.services.ServicesManager servicesManager,
                             java.lang.String authenticationContextAttribute,
                             boolean releaseProtocolAttributes,
                             org.apereo.cas.authentication.AuthenticationAttributeReleasePolicy authenticationAttributeReleasePolicy,
                             org.apereo.cas.authentication.AuthenticationServiceSelectionPlan serviceSelectionStrategy,
                             org.apereo.cas.validation.CasProtocolAttributesRenderer attributesRenderer)

Method Detail

prepareMergedOutputModel

protected void prepareMergedOutputModel(java.util.Map<java.lang.String,java.lang.Object> model,
                                        javax.servlet.http.HttpServletRequest request,
                                        javax.servlet.http.HttpServletResponse response)

Overrides:

prepareMergedOutputModel in class Cas30ResponseView