org.jasig.portal.portlet.rendering
Interface IPortletRenderer

All Known Implementing Classes:

PortletRendererImpl

public interface IPortletRenderer

Provides easy API for executing methods on portlets. Takes care of all of the uPortal specific setup and tear down around portlet calls.

Version:

$Revision$

Author:

Eric Dalquist

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 writer) 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

Method Detail

doInit

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

Initializes the portlet within the portlet container

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

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

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

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

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

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

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)

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

doReset

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

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

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)