org.springframework.extensions.surf.mvc

Class AbstractWebFrameworkViewResolver

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

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

Direct Known Subclasses:

ComponentViewResolver, ObjectViewResolver, PageTypeViewResolver, PageViewResolver, RegionViewResolver

public abstract class AbstractWebFrameworkViewResolver
extends org.springframework.extensions.webscripts.servlet.mvc.AbstractWebScriptViewResolver
implements org.springframework.beans.factory.BeanNameAware

Abstract Spring MVC implementation of a view resolver for Surf.

Developers who wish to implement custom Spring view resolvers may wish to extend their own view implementations from this class so as to gain access to member convenience functions for working with Surf services.

Author:

muzquiano, David Draper, Kevin Roast

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
AbstractWebFrameworkViewResolver() Constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	addPrefix(String prefix)
void	addReqParm(String reqParm)
protected boolean	canHandle(String viewName, Locale locale) Determines whether or not this view resolver can handle the requested view.
UriTemplateListIndex	generateUriTemplateListIndexFromConfig(WebFrameworkServiceRegistry serviceRegistry, String targetElement) Creates a UriTemplateListIndex populated with configuration data found in config elements matching the target provided.
String	getBeanName() Returns the id given to this class when it is defined as a Spring bean.
ModelObjectService	getModelObjectService()
WebFrameworkServiceRegistry	getServiceRegistry() Deprecated. This method only persists as it is used by DynamicPageViewResolver in the Web Quick Start application.
TemplatesContainer	getTemplatesContainer()
UriTemplateListIndex	getUriTemplateListIndex() Gets the UriTemplateListIndex for the view resolver
URLHelperFactory	getUrlHelperFactory()
WebFrameworkConfigElement	getWebframeworkConfigElement()
RenderService	getWebFrameworkRenderService()
ResourceService	getWebFrameworkResourceService()
WebFrameworkServiceRegistry	getWebFrameworkServiceRegistry() Deprecated.
protected Page	lookupPage(String pageId) Retrieves the page object with the given page id.
Map<String,String>	matchUriTemplate(String uri) Performs a match of the given URI to a template.
String	processView(String viewName) Processes the supplied raw view String to return a value that does not include any prefixes.
void	setBeanName(String name) This method is required to implement the the BeanNameAware interface and will be invoked by the Spring framework to set the configured name of this class when defined as a Spring bean.
void	setModelObjectService(ModelObjectService modelObjectService)
void	setServiceRegistry(WebFrameworkServiceRegistry webFrameworkServiceRegistry)
void	setTemplatesContainer(TemplatesContainer templatesContainer)
void	setUriTemplateIndex(UriTemplateListIndex uriTemplateIndex) Sets the UriTemplateListIndex
void	setUrlHelperFactory(URLHelperFactory urlHelperFactory)
void	setWebframeworkConfigElement(WebFrameworkConfigElement webframeworkConfigElement)
void	setWebFrameworkRenderService(RenderService webFrameworkRenderService)
void	setWebFrameworkResourceService(ResourceService webFrameworkResourceService)

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

clearCache, removeFromCache, resolveViewName

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

buildView, createView, getAttributesMap, getCacheKey, 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

AbstractWebFrameworkViewResolver

public AbstractWebFrameworkViewResolver()

Constructor

Method Detail

getUriTemplateListIndex

public UriTemplateListIndex getUriTemplateListIndex()

Gets the UriTemplateListIndex for the view resolver

Returns:

The UriTemplateListIndex for the view resolver

setUriTemplateIndex

public void setUriTemplateIndex(UriTemplateListIndex uriTemplateIndex)

Sets the UriTemplateListIndex

Parameters:

uriTemplateIndex - The UriTemplateListIndex to set.

addPrefix

public void addPrefix(String prefix)

addReqParm

public void addReqParm(String reqParm)

processView

public String processView(String viewName)

Processes the supplied raw view String to return a value that does not include any prefixes. Each extending view resolver can populate the prefixes list of prefixes that indicate that it can handle a view that contains them. If the raw view begins with a specified prefix then the prefix is removed and the "processed" String is returned to the caller.

Some view resolvers can also handle views when the view name is defined as a request parameter. The names of these request parameters are added to the reqParms and if found in the URL then their value is returned as the processed view

If no matching prefixes or request parameters are found then null is returned

Parameters:

viewName - The name of the requested view.

Returns:

A matching id or null if the view requested cannot be resolved to an id.

lookupPage

protected Page lookupPage(String pageId)

Retrieves the page object with the given page id. If a page object doesn't exist, this supports the short-cut method of wiring directly to a template file on disk. If a template file exists on disk with the same id as the page, we create in-memory disposal objects to represent the page and the template instance required to arrive to that template. This provides a quick way to get started building templated sites.

Parameters:

pageId - String

Returns:

Page object or null if not found

matchUriTemplate

public Map<String,String> matchUriTemplate(String uri)

Performs a match of the given URI to a template. If a match is found, the variables representing representing the tokens and the values extracted from the supplied URI are returned.

Parameters:

uri - The URI to compare against the template.

Returns:

map of tokens to values or null if no match found

generateUriTemplateListIndexFromConfig

public UriTemplateListIndex generateUriTemplateListIndexFromConfig(WebFrameworkServiceRegistry serviceRegistry,
                                                          String targetElement)

Creates a UriTemplateListIndex populated with configuration data found in config elements matching the target provided.

Parameters:

serviceRegistry - service registry

targetElement - The type of UriTemplate configurations to look for.

Returns:

map of tokens to values or null if no match found

canHandle

protected boolean canHandle(String viewName,
                Locale locale)

Determines whether or not this view resolver can handle the requested view.

Overrides:

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

getTemplatesContainer

public TemplatesContainer getTemplatesContainer()

setTemplatesContainer

public void setTemplatesContainer(TemplatesContainer templatesContainer)

getWebframeworkConfigElement

public WebFrameworkConfigElement getWebframeworkConfigElement()

setWebframeworkConfigElement

public void setWebframeworkConfigElement(WebFrameworkConfigElement webframeworkConfigElement)

getWebFrameworkServiceRegistry

public WebFrameworkServiceRegistry getWebFrameworkServiceRegistry()

Deprecated.

Returns:

WebFrameworkServiceRegistry

getServiceRegistry

public WebFrameworkServiceRegistry getServiceRegistry()

Deprecated. This method only persists as it is used by DynamicPageViewResolver in the Web Quick Start application.

Returns:

WebFrameworkServiceRegistry

setServiceRegistry

public void setServiceRegistry(WebFrameworkServiceRegistry webFrameworkServiceRegistry)

getModelObjectService

public ModelObjectService getModelObjectService()

setModelObjectService

public void setModelObjectService(ModelObjectService modelObjectService)

getWebFrameworkRenderService

public RenderService getWebFrameworkRenderService()

setWebFrameworkRenderService

public void setWebFrameworkRenderService(RenderService webFrameworkRenderService)

getWebFrameworkResourceService

public ResourceService getWebFrameworkResourceService()

setWebFrameworkResourceService

public void setWebFrameworkResourceService(ResourceService webFrameworkResourceService)

setBeanName

public void setBeanName(String name)

This method is required to implement the the BeanNameAware interface and will be invoked by the Spring framework to set the configured name of this class when defined as a Spring bean.

Specified by:

setBeanName in interface org.springframework.beans.factory.BeanNameAware

getBeanName

public String getBeanName()

Returns the id given to this class when it is defined as a Spring bean. If this class has not bean instantiated by the Spring framework then this will return null.

Returns:

The "id" property given to this class when defining it as a Spring bean.

getUrlHelperFactory

public URLHelperFactory getUrlHelperFactory()

setUrlHelperFactory

public void setUrlHelperFactory(URLHelperFactory urlHelperFactory)