org.sakaiproject.portal.api
Interface PortalRenderEngine

public interface PortalRenderEngine

Repesents the API used by the protal to comunicate with the RenderEngine implimentation.

Since:

Sakai 2.4

Version:

$Rev: 59680 $

Author:

ieb

Method Summary

void	init() Initialise the render engine
PortalRenderContext	newRenderContext(javax.servlet.http.HttpServletRequest request) generate a non thread safe render context for the current request/thread/operation
void	render(String template, PortalRenderContext rcontext, Writer out) Render a PortalRenderContext against a template.
void	setupForward(javax.servlet.http.HttpServletRequest req, javax.servlet.http.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.

Method Detail

init

void init()
          throws Exception

Initialise the render engine

Throws:

Exception

newRenderContext

PortalRenderContext newRenderContext(javax.servlet.http.HttpServletRequest request)

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

Parameters:

request -

Returns:

render

void render(String template,
            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

Parameters:

template -

rcontext -

out -

Throws:

Exception

setupForward

void setupForward(javax.servlet.http.HttpServletRequest req,
                  javax.servlet.http.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.

Parameters:

req -

res -

p -

skin -