org.zaproxy.zap.spider.filters

Class HttpPrefixFetchFilter

java.lang.Object

org.zaproxy.zap.spider.filters.FetchFilter

org.zaproxy.zap.spider.filters.HttpPrefixFetchFilter

public class HttpPrefixFetchFilter
extends FetchFilter

A FetchFilter that filters based on a HTTP or HTTPS URI.

The filtered URIs are required to start with the URI (the prefix) to be considered valid.

Since:

2.5.0

See Also:

checkFilter(URI)

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
HttpPrefixFetchFilter(org.apache.commons.httpclient.URI prefix) Constructs a HttpPrefixFetchFilter using the given URI as prefix.

Method Summary

Modifier and Type	Method and Description
FetchFilter.FetchStatus	checkFilter(org.apache.commons.httpclient.URI uri) Filters any URI that does not start with the defined prefix.
String	getNormalisedPrefix() Gets the prefix normalised, as it is used to filter the URIs.

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

HttpPrefixFetchFilter

public HttpPrefixFetchFilter(org.apache.commons.httpclient.URI prefix)

Constructs a HttpPrefixFetchFilter using the given URI as prefix.

The user info, query component and fragment of the given URI are discarded. The scheme and domain comparisons are done in a case insensitive way while the path component comparison is case sensitive.

Parameters:

prefix - the URI that will be used as prefix

Throws:

IllegalArgumentException - if any of the following conditions is true:

• The given prefix is null;
• The given prefix has null scheme;
• The scheme of the given prefix is not HTTP or HTTPS;
• The given prefix has null host;
• The given prefix has malformed host.

Method Detail

getNormalisedPrefix

public String getNormalisedPrefix()

Gets the prefix normalised, as it is used to filter the URIs.

Returns:

a String with the prefix normalised

See Also:

checkFilter(URI)

checkFilter

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

Filters any URI that does not start with the defined prefix.

Specified by:

checkFilter in class FetchFilter

Parameters:

uri - the uri to be processed

Returns:

FetchStatus.VALID if the uri starts with the prefix, FetchStatus.OUT_OF_SCOPE otherwise