org.jasig.portal.url.support
Interface IChannelRequestParameterManager

All Known Implementing Classes:

ChannelRequestParameterManager

public interface IChannelRequestParameterManager

Manages request parameters for channels for the duration of a HttpServletRequest.

Version:

$Revision$

Author:

Eric Dalquist

Method Summary

Map<String,Object[]>	getChannelParameters(HttpServletRequest request, String channelId) Gets the parameter Map for the specified channel Id for the request.
Set<String>	getTargetedChannelIds(HttpServletRequest request) Get all channelIds that have had parameters associated with them for this request.
void	setChannelParameters(HttpServletRequest request, String channelId, Map<String,Object[]> parameters) Associates the parameter Map with the specified channel ID for the request.
void	setNoChannelParameters(HttpServletRequest request) Mark this request as not having any channel request parameters associated with it.

Method Detail

setNoChannelParameters

void setNoChannelParameters(HttpServletRequest request)

Mark this request as not having any channel request parameters associated with it.

Parameters:

request - The current request.

Throws:

IllegalArgumentException - If request is null

IllegalStateException - if setChannelParameters(HttpServletRequest, String, Map) has already been called

setChannelParameters

void setChannelParameters(HttpServletRequest request,
                          String channelId,
                          Map<String,Object[]> parameters)

Associates the parameter Map with the specified channel ID for the request.

Parameters:

request - The current request.

channelId - The ID of the channel to store parameters for.

parameters - The parameter map for the channel.

Throws:

IllegalArgumentException - If request, channelId, or parameters are null

IllegalStateException - if setNoChannelParameters(HttpServletRequest) has already been called

getTargetedChannelIds

Set<String> getTargetedChannelIds(HttpServletRequest request)

Get all channelIds that have had parameters associated with them for this request.

Parameters:

request - The current request.

Returns:

A Set of channel ids that have had parameters associated with this request.

Throws:

IllegalArgumentException - If request is null

RequestParameterProcessingIncompleteException - If this request doesn't have the necessary information associated with it yet to return the id set

getChannelParameters

Map<String,Object[]> getChannelParameters(HttpServletRequest request,
                                          String channelId)

Gets the parameter Map for the specified channel Id for the request.

Parameters:

request - The current request.

channelId - The ID of the channel to get parameters for.

Returns:

The parameter map for the channel id, null if the request did not target the channel.

Throws:

IllegalArgumentException - If request, or channelId

RequestParameterProcessingIncompleteException - If this request doesn't have the necessary information associated with it yet to return a parameter map.