org.springframework.extensions.surf.mvc

Class PageTypeViewResolver

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.extensions.webscripts.servlet.mvc.AbstractWebScriptViewResolver

org.springframework.extensions.surf.mvc.AbstractWebFrameworkViewResolver

org.springframework.extensions.surf.mvc.PageTypeViewResolver

All Implemented Interfaces:

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

public class PageTypeViewResolver
extends AbstractWebFrameworkViewResolver

Resolver for web framework Page Type views

Author:

muzquiano, Dave Draper

Field Summary

Fields inherited from class org.springframework.extensions.webscripts.servlet.mvc.AbstractWebScriptViewResolver

useNullSentinel

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 interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
PageTypeViewResolver()

Method Summary

Methods

Modifier and Type	Method and Description
protected org.springframework.web.servlet.view.AbstractUrlBasedView	buildView(String viewName) Constructs the view for a page type request.
protected boolean	canHandle(String viewName, Locale locale) Determines whether or not this view resolver can be used for the supplied view name.
protected Object	getCacheKey(String viewName, Locale locale) Overrides the default implementation from AbstractCachingViewResolver to ensure that page type view are cached with respect to the requested view.

Methods inherited from class org.springframework.extensions.surf.mvc.AbstractWebFrameworkViewResolver

addPrefix, addReqParm, generateUriTemplateListIndexFromConfig, getBeanName, getModelObjectService, getServiceRegistry, getTemplatesContainer, getUriTemplateListIndex, getUrlHelperFactory, getWebframeworkConfigElement, getWebFrameworkRenderService, getWebFrameworkResourceService, getWebFrameworkServiceRegistry, lookupPage, matchUriTemplate, processView, setBeanName, setModelObjectService, setServiceRegistry, setTemplatesContainer, setUriTemplateIndex, setUrlHelperFactory, setWebframeworkConfigElement, setWebFrameworkRenderService, setWebFrameworkResourceService

Methods inherited from class org.springframework.extensions.webscripts.servlet.mvc.AbstractWebScriptViewResolver

clearCache, removeFromCache, resolveViewName

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

createView, getAttributesMap, getContentType, getExposePathVariables, getOrder, getPrefix, getRequestContextAttribute, getSuffix, getViewClass, getViewNames, initApplicationContext, isRedirectContextRelative, isRedirectHttp10Compatible, loadView, requiredViewClass, setAttributes, setAttributesMap, setContentType, setExposePathVariables, setOrder, setPrefix, setRedirectContextRelative, setRedirectHttp10Compatible, setRequestContextAttribute, setSuffix, setViewClass, setViewNames

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

getCacheLimit, isCache, isCacheUnresolved, setCache, 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

PageTypeViewResolver

public PageTypeViewResolver()

Method Detail

canHandle

protected boolean canHandle(String viewName,
                Locale locale)

Determines whether or not this view resolver can be used for the supplied view name. This will return true if the view name is prefixed by any of the prefixes contained in the prefixes property.

Overrides:

canHandle in class AbstractWebFrameworkViewResolver

Parameters:

viewName - The name of the view to check for page type requests

locale - The locale of the request.

Returns:

Returns true if the view name is prefixed by any of the prefixes contained in the prefixes property.

getCacheKey

protected Object getCacheKey(String viewName,
                 Locale locale)

Overrides the default implementation from AbstractCachingViewResolver to ensure that page type view are cached with respect to the requested view. Default caching only takes the basic URL suffix into consideration and does not look at any request parameters that have been provided. This means that if a user attempts to request a page type with a different theme from the cached view then they would not see the page type they've requested. By setting a cache key that includes the requested theme as well as the view name it is possible to switch between themes in a single session.

Overrides:

getCacheKey in class org.springframework.web.servlet.view.UrlBasedViewResolver

buildView

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

Constructs the view for a page type request. The view is based on the requested theme, if no specific theme has been requested then the default theme is used. The theme configuration should specify the page id to use for the requested page type.

Overrides:

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

Parameters:

viewName - The name of the view to build.

Returns:

An AbstractUrlBasedView

Throws:

Exception