org.codehaus.plexus.summit.parameters
Interface RequestParameterParser

All Known Implementing Classes:
BaseRequestParameterParser

public interface RequestParameterParser

Parses an HTTP GET/POST request for parameters passed via the query info and/or path info. The parser generates a map of parameters which is then wrapped in a RequestParameters object that provides numerous convienence methods that operate on the map.

Author:
Pete Kazmier

Field Summary
static java.lang.String ROLE
          The role.
 
Method Summary
 RequestParameters parse(javax.servlet.http.HttpServletRequest request)
          Parses the query info and path info of an HTTP request for parameters in the form of name/value pairs.
 

Field Detail

ROLE

public static final java.lang.String ROLE
The role.

Method Detail

parse

public RequestParameters parse(javax.servlet.http.HttpServletRequest request)
Parses the query info and path info of an HTTP request for parameters in the form of name/value pairs. The parameters are returned to the user wrapped by RequestParameters.

Parameters:
request - The HTTP request to parse for parameters.
Returns:
RequestParameters The requested parameters wrapped in a RequestParameters object for easy access to the parameters.