org.springframework.extensions.surf.render

Class RenderService

java.lang.Object

org.springframework.extensions.surf.render.RenderService

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public class RenderService
extends Object
implements org.springframework.context.ApplicationContextAware

Web Framework Render Service.

Author:

kevinr, David Draper

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	RenderService.SubComponentData

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTEXT_VALUE_ERROR_COMPONENT_ID
static String	CONTEXT_VALUE_ERROR_DESCRIPTION
static String	CONTEXT_VALUE_ERROR_PAGE_ID
static String	CONTEXT_VALUE_ERROR_REGION_ID
static String	CONTEXT_VALUE_ERROR_REGION_SCOPE_ID
static String	CONTEXT_VALUE_ERROR_REGION_SOURCE_ID
static String	CONTEXT_VALUE_ERROR_TEMPLATE_ID
static String	CONTEXT_VALUE_ERROR_THROWABLE
static String	CONTEXT_VALUE_ERROR_TITLE
static String	CONTEXT_VALUE_STACKTRACE
static String	NEWLINE

Constructor Summary

Constructors

Constructor and Description
RenderService()

Method Summary

Methods

Modifier and Type	Method and Description
String	generateAnchorLink(String pageTypeId, String pageId, String objectId, String formatId, String target) This method wraps the generateLink method to place the link inside an HTML anchor tag which is then returned.
String	generateLink(String pageTypeId, String pageId, String objectId, String formatId) Uses the LinkBuilder created from the LinkBuilderFactory that should have been set as a property of this class when instantiated as a Spring bean.
String	generateResourceURL(RequestContext renderContext, ModelObject object, String name, String id, String protocol, String endpoint, String objectId, String payload)
String	getBeanName() Returns the id given to this class when it is defined as a Spring bean.
Component	getComponentBoundToRegion(RequestContext context, String regionId, String regionScopeId, String regionSourceId) Determines the component which is bound to the given region If there is no component bound, then null is returned.
Chrome	getRegionChrome(String regionId, String chromeId) Returns the Chrome instance to utilize while rendering the given region on the given template.
Processor	getRenditionProcessor(Renderable renderable) Returns a rendition processor for a renderable in the default VIEW render mode
Processor	getRenditionProcessor(Renderable renderable, RenderMode renderMode) Returns a rendition processor for a renderable in the given render mode
Processor	getRenditionProcessorById(String id) Returns a rendition processor for the given id (i.e.
SurfBug	getSurfBug() Returns the SurfBug instance associated with the running application (which will be obtained from the ModelObjectService if not previously obtained.
protected void	handleError(RequestContext context, String errorTitle, String errorDescription, Throwable t) This method sets up the RequestContext and attempts to redirect the request to the general error page.
protected void	handleRenderProblem(String targetId, String errorPageId, RequestContext context, Throwable t) This method is invoked whenever the RenderService fails to render something.
void	processComponent(RequestContext context, RenderFocus renderFocus, Component component, boolean chromeless) Executes the processor for the given render focus on the given component instance.
void	processRenderable(RequestContext context, RenderFocus renderFocus, ModelObject object, Renderable renderable) Executes the processor for the given focus on the provided renderable object.
void	processTemplate(RequestContext context, RenderFocus renderFocus, TemplateInstance template) Executes the processor for the given render focus on the given template instance.
void	renderChromeInclude(RequestContext context, ModelObject object) Renders either a component or a region depending upon the value of RENDER_TYPE key set in the current RequestContext.
void	renderComponent(RequestContext context, RenderFocus renderFocus, Component component, String chromeIdOverride, boolean chromeless) Entry point for the rendering a single identified component with the default chrome.
void	renderComponent(RequestContext context, RenderFocus renderFocus, String componentId, String overrideChromeId, boolean chromeless) Entry point for the rendering a component with the given chrome.
boolean	renderErrorHandlerPage(RequestContext context, String errorHandlerPageId) Renders a default error handler page A system page can be configured to handle a fault state for the web framework.
void	renderPage(RequestContext context, RenderFocus renderFocus) Entry point for the rendering of the current page as provided by the request context.
void	renderRegion(RequestContext context, RenderFocus renderFocus, String templateId, String regionId, String regionScopeId, String overrideChromeId, boolean chromeless) Entry point for the rendering a region of a given template
void	renderRegionComponents(RequestContext context, ModelObject object, boolean chromeless) Renders the components of the region described by the render context This method is generally called from the region include tag.
void	renderSubComponent(SubComponent subComponent, RequestContext context, RenderFocus renderFocus) Renders the supplied SubComponent.
void	renderSurfBugInclude(RequestContext context) Convenience method provided for both the "surfbugInclude" FreeMarker directive and JSP tag to use.
boolean	renderSystemPage(RequestContext context, String systemPageId) Renders a default system page A system container is a page fragment that is rendered as a container of other elements like components.
void	renderTemplate(RequestContext context, RenderFocus renderFocus) Entry point for the rendering of the current content item as provided by the request context.
String	renderTemplateHeaderAsString(RequestContext context, ModelObject object) Generates text to be inserted into template markup head for a given renderer context.
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
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	setChromeRenderer(ChromeRenderer chromeRenderer)
void	setComponentRenderer(ComponentRenderer componentRenderer)
void	setDojoDependencyHandler(DojoDependencyHandler dojoDependencyHandler)
void	setLinkBuilderFactory(LinkBuilderFactory linkBuilderFactory) This method is provided to allow the Spring framework to inject a LinkBuilderFactory into this class when it is instantiated as a Spring bean.
void	setModelObjectService(ModelObjectService modelObjectService)
void	setPageRenderer(PageRenderer pageRenderer)
void	setRegionRenderer(RegionRenderer regionRenderer)
void	setResourceService(ResourceService resourceService) This setter method is provided so that Spring can inject a ResourceService into this bean.
void	setTemplateRenderer(TemplateInstanceRenderer templateRenderer)
void	setWebFrameworkConfiguration(WebFrameworkConfigElement webFrameworkConfiguration)
void	updateStyleSheetImports(RequestContext context, String href) Adds to the (or creates a new) LinkedList of CSS style sheet URLs stored as the WebFrameworkConstants.STYLESHEET_RENDER_CONTEXT_NAME attribute in the supplied RequestContext.

Methods inherited from class java.lang.Object

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

Field Detail

CONTEXT_VALUE_ERROR_THROWABLE

public static final String CONTEXT_VALUE_ERROR_THROWABLE

See Also:

Constant Field Values

CONTEXT_VALUE_ERROR_PAGE_ID

public static final String CONTEXT_VALUE_ERROR_PAGE_ID

See Also:

Constant Field Values

CONTEXT_VALUE_ERROR_TEMPLATE_ID

public static final String CONTEXT_VALUE_ERROR_TEMPLATE_ID

See Also:

Constant Field Values

CONTEXT_VALUE_ERROR_REGION_ID

public static final String CONTEXT_VALUE_ERROR_REGION_ID

See Also:

Constant Field Values

CONTEXT_VALUE_ERROR_REGION_SCOPE_ID

public static final String CONTEXT_VALUE_ERROR_REGION_SCOPE_ID

See Also:

Constant Field Values

CONTEXT_VALUE_ERROR_REGION_SOURCE_ID

public static final String CONTEXT_VALUE_ERROR_REGION_SOURCE_ID

See Also:

Constant Field Values

CONTEXT_VALUE_ERROR_COMPONENT_ID

public static final String CONTEXT_VALUE_ERROR_COMPONENT_ID

See Also:

Constant Field Values

CONTEXT_VALUE_ERROR_TITLE

public static final String CONTEXT_VALUE_ERROR_TITLE

See Also:

Constant Field Values

CONTEXT_VALUE_ERROR_DESCRIPTION

public static final String CONTEXT_VALUE_ERROR_DESCRIPTION

See Also:

Constant Field Values

CONTEXT_VALUE_STACKTRACE

public static final String CONTEXT_VALUE_STACKTRACE

See Also:

Constant Field Values

NEWLINE

public static final String NEWLINE

See Also:

Constant Field Values

Constructor Detail

RenderService

public RenderService()

Method Detail

getRenditionProcessorById

public Processor getRenditionProcessorById(String id)

Returns a rendition processor for the given id (i.e. jsp, webscript, etc)

Parameters:

id - String

Returns:

processor

getRenditionProcessor

public Processor getRenditionProcessor(Renderable renderable)

Returns a rendition processor for a renderable in the default VIEW render mode

Parameters:

renderable - Renderable

Returns:

Processor

getRenditionProcessor

public Processor getRenditionProcessor(Renderable renderable,
                              RenderMode renderMode)

Returns a rendition processor for a renderable in the given render mode

Parameters:

renderable - Renderable

renderMode - RenderMode

Returns:

Processor

processRenderable

public void processRenderable(RequestContext context,
                     RenderFocus renderFocus,
                     ModelObject object,
                     Renderable renderable)
                       throws RendererExecutionException

Executes the processor for the given focus on the provided renderable object.

Parameters:

context - RequestContext

renderFocus - RenderFocus

object - ModelObject

renderable - Renderable

Throws:

RendererExecutionException

getSurfBug

public SurfBug getSurfBug()

Returns the SurfBug instance associated with the running application (which will be obtained from the ModelObjectService if not previously obtained.

Returns:

The instance of SurfBug associated with the running application.

processComponent

public void processComponent(RequestContext context,
                    RenderFocus renderFocus,
                    Component component,
                    boolean chromeless)
                      throws RendererExecutionException

Executes the processor for the given render focus on the given component instance.

Parameters:

context - RequestContext

renderFocus - RenderFocus

component - Component

chromeless - boolean

Throws:

RendererExecutionException

renderSubComponent

public void renderSubComponent(SubComponent subComponent,
                      RequestContext context,
                      RenderFocus renderFocus)

Renders the supplied SubComponent.

Parameters:

subComponent - The SubComponent to render.

context - The current RequestContext

renderFocus - The current focus of the request.

processTemplate

public void processTemplate(RequestContext context,
                   RenderFocus renderFocus,
                   TemplateInstance template)
                     throws RendererExecutionException

Executes the processor for the given render focus on the given template instance.

Parameters:

context - RequestContext

renderFocus - RenderFocus

template - TemplateInstance

Throws:

RendererExecutionException

renderPage

public void renderPage(RequestContext context,
              RenderFocus renderFocus)

Entry point for the rendering of the current page as provided by the request context.

Parameters:

context - the render context

renderTemplate

public void renderTemplate(RequestContext context,
                  RenderFocus renderFocus)

Entry point for the rendering of the current content item as provided by the request context.

Parameters:

context - the render context

renderFocus - the render focus

renderRegion

public void renderRegion(RequestContext context,
                RenderFocus renderFocus,
                String templateId,
                String regionId,
                String regionScopeId,
                String overrideChromeId,
                boolean chromeless)

Entry point for the rendering a region of a given template

Parameters:

context - RequestContext

renderFocus - RenderFocus

templateId - String

regionId - String

regionScopeId - String

overrideChromeId - String

chromeless - boolean

renderRegionComponents

public void renderRegionComponents(RequestContext context,
                          ModelObject object,
                          boolean chromeless)
                            throws RendererExecutionException

Renders the components of the region described by the render context This method is generally called from the region include tag.

Parameters:

context - RequestContext

object - ModelObject

chromeless - boolean

Throws:

RendererExecutionException

renderComponent

public void renderComponent(RequestContext context,
                   RenderFocus renderFocus,
                   Component component,
                   String chromeIdOverride,
                   boolean chromeless)

Entry point for the rendering a single identified component with the default chrome.

Parameters:

context - RequestContext

renderFocus - RenderFocus

component - Component

chromeIdOverride - String

chromeless - boolean

renderComponent

public void renderComponent(RequestContext context,
                   RenderFocus renderFocus,
                   String componentId,
                   String overrideChromeId,
                   boolean chromeless)

Entry point for the rendering a component with the given chrome.

Parameters:

context - RequestContext

renderFocus - RenderFocus

componentId - String

overrideChromeId - String

chromeless - boolean

getRegionChrome

public Chrome getRegionChrome(String regionId,
                     String chromeId)

Returns the Chrome instance to utilize while rendering the given region on the given template.

getComponentBoundToRegion

public Component getComponentBoundToRegion(RequestContext context,
                                  String regionId,
                                  String regionScopeId,
                                  String regionSourceId)

Determines the component which is bound to the given region If there is no component bound, then null is returned.

Parameters:

context - RequestContext

regionId - String

regionScopeId - String

regionSourceId - String

Returns:

the component

renderErrorHandlerPage

public boolean renderErrorHandlerPage(RequestContext context,
                             String errorHandlerPageId)
                               throws RendererExecutionException

Renders a default error handler page A system page can be configured to handle a fault state for the web framework. Several fault states exist and a system page provides a way for default presentation to be rendered back.

Parameters:

context - RequestContext

errorHandlerPageId - String

Returns:

whether an error handler page could handle the fault

Throws:

RendererExecutionException

renderSystemPage

public boolean renderSystemPage(RequestContext context,
                       String systemPageId)
                         throws RendererExecutionException

Renders a default system page A system container is a page fragment that is rendered as a container of other elements like components.

Parameters:

context - RequestContext

systemPageId - String

Returns:

whether the system page was

Throws:

RendererExecutionException

renderTemplateHeaderAsString

public String renderTemplateHeaderAsString(RequestContext context,
                                  ModelObject object)
                                    throws RendererExecutionException,
                                           UnsupportedEncodingException

Generates text to be inserted into template markup head for a given renderer context. The renderer context must describe a template.

Parameters:

context - RequestContext

object - ModelObject

Returns:

head tags render output

Throws:

RendererExecutionException

UnsupportedEncodingException

setResourceService

public void setResourceService(ResourceService resourceService)

This setter method is provided so that Spring can inject a ResourceService into this bean.

Parameters:

resourceService - ResourceService

setLinkBuilderFactory

public void setLinkBuilderFactory(LinkBuilderFactory linkBuilderFactory)

This method is provided to allow the Spring framework to inject a LinkBuilderFactory into this class when it is instantiated as a Spring bean. As well as setting the LinkBuilderFactory it will also use the factory to create a new LinkBuilder.

Parameters:

linkBuilderFactory - LinkBuilderFactory

renderSurfBugInclude

public void renderSurfBugInclude(RequestContext context)
                          throws RendererExecutionException

Convenience method provided for both the "surfbugInclude" FreeMarker directive and JSP tag to use. Currently this only defers control to the processComponent method but in the future may be required to carry out additional processing

Parameters:

context - RequestContext

Throws:

RendererExecutionException

renderChromeInclude

public void renderChromeInclude(RequestContext context,
                       ModelObject object)
                         throws RequestDispatchException

Renders either a component or a region depending upon the value of RENDER_TYPE key set in the current RequestContext. This means that either the <componentInclude> or <regionInclude> tag can be incorrectly used within the chrome implementation without errors occurring.

Parameters:

context - RequestContext

object - ModelObject

Throws:

RequestDispatchException

generateAnchorLink

public String generateAnchorLink(String pageTypeId,
                        String pageId,
                        String objectId,
                        String formatId,
                        String target)

This method wraps the generateLink method to place the link inside an HTML anchor tag which is then returned. The anchor tag can optionally include a "target" property if one is provided.

Parameters:

pageTypeId - String

pageId - String

objectId - String

formatId - String

target - String

Returns:

String

generateLink

public String generateLink(String pageTypeId,
                  String pageId,
                  String objectId,
                  String formatId)

Uses the LinkBuilder created from the LinkBuilderFactory that should have been set as a property of this class when instantiated as a Spring bean.

Parameters:

pageTypeId - String

pageId - String

objectId - String

formatId - String

Returns:

String

generateResourceURL

public String generateResourceURL(RequestContext renderContext,
                         ModelObject object,
                         String name,
                         String id,
                         String protocol,
                         String endpoint,
                         String objectId,
                         String payload)

Parameters:

renderContext - RequestContext

name - ModelObject

id - String

protocol - String

endpoint - String

objectId - String

payload - String

Returns:

String

updateStyleSheetImports

public void updateStyleSheetImports(RequestContext context,
                           String href)

Adds to the (or creates a new) LinkedList of CSS style sheet URLs stored as the WebFrameworkConstants.STYLESHEET_RENDER_CONTEXT_NAME attribute in the supplied RequestContext.

Parameters:

context - RequestContext

href - String

handleError

protected void handleError(RequestContext context,
               String errorTitle,
               String errorDescription,
               Throwable t)
                    throws RequestDispatchException

This method sets up the RequestContext and attempts to redirect the request to the general error page. It only sets the context with non-null arguments. Ideally, a title, description and Throwable instance should be supplied to provide as much debug information as possible. The description should be as verbose as possible and can contain HTML elements to format the output if required.

Currently the output is not translated. In the future this should be updated to accept NLS keys to make the error page consumable in other languages.

Parameters:

context - The context to add the diagnostic information to.

errorTitle - The title of the error (a short explanation of what went wrong!)

errorDescription - A verbose description of what has happened and what could be done to address the issue.

t - A Throwable instance from which to obtain a stack trace to display.

Throws:

RequestDispatchException

handleRenderProblem

protected void handleRenderProblem(String targetId,
                       String errorPageId,
                       RequestContext context,
                       Throwable t)

This method is invoked whenever the RenderService fails to render something. It renders the requested error page (hopefully!) indicating the cause of the problem.

Parameters:

targetId - The id of the page/template/region/component that could not be rendered

errorPageId - The target error page to render

context - The current RequestContext

setModelObjectService

public void setModelObjectService(ModelObjectService modelObjectService)

setWebFrameworkConfiguration

public void setWebFrameworkConfiguration(WebFrameworkConfigElement webFrameworkConfiguration)

setPageRenderer

public void setPageRenderer(PageRenderer pageRenderer)

setTemplateRenderer

public void setTemplateRenderer(TemplateInstanceRenderer templateRenderer)

setRegionRenderer

public void setRegionRenderer(RegionRenderer regionRenderer)

setComponentRenderer

public void setComponentRenderer(ComponentRenderer componentRenderer)

setChromeRenderer

public void setChromeRenderer(ChromeRenderer chromeRenderer)

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Throws:

org.springframework.beans.BeansException

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.

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.

setDojoDependencyHandler

public void setDojoDependencyHandler(DojoDependencyHandler dojoDependencyHandler)