org.springframework.extensions.surf.mvc

Class PageView

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

org.springframework.extensions.surf.mvc.PageView

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

public class PageView
extends AbstractWebFrameworkView

Default view implementation for Surf pages.

Author:

muzquiano, kevinr, David Draper

Field Summary

Fields inherited from class org.springframework.extensions.surf.mvc.AbstractWebFrameworkView

MIMETYPE_HTML

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

DEFAULT_CONTENT_TYPE

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

PATH_VARIABLES, RESPONSE_STATUS_ATTRIBUTE, SELECTED_CONTENT_TYPE

Constructor Summary

Constructors

Constructor and Description
PageView(WebFrameworkConfigElement webFrameworkConfiguration, ModelObjectService modelObjectService, ResourceService resourceService, RenderService renderService, TemplatesContainer templatesContainer) This is the preferred constructor to use for instantiating a new PageView because it allows complete flexibility when rendering the view.
PageView(WebFrameworkServiceRegistry serviceRegistry) Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
protected String	buildLoginRedirectURL(javax.servlet.http.HttpServletRequest request)
protected static void	debug(RequestContext context, String value) Debug logger helper function.
void	dispatchPage(RequestContext context, String pageId, String formatId) Dispatches a given page in a given format.
protected boolean	loginRequiredForPage(RequestContext context, javax.servlet.http.HttpServletRequest request, Page page) Return if login page should be display for the given page.
protected void	prepareResponse(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected void	renderView(RequestContext context) To be implemented by view classes to provide render dispatch
void	setPage(Page page) Set the Page to be rendered by this view.
protected void	setupRequestContext(Map<String,Object> mvcModel, javax.servlet.http.HttpServletRequest request) Initial setup of the request context.
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.extensions.surf.mvc.AbstractWebFrameworkView

exposeForwardRequestAttributes, getObjectService, getRenderService, getResourceService, getTemplatesContainer, getUriTokens, getUrlHelperFactory, getWebFrameworkConfiguration, lookupPage, populateRequestContext, renderMergedOutputModel, setUriTokens, setUrlHelperFactory

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

Constructor Detail

PageView

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

This is the preferred constructor to use for instantiating a new PageView because it allows complete flexibility when rendering the view. An AbstractWebFrameworkView is typically instantiated from within a AbstractWebFrameworkViewResolver and all the arguments in the constructor signature should be supplied to the AbstractWebFrameworkViewResolver as beans via the Spring configuration.

Parameters:

webFrameworkConfiguration - WebFrameworkConfigElement

modelObjectService - ModelObjectService

resourceService - ResourceService

renderService - RenderService

templatesContainer - TemplatesContainer

PageView

public PageView(WebFrameworkServiceRegistry serviceRegistry)

Deprecated.

This constructor should be avoided if possible because it relies on the supplied WebFrameworkServiceRegistry argument to provide all the other Spring beans required to render the view. This means that there is no flexibility via configuration to adapt different views to use different beans.

Parameters:

serviceRegistry - WebFrameworkServiceRegistry

Method Detail

setPage

public void setPage(Page page)

Set the Page to be rendered by this view.

Parameters:

page - Page

setupRequestContext

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

Initial setup of the request context.

Overrides:

setupRequestContext in class AbstractWebFrameworkView

Parameters:

mvcModel - Map

request - HttpServletRequest

Throws:

Exception

validateRequestContext

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

Description copied from class: AbstractWebFrameworkView

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.

Overrides:

validateRequestContext in class AbstractWebFrameworkView

Parameters:

context - RequestContext

request - HttpServletRequest

Throws:

Exception

buildLoginRedirectURL

protected String buildLoginRedirectURL(javax.servlet.http.HttpServletRequest request)

renderView

protected void renderView(RequestContext context)
                   throws Exception

Description copied from class: AbstractWebFrameworkView

To be implemented by view classes to provide render dispatch

Specified by:

renderView in class AbstractWebFrameworkView

Parameters:

context - the render context

Throws:

Exception

loginRequiredForPage

protected boolean loginRequiredForPage(RequestContext context,
                           javax.servlet.http.HttpServletRequest request,
                           Page page)

Return if login page should be display for the given page.

Default implementation of this method will retrieve the current User and test to see if a guest, non-guest or admin user id is present as appropriate for the authentication level specified on the supplied page object.

Parameters:

context - RequestContext

request - HttpServletRequest

page - Page to test authentication for

Returns:

true if login is required for given page, false otherwise

dispatchPage

public void dispatchPage(RequestContext context,
                String pageId,
                String formatId)
                  throws RequestDispatchException

Dispatches a given page in a given format.

Parameters:

context - RequestContext

pageId - String

formatId - String

Throws:

RequestDispatchException

prepareResponse

protected void prepareResponse(javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response)

Overrides:

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

debug

protected static void debug(RequestContext context,
         String value)

Debug logger helper function.

Parameters:

context - RequestContext

value - String