org.springframework.extensions.surf.mvc

Class AbstractWebFrameworkView

java.lang.Object

org.springframework.context.support.ApplicationObjectSupport

org.springframework.web.context.support.WebApplicationObjectSupport

org.springframework.web.servlet.view.AbstractView

org.springframework.web.servlet.view.AbstractUrlBasedView

org.springframework.extensions.surf.mvc.AbstractWebFrameworkView

All Implemented Interfaces:

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

Direct Known Subclasses:

ComponentView, ErrorHandlerPageView, PageView, RegionView, SystemPageView, TemplateView

public abstract class AbstractWebFrameworkView
extends org.springframework.web.servlet.view.AbstractUrlBasedView

Abstract Spring MVC implementation of a view resolver for Surf.

Developers who wish to implement custom Spring views 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:

Dave Draper, muzquiano, kevinr

Field Summary

Fields

Modifier and Type	Field and Description
static String	MIMETYPE_HTML

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
AbstractWebFrameworkView(WebFrameworkConfigElement webFrameworkConfiguration, ModelObjectService modelObjectService, ResourceService resourceService, RenderService renderService, TemplatesContainer templatesContainer) Constructor
AbstractWebFrameworkView(WebFrameworkServiceRegistry webFrameworkServiceRegistry) Deprecated. Due to dependencies upon static helper methods rather than Spring configuration.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	exposeForwardRequestAttributes(javax.servlet.http.HttpServletRequest request) Expose forward request attributes.
ModelObjectService	getObjectService() Gets a ModelObjectService.
RenderService	getRenderService() TODO: Add JavaDoc describing what a RenderService is!
ResourceService	getResourceService() Gets a ResourceService.
TemplatesContainer	getTemplatesContainer() TODO: Add JavaDoc describing what a TemplatesContainer is!
Map<String,String>	getUriTokens() Get the URI tokens for the view
URLHelperFactory	getUrlHelperFactory()
WebFrameworkConfigElement	getWebFrameworkConfiguration() Gets a WebFrameworkConfigElement.
protected Page	lookupPage(String pageId) Retrieves the page object with the given page id.
protected void	populateRequestContext(RequestContext context, javax.servlet.http.HttpServletRequest request) Performs default population of the request context.
protected void	renderMergedOutputModel(Map<String,Object> mvcModel, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method must be implemented to actually render the view.
protected abstract void	renderView(RequestContext context) To be implemented by view classes to provide render dispatch
protected void	setupRequestContext(Map<String,Object> mvcModel, javax.servlet.http.HttpServletRequest request) Implementation classes should extend this method to provide for any initial setup of the request context.
void	setUriTokens(Map<String,String> uriTokens) Set the URI tokens associates with the view
void	setUrlHelperFactory(URLHelperFactory urlHelper)
protected void	validateRequestContext(RequestContext context, javax.servlet.http.HttpServletRequest request) Extension point for performing any validation of the request context state If the request context state is invalid, it can either be adjusted or an exception can be raised.

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

afterPropertiesSet, checkResource, getUrl, isUrlRequired, setUrl, toString

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

addStaticAttribute, createMergedOutputModel, createRequestContext, createTemporaryOutputStream, exposeModelAsRequestAttributes, generatesDownloadContent, getAttributesMap, getBeanName, getContentType, getRequestContextAttribute, getStaticAttributes, isExposePathVariables, prepareResponse, render, setAttributes, setAttributesCSV, setAttributesMap, setBeanName, setContentType, setExposePathVariables, setRequestContextAttribute, setResponseContentType, 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

MIMETYPE_HTML

public static final String MIMETYPE_HTML

See Also:

Constant Field Values

Constructor Detail

AbstractWebFrameworkView

public AbstractWebFrameworkView(WebFrameworkConfigElement webFrameworkConfiguration,
                        ModelObjectService modelObjectService,
                        ResourceService resourceService,
                        RenderService renderService,
                        TemplatesContainer templatesContainer)

Constructor

Parameters:

webFrameworkConfiguration - WebFrameworkConfigElement

modelObjectService - ModelObjectService

resourceService - ResourceService

renderService - RenderService

templatesContainer - TemplatesContainer

AbstractWebFrameworkView

public AbstractWebFrameworkView(WebFrameworkServiceRegistry webFrameworkServiceRegistry)

Deprecated. Due to dependencies upon static helper methods rather than Spring configuration.

This constructor is temporarily retained to support legacy applications that may depend on it. However, it has since been deprecated and should no longer be used for new implementations. The reason for the change is that Spring Surf was originally coded to have many dependencies upon static helper methods rather than using properly configured Spring beans. This is a problem because it inhibits flexibility and extensibility.

Parameters:

webFrameworkServiceRegistry - WebFrameworkServiceRegistry

Method Detail

getUrlHelperFactory

public URLHelperFactory getUrlHelperFactory()

setUrlHelperFactory

public void setUrlHelperFactory(URLHelperFactory urlHelper)

getWebFrameworkConfiguration

public WebFrameworkConfigElement getWebFrameworkConfiguration()

Gets a WebFrameworkConfigElement.

Returns:

The WebFrameworkConfigElement stored in the WebFrameworkServiceRegistry (if this view was instantiated using the deprecated constructor) or the WebFrameworkConfigElement supplied to the non-deprecated constructor

getObjectService

public ModelObjectService getObjectService()

Gets a ModelObjectService.

Returns:

The ModelObjectService stored in the WebFrameworkServiceRegistry (if this view was instantiated using the deprecated constructor) or the ModelObjectService supplied to the non-deprecated constructor

getResourceService

public ResourceService getResourceService()

Gets a ResourceService.

Returns:

The ResourceService stored in the WebFrameworkServiceRegistry (if this view was instantiated using the deprecated constructor) or the ResourceService supplied to the non-deprecated constructor

getTemplatesContainer

public TemplatesContainer getTemplatesContainer()

TODO: Add JavaDoc describing what a TemplatesContainer is!

Returns the TemplatesContainer to be used by the view. In legacy mode this will always be the TemplatesContainer stored in the WebFrameworkServiceRegistry (supplied in the constructor). However, if this view has been constructed using the non-deprecated constructor then the TemplatesContainer returned will be the one supplied in the constructor.

getRenderService

public RenderService getRenderService()

TODO: Add JavaDoc describing what a RenderService is!

Returns the RenderService to be used by the view. In legacy mode this will always be the RenderService stored in the WebFrameworkServiceRegistry (supplied in the constructor). However, if this view has been constructed using the non-deprecated constructor then the RenderService returned will be the one supplied in the constructor.

Returns:

the render service

getUriTokens

public Map<String,String> getUriTokens()

Get the URI tokens for the view

Returns:

A Map of name/value pairs derived from the URI associated with the view.

setUriTokens

public void setUriTokens(Map<String,String> uriTokens)

Set the URI tokens associates with the view

Parameters:

uriTokens - A Map of name/value pairs derived from the URI associated with the view.

renderMergedOutputModel

protected void renderMergedOutputModel(Map<String,Object> mvcModel,
                           javax.servlet.http.HttpServletRequest request,
                           javax.servlet.http.HttpServletResponse response)
                                throws Exception

This method must be implemented to actually render the view. One of the key functions of this implementation is to retrieve the RequestContext instantiated by the RequestContextInterceptor and complete it's initialisation.

Specified by:

renderMergedOutputModel in class org.springframework.web.servlet.view.AbstractView

Throws:

Exception

renderView

protected abstract void renderView(RequestContext context)
                            throws Exception

To be implemented by view classes to provide render dispatch

Parameters:

context - the render context

Throws:

Exception

exposeForwardRequestAttributes

protected void exposeForwardRequestAttributes(javax.servlet.http.HttpServletRequest request)

Expose forward request attributes.

Parameters:

request - the request

setupRequestContext

protected void setupRequestContext(Map<String,Object> mvcModel,
                       javax.servlet.http.HttpServletRequest request)
                            throws Exception

Implementation classes should extend this method to provide for any initial setup of the request context. This may include setting its internal state.

Parameters:

mvcModel - Map

request - HttpServletRequest

Throws:

Exception

populateRequestContext

protected void populateRequestContext(RequestContext context,
                          javax.servlet.http.HttpServletRequest request)
                               throws Exception

Performs default population of the request context.

Parameters:

context - RequestContext

request - HttpServletRequest

Throws:

Exception

validateRequestContext

protected void validateRequestContext(RequestContext context,
                          javax.servlet.http.HttpServletRequest request)
                               throws Exception

Extension point for performing any validation of the request context state If the request context state is invalid, it can either be adjusted or an exception can be raised. By default, no validation is performed.

Parameters:

context - RequestContext

request - HttpServletRequest

Throws:

Exception

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