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 765538 2009-04-16 09:33:58Z ate $

Author:

Rapha�l Luta, David Sean Taylor, Woonsan Ko

Method Summary

RenderingJob	createRenderingJob(ContentFragment fragment, RequestContext request) Create a rendering job for the specified Page fragment.
PortletTrackingManager	getPortletTrackingManager()
void	notifyContentComplete(RequestContext context, PortletWindow window) Notify that content completed by worker jobs So that renderer can update its state
void	processRenderingJob(RenderingJob job) Render the specified rendering job.
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	renderNow(ContentFragment fragment, RequestContext request, boolean spawned) Render the specified Page fragment in a separate Thread from the current (rendering) Thread Result is returned in the PortletResponse.
void	waitForRenderingJobs(java.util.List<RenderingJob> 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.

renderNow

void renderNow(ContentFragment fragment,
               RequestContext request,
               boolean spawned)

Render the specified Page fragment in a separate Thread from the current (rendering) Thread Result is returned in the PortletResponse.

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.

createRenderingJob

RenderingJob createRenderingJob(ContentFragment fragment,
                                RequestContext request)
                                throws PortletAccessDeniedException

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:

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.

waitForRenderingJobs

void waitForRenderingJobs(java.util.List<RenderingJob> 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.

notifyContentComplete

void notifyContentComplete(RequestContext context,
                           PortletWindow window)

Notify that content completed by worker jobs So that renderer can update its state

Parameters:

context -

window -

getPortletTrackingManager

PortletTrackingManager getPortletTrackingManager()