org.parosproxy.paros.core.scanner

Class ScannerParamFilter

java.lang.Object

org.parosproxy.paros.core.scanner.ScannerParamFilter

All Implemented Interfaces:

Cloneable

public class ScannerParamFilter
extends Object
implements Cloneable

Module for parameter filtering according to URL, type and parameter name regexes

See Also:

NameValuePair

Constructor Summary

Constructors

Constructor and Description
ScannerParamFilter() Default constructor to initialize default values
ScannerParamFilter(String paramName, int paramType, String urlPattern)

Method Summary

Modifier and Type	Method and Description
ScannerParamFilter	clone() Clone this filter
boolean	equals(Object obj)
static Collection<String>	getListTypes()
String	getParamName()
static String	getStringType(int paramType)
int	getType()
static Map<Integer,String>	getTypes() Gets the parameter types (IDs and corresponding name).
String	getTypeString()
String	getWildcardedUrl()
int	hashCode()
boolean	isToExclude(HttpMessage msg, NameValuePair param) Check if the parameter should be excluded by the scanner
static boolean	isValidParamNameRegex(String paramNameRegex)
void	setParamName(String paramNameRegex)
void	setType(int paramType)
void	setType(String value)
void	setWildcardedUrl(String wildcardedUrl)

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScannerParamFilter

public ScannerParamFilter()

Default constructor to initialize default values

ScannerParamFilter

public ScannerParamFilter(String paramName,
                          int paramType,
                          String urlPattern)

Method Detail

getType

public int getType()

setType

public void setType(int paramType)

getParamName

public String getParamName()

setParamName

public final void setParamName(String paramNameRegex)

isValidParamNameRegex

public static boolean isValidParamNameRegex(String paramNameRegex)

getWildcardedUrl

public String getWildcardedUrl()

setWildcardedUrl

public final void setWildcardedUrl(String wildcardedUrl)

isToExclude

public boolean isToExclude(HttpMessage msg,
                           NameValuePair param)

Check if the parameter should be excluded by the scanner

Parameters:

msg - the message that is currently under scanning

param - the Value/Name param object that is currently under scanning

Returns:

true if the parameter should be excluded

clone

public ScannerParamFilter clone()

Clone this filter

Overrides:

clone in class Object

Returns:

a new filter with replicated contents

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getTypeString

public String getTypeString()

setType

public void setType(String value)

getListTypes

public static final Collection<String> getListTypes()

getStringType

public static final String getStringType(int paramType)

getTypes

public static Map<Integer,String> getTypes()

Gets the parameter types (IDs and corresponding name).

Returns:

the parameter types.

Since:

2.6.0