ParameterParser (webgoat-container 7.1 API)

java.lang.Object
- org.owasp.webgoat.session.ParameterParser

```
public class ParameterParser
extends Object
```
************************************************************************************************* This file is part of WebGoat, an Open Web Application Security Project utility. For details, please see http://www.owasp.org/ Copyright (c) 2002 - 20014 Bruce Mayhew This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. Getting Source ============== Source for this application is maintained at https://github.com/WebGoat/WebGoat, a repository for free software projects.

Version:

$Id: $Id

Author:

Jeff Williams Aspect Security

Constructor Summary

Constructors
Constructor and Description

ParameterParser(javax.servlet.ServletRequest request)
Constructs a new ParameterParser to handle the parameters of the given request.

Constructors
Constructor and Description
`ParameterParser(javax.servlet.ServletRequest request)` Constructs a new ParameterParser to handle the parameters of the given request.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`getBooleanParameter(String name)` Gets the named parameter value as a boolean
`boolean`	`getBooleanParameter(String name, boolean def)` Gets the named parameter value as a boolean, with a default.
`boolean`	`getBooleanSubParameter(String first, String next, boolean def)` Gets the booleanSubParameter attribute of the ParameterParser object
`byte`	`getByteParameter(String name)` Gets the named parameter value as a byte
`byte`	`getByteParameter(String name, byte def)` Gets the named parameter value as a byte, with a default.
`String`	`getCcnParameter(String name)` getCcnParameter.
`char`	`getCharParameter(String name)` Gets the named parameter value as a char
`char`	`getCharParameter(String name, char def)` Gets the named parameter value as a char, with a default.
`String`	`getClassNameParameter(String name)` Gets the classNameParameter attribute of the ParameterParser object
`String`	`getClassNameParameter(String name, String def)` Gets the classNameParameter attribute of the ParameterParser object
`String`	`getDateParameter(String name)` getDateParameter.
`String`	`getDateParameter(String name, String def)` getDateParameter.
`double`	`getDoubleParameter(String name)` Gets the named parameter value as a double
`double`	`getDoubleParameter(String name, double def)` Gets the named parameter value as a double, with a default.
`String`	`getEMailParameter(String name)` getEMailParameter.
`String`	`getEMailParameter(String name, String def)` getEMailParameter.
`float`	`getFloatParameter(String name)` Gets the named parameter value as a float
`float`	`getFloatParameter(String name, float def)` Gets the named parameter value as a float, with a default.
`int`	`getIntParameter(String name)` Gets the named parameter value as a int
`int`	`getIntParameter(String name, int def)` Gets the named parameter value as a int, with a default.
`String`	`getIPParameter(String name)` Gets the named parameter value as an IP String
`String`	`getIPParameter(String name, String def)` Gets the named parameter value as an IP String, with a default.
`long`	`getLongParameter(String name)` Gets the named parameter value as a long
`long`	`getLongParameter(String name, long def)` Gets the named parameter value as a long, with a default.
`String[]`	`getMissingParameters(String[] requestuired)` Determines which of the required parameters were missing from the request.
`Enumeration<String>`	`getParameterNames()` Gets the parameterNames attribute of the ParameterParser object
`String[]`	`getParameterValues(String name)` Gets the parameterValues attribute of the ParameterParser object
`String`	`getPhoneParameter(String name)` getPhoneParameter.
`String`	`getPhoneParameter(String name, String def)` getPhoneParameter.
`String`	`getRawParameter(String name)` Gets the rawParameter attribute of the ParameterParser object
`String`	`getRawParameter(String name, String def)` Gets the rawParameter attribute of the ParameterParser object
`short`	`getShortParameter(String name)` Gets the named parameter value as a short
`short`	`getShortParameter(String name, short def)` Gets the named parameter value as a short, with a default.
`String`	`getSsnParameter(String name)` getSsnParameter.
`String`	`getStrictAlphaParameter(String name, int maxLength)` getStrictAlphaParameter.
`String`	`getStrictNumericParameter(String name, int maxLength)` getStrictNumericParameter.
`String`	`getStringParameter(String name)` Gets the named parameter value as a String
`String`	`getStringParameter(String name, String def)` Gets the named parameter value as a String, with a default.
`String`	`getSubParameter(String first, String next)` Gets the parameter named 'next' following the parameter 'first'.
`String`	`getSubParameter(String first, String next, String def)` Gets the subParameter attribute of the ParameterParser object
`String`	`getURLParameter(String name)` getURLParameter.
`String`	`getURLParameter(String name, String def)` getURLParameter.
`String`	`getWordParameter(String name)` Gets the wordParameter attribute of the ParameterParser object
`String`	`getWordParameter(String name, String def)` Gets the wordParameter attribute of the ParameterParser object
`String`	`getZipParameter(String name)` getZipParameter.
`String`	`getZipParameter(String name, String def)` getZipParameter.
`protected static String`	`htmlEncode(String s)` htmlEncode.
`String`	`toString()` Description of the Method
`void`	`update(javax.servlet.ServletRequest request)` Description of the Method

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ParameterParser
```
public ParameterParser(javax.servlet.ServletRequest request)
```
    Constructs a new ParameterParser to handle the parameters of the given request.
    
    Parameters:
    
    request - the servlet request
- Method Detail
  - getBooleanParameter
```
public boolean getBooleanParameter(String name)
                            throws ParameterNotFoundException
```
    Gets the named parameter value as a boolean
    
    Parameters:
    
    name - the parameter name
    
    Returns:
    
    the parameter value as a boolean
    
    Throws:
    
    ParameterNotFoundException - if the parameter was not found
    
    ParameterNotFoundException - if any.
  - getBooleanParameter
```
public boolean getBooleanParameter(String name,
                                   boolean def)
```
    Gets the named parameter value as a boolean, with a default. Returns the default value if the parameter is not found.
    
    Parameters:
    
    name - the parameter name
    
    def - the default parameter value
    
    Returns:
    
    the parameter value as a boolean, or the default
  - getBooleanSubParameter
```
public boolean getBooleanSubParameter(String first,
                                      String next,
                                      boolean def)
```
    Gets the booleanSubParameter attribute of the ParameterParser object
    
    Parameters:
    
    first - Description of the Parameter
    
    next - Description of the Parameter
    
    def - Description of the Parameter
    
    Returns:
    
    The booleanSubParameter value
  - getByteParameter
```
public byte getByteParameter(String name)
                      throws ParameterNotFoundException,
                             NumberFormatException
```
    Gets the named parameter value as a byte
    
    Parameters:
    
    name - the parameter name
    
    Returns:
    
    the parameter value as a byte
    
    Throws:
    
    ParameterNotFoundException - if the parameter was not found
    
    NumberFormatException - if the parameter value could not be converted to a byte
    
    ParameterNotFoundException - if any.
    
    NumberFormatException - if any.
  - getByteParameter
```
public byte getByteParameter(String name,
                             byte def)
```
    Gets the named parameter value as a byte, with a default. Returns the default value if the parameter is not found or cannot be converted to a byte.
    
    Parameters:
    
    name - the parameter name
    
    def - the default parameter value
    
    Returns:
    
    the parameter value as a byte, or the default
  - getCharParameter
```
public char getCharParameter(String name)
                      throws ParameterNotFoundException
```
    Gets the named parameter value as a char
    
    Parameters:
    
    name - the parameter name
    
    Returns:
    
    the parameter value as a char
    
    Throws:
    
    ParameterNotFoundException - if the parameter was not found or was the empty string
    
    ParameterNotFoundException - if any.
  - getCharParameter
```
public char getCharParameter(String name,
                             char def)
```
    Gets the named parameter value as a char, with a default. Returns the default value if the parameter is not found.
    
    Parameters:
    
    name - the parameter name
    
    def - the default parameter value
    
    Returns:
    
    the parameter value as a char, or the default
  - getClassNameParameter
```
public String getClassNameParameter(String name)
                             throws ParameterNotFoundException
```
    Gets the classNameParameter attribute of the ParameterParser object
    
    Parameters:
    
    name - Description of the Parameter
    
    Returns:
    
    The classNameParameter value
    
    Throws:
    
    ParameterNotFoundException - if any.
  - getClassNameParameter
```
public String getClassNameParameter(String name,
                                    String def)
```
    Gets the classNameParameter attribute of the ParameterParser object
    
    Parameters:
    
    name - Description of the Parameter
    
    def - Description of the Parameter
    
    Returns:
    
    The classNameParameter value
  - getDoubleParameter
```
public double getDoubleParameter(String name)
                          throws ParameterNotFoundException,
                                 NumberFormatException
```
    Gets the named parameter value as a double
    
    Parameters:
    
    name - the parameter name
    
    Returns:
    
    the parameter value as a double
    
    Throws:
    
    ParameterNotFoundException - if the parameter was not found
    
    NumberFormatException - if the parameter could not be converted to a double
    
    ParameterNotFoundException - if any.
    
    NumberFormatException - if any.
  - getDoubleParameter
```
public double getDoubleParameter(String name,
                                 double def)
```
    Gets the named parameter value as a double, with a default. Returns the default value if the parameter is not found.
    
    Parameters:
    
    name - the parameter name
    
    def - the default parameter value
    
    Returns:
    
    the parameter value as a double, or the default
  - getFloatParameter
```
public float getFloatParameter(String name)
                        throws ParameterNotFoundException,
                               NumberFormatException
```
    Gets the named parameter value as a float
    
    Parameters:
    
    name - the parameter name
    
    Returns:
    
    the parameter value as a float
    
    Throws:
    
    ParameterNotFoundException - if the parameter was not found
    
    NumberFormatException - if the parameter could not be converted to a float
    
    ParameterNotFoundException - if any.
    
    NumberFormatException - if any.
  - getFloatParameter
```
public float getFloatParameter(String name,
                               float def)
```
    Gets the named parameter value as a float, with a default. Returns the default value if the parameter is not found.
    
    Parameters:
    
    name - the parameter name
    
    def - the default parameter value
    
    Returns:
    
    the parameter value as a float, or the default
  - getIPParameter
```
public String getIPParameter(String name,
                             String def)
```
    Gets the named parameter value as an IP String, with a default. Returns the default value if the parameter is not found or is the empty string.
    
    Parameters:
    
    name - the parameter name
    
    def - the default parameter value
    
    Returns:
    
    the parameter value as a String, or the default
  - getIPParameter
```
public String getIPParameter(String name)
                      throws ParameterNotFoundException
```
    Gets the named parameter value as an IP String
    
    Parameters:
    
    name - the parameter name
    
    Returns:
    
    the parameter value as a valid IP String or an Empty string if invalid
    
    Throws:
    
    ParameterNotFoundException - if the parameter was not found or was the empty string
    
    ParameterNotFoundException - if any.
  - getIntParameter
```
public int getIntParameter(String name)
                    throws ParameterNotFoundException,
                           NumberFormatException
```
    Gets the named parameter value as a int
    
    Parameters:
    
    name - the parameter name
    
    Returns:
    
    the parameter value as a int
    
    Throws:
    
    ParameterNotFoundException - if the parameter was not found
    
    NumberFormatException - if the parameter could not be converted to a int
    
    ParameterNotFoundException - if any.
    
    NumberFormatException - if any.
  - getIntParameter
```
public int getIntParameter(String name,
                           int def)
```
    Gets the named parameter value as a int, with a default. Returns the default value if the parameter is not found.
    
    Parameters:
    
    name - the parameter name
    
    def - the default parameter value
    
    Returns:
    
    the parameter value as a int, or the default
  - getLongParameter
```
public long getLongParameter(String name)
                      throws ParameterNotFoundException,
                             NumberFormatException
```
    Gets the named parameter value as a long
    
    Parameters:
    
    name - the parameter name
    
    Returns:
    
    the parameter value as a long
    
    Throws:
    
    ParameterNotFoundException - if the parameter was not found
    
    NumberFormatException - if the parameter could not be converted to a long
    
    ParameterNotFoundException - if any.
    
    NumberFormatException - if any.
  - getLongParameter
```
public long getLongParameter(String name,
                             long def)
```
    Gets the named parameter value as a long, with a default. Returns the default value if the parameter is not found.
    
    Parameters:
    
    name - the parameter name
    
    def - the default parameter value
    
    Returns:
    
    the parameter value as a long, or the default
  - getMissingParameters
```
public String[] getMissingParameters(String[] requestuired)
```
    Determines which of the required parameters were missing from the request. Returns null if all the parameters are present.
    
    Parameters:
    
    requestuired - Description of the Parameter
    
    Returns:
    
    an array of missing parameters, or null if none are missing
  - getParameterNames
```
public Enumeration<String> getParameterNames()
```
    Gets the parameterNames attribute of the ParameterParser object
    
    Returns:
    
    The parameterNames value
  - getParameterValues
```
public String[] getParameterValues(String name)
```
    Gets the parameterValues attribute of the ParameterParser object
    
    Parameters:
    
    name - Description of the Parameter
    
    Returns:
    
    The parameterValues value
  - getRawParameter
```
public String getRawParameter(String name,
                              String def)
```
    Gets the rawParameter attribute of the ParameterParser object
    
    Parameters:
    
    name - Description of the Parameter
    
    def - Description of the Parameter
    
    Returns:
    
    The rawParameter value
  - getRawParameter
```
public String getRawParameter(String name)
                       throws ParameterNotFoundException
```
    Gets the rawParameter attribute of the ParameterParser object
    
    Parameters:
    
    name - Description of the Parameter
    
    Returns:
    
    The rawParameter value
    
    Throws:
    
    ParameterNotFoundException - Description of the Exception
    
    ParameterNotFoundException - if any.
  - getShortParameter
```
public short getShortParameter(String name)
                        throws ParameterNotFoundException,
                               NumberFormatException
```
    Gets the named parameter value as a short
    
    Parameters:
    
    name - the parameter name
    
    Returns:
    
    the parameter value as a short
    
    Throws:
    
    ParameterNotFoundException - if the parameter was not found
    
    NumberFormatException - if the parameter could not be converted to a short
    
    ParameterNotFoundException - if any.
    
    NumberFormatException - if any.
  - getShortParameter
```
public short getShortParameter(String name,
                               short def)
```
    Gets the named parameter value as a short, with a default. Returns the default value if the parameter is not found.
    
    Parameters:
    
    name - the parameter name
    
    def - the default parameter value
    
    Returns:
    
    the parameter value as a short, or the default
  - getStringParameter
```
public String getStringParameter(String name)
                          throws ParameterNotFoundException
```
    Gets the named parameter value as a String
    
    Parameters:
    
    name - the parameter name
    
    Returns:
    
    the parameter value as a String
    
    Throws:
    
    ParameterNotFoundException - if the parameter was not found or was the empty string
    
    ParameterNotFoundException - if any.
  - getStringParameter
```
public String getStringParameter(String name,
                                 String def)
```
    Gets the named parameter value as a String, with a default. Returns the default value if the parameter is not found or is the empty string.
    
    Parameters:
    
    name - the parameter name
    
    def - the default parameter value
    
    Returns:
    
    the parameter value as a String, or the default
  - getSubParameter
```
public String getSubParameter(String first,
                              String next,
                              String def)
```
    Gets the subParameter attribute of the ParameterParser object
    
    Parameters:
    
    first - Description of the Parameter
    
    next - Description of the Parameter
    
    def - Description of the Parameter
    
    Returns:
    
    The subParameter value
  - getSubParameter
```
public String getSubParameter(String first,
                              String next)
                       throws ParameterNotFoundException
```
    Gets the parameter named 'next' following the parameter 'first'. Presumes the structure: first=firstvalue&next=nextValue
    
    Parameters:
    
    first - Description of the Parameter
    
    next - Description of the Parameter
    
    Returns:
    
    The subParameter value
    
    Throws:
    
    ParameterNotFoundException - Description of the Exception
    
    ParameterNotFoundException - if any.
  - getWordParameter
```
public String getWordParameter(String name)
                        throws ParameterNotFoundException
```
    Gets the wordParameter attribute of the ParameterParser object
    
    Parameters:
    
    name - Description of the Parameter
    
    Returns:
    
    The wordParameter value
    
    Throws:
    
    ParameterNotFoundException - if any.
  - getWordParameter
```
public String getWordParameter(String name,
                               String def)
```
    Gets the wordParameter attribute of the ParameterParser object
    
    Parameters:
    
    name - Description of the Parameter
    
    def - Description of the Parameter
    
    Returns:
    
    The wordParameter value
  - getStrictAlphaParameter
```
public String getStrictAlphaParameter(String name,
                                      int maxLength)
                               throws ParameterNotFoundException,
                                      ValidationException
```
    getStrictAlphaParameter.
    
    Parameters:
    
    name - a String object.
    
    maxLength - a int.
    
    Returns:
    
    a String object.
    
    Throws:
    
    ParameterNotFoundException - if any.
    
    ValidationException - if any.
  - getStrictNumericParameter
```
public String getStrictNumericParameter(String name,
                                        int maxLength)
                                 throws ParameterNotFoundException,
                                        ValidationException
```
    getStrictNumericParameter.
    
    Parameters:
    
    name - a String object.
    
    maxLength - a int.
    
    Returns:
    
    a String object.
    
    Throws:
    
    ParameterNotFoundException - if any.
    
    ValidationException - if any.
  - getSsnParameter
```
public String getSsnParameter(String name)
                       throws ParameterNotFoundException,
                              ValidationException
```
    getSsnParameter.
    
    Parameters:
    
    name - a String object.
    
    Returns:
    
    a String object.
    
    Throws:
    
    ParameterNotFoundException - if any.
    
    ValidationException - if any.
  - getCcnParameter
```
public String getCcnParameter(String name)
                       throws ParameterNotFoundException,
                              ValidationException
```
    getCcnParameter.
    
    Parameters:
    
    name - a String object.
    
    Returns:
    
    a String object.
    
    Throws:
    
    ParameterNotFoundException - if any.
    
    ValidationException - if any.
  - getZipParameter
```
public String getZipParameter(String name)
                       throws ParameterNotFoundException,
                              ValidationException
```
    getZipParameter.
    
    Parameters:
    
    name - a String object.
    
    Returns:
    
    a String object.
    
    Throws:
    
    ParameterNotFoundException - if any.
    
    ValidationException - if any.
  - getZipParameter
```
public String getZipParameter(String name,
                              String def)
                       throws ValidationException
```
    getZipParameter.
    
    Parameters:
    
    name - a String object.
    
    def - a String object.
    
    Returns:
    
    a String object.
    
    Throws:
    
    ValidationException - if any.
  - getPhoneParameter
```
public String getPhoneParameter(String name)
                         throws ParameterNotFoundException,
                                ValidationException
```
    getPhoneParameter.
    
    Parameters:
    
    name - a String object.
    
    Returns:
    
    a String object.
    
    Throws:
    
    ParameterNotFoundException - if any.
    
    ValidationException - if any.
  - getPhoneParameter
```
public String getPhoneParameter(String name,
                                String def)
                         throws ValidationException
```
    getPhoneParameter.
    
    Parameters:
    
    name - a String object.
    
    def - a String object.
    
    Returns:
    
    a String object.
    
    Throws:
    
    ValidationException - if any.
  - getEMailParameter
```
public String getEMailParameter(String name)
                         throws ParameterNotFoundException,
                                ValidationException
```
    getEMailParameter.
    
    Parameters:
    
    name - a String object.
    
    Returns:
    
    a String object.
    
    Throws:
    
    ParameterNotFoundException - if any.
    
    ValidationException - if any.
  - getEMailParameter
```
public String getEMailParameter(String name,
                                String def)
                         throws ValidationException
```
    getEMailParameter.
    
    Parameters:
    
    name - a String object.
    
    def - a String object.
    
    Returns:
    
    a String object.
    
    Throws:
    
    ValidationException - if any.
  - getDateParameter
```
public String getDateParameter(String name)
                        throws ParameterNotFoundException,
                               ValidationException
```
    getDateParameter.
    
    Parameters:
    
    name - a String object.
    
    Returns:
    
    a String object.
    
    Throws:
    
    ParameterNotFoundException - if any.
    
    ValidationException - if any.
  - getDateParameter
```
public String getDateParameter(String name,
                               String def)
                        throws ValidationException
```
    getDateParameter.
    
    Parameters:
    
    name - a String object.
    
    def - a String object.
    
    Returns:
    
    a String object.
    
    Throws:
    
    ValidationException - if any.
  - getURLParameter
```
public String getURLParameter(String name)
                       throws ParameterNotFoundException,
                              ValidationException
```
    getURLParameter.
    
    Parameters:
    
    name - a String object.
    
    Returns:
    
    a String object.
    
    Throws:
    
    ParameterNotFoundException - if any.
    
    ValidationException - if any.
  - getURLParameter
```
public String getURLParameter(String name,
                              String def)
                       throws ValidationException
```
    getURLParameter.
    
    Parameters:
    
    name - a String object.
    
    def - a String object.
    
    Returns:
    
    a String object.
    
    Throws:
    
    ValidationException - if any.
  - htmlEncode
```
protected static String htmlEncode(String s)
```
    htmlEncode.
    
    Parameters:
    
    s - a String object.
    
    Returns:
    
    a String object.
  - toString
```
public String toString()
```
    Description of the Method
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    Description of the Return Value
  - update
```
public void update(javax.servlet.ServletRequest request)
```
    Description of the Method
    
    Parameters:
    
    request - Description of the Parameter

Class ParameterParser

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ParameterParser

Method Detail

getBooleanParameter

getBooleanParameter

getBooleanSubParameter

getByteParameter

getByteParameter

getCharParameter

getCharParameter

getClassNameParameter

getClassNameParameter

getDoubleParameter

getDoubleParameter

getFloatParameter

getFloatParameter

getIPParameter

getIPParameter

getIntParameter

getIntParameter

getLongParameter

getLongParameter

getMissingParameters

getParameterNames

getParameterValues

getRawParameter

getRawParameter

getShortParameter

getShortParameter

getStringParameter

getStringParameter

getSubParameter

getSubParameter

getWordParameter

getWordParameter

getStrictAlphaParameter

getStrictNumericParameter

getSsnParameter

getCcnParameter

getZipParameter

getZipParameter

getPhoneParameter

getPhoneParameter

getEMailParameter

getEMailParameter

getDateParameter

getDateParameter

getURLParameter

getURLParameter

htmlEncode

toString

update