org.jasig.cas.services.web

Class RegisteredServiceThemeBasedViewResolver

java.lang.Object

org.springframework.context.support.ApplicationObjectSupport

org.springframework.web.context.support.WebApplicationObjectSupport

org.springframework.web.servlet.view.AbstractCachingViewResolver

org.springframework.web.servlet.view.UrlBasedViewResolver

org.springframework.web.servlet.view.InternalResourceViewResolver

org.jasig.cas.services.web.RegisteredServiceThemeBasedViewResolver

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.core.Ordered, org.springframework.web.context.ServletContextAware, org.springframework.web.servlet.ViewResolver

public final class RegisteredServiceThemeBasedViewResolver
extends org.springframework.web.servlet.view.InternalResourceViewResolver

RegisteredServiceThemeBasedViewResolver is an alternate Spring View Resolver that utilizes a service's associated theme to selectively choose which set of UI views will be used to generate the standard views (casLoginView.jsp, casLogoutView.jsp etc).

Views associated with a particular theme by default are expected to be found at: DEFAULT_PATH_PREFIX/themeId/ui. A starting point may be to clone the default set of view pages into a new directory based on the theme id.

Note: There also exists a ServiceThemeResolver that attempts to resolve the view name based on the service theme id. The difference however is that ServiceThemeResolver only decorates the default view pages with additional tags and coloring, such as CSS and JS. The component presented here on the other hand has the ability to load an entirely new set of pages that are may be totally different from that of the default's. This is specially useful in cases where the set of pages for a theme that are targetted for a different type of audience are entirely different structurally that simply using the ServiceThemeResolver is not practical to augment the default views. In such cases, new view pages may be required.

Since:

4.1.0

Author:

John Gasper, Misagh Moayyed

Field Summary

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

FORWARD_URL_PREFIX, REDIRECT_URL_PREFIX

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

DEFAULT_CACHE_LIMIT

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

logger

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
RegisteredServiceThemeBasedViewResolver(String defaultThemeId, ServicesManager servicesManager) The RegisteredServiceThemeBasedViewResolver constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected org.springframework.web.servlet.view.AbstractUrlBasedView	buildView(String viewName) Uses the viewName and the theme associated with the service.
void	setCache(boolean cache) setCache is not supported in the RegisteredServiceThemeBasedViewResolver because each request must be independently evaluated.
void	setPathPrefix(String pathPrefix) Sets path prefix.

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

requiredViewClass, setAlwaysInclude

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

canHandle, createView, getAttributesMap, getCacheKey, getContentType, getExposeContextBeansAsAttributes, getExposedContextBeanNames, getExposePathVariables, getOrder, getPrefix, getRequestContextAttribute, getSuffix, getViewClass, getViewNames, initApplicationContext, isRedirectContextRelative, isRedirectHttp10Compatible, loadView, setAttributes, setAttributesMap, setContentType, setExposeContextBeansAsAttributes, setExposedContextBeanNames, setExposePathVariables, setOrder, setPrefix, setRedirectContextRelative, setRedirectHttp10Compatible, setRequestContextAttribute, setSuffix, setViewClass, setViewNames

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

clearCache, getCacheLimit, isCache, isCacheUnresolved, removeFromCache, resolveViewName, setCacheLimit, setCacheUnresolved

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

Methods inherited from class java.lang.Object

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

Constructor Detail

RegisteredServiceThemeBasedViewResolver

public RegisteredServiceThemeBasedViewResolver(String defaultThemeId,
                                       ServicesManager servicesManager)

The RegisteredServiceThemeBasedViewResolver constructor.

Parameters:

defaultThemeId - the theme to apply if the service doesn't specific one or a service is not provided

servicesManager - the serviceManager implementation

See Also:

setCache(boolean)

Method Detail

buildView

protected org.springframework.web.servlet.view.AbstractUrlBasedView buildView(String viewName)
                                                                       throws Exception

Uses the viewName and the theme associated with the service. being requested and returns the appropriate view.

Overrides:

buildView in class org.springframework.web.servlet.view.InternalResourceViewResolver

Parameters:

viewName - the name of the view to be resolved

Returns:

a theme-based UrlBasedView

Throws:

Exception - an exception

setCache

public void setCache(boolean cache)

setCache is not supported in the RegisteredServiceThemeBasedViewResolver because each request must be independently evaluated.

Overrides:

setCache in class org.springframework.web.servlet.view.AbstractCachingViewResolver

Parameters:

cache - a value indicating whether the view should cache results.

setPathPrefix

public void setPathPrefix(String pathPrefix)

Sets path prefix. This is the location where views are expected to be found. The default prefix is DEFAULT_PATH_PREFIX.

Parameters:

pathPrefix - the path prefix