org.sakaiproject.portal.render.fragment
Class FragmentToolRenderService

java.lang.Object
  org.sakaiproject.portal.render.fragment.FragmentToolRenderService

All Implemented Interfaces:

ToolRenderService

public class FragmentToolRenderService
extends Object
implements ToolRenderService

Attempts to render a tool as a fragment rather than an Iframe.

Since:

Sakai 2.4

Version:

$Rev: 110562 $

Author:

ieb

Constructor Summary

FragmentToolRenderService()

Method Summary

boolean	accept(Portal portal, org.sakaiproject.site.api.ToolConfiguration configuration, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.ServletContext context) This is called during render to accept the request into this tool.
protected void	doTool(org.sakaiproject.site.api.ToolConfiguration toolConfiguration, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, org.sakaiproject.tool.api.Session session, String placementId, String toolContextPath, String toolPathInfo)
protected void	forwardTool(org.sakaiproject.tool.api.ActiveTool tool, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, org.sakaiproject.tool.api.Placement p, String skin, String toolContextPath, String toolPathInfo) Taken from Charon, should be in a service
boolean	preprocess(Portal portal, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.ServletContext context)
RenderResult	render(Portal portal, org.sakaiproject.site.api.ToolConfiguration toolConfiguration, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.ServletContext context)
void	reset(org.sakaiproject.site.api.ToolConfiguration configuration)
void	setPortalService(PortalService portal)

Methods inherited from class java.lang.Object

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

Constructor Detail

FragmentToolRenderService

public FragmentToolRenderService()

Method Detail

accept

public boolean accept(Portal portal,
                      org.sakaiproject.site.api.ToolConfiguration configuration,
                      javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response,
                      javax.servlet.ServletContext context)

This is called during render to accept the request into this tool. If the placement is handled by the FragmentToolRenderService, this should return true, then the render will be invoked.

Specified by:

accept in interface ToolRenderService

preprocess

public boolean preprocess(Portal portal,
                          javax.servlet.http.HttpServletRequest request,
                          javax.servlet.http.HttpServletResponse response,
                          javax.servlet.ServletContext context)
                   throws IOException

Specified by:

preprocess in interface ToolRenderService

Throws:

IOException

render

public RenderResult render(Portal portal,
                           org.sakaiproject.site.api.ToolConfiguration toolConfiguration,
                           javax.servlet.http.HttpServletRequest request,
                           javax.servlet.http.HttpServletResponse response,
                           javax.servlet.ServletContext context)
                    throws IOException,
                           ToolRenderException

Specified by:

render in interface ToolRenderService

Throws:

IOException

ToolRenderException

doTool

protected void doTool(org.sakaiproject.site.api.ToolConfiguration toolConfiguration,
                      javax.servlet.http.HttpServletRequest req,
                      javax.servlet.http.HttpServletResponse res,
                      org.sakaiproject.tool.api.Session session,
                      String placementId,
                      String toolContextPath,
                      String toolPathInfo)
               throws org.sakaiproject.tool.api.ToolException,
                      IOException

Throws:

org.sakaiproject.tool.api.ToolException

IOException

forwardTool

protected void forwardTool(org.sakaiproject.tool.api.ActiveTool tool,
                           javax.servlet.http.HttpServletRequest req,
                           javax.servlet.http.HttpServletResponse res,
                           org.sakaiproject.tool.api.Placement p,
                           String skin,
                           String toolContextPath,
                           String toolPathInfo)
                    throws org.sakaiproject.tool.api.ToolException

Taken from Charon, should be in a service

Parameters:

tool -

req -

res -

p -

skin -

toolContextPath -

toolPathInfo -

Throws:

org.sakaiproject.tool.api.ToolException

setPortalService

public void setPortalService(PortalService portal)

reset

public void reset(org.sakaiproject.site.api.ToolConfiguration configuration)

Specified by:

reset in interface ToolRenderService