org.jasig.portal.url.processing
Interface IRequestParameterProcessor

All Known Implementing Classes:

ChannelRequestParameterProcessor, PortletRequestParameterProcessor, UrlRequestParameterProcessor, UserLayoutParameterProcessor

public interface IRequestParameterProcessor

Provides APIs a class can implement if it wishes to be part of the request parameter processing chain. Implementations can read and write request parameters before any other part of the framework deals with the request.

Version:

$Revision: 11911 $

Author:

Eric Dalquist

Method Summary

boolean

processParameters(IWritableHttpServletRequest request, HttpServletResponse response) Analyze current request, process necessary URL parameters, delivering information to the appropriate components.

Method Detail

processParameters

boolean processParameters(IWritableHttpServletRequest request,
                          HttpServletResponse response)

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.

Parameters:

req - - incoming request

res - - outgoing response

Throws:

IllegalArgumentException - If req or res are null.