org.zaproxy.zap.spider

Class SpiderController

java.lang.Object

org.zaproxy.zap.spider.SpiderController

All Implemented Interfaces:

SpiderParserListener

public class SpiderController
extends Object
implements SpiderParserListener

The SpiderController is used to manage the crawling process and interacts directly with the Spider Task threads.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SpiderController(Spider spider, List<SpiderParser> customParsers) Instantiates a new spider controller.

Method Summary

Modifier and Type	Method and Description
void	addFetchFilter(FetchFilter filter) Adds a new fetch filter to the spider.
void	addParseFilter(ParseFilter filter) Adds the parse filter to the spider controller.
protected void	addSeed(org.apache.commons.httpclient.URI uri, String method) Adds a new seed, if it wasn't already processed.
void	addSpiderParser(SpiderParser parser)
protected ParseFilter	getDefaultParseFilter()
protected LinkedList<FetchFilter>	getFetchFilters() Gets the fetch filters used by the spider during the spidering process.
protected LinkedList<ParseFilter>	getParseFilters() Gets the parses the filters.
List<SpiderParser>	getParsers() Gets an unmodifiable view of the list of that should be used during the scan.
void	init()
void	reset() Clears the previous process.
void	resourceFound(SpiderResourceFound resourceFound) Event triggered when a new resource is found.
protected void	setDefaultParseFilter(ParseFilter filter)

Methods inherited from class java.lang.Object

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

Constructor Detail

SpiderController

protected SpiderController(Spider spider,
                           List<SpiderParser> customParsers)

Instantiates a new spider controller.

Parameters:

spider - the spider

customParsers - the custom spider parsers

Method Detail

addSeed

protected void addSeed(org.apache.commons.httpclient.URI uri,
                       String method)

Adds a new seed, if it wasn't already processed.

Parameters:

uri - the uri

method - the http method used for fetching the resource

getFetchFilters

protected LinkedList<FetchFilter> getFetchFilters()

Gets the fetch filters used by the spider during the spidering process.

Returns:

the fetch filters

addFetchFilter

public void addFetchFilter(FetchFilter filter)

Adds a new fetch filter to the spider.

Parameters:

filter - the filter

getParseFilters

protected LinkedList<ParseFilter> getParseFilters()

Gets the parses the filters.

Returns:

the parses the filters

addParseFilter

public void addParseFilter(ParseFilter filter)

Adds the parse filter to the spider controller.

Parameters:

filter - the filter

setDefaultParseFilter

protected void setDefaultParseFilter(ParseFilter filter)

getDefaultParseFilter

protected ParseFilter getDefaultParseFilter()

init

public void init()

reset

public void reset()

Clears the previous process.

resourceFound

public void resourceFound(SpiderResourceFound resourceFound)

Description copied from interface: SpiderParserListener

Event triggered when a new resource is found. The resourceFound contains all the required information about the resource (source message, URI, depth, method, etc.).

Specified by:

resourceFound in interface SpiderParserListener

Parameters:

resourceFound - definition of found spider resource

getParsers

public List<SpiderParser> getParsers()

Gets an unmodifiable view of the list of that should be used during the scan.

Returns:

the parsers

addSpiderParser

public void addSpiderParser(SpiderParser parser)