org.jasig.portal.layout.dlm.processing
Interface IParameterProcessor

All Known Implementing Classes:

AjaxPreferencesThemeParamInjector, AuthenticatedUserThemeParamInjector, ExampleStickyTabEnforcer, ProcessingPipe, RegularViewChannelRemover, ThemeParamInjector

public interface IParameterProcessor

Represents an object that can process layout parameters submitted to the portal as part of a request and/or alter the SAX stream representing the user's layout. Implementations of this interface can take part in acting on parameters submitted to the portal dealing with layout manipulation and can also take part in altering or filtering the SAX events of the raw user layout. Implementations of this class enable the decoupling of DistributedLayoutManager from processing needed to handle URL syntax for a specific Structure and/or Theme transformation stylesheet combination. These implementations are made available to the DistributedLayoutManager via properties/context/layoutContext.xml.

Author:

Mark Boyd

Method Summary

void	processParameters(UserPreferences prefs, HttpServletRequest request) Called from DistributedLayoutManager's processLayoutParameters() method allowing this processor to modify the DistributedLayoutManager's state or the state of this object.
void	setResources(IPerson person, DistributedLayoutManager dlm) Sets the IPerson and DistributedLayoutManager objects for use by this object in the implementation of its characteristics.

Method Detail

setResources

void setResources(IPerson person,
                  DistributedLayoutManager dlm)

Sets the IPerson and DistributedLayoutManager objects for use by this object in the implementation of its characteristics.

Parameters:

person -

dlm -

processParameters

void processParameters(UserPreferences prefs,
                       HttpServletRequest request)

Called from DistributedLayoutManager's processLayoutParameters() method allowing this processor to modify the DistributedLayoutManager's state or the state of this object. During rendering of a request for a user the UserInstance object's renderState() method synchronizes access to this call and the call that pushes layout SAX events through this object. Therefore, instance variables can be set on this class as a result of this method being called and then used during handling of the ContentHandler event calls.

Parameters:

prefs -

request -