org.apache.jetspeed.aggregator
Interface PortletRenderer


public interface PortletRenderer

PortletRendererService
Jetspeed-2 Rendering service.

This service process all portlet rendering requests and interfaces with the portlet container to generate the resulting markup

Version:
$Id: PortletRenderer.java 591867 2007-11-05 02:20:06Z woonsan $
Author:
Rapha?l Luta, David Sean Taylor, Woonsan Ko

Method Summary
 void addTitleToHeader(org.apache.pluto.om.window.PortletWindow portletWindow, ContentFragment fragment, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, ContentDispatcherCtrl dispatcher, boolean isCacheTitle)
          Set title of portlet window.
 RenderingJob createRenderingJob(ContentFragment fragment, RequestContext request)
          Create a rendering job for the specified Page fragment.
 ContentDispatcher getDispatcher(RequestContext request, boolean isParallel)
          Retrieve the ContentDispatcher for the specified request
 PortletTrackingManager getPortletTrackingManager()
           
 void notifyContentComplete(PortletContent content)
          Notify that content completed by worker jobs So that renderer can update its state
 void processRenderingJob(RenderingJob job)
          Render the specified rendering job.
 RenderingJob render(ContentFragment fragment, RequestContext request)
          Deprecated.  
 void renderNow(ContentFragment fragment, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Render the specified Page fragment.
 void renderNow(ContentFragment fragment, RequestContext request)
          Render the specified Page fragment.
 void waitForRenderingJobs(List renderingJobs)
          Wait for all rendering jobs in the collection to finish successfully or otherwise.
 

Method Detail

renderNow

void renderNow(ContentFragment fragment,
               RequestContext request)
Render the specified Page fragment. Result is returned in the PortletResponse.

Throws:
FailedToRenderFragmentException
FailedToRetrievePortletWindow
UnknownPortletDefinitionException
PortletAccessDeniedException

renderNow

void renderNow(ContentFragment fragment,
               javax.servlet.http.HttpServletRequest request,
               javax.servlet.http.HttpServletResponse response)
Render the specified Page fragment. Result is returned in the PortletResponse.

Throws:
FailedToRenderFragmentException
FailedToRetrievePortletWindow
UnknownPortletDefinitionException
PortletAccessDeniedException

render

RenderingJob render(ContentFragment fragment,
                    RequestContext request)
Deprecated. 

Render the specified Page fragment. The method returns before rendering is complete, rendered content can be accessed through the ContentDispatcher

Returns:
the asynchronous portlet rendering job to synchronize

createRenderingJob

RenderingJob createRenderingJob(ContentFragment fragment,
                                RequestContext request)
Create a rendering job for the specified Page fragment. The method returns a rendering job which should be passed to 'processRenderingJob(RenderingJob job)' method.

Returns:
portlet rendering job to pass to render(RenderingJob job) method
Throws:
FailedToRetrievePortletWindow
UnknownPortletDefinitionException
PortletAccessDeniedException

processRenderingJob

void processRenderingJob(RenderingJob job)
Render the specified rendering job. The method returns before rendering is complete when the job is processed in parallel mode. When the job is not parallel mode, it returns after rendering is complete.

Throws:
FailedToRenderFragmentException

waitForRenderingJobs

void waitForRenderingJobs(List renderingJobs)
Wait for all rendering jobs in the collection to finish successfully or otherwise.

Parameters:
renderingJobs - the Collection of rendering job objects to wait for.

getDispatcher

ContentDispatcher getDispatcher(RequestContext request,
                                boolean isParallel)
Retrieve the ContentDispatcher for the specified request


notifyContentComplete

void notifyContentComplete(PortletContent content)
Notify that content completed by worker jobs So that renderer can update its state

Parameters:
content -

addTitleToHeader

void addTitleToHeader(org.apache.pluto.om.window.PortletWindow portletWindow,
                      ContentFragment fragment,
                      javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response,
                      ContentDispatcherCtrl dispatcher,
                      boolean isCacheTitle)
Set title of portlet window.

Parameters:
portletWindow -
fragment -
request -
response -
dispatcher -
isCacheTitle -

getPortletTrackingManager

PortletTrackingManager getPortletTrackingManager()


Copyright © 1999-2007 Apache Software Foundation. All Rights Reserved.