org.sakaiproject.portal.xsltcharon.impl

Class XsltRenderEngine

java.lang.Object

org.sakaiproject.portal.xsltcharon.impl.XsltRenderEngine

All Implemented Interfaces:

org.sakaiproject.portal.api.PortalRenderEngine

public class XsltRenderEngine
extends Object
implements org.sakaiproject.portal.api.PortalRenderEngine

Created by IntelliJ IDEA. User: johnellis Date: Jul 13, 2007 Time: 12:06:22 PM To change this template use File | Settings | File Templates.

Constructor Summary

Constructors

Constructor and Description
XsltRenderEngine()
XsltRenderEngine(org.sakaiproject.portal.api.PortalService portalService)

Method Summary

Methods

Modifier and Type	Method and Description
protected Templates	createTemplate()
protected Templates	createTemplate(InputStream stream)
protected Templates	createTemplate(String transformerPath)
protected Templates	createTemplate(URL url)
void	destroy()
Templates	getDefaultTemplates()
String	getDefaultTransformerPath()
URIResolver	getLibraryServletResolver()
org.sakaiproject.webapp.api.WebappResourceManager	getLibraryWebappResourceManager()
org.sakaiproject.portal.api.PortalService	getPortalService()
org.sakaiproject.webapp.api.WebappResourceManager	getPortalWebappResourceManager()
URIResolver	getServletResolver()
protected URIResolver	getServletResolver(boolean skin)
protected Templates	getSkinTemplates(XsltRenderContext xrc)
Map<String,Templates>	getTemplates()
Transformer	getTransformer(XsltRenderContext xrc)
Map<String,String>	getTransformerPaths()
void	init() Initialise the render engine
boolean	isCacheTemplates()
org.sakaiproject.portal.api.PortalRenderContext	newRenderContext(HttpServletRequest request) generate a non thread safe render context for the current request/thread/operation
void	render(String template, org.sakaiproject.portal.api.PortalRenderContext rcontext, Writer out) Render a PortalRenderContext against a template.
void	setCacheTemplates(boolean cacheTemplates)
void	setDefaultTemplates(Templates defaultTemplates)
void	setDefaultTransformerPath(String defaultTransformerPath)
void	setLibraryServletResolver(URIResolver libraryServletResolver)
void	setLibraryWebappResourceManager(org.sakaiproject.webapp.api.WebappResourceManager libraryWebappResourceManager)
void	setPortalService(org.sakaiproject.portal.api.PortalService portalService)
void	setPortalWebappResourceManager(org.sakaiproject.webapp.api.WebappResourceManager portalWebappResourceManager)
void	setServletResolver(URIResolver servletResolver)
void	setTemplates(Map<String,Templates> templates)
void	setTransformerPaths(Map<String,String> transformerPaths)
void	setupForward(HttpServletRequest req, HttpServletResponse res, org.sakaiproject.tool.api.Placement p, String skin) prepare for a forward operation in the render engine, this might include modifying the request attributes.
protected void	setupTemplates()
void	springInit()
protected void	writeDocument(Document doc, Writer out, XsltRenderContext xrc)

Methods inherited from class java.lang.Object

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

Constructor Detail

XsltRenderEngine

public XsltRenderEngine()

XsltRenderEngine

public XsltRenderEngine(org.sakaiproject.portal.api.PortalService portalService)

Method Detail

init

public void init()
          throws Exception

Initialise the render engine

Specified by:

init in interface org.sakaiproject.portal.api.PortalRenderEngine

Throws:

Exception

springInit

public void springInit()

setupTemplates

protected void setupTemplates()
                       throws IOException,
                              TransformerConfigurationException

Throws:

IOException

TransformerConfigurationException

destroy

public void destroy()

newRenderContext

public org.sakaiproject.portal.api.PortalRenderContext newRenderContext(HttpServletRequest request)

generate a non thread safe render context for the current request/thread/operation

Specified by:

newRenderContext in interface org.sakaiproject.portal.api.PortalRenderEngine

Parameters:

request -

Returns:

new render context

render

public void render(String template,
          org.sakaiproject.portal.api.PortalRenderContext rcontext,
          Writer out)
            throws Exception

Render a PortalRenderContext against a template. The real template may be based on a skining name, out output will be send to the Writer

Specified by:

render in interface org.sakaiproject.portal.api.PortalRenderEngine

Parameters:

template -

rcontext -

out -

Throws:

Exception

writeDocument

protected void writeDocument(Document doc,
                 Writer out,
                 XsltRenderContext xrc)

getTransformer

public Transformer getTransformer(XsltRenderContext xrc)

getSkinTemplates

protected Templates getSkinTemplates(XsltRenderContext xrc)
                              throws IOException,
                                     TransformerConfigurationException

Throws:

IOException

TransformerConfigurationException

getServletResolver

protected URIResolver getServletResolver(boolean skin)

getDefaultTemplates

public Templates getDefaultTemplates()

setDefaultTemplates

public void setDefaultTemplates(Templates defaultTemplates)

getServletResolver

public URIResolver getServletResolver()

setServletResolver

public void setServletResolver(URIResolver servletResolver)

setupForward

public void setupForward(HttpServletRequest req,
                HttpServletResponse res,
                org.sakaiproject.tool.api.Placement p,
                String skin)

prepare for a forward operation in the render engine, this might include modifying the request attributes.

Specified by:

setupForward in interface org.sakaiproject.portal.api.PortalRenderEngine

Parameters:

req -

res -

p -

skin -

getPortalService

public org.sakaiproject.portal.api.PortalService getPortalService()

setPortalService

public void setPortalService(org.sakaiproject.portal.api.PortalService portalService)

createTemplate

protected Templates createTemplate()
                            throws IOException,
                                   TransformerConfigurationException

Throws:

IOException

TransformerConfigurationException

createTemplate

protected Templates createTemplate(String transformerPath)
                            throws IOException,
                                   TransformerConfigurationException

Throws:

IOException

TransformerConfigurationException

createTemplate

protected Templates createTemplate(URL url)
                            throws IOException,
                                   TransformerConfigurationException

Throws:

IOException

TransformerConfigurationException

createTemplate

protected Templates createTemplate(InputStream stream)
                            throws IOException,
                                   TransformerConfigurationException

Throws:

IOException

TransformerConfigurationException

getDefaultTransformerPath

public String getDefaultTransformerPath()

setDefaultTransformerPath

public void setDefaultTransformerPath(String defaultTransformerPath)

getTemplates

public Map<String,Templates> getTemplates()

setTemplates

public void setTemplates(Map<String,Templates> templates)

getTransformerPaths

public Map<String,String> getTransformerPaths()

setTransformerPaths

public void setTransformerPaths(Map<String,String> transformerPaths)

getLibraryWebappResourceManager

public org.sakaiproject.webapp.api.WebappResourceManager getLibraryWebappResourceManager()

setLibraryWebappResourceManager

public void setLibraryWebappResourceManager(org.sakaiproject.webapp.api.WebappResourceManager libraryWebappResourceManager)

getPortalWebappResourceManager

public org.sakaiproject.webapp.api.WebappResourceManager getPortalWebappResourceManager()

setPortalWebappResourceManager

public void setPortalWebappResourceManager(org.sakaiproject.webapp.api.WebappResourceManager portalWebappResourceManager)

isCacheTemplates

public boolean isCacheTemplates()

setCacheTemplates

public void setCacheTemplates(boolean cacheTemplates)

getLibraryServletResolver

public URIResolver getLibraryServletResolver()

setLibraryServletResolver

public void setLibraryServletResolver(URIResolver libraryServletResolver)