org.parosproxy.paros.core.scanner

Class VariantAbstractQuery

java.lang.Object

org.parosproxy.paros.core.scanner.VariantAbstractQuery

All Implemented Interfaces:

Variant

Direct Known Subclasses:

VariantFormQuery, VariantURLQuery

public abstract class VariantAbstractQuery
extends Object
implements Variant

Constructor Summary

Constructors

Constructor and Description
VariantAbstractQuery()

Method Summary

Modifier and Type	Method and Description
protected abstract void	buildMessage(HttpMessage msg, String query) Build the message content setting the query string according to the Variant specific implementation
protected String	getEscapedName(HttpMessage msg, String name) Gets parameter's name in encoded/escaped form.
protected abstract String	getEscapedValue(HttpMessage msg, String value) Return escaped mutate of the value.
List<NameValuePair>	getParamList() Gets the list of parameters handled by this variant.
protected abstract String	getUnescapedValue(String value) Return unescaped mutate of the value.
void	setAddQueryParam(boolean addQueryParam)
String	setEscapedParameter(HttpMessage msg, NameValuePair originalPair, String name, String value)
String	setParameter(HttpMessage msg, NameValuePair originalPair, String name, String value) If name and value = null, not to append entire parameter.
protected void	setParameters(int type, List<NameValuePair> parameters) Sets the given parameters of the given type as the list of parameters handled by this variant.
protected void	setParams(int type, Map<String,String> params) Deprecated. (2.5.0) use setParameters(int, List) instead.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.parosproxy.paros.core.scanner.Variant

getLeafName, getTreePath, setMessage, setParameters

Constructor Detail

VariantAbstractQuery

public VariantAbstractQuery()

Method Detail

buildMessage

protected abstract void buildMessage(HttpMessage msg,
                                     String query)

Build the message content setting the query string according to the Variant specific implementation

Parameters:

msg - the message object we need to modify

query - the query string we need to set inside the message

getEscapedValue

protected abstract String getEscapedValue(HttpMessage msg,
                                          String value)

Return escaped mutate of the value. To be overridden by subclass.

Parameters:

msg -

value -

Returns:

the escaped value

getEscapedName

protected String getEscapedName(HttpMessage msg,
                                String name)

Gets parameter's name in encoded/escaped form.

Default implementation is to URL encode the name.

Parameters:

msg - the message that contains the parameter

name - the name to escape

Returns:

the escaped name

Since:

2.5.0

See Also:

URLEncoder.encode(String, String)

getUnescapedValue

protected abstract String getUnescapedValue(String value)

Return unescaped mutate of the value. To be overridden by subclass.

Parameters:

value -

Returns:

the unescaped value

setParams

@Deprecated
protected void setParams(int type,
                                     Map<String,String> params)

Deprecated. (2.5.0) use setParameters(int, List) instead.

setParameters

protected void setParameters(int type,
                             List<NameValuePair> parameters)

Sets the given parameters of the given type as the list of parameters handled by this variant.

The names and values of the parameters are expected to be in decoded form.

Parameters:

type - the type of parameters

parameters - the actual parameters to add

Throws:

IllegalArgumentException - if parameters is null.

Since:

2.5.0

See Also:

getParamList(), NameValuePair.TYPE_QUERY_STRING, NameValuePair.TYPE_POST_DATA

getParamList

public List<NameValuePair> getParamList()

Description copied from interface: Variant

Gets the list of parameters handled by this variant.

Specified by:

getParamList in interface Variant

Returns:

a List containing the parameters

setParameter

public String setParameter(HttpMessage msg,
                           NameValuePair originalPair,
                           String name,
                           String value)

If name and value = null, not to append entire parameter.

Specified by:

setParameter in interface Variant

setEscapedParameter

public String setEscapedParameter(HttpMessage msg,
                                  NameValuePair originalPair,
                                  String name,
                                  String value)

Specified by:

setEscapedParameter in interface Variant

setAddQueryParam

public void setAddQueryParam(boolean addQueryParam)