org.jahia.services.render

Class RenderService

java.lang.Object

org.jahia.services.render.RenderService

All Implemented Interfaces:

org.springframework.beans.factory.InitializingBean

public class RenderService
extends Object
implements org.springframework.beans.factory.InitializingBean

Service to render node

Author:

toto

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RenderService.RenderServiceBeanPostProcessor

Field Summary

Fields

Modifier and Type	Field and Description
static String	RENDER_SERVICE_TEMPLATES_CACHE

Constructor Summary

Constructors

Constructor and Description
RenderService()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
void	flushCache(String modulePath)
static RenderService	getInstance()
List<String>	getNodeTypesWithTheme()
RenderChain	getRenderChainInstance() Returns a new instance of the RenderChain with all filters.
Collection<ScriptResolver>	getScriptResolvers()
List<JCRNodeWrapper>	getTemplateNodes(String templateName, String path, String type, boolean defaultOnly, JCRSessionWrapper session)
SortedSet<View>	getViewsSet(ExtendedNodeType nt, JCRSiteNode site, String templateType)
boolean	hasView(ExtendedNodeType nt, String key, JCRSiteNode site, String templateType, RenderContext renderContext)
boolean	hasView(JCRNodeWrapper node, String key, String templateType, RenderContext renderContext)
String	render(Resource resource, RenderContext context) Render a specific resource and returns it as a StringBuffer.
Script	resolveScript(Resource resource, RenderContext context) This resolves the executable script from the resource object.
Template	resolveTemplate(Resource resource, RenderContext renderContext)
void	setCacheProvider(EhCacheProvider cacheProvider)
void	setChannelService(ChannelService channelService)
void	setNodeTypesWithTheme(List<String> nodeTypesWithTheme)
void	setRenderTimeMonitor(RenderTimeMonitor renderChainMonitor)
void	setScriptResolvers(Collection<ScriptResolver> scriptResolvers)
void	setSettingsBean(SettingsBean settingsBean)
void	setTemplateManagerService(JahiaTemplateManagerService templateManagerService)
void	setTemplatesCacheLockTimeout(long templatesCacheLockTimeout)
void	setUserManagerService(JahiaUserManagerService userManagerService)
void	start()
void	stop()

Methods inherited from class java.lang.Object

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

Field Detail

RENDER_SERVICE_TEMPLATES_CACHE

public static final String RENDER_SERVICE_TEMPLATES_CACHE

See Also:

Constant Field Values

Constructor Detail

RenderService

public RenderService()

Method Detail

getInstance

public static RenderService getInstance()

setTemplateManagerService

public void setTemplateManagerService(JahiaTemplateManagerService templateManagerService)

setScriptResolvers

public void setScriptResolvers(Collection<ScriptResolver> scriptResolvers)

getScriptResolvers

public Collection<ScriptResolver> getScriptResolvers()

getNodeTypesWithTheme

public List<String> getNodeTypesWithTheme()

setNodeTypesWithTheme

public void setNodeTypesWithTheme(List<String> nodeTypesWithTheme)

start

public void start()
           throws JahiaInitializationException

Throws:

JahiaInitializationException

stop

public void stop()
          throws JahiaException

Throws:

JahiaException

render

public String render(Resource resource,
                     RenderContext context)
              throws RenderException

Render a specific resource and returns it as a StringBuffer.

Parameters:

resource - Resource to display

context - The render context

Returns:

The rendered result

Throws:

RenderException - in case of rendering issues

resolveScript

public Script resolveScript(Resource resource,
                            RenderContext context)
                     throws javax.jcr.RepositoryException,
                            TemplateNotFoundException

This resolves the executable script from the resource object. This should be able to find the proper script depending of the template / template type. Currently resolves only simple JSPScript.

If template cannot be resolved, fall back on default template

Parameters:

resource - The resource to display

context - rendering context instance

Returns:

An executable script

Throws:

javax.jcr.RepositoryException - in case of JCR-related errors

TemplateNotFoundException - in case the template could not be found for the supplied resource

hasView

public boolean hasView(JCRNodeWrapper node,
                       String key,
                       String templateType,
                       RenderContext renderContext)

hasView

public boolean hasView(ExtendedNodeType nt,
                       String key,
                       JCRSiteNode site,
                       String templateType,
                       RenderContext renderContext)

getRenderChainInstance

public RenderChain getRenderChainInstance()

Returns a new instance of the RenderChain with all filters.

Returns:

a new instance of the RenderChain with all filters

getViewsSet

public SortedSet<View> getViewsSet(ExtendedNodeType nt,
                                   JCRSiteNode site,
                                   String templateType)

resolveTemplate

public Template resolveTemplate(Resource resource,
                                RenderContext renderContext)
                         throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

getTemplateNodes

public List<JCRNodeWrapper> getTemplateNodes(String templateName,
                                             String path,
                                             String type,
                                             boolean defaultOnly,
                                             JCRSessionWrapper session)
                                      throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

flushCache

public void flushCache(String modulePath)

setCacheProvider

public void setCacheProvider(EhCacheProvider cacheProvider)

setChannelService

public void setChannelService(ChannelService channelService)

setUserManagerService

public void setUserManagerService(JahiaUserManagerService userManagerService)

setRenderTimeMonitor

public void setRenderTimeMonitor(RenderTimeMonitor renderChainMonitor)

setSettingsBean

public void setSettingsBean(SettingsBean settingsBean)

setTemplatesCacheLockTimeout

public void setTemplatesCacheLockTimeout(long templatesCacheLockTimeout)

Parameters:

templatesCacheLockTimeout - the templatesCacheLockTimeout to set

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception