org.zaproxy.zap.spider.filters

Class DefaultParseFilter

java.lang.Object

org.zaproxy.zap.spider.filters.ParseFilter

org.zaproxy.zap.spider.filters.DefaultParseFilter

public class DefaultParseFilter
extends ParseFilter

The DefaultParseFilter is an implementation of a ParseFilter that is default for spidering process. Its filter rules are the following:

• the resource body should be under a number of bytes, otherwise it's considered a binary resource.
• the resource must be of parsable type (text, html, xml, javascript). Actually, the content type should be text/...

Nested Class Summary

Nested classes/interfaces inherited from class org.zaproxy.zap.spider.filters.ParseFilter

ParseFilter.FilterResult

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_RESPONSE_BODY_SIZE Deprecated. (2.7.0) No longer in use, replaced by SpiderParam.getMaxParseSizeBytes().

Fields inherited from class org.zaproxy.zap.spider.filters.ParseFilter

log

Constructor Summary

Constructors

Constructor and Description
DefaultParseFilter() Deprecated. (2.7.0) Replaced by DefaultParseFilter(SpiderParam, ResourceBundle).
DefaultParseFilter(SpiderParam params, ResourceBundle resourceBundle) Constructs a DefaultParseFilter with the given configurations and resource bundle.

Method Summary

Modifier and Type	Method and Description
ParseFilter.FilterResult	filtered(HttpMessage responseMessage) Tells whether or not the given resource is filtered.

Methods inherited from class org.zaproxy.zap.spider.filters.ParseFilter

getLogger, isFiltered

Methods inherited from class java.lang.Object

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

Field Detail

MAX_RESPONSE_BODY_SIZE

@Deprecated
public static final int MAX_RESPONSE_BODY_SIZE

Deprecated. (2.7.0) No longer in use, replaced by SpiderParam.getMaxParseSizeBytes().

The Constant MAX_RESPONSE_BODY_SIZE defining the size of response body that is considered too big for a parsable file.

See Also:

Constant Field Values

Constructor Detail

DefaultParseFilter

@Deprecated
public DefaultParseFilter()

Deprecated. (2.7.0) Replaced by DefaultParseFilter(SpiderParam, ResourceBundle).

Constructs a DefaultParseFilter with default configurations.

DefaultParseFilter

public DefaultParseFilter(SpiderParam params,
                          ResourceBundle resourceBundle)

Constructs a DefaultParseFilter with the given configurations and resource bundle.

The resource bundle is used to obtain the (internationalised) reasons of why the message was filtered.

Parameters:

params - the spider configurations

resourceBundle - the resource bundle to obtain the internationalised reasons.

Throws:

IllegalArgumentException - if any of the given parameters is null.

Since:

2.7.0

See Also:

SpiderParam.getMaxParseSizeBytes()

Method Detail

filtered

public ParseFilter.FilterResult filtered(HttpMessage responseMessage)

Description copied from class: ParseFilter

Tells whether or not the given resource is filtered. Filtered resources are not parsed.

Default is not filtered.

Overrides:

filtered in class ParseFilter

Parameters:

responseMessage - the HTTP message containing the response to be or not parsed.

Returns:

the filter result, must not be null.