org.jasig.portal.rendering
Class StaticRenderingPipeline

java.lang.Object
  org.jasig.portal.rendering.StaticRenderingPipeline

All Implemented Interfaces:

IPortalRenderingPipeline, InitializingBean, ApplicationEventPublisherAware

public class StaticRenderingPipeline
extends Object
implements IPortalRenderingPipeline, ApplicationEventPublisherAware, InitializingBean

Hard-coded rendering pipeline workflow, copied almost exactly from the uPortal 2.X UserInstance code.

Version:

$Revision$

Author:

Eric Dalquist

Nested Class Summary

protected static class

StaticRenderingPipeline.CharacterCacheEntry

Field Summary

protected org.apache.commons.logging.Log

log

Constructor Summary

StaticRenderingPipeline()

Method Summary

void	afterPropertiesSet()
void	clearSystemCharacterCache() Calls Map.clear() on the system character cache.
protected String	constructCacheKey(IUserPreferencesManager uPreferencesManager, String rootNodeId)
protected IUserLayoutFolderDescription	getActiveTab(IUserLayoutManager userLayoutManager, int activeTabIndex)
CarResources	getCarResources()
static MovingAverageSample	getLastRenderSample()
IPortletRequestParameterManager	getPortletRequestParameterManager()
IPortletWindowRegistry	getPortletWindowRegistry()
protected boolean	processWorkerDispatchIfNecessary(HttpServletRequest req, HttpServletResponse res, IUserPreferencesManager uPreferencesManager, ChannelManager cm) A method will determine if current request is a worker dispatch, and if so process it appropriately
void	renderState(HttpServletRequest req, HttpServletResponse res, IUserInstance userInstance) renderState method orchestrates the rendering pipeline which includes worker dispatching, and the rendering process from layout access, to channel rendering, to writing content to the browser.
void	setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)
void	setCarResources(CarResources carResources)
void	setPortletRequestParameterManager(IPortletRequestParameterManager portletRequestParameterManager)
void	setPortletWindowRegistry(IPortletWindowRegistry portletWindowRegistry)
void	setResourcesElementsProvider(org.jasig.resource.aggr.util.ResourcesElementsProvider resourcesElementsProvider)

Methods inherited from class java.lang.Object

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

Field Detail

log

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

Constructor Detail

StaticRenderingPipeline

public StaticRenderingPipeline()

Method Detail

getLastRenderSample

public static MovingAverageSample getLastRenderSample()

getPortletRequestParameterManager

public IPortletRequestParameterManager getPortletRequestParameterManager()

Returns:

the portletRequestParameterManager

setPortletRequestParameterManager

public void setPortletRequestParameterManager(IPortletRequestParameterManager portletRequestParameterManager)

Parameters:

portletRequestParameterManager - the portletRequestParameterManager to set

getPortletWindowRegistry

public IPortletWindowRegistry getPortletWindowRegistry()

Returns:

the portletWindowRegistry

setPortletWindowRegistry

public void setPortletWindowRegistry(IPortletWindowRegistry portletWindowRegistry)

Parameters:

portletWindowRegistry - the portletWindowRegistry to set

getCarResources

public CarResources getCarResources()

setCarResources

public void setCarResources(CarResources carResources)

Parameters:

carResources - the carResources to set

setResourcesElementsProvider

public void setResourcesElementsProvider(org.jasig.resource.aggr.util.ResourcesElementsProvider resourcesElementsProvider)

Parameters:

resourcesDao - the resourcesDao to set

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface InitializingBean

Throws:

Exception

setApplicationEventPublisher

public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)

Specified by:

setApplicationEventPublisher in interface ApplicationEventPublisherAware

renderState

public void renderState(HttpServletRequest req,
                        HttpServletResponse res,
                        IUserInstance userInstance)
                 throws PortalException

Description copied from interface: IPortalRenderingPipeline

renderState method orchestrates the rendering pipeline which includes worker dispatching, and the rendering process from layout access, to channel rendering, to writing content to the browser.

Specified by:

renderState in interface IPortalRenderingPipeline

Parameters:

req - the HttpServletRequest

res - the HttpServletResponse

userInstance - The data object containing all information needed to rendering content for the current user

Throws:

PortalException - if an error occurs

getActiveTab

protected IUserLayoutFolderDescription getActiveTab(IUserLayoutManager userLayoutManager,
                                                    int activeTabIndex)

processWorkerDispatchIfNecessary

protected boolean processWorkerDispatchIfNecessary(HttpServletRequest req,
                                                   HttpServletResponse res,
                                                   IUserPreferencesManager uPreferencesManager,
                                                   ChannelManager cm)
                                            throws PortalException

A method will determine if current request is a worker dispatch, and if so process it appropriately

Returns:

true if a worker was successfully dispatched to, false if no worker dispatch was requested.

Throws:

PortalException - if an error occurs while dispatching

constructCacheKey

protected String constructCacheKey(IUserPreferencesManager uPreferencesManager,
                                   String rootNodeId)
                            throws PortalException

Throws:

PortalException

clearSystemCharacterCache

public void clearSystemCharacterCache()

Calls Map.clear() on the system character cache.

Specified by:

clearSystemCharacterCache in interface IPortalRenderingPipeline

See Also:

IPortalRenderingPipeline.clearSystemCharacterCache()