org.apache.jetspeed.aggregator

Interface PortletRenderer

public interface PortletRenderer

The Portlet Renderer Service is the interface to processing portlet rendering requests and interfaces with the portlet container to generate the resulting markup. The renderer is called by the aggregator PortletAggregator to render the content of one portlet. The render works directly with ContentFragments, which are wrappers around portlet instances.

Version:

$Id: PortletRenderer.java 1510080 2013-08-03 23:35:19Z taylor $

Author:

Rapha�l Luta, David Sean Taylor, Woonsan Ko

Method Summary

Methods

Modifier and Type	Method and Description
RenderingJob	createRenderingJob(ContentFragment fragment, RequestContext request) Create a rendering job for the specified content fragment.
PortletTrackingManager	getPortletTrackingManager() Returns an instance of the PortletTrackingManager which is monitoring this rendering request.
void	notifyContentComplete(RequestContext context, PortletWindow window) Notification callback from job to this renderer informing that the content rendering has completed.
void	processRenderingJob(RenderingJob job) Processes the actual rendering of the specified rendering job, dispatching to the portlet container to process the rendering of a portlet instance.
void	renderNow(ContentFragment fragment, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Deprecated.
void	renderNow(ContentFragment fragment, RequestContext request) Renders the specified fragment immediately.
void	renderNow(ContentFragment fragment, RequestContext request, boolean spawned) Render the specified fragment immediately.
void	waitForRenderingJobs(List<RenderingJob> renderingJobs) Waits for all rendering jobs in the list of jobs to finish successfully or otherwise.

Method Detail

renderNow

void renderNow(ContentFragment fragment,
             RequestContext request)

Renders the specified fragment immediately.

Parameters:

fragment - represents the content and runtime preferences about the portlet instance to be rendered

request - the request context holding runtime request parameters to be normalized

renderNow

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

Render the specified fragment immediately. If spawned is set to true, the rendering can occur in a separate thread from the current (rendering) thread.

Parameters:

fragment - represents the content and runtime preferences about the portlet instance to be rendered

request - the request context holding runtime request parameters to be normalized

spawned - true if this rendering to occur in a separate thread

renderNow

void renderNow(ContentFragment fragment,
             javax.servlet.http.HttpServletRequest request,
             javax.servlet.http.HttpServletResponse response)

Deprecated.

Render the specified fragment immediately. If spawned is set to true, the rendering can occur in a separate thread from the current (rendering) thread.

Parameters:

fragment - represents the content and runtime preferences about the portlet instance to be rendered

request - the servlet request

response - the servlet response

createRenderingJob

RenderingJob createRenderingJob(ContentFragment fragment,
                              RequestContext request)
                                throws PortletAccessDeniedException

Create a rendering job for the specified content fragment. All rendering is done under the context of a rendering job, whether is scheduled in parallel, or sequential. The returned job is passed to the processRenderingJob(RenderingJob job) method.

Parameters:

fragment - represents the content and runtime preferences about the portlet instance to be rendered

request - the request context holding runtime request parameters to be normalized

Returns:

a portlet rendering job to pass to processRenderingJob(RenderingJob job) method

Throws:

PortletAccessDeniedException

processRenderingJob

void processRenderingJob(RenderingJob job)

Processes the actual rendering of the specified rendering job, dispatching to the portlet container to process the rendering of a portlet instance. The implementation can return 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.

Parameters:

job - the rendering job to process

waitForRenderingJobs

void waitForRenderingJobs(List<RenderingJob> renderingJobs)

Waits for all rendering jobs in the list of jobs to finish successfully or otherwise.

Parameters:

renderingJobs - the list of rendering job objects to wait for.

notifyContentComplete

void notifyContentComplete(RequestContext context,
                         PortletWindow window)

Notification callback from job to this renderer informing that the content rendering has completed.

Parameters:

context - the request context holding runtime request parameters to be normalized

window - the portlet window associated with the job

getPortletTrackingManager

PortletTrackingManager getPortletTrackingManager()

Returns an instance of the PortletTrackingManager which is monitoring this rendering request.

Returns:

the PortletTrackingManager