StandardParameterParser (OWASP Zed Attack Proxy)

java.lang.Object
- org.zaproxy.zap.model.StandardParameterParser

All Implemented Interfaces:: ParameterParser

public class StandardParameterParser
extends Object
implements ParameterParser

Constructor Summary

Constructors
Constructor and Description

StandardParameterParser()

StandardParameterParser(String keyValuePairSeparators, String keyValueSeparators)

Constructors
Constructor and Description
`StandardParameterParser()`
`StandardParameterParser(String keyValuePairSeparators, String keyValueSeparators)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`StandardParameterParser`	`clone()`
`String`	`getAncestorPath(org.apache.commons.httpclient.URI uri, int depth)` Gets the path of the URI's ancestor found at the given depth, taking into account any context specific configuration (e.g.
`String`	`getConfig()`
`Context`	`getContext()`
`String`	`getDefaultKeyValuePairSeparator()`
`String`	`getDefaultKeyValueSeparator()`
`String`	`getKeyValuePairSeparators()`
`String`	`getKeyValueSeparators()`
`List<NameValuePair>`	`getParameters(HttpMessage msg, HtmlParameter.Type type)` Gets the parameters of the given `type` from the given `message`.
`Map<String,String>`	`getParams(HttpMessage msg, HtmlParameter.Type type)`
`List<String>`	`getStructuralParameters()`
`List<String>`	`getTreePath(HttpMessage msg)`
`List<String>`	`getTreePath(org.apache.commons.httpclient.URI uri)`
`void`	`init(String config)`
`Map<String,String>`	`parse(String paramStr)`
`List<NameValuePair>`	`parseParameters(String parameters)` Parses the given `parameters` into a list of `NameValuePair`.
`void`	`setContext(Context context)`
`void`	`setKeyValuePairSeparators(String keyValuePairSeparators)`
`void`	`setKeyValueSeparators(String keyValueSeparators)`
`void`	`setStructuralParameters(List<String> structuralParameters)`

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

- Constructor Detail
  - StandardParameterParser
```
public StandardParameterParser(String keyValuePairSeparators,
                               String keyValueSeparators)
                        throws PatternSyntaxException
```
    Throws:
    
    PatternSyntaxException
  - StandardParameterParser
```
public StandardParameterParser()
```
- Method Detail
  - init
```
public void init(String config)
```
    Specified by:
    
    init in interface ParameterParser
  - getConfig
```
public String getConfig()
```
    Specified by:
    
    getConfig in interface ParameterParser
  - getParams
```
public Map<String,String> getParams(HttpMessage msg,
                                    HtmlParameter.Type type)
```
    Specified by:
    
    getParams in interface ParameterParser
  - getParameters
```
public List<NameValuePair> getParameters(HttpMessage msg,
                                         HtmlParameter.Type type)
```
    Description copied from interface: ParameterParser
    
    Gets the parameters of the given type from the given message.
    The parameters are split using the key value pair separator(s) and each resulting parameter is split into name/value pairs using key value separator(s).
    Parameters' names and values are in decoded form.
    
    Specified by:
    
    getParameters in interface ParameterParser
    
    Parameters:
    
    msg - the message whose parameters will be extracted from
    
    type - the type of parameters to extract
    
    Returns:
    
    a List containing the parameters
    
    Throws:
    
    IllegalArgumentException - if any of the parameters is null or if the given type is not url or form.
    
    See Also:
    
    ParameterParser.getDefaultKeyValuePairSeparator(), ParameterParser.getDefaultKeyValueSeparator()
  - getKeyValuePairSeparators
```
public String getKeyValuePairSeparators()
```
  - setKeyValuePairSeparators
```
public void setKeyValuePairSeparators(String keyValuePairSeparators)
                               throws PatternSyntaxException
```
    Throws:
    
    PatternSyntaxException
  - getKeyValueSeparators
```
public String getKeyValueSeparators()
```
  - setKeyValueSeparators
```
public void setKeyValueSeparators(String keyValueSeparators)
                           throws PatternSyntaxException
```
    Throws:
    
    PatternSyntaxException
  - getDefaultKeyValuePairSeparator
```
public String getDefaultKeyValuePairSeparator()
```
    Specified by:
    
    getDefaultKeyValuePairSeparator in interface ParameterParser
  - getDefaultKeyValueSeparator
```
public String getDefaultKeyValueSeparator()
```
    Specified by:
    
    getDefaultKeyValueSeparator in interface ParameterParser
  - getStructuralParameters
```
public List<String> getStructuralParameters()
```
  - setStructuralParameters
```
public void setStructuralParameters(List<String> structuralParameters)
```
  - parse
```
public Map<String,String> parse(String paramStr)
```
    Specified by:
    
    parse in interface ParameterParser
  - parseParameters
```
public List<NameValuePair> parseParameters(String parameters)
```
    Description copied from interface: ParameterParser
    
    Parses the given parameters into a list of NameValuePair.
    The parameters are split using the key value pair separator(s) and each resulting parameter is split into name/value pairs using key value separator(s).
    Parameters' names and values are in decoded form.
    
    Specified by:
    
    parseParameters in interface ParameterParser
    
    Parameters:
    
    parameters - the String of parameters to parse, might be null
    
    Returns:
    
    a List containing the parameters parsed
    
    See Also:
    
    ParameterParser.getDefaultKeyValuePairSeparator(), ParameterParser.getDefaultKeyValueSeparator()
  - clone
```
public StandardParameterParser clone()
```
    Specified by:
    
    clone in interface ParameterParser
    
    Overrides:
    
    clone in class Object
  - getTreePath
```
public List<String> getTreePath(org.apache.commons.httpclient.URI uri)
                         throws org.apache.commons.httpclient.URIException
```
    Specified by:
    
    getTreePath in interface ParameterParser
    
    Throws:
    
    org.apache.commons.httpclient.URIException
  - getTreePath
```
public List<String> getTreePath(HttpMessage msg)
                         throws org.apache.commons.httpclient.URIException
```
    Specified by:
    
    getTreePath in interface ParameterParser
    
    Throws:
    
    org.apache.commons.httpclient.URIException
  - getAncestorPath
```
public String getAncestorPath(org.apache.commons.httpclient.URI uri,
                              int depth)
                       throws org.apache.commons.httpclient.URIException
```
    Description copied from interface: ParameterParser
    Gets the path of the URI's ancestor found at the given depth, taking into account any context specific configuration (e.g. structural parameters). The depth could also be seen as the number of path elements returned.
    A few examples (uri, depth):
    - (http://example.org/path/to/element, 0) -> ""
    - (http://example.org/path/to/element, 1) -> "/path"
    - (http://example.org/path/to/element, 3) -> "/path/to/element"
    - (http://example.org/path?page=12&data=123, 2) -> "/path?page=12", if page is a structural parameter
    - (http://example.org/path?page=12&data=123&type=1, 3) -> "/path?page=12&type=1", if page and type are both structural parameter
    Specified by:
    
    getAncestorPath in interface ParameterParser
    
    Parameters:
    
    uri - the URI
    
    depth - the depth
    
    Returns:
    
    the path of the ancestor
    
    Throws:
    
    org.apache.commons.httpclient.URIException - if an error occurred while accessing the provided uri
  - setContext
```
public void setContext(Context context)
```
    Specified by:
    
    setContext in interface ParameterParser
  - getContext
```
public Context getContext()
```
    Specified by:
    
    getContext in interface ParameterParser

Class StandardParameterParser

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StandardParameterParser

StandardParameterParser

Method Detail

init

getConfig

getParams

getParameters

getKeyValuePairSeparators

setKeyValuePairSeparators

getKeyValueSeparators

setKeyValueSeparators

getDefaultKeyValuePairSeparator

getDefaultKeyValueSeparator

getStructuralParameters

setStructuralParameters

parse

parseParameters

clone

getTreePath

getTreePath

getAncestorPath

setContext

getContext