org.jasig.portal.portlet.rendering
Class PortletRendererImpl

java.lang.Object
  org.jasig.portal.portlet.rendering.PortletRendererImpl

All Implemented Interfaces:

IPortletRenderer

public class PortletRendererImpl
extends Object
implements IPortletRenderer

Executes methods on portlets using Pluto

Version:

$Revision$

Author:

Eric Dalquist

Field Summary

protected org.apache.commons.logging.Log

logger

Constructor Summary

PortletRendererImpl()

Method Summary

void	doAction(IPortletWindowId portletWindowId, HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse) Executes an action in a portlet, handles all the request and response setup and teardown
IPortletWindowId	doInit(IPortletEntity portletEntity, IPortletWindowId portletWindowId, HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse) Initializes the portlet within the portlet container
PortletRenderResult	doRender(IPortletWindowId portletWindowId, HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Writer printWriter) Executes a render in a portlet, handles all the request and response setup and teardown
void	doReset(IPortletWindowId portletWindowId, HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse) Resets a portlet's window data to the defaults and clears all portlet scoped session data
void	setPersonManager(IPersonManager personManager)
void	setPortletContainer(org.apache.pluto.PortletContainer portletContainer)
void	setPortletDefinitionRegistry(IPortletDefinitionRegistry portletDefinitionRegistry)
void	setPortletDelegationLocator(PortletDelegationLocator portletDelegationLocator)
void	setPortletEntityRegistry(IPortletEntityRegistry portletEntityRegistry)
void	setPortletRequestParameterManager(IPortletRequestParameterManager portletRequestParameterManager)
void	setPortletWindowRegistry(IPortletWindowRegistry portletWindowRegistry)
protected HttpServletRequest	setupPortletRequest(HttpServletRequest httpServletRequest, IPortletWindow portletWindow, Map<String,List<String>> parameters)
protected void	setupPortletWindow(HttpServletRequest httpServletRequest, IPortletWindow portletWindow, PortletUrl portletUrl)

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.apache.commons.logging.Log logger

Constructor Detail

PortletRendererImpl

public PortletRendererImpl()

Method Detail

setPersonManager

public void setPersonManager(IPersonManager personManager)

setPortletDefinitionRegistry

public void setPortletDefinitionRegistry(IPortletDefinitionRegistry portletDefinitionRegistry)

setPortletEntityRegistry

public void setPortletEntityRegistry(IPortletEntityRegistry portletEntityRegistry)

setPortletWindowRegistry

public void setPortletWindowRegistry(IPortletWindowRegistry portletWindowRegistry)

setPortletContainer

public void setPortletContainer(org.apache.pluto.PortletContainer portletContainer)

setPortletRequestParameterManager

public void setPortletRequestParameterManager(IPortletRequestParameterManager portletRequestParameterManager)

setPortletDelegationLocator

public void setPortletDelegationLocator(PortletDelegationLocator portletDelegationLocator)

doInit

public IPortletWindowId doInit(IPortletEntity portletEntity,
                               IPortletWindowId portletWindowId,
                               HttpServletRequest httpServletRequest,
                               HttpServletResponse httpServletResponse)

Description copied from interface: IPortletRenderer

Initializes the portlet within the portlet container

Specified by:

doInit in interface IPortletRenderer

Parameters:

portletEntity - The portlet entity to base the window on

portletWindowId - Window ID of the portlet to inititalize, may be null

httpServletRequest - The portal's request

httpServletResponse - The portal's response (nothing will be written to the response)

Returns:

The correct portlet window ID, this ID should be used to track the portlet that was initialized

doAction

public void doAction(IPortletWindowId portletWindowId,
                     HttpServletRequest httpServletRequest,
                     HttpServletResponse httpServletResponse)

Description copied from interface: IPortletRenderer

Executes an action in a portlet, handles all the request and response setup and teardown

Specified by:

doAction in interface IPortletRenderer

Parameters:

portletWindowId - Portlet to target with the action

httpServletRequest - The portal's request

httpServletResponse - The portal's response (nothing will be written to the response)

doRender

public PortletRenderResult doRender(IPortletWindowId portletWindowId,
                                    HttpServletRequest httpServletRequest,
                                    HttpServletResponse httpServletResponse,
                                    Writer printWriter)

Description copied from interface: IPortletRenderer

Executes a render in a portlet, handles all the request and response setup and teardown

Specified by:

doRender in interface IPortletRenderer

Parameters:

portletWindowId - Portlet to target with the render

httpServletRequest - The portal's request

httpServletResponse - The portal's response (nothing will be written to the response)

printWriter - The writer to write the portlet's output to

doReset

public void doReset(IPortletWindowId portletWindowId,
                    HttpServletRequest httpServletRequest,
                    HttpServletResponse httpServletResponse)

Description copied from interface: IPortletRenderer

Resets a portlet's window data to the defaults and clears all portlet scoped session data

Specified by:

doReset in interface IPortletRenderer

Parameters:

portletWindowId - Portlet to target with the render

httpServletRequest - The portal's request

httpServletResponse - The portal's response (nothing will be written to the response)

setupPortletRequest

protected HttpServletRequest setupPortletRequest(HttpServletRequest httpServletRequest,
                                                 IPortletWindow portletWindow,
                                                 Map<String,List<String>> parameters)

setupPortletWindow

protected void setupPortletWindow(HttpServletRequest httpServletRequest,
                                  IPortletWindow portletWindow,
                                  PortletUrl portletUrl)