org.jasig.portal.url.processing
Class UserLayoutParameterProcessor

java.lang.Object
  org.jasig.portal.url.processing.UserLayoutParameterProcessor

All Implemented Interfaces:

IRequestParameterProcessor

public class UserLayoutParameterProcessor
extends Object
implements IRequestParameterProcessor

This helper class processes HttpServletRequests for parameters relating to user layout actions, propagating appropriate events to the user's layout manager, preferences, and channel manager. This class results from factoring the processUserLayoutParameters method out of UserInstance in an effort to make UserInstance smaller and more literate.

Field Summary

protected org.apache.commons.logging.Log

logger

Constructor Summary

UserLayoutParameterProcessor()

Method Summary

IUserInstanceManager	getUserInstanceManager()
protected void	parseMultiTargetEvent(IWritableHttpServletRequest request, HttpServletResponse response, String parameterName, PortalEvent event, ChannelManager channelManager) Passes the specified event to all channel IDs specified by the parameter.
protected void	parseSingleTargetEvent(IWritableHttpServletRequest request, HttpServletResponse response, String parameterName, PortalEvent event, ChannelManager channelManager) Passes the specified event to the first channel ID specified by the parameter.
boolean	processParameters(IWritableHttpServletRequest request, HttpServletResponse response) Analyze current request, process necessary URL parameters, delivering information to the appropriate components.
void	setUserInstanceManager(IUserInstanceManager userInstanceManager)

Methods inherited from class java.lang.Object

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

Field Detail

logger

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

Constructor Detail

UserLayoutParameterProcessor

public UserLayoutParameterProcessor()

Method Detail

getUserInstanceManager

public IUserInstanceManager getUserInstanceManager()

Returns:

the userInstanceManager

setUserInstanceManager

public void setUserInstanceManager(IUserInstanceManager userInstanceManager)

Parameters:

userInstanceManager - the userInstanceManager to set

processParameters

public boolean processParameters(IWritableHttpServletRequest request,
                                 HttpServletResponse response)

Description copied from interface: IRequestParameterProcessor

Analyze current request, process necessary URL parameters, delivering information to the appropriate components. This method can also add, modify and remove parameters on the request. If the request is not yet in a state where it can be completely processed this method may return false so that it can be called again after other processors have been allowed to execute. Even if false is returned as much processing as possible should happen for each pass.

Specified by:

processParameters in interface IRequestParameterProcessor

parseMultiTargetEvent

protected void parseMultiTargetEvent(IWritableHttpServletRequest request,
                                     HttpServletResponse response,
                                     String parameterName,
                                     PortalEvent event,
                                     ChannelManager channelManager)

Passes the specified event to all channel IDs specified by the parameter.

parseSingleTargetEvent

protected void parseSingleTargetEvent(IWritableHttpServletRequest request,
                                      HttpServletResponse response,
                                      String parameterName,
                                      PortalEvent event,
                                      ChannelManager channelManager)

Passes the specified event to the first channel ID specified by the parameter.