org.zaproxy.zap.spider.filters

Class DefaultFetchFilter

java.lang.Object

org.zaproxy.zap.spider.filters.FetchFilter

org.zaproxy.zap.spider.filters.DefaultFetchFilter

public class DefaultFetchFilter
extends FetchFilter

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

• the resource protocol/scheme must be 'HTTP' or 'HTTPs'.
• the resource must be found in the scope (domain) of the spidering process.
• the resource must be not be excluded by user request - exclude list.

Nested Class Summary

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

FetchFilter.FetchStatus

Field Summary

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

log

Constructor Summary

Constructors

Constructor and Description
DefaultFetchFilter()

Method Summary

Modifier and Type	Method and Description
void	addScopeRegex(String scope) Adds a new domain to the scope list of the spider process.
FetchFilter.FetchStatus	checkFilter(org.apache.commons.httpclient.URI uri) Checks if the uri must be ignored and not processed and return the filter status.
void	setDomainsAlwaysInScope(List<DomainAlwaysInScopeMatcher> domainsAlwaysInScope) Sets the domains that will be considered as always in scope.
void	setExcludeRegexes(List<String> excl) Sets the regexes which are used for checking if an uri should be skipped.
void	setScanContext(Context scanContext) Sets the scan context.

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

getLogger

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultFetchFilter

public DefaultFetchFilter()

Method Detail

checkFilter

public FetchFilter.FetchStatus checkFilter(org.apache.commons.httpclient.URI uri)

Description copied from class: FetchFilter

Checks if the uri must be ignored and not processed and return the filter status.

Specified by:

checkFilter in class FetchFilter

Parameters:

uri - the uri to be processed

Returns:

the fetch status, stating if the uri is accepted or, if not, why was it not accepted.

addScopeRegex

public void addScopeRegex(String scope)

Adds a new domain to the scope list of the spider process.

Parameters:

scope - the scope

setDomainsAlwaysInScope

public void setDomainsAlwaysInScope(List<DomainAlwaysInScopeMatcher> domainsAlwaysInScope)

Sets the domains that will be considered as always in scope.

Parameters:

domainsAlwaysInScope - the list containing all domains that are always in scope.

Since:

2.3.0

setExcludeRegexes

public void setExcludeRegexes(List<String> excl)

Sets the regexes which are used for checking if an uri should be skipped.

Parameters:

excl - the new exclude regexes

setScanContext

public void setScanContext(Context scanContext)

Sets the scan context. If set, only uris that are part of the context are considered valid for fetching.

Parameters:

scanContext - the new scan context