SpiderParam (OWASP Zed Attack Proxy)

java.lang.Object
- org.parosproxy.paros.common.AbstractParam
- - org.zaproxy.zap.spider.SpiderParam

All Implemented Interfaces:

Cloneable
```
public class SpiderParam
extends AbstractParam
```
The SpiderParam wraps all the parameters that are given to the spider.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`SpiderParam.HandleParametersOption` This option is used to define how the parameters are used when checking if an URI was already visited.

Field Summary

Fields
Modifier and Type Field and Description

static int UNLIMITED_DEPTH
The value that indicates that the crawl depth is unlimited.

Fields
Modifier and Type	Field and Description
`static int`	`UNLIMITED_DEPTH` The value that indicates that the crawl depth is unlimited.

Constructor Summary

Constructors
Constructor and Description

SpiderParam()
Instantiates a new spider param.

Constructors
Constructor and Description
`SpiderParam()` Instantiates a new spider param.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`List<DomainAlwaysInScopeMatcher>`	`getDomainsAlwaysInScope()` Returns the domains that will be always in scope.
`List<DomainAlwaysInScopeMatcher>`	`getDomainsAlwaysInScopeEnabled()` Returns the, enabled, domains that will be always in scope.
`SpiderParam.HandleParametersOption`	`getHandleParameters()` Gets how the spider handles parameters when checking URIs visited.
`int`	`getMaxChildren()` Gets the maximum number of child nodes (per node) that can be crawled, 0 means no limit.
`int`	`getMaxDepth()` Gets the maximum depth the spider can crawl.
`int`	`getMaxDuration()` Returns the maximum duration in minutes that the spider should run for.
`int`	`getMaxParseSizeBytes()` Gets the maximum size, in bytes, that a response might have to be parsed.
`int`	`getMaxScansInUI()`
`int`	`getRequestWaitTime()` Gets the time between the requests sent to a server.
`String`	`getScope()` Deprecated. (2.3.0) Replaced by `getDomainsAlwaysInScope()` and `getDomainsAlwaysInScopeEnabled()`.
`String`	`getScopeText()` Deprecated. (2.3.0) Replaced by `getDomainsAlwaysInScope()` and `getDomainsAlwaysInScopeEnabled()`. Note: Newer regular expression excluded domains will not be returned by this method.
`String`	`getSkipURLString()` Gets the skip url string.
`int`	`getThreadCount()` Gets the thread count.
`String`	`getUserAgent()` Gets the user agent.
`boolean`	`isAcceptCookies()` Tells whether or not a spider process should accept cookies while spidering.
`boolean`	`isConfirmRemoveDomainAlwaysInScope()` Tells whether or not the remotion of a "domain always in scope" needs confirmation.
`boolean`	`isHandleODataParametersVisited()` Check if the spider should take into account OData-specific parameters (i.e : resource identifiers) in order to identify already visited URL
`boolean`	`isParseComments()` Checks if the spider should parse the comments.
`boolean`	`isParseGit()` Checks if the spider should parse the Git files for URIs.
`boolean`	`isParseRobotsTxt()` Checks if the spider should parse the robots.txt for uris (not related to following the directions).
`boolean`	`isParseSitemapXml()` Checks if the spider should parse the sitemap.xml for URIs.
`boolean`	`isParseSVNEntries()` Checks if the spider should parse the SVN entries files for URIs (not related to following the directions).
`boolean`	`isPostForm()` Checks if is the forms should be submitted with the HTTP POST method.
`boolean`	`isProcessForm()` Checks if the forms should be processed.
`boolean`	`isSendRefererHeader()` Tells whether or not the "Referer" header should be sent in spider requests.
`boolean`	`isShowAdvancedDialog()`
`boolean`	`isSkipURL(org.apache.commons.httpclient.URI uri)` Checks if is this url should be skipped.
`protected void`	`parse()` Parses the configurations.
`void`	`setAcceptCookies(boolean acceptCookies)` Sets whether or not a spider process should accept cookies while spidering.
`void`	`setConfirmRemoveDomainAlwaysInScope(boolean confirmRemove)` Sets whether or not the remotion of a "domain always in scope" needs confirmation.
`void`	`setDomainsAlwaysInScope(List<DomainAlwaysInScopeMatcher> domainsAlwaysInScope)` Sets the domains that will be always in scope.
`void`	`setHandleODataParametersVisited(boolean handleODataParametersVisited)` Defines if the spider should handle OData specific parameters (i.e : resource identifiers) To identify already visited URL
`void`	`setHandleParameters(SpiderParam.HandleParametersOption handleParametersVisited)` Sets the how the spider handles parameters when checking URIs visited.
`void`	`setHandleParameters(String handleParametersVisited)` Sets the how the spider handles parameters when checking URIs visited.
`void`	`setMaxChildren(int maxChildren)` Sets the maximum number of child nodes (per node) that can be crawled, 0 means no limit.
`void`	`setMaxDepth(int maxDepth)` Sets the maximum depth the spider can crawl.
`void`	`setMaxDuration(int maxDuration)` Sets the maximum duration in minutes that the spider should run for.
`void`	`setMaxParseSizeBytes(int maxParseSizeBytes)` Sets the maximum size, in bytes, that a response might have to be parsed.
`void`	`setMaxScansInUI(int maxScansInUI)`
`void`	`setParseComments(boolean parseComments)` Sets the whether the spider parses the comments.
`void`	`setParseGit(boolean parseGit)` Sets the whether the spider parses Git files for URIs
`void`	`setParseRobotsTxt(boolean parseRobotsTxt)` Sets the whether the spider parses the robots.txt for uris (not related to following the directions).
`void`	`setParseSitemapXml(boolean parseSitemapXml)` Sets the whether the spider parses the sitemap.xml for URIs.
`void`	`setParseSVNEntries(boolean parseSVNentries)` Sets the whether the spider parses the SVN entries file for URIs (not related to following the directions).
`void`	`setPostForm(boolean postForm)` Sets if the forms should be submitted with the HTTP POST method.
`void`	`setProcessForm(boolean processForm)` Sets if the forms should be processed.
`void`	`setRequestWaitTime(int requestWait)` Sets the time between the requests sent to a server.
`void`	`setScopeString(String scope)` Deprecated. (2.3.0) Replaced by `setDomainsAlwaysInScope(List)`
`void`	`setSendRefererHeader(boolean send)` Sets whether or not the "Referer" header should be sent in spider requests.
`void`	`setShowAdvancedDialog(boolean showAdvancedDialog)`
`void`	`setSkipURLString(String skipURL)` Sets the skip url string.
`void`	`setThreadCount(int thread)` Sets the thread count.
`void`	`setUserAgent(String userAgent)` Sets the user agent, if different from the default one.

Methods inherited from class org.parosproxy.paros.common.AbstractParam
clone, getBoolean, getConfig, getInt, getInteger, getString, load, load, load, logConversionException, reset

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - UNLIMITED_DEPTH
```
public static final int UNLIMITED_DEPTH
```
    The value that indicates that the crawl depth is unlimited.
    
    Since:
    
    2.8.0
    
    See Also:
    
    setMaxDepth(int), Constant Field Values
- Constructor Detail
  - SpiderParam
```
public SpiderParam()
```
    Instantiates a new spider param.
- Method Detail
  - parse
```
protected void parse()
```
    Description copied from class: AbstractParam
    
    Parses the configurations.
    Called each time the configurations are loaded.
    
    Specified by:
    
    parse in class AbstractParam
    
    See Also:
    
    AbstractParam.getConfig()
  - getMaxDepth
```
public int getMaxDepth()
```
    Gets the maximum depth the spider can crawl.
    
    Returns:
    
    the maximum depth, or 0 if unlimited.
    
    See Also:
    
    setMaxDepth(int)
  - setMaxDepth
```
public void setMaxDepth(int maxDepth)
```
    Sets the maximum depth the spider can crawl.
    Value 0 for unlimited depth.
    
    Parameters:
    
    maxDepth - the new maximum depth.
    
    See Also:
    
    getMaxDepth()
  - getScopeText
```
@Deprecated
public String getScopeText()
```
    Deprecated. (2.3.0) Replaced by getDomainsAlwaysInScope() and getDomainsAlwaysInScopeEnabled(). Note: Newer regular expression excluded domains will not be returned by this method.
    
    Gets the text describing the text.
    
    Returns:
    
    returns the scope.
  - getScope
```
@Deprecated
public String getScope()
```
    Deprecated. (2.3.0) Replaced by getDomainsAlwaysInScope() and getDomainsAlwaysInScopeEnabled().
    
    Gets the scope's regex.
    
    Returns:
    
    returns the scope.
  - setScopeString
```
@Deprecated
public void setScopeString(String scope)
```
    Deprecated. (2.3.0) Replaced by setDomainsAlwaysInScope(List)
    
    Sets the scope string.
    
    Parameters:
    
    scope - The scope string to set.
  - getThreadCount
```
public int getThreadCount()
```
    Gets the thread count.
    
    Returns:
    
    Returns the thread count
  - setThreadCount
```
public void setThreadCount(int thread)
```
    Sets the thread count.
    
    Parameters:
    
    thread - The thread count to set.
  - isPostForm
```
public boolean isPostForm()
```
    Checks if is the forms should be submitted with the HTTP POST method. This option should not be used if the forms are not processed at all (processForm).
    
    Returns:
    
    true, if the forms should be posted.
  - setPostForm
```
public void setPostForm(boolean postForm)
```
    Sets if the forms should be submitted with the HTTP POST method. This option should not be used if the forms are not processed at all (processForm).
    
    Parameters:
    
    postForm - the new post form status
  - isProcessForm
```
public boolean isProcessForm()
```
    Checks if the forms should be processed.
    
    Returns:
    
    true, if the forms should be processed
  - setProcessForm
```
public void setProcessForm(boolean processForm)
```
    Sets if the forms should be processed.
    
    Parameters:
    
    processForm - the new process form status
  - setSkipURLString
```
public void setSkipURLString(String skipURL)
```
    Sets the skip url string. This string is being parsed into a pattern which is used to check if a url should be skipped while crawling.
    
    Parameters:
    
    skipURL - the new skip url string
  - getSkipURLString
```
public String getSkipURLString()
```
    Gets the skip url string.
    
    Returns:
    
    the skip url string
  - isSkipURL
```
public boolean isSkipURL(org.apache.commons.httpclient.URI uri)
```
    Checks if is this url should be skipped.
    
    Parameters:
    
    uri - the uri
    
    Returns:
    
    true, if the url should be skipped
  - getRequestWaitTime
```
public int getRequestWaitTime()
```
    Gets the time between the requests sent to a server.
    
    Returns:
    
    the request wait time
  - setRequestWaitTime
```
public void setRequestWaitTime(int requestWait)
```
    Sets the time between the requests sent to a server.
    
    Parameters:
    
    requestWait - the new request wait time
  - getUserAgent
```
public String getUserAgent()
```
    Gets the user agent.
    
    Returns:
    
    the user agent
  - setUserAgent
```
public void setUserAgent(String userAgent)
```
    Sets the user agent, if different from the default one.
    
    Parameters:
    
    userAgent - the new user agent
  - isParseComments
```
public boolean isParseComments()
```
    Checks if the spider should parse the comments.
    
    Returns:
    
    true, if it parses the comments
  - setParseComments
```
public void setParseComments(boolean parseComments)
```
    Sets the whether the spider parses the comments.
    
    Parameters:
    
    parseComments - the new parses the comments value
  - isParseRobotsTxt
```
public boolean isParseRobotsTxt()
```
    Checks if the spider should parse the robots.txt for uris (not related to following the directions).
    
    Returns:
    
    true, if it parses the file
  - isParseSitemapXml
```
public boolean isParseSitemapXml()
```
    Checks if the spider should parse the sitemap.xml for URIs.
    
    Returns:
    
    true, if it parses the file
  - isParseSVNEntries
```
public boolean isParseSVNEntries()
```
    Checks if the spider should parse the SVN entries files for URIs (not related to following the directions).
    
    Returns:
    
    true, if it parses the file
  - isParseGit
```
public boolean isParseGit()
```
    Checks if the spider should parse the Git files for URIs.
    
    Returns:
    
    true, if it parses the files
  - setParseRobotsTxt
```
public void setParseRobotsTxt(boolean parseRobotsTxt)
```
    Sets the whether the spider parses the robots.txt for uris (not related to following the directions).
    
    Parameters:
    
    parseRobotsTxt - the new value for parseRobotsTxt
  - setParseSitemapXml
```
public void setParseSitemapXml(boolean parseSitemapXml)
```
    Sets the whether the spider parses the sitemap.xml for URIs.
    
    Parameters:
    
    parseSitemapXml - the new value for parseSitemapXml
  - setParseSVNEntries
```
public void setParseSVNEntries(boolean parseSVNentries)
```
    Sets the whether the spider parses the SVN entries file for URIs (not related to following the directions).
    
    Parameters:
    
    parseSVNentries - the new value for parseSVNentries
  - setParseGit
```
public void setParseGit(boolean parseGit)
```
    Sets the whether the spider parses Git files for URIs
    
    Parameters:
    
    parseGit - the new value for parseGit
  - getHandleParameters
```
public SpiderParam.HandleParametersOption getHandleParameters()
```
    Gets how the spider handles parameters when checking URIs visited.
    
    Returns:
    
    the handle parameters visited
  - setHandleParameters
```
public void setHandleParameters(SpiderParam.HandleParametersOption handleParametersVisited)
```
    Sets the how the spider handles parameters when checking URIs visited.
    
    Parameters:
    
    handleParametersVisited - the new handle parameters visited value
  - setHandleParameters
```
public void setHandleParameters(String handleParametersVisited)
```
    Sets the how the spider handles parameters when checking URIs visited.
    The provided parameter is, in this case, a String which is cast to the proper value. Possible values are: "USE_ALL", "IGNORE_VALUE", "IGNORE_COMPLETELY".
    
    Parameters:
    
    handleParametersVisited - the new handle parameters visited value
    
    Throws:
    
    IllegalArgumentException - if the given parameter is not a value of HandleParametersOption.
  - isHandleODataParametersVisited
```
public boolean isHandleODataParametersVisited()
```
    Check if the spider should take into account OData-specific parameters (i.e : resource identifiers) in order to identify already visited URL
    
    Returns:
    
    true, for handling OData parameters
  - setHandleODataParametersVisited
```
public void setHandleODataParametersVisited(boolean handleODataParametersVisited)
```
    Defines if the spider should handle OData specific parameters (i.e : resource identifiers) To identify already visited URL
    
    Parameters:
    
    handleODataParametersVisited - the new value for handleODataParametersVisited
  - getDomainsAlwaysInScope
```
public List<DomainAlwaysInScopeMatcher> getDomainsAlwaysInScope()
```
    Returns the domains that will be always in scope.
    
    Returns:
    
    the domains that will be always in scope.
    
    Since:
    
    2.3.0
    
    See Also:
    
    getDomainsAlwaysInScopeEnabled(), setDomainsAlwaysInScope(List)
  - getDomainsAlwaysInScopeEnabled
```
public List<DomainAlwaysInScopeMatcher> getDomainsAlwaysInScopeEnabled()
```
    Returns the, enabled, domains that will be always in scope.
    
    Returns:
    
    the enabled domains that will be always in scope.
    
    Since:
    
    2.3.0
    
    See Also:
    
    getDomainsAlwaysInScope(), setDomainsAlwaysInScope(List)
  - setDomainsAlwaysInScope
```
public void setDomainsAlwaysInScope(List<DomainAlwaysInScopeMatcher> domainsAlwaysInScope)
```
    Sets the domains that will be always in scope.
    
    Parameters:
    
    domainsAlwaysInScope - the domains that will be excluded.
    
    Since:
    
    2.3.0
  - isConfirmRemoveDomainAlwaysInScope
```
public boolean isConfirmRemoveDomainAlwaysInScope()
```
    Tells whether or not the remotion of a "domain always in scope" needs confirmation.
    
    Returns:
    
    true if the remotion needs confirmation, false otherwise.
    
    Since:
    
    2.3.0
  - setConfirmRemoveDomainAlwaysInScope
```
public void setConfirmRemoveDomainAlwaysInScope(boolean confirmRemove)
```
    Sets whether or not the remotion of a "domain always in scope" needs confirmation.
    
    Parameters:
    
    confirmRemove - true if the remotion needs confirmation, false otherwise.
    
    Since:
    
    2.3.0
  - getMaxScansInUI
```
public int getMaxScansInUI()
```
  - setMaxScansInUI
```
public void setMaxScansInUI(int maxScansInUI)
```
  - isShowAdvancedDialog
```
public boolean isShowAdvancedDialog()
```
  - setShowAdvancedDialog
```
public void setShowAdvancedDialog(boolean showAdvancedDialog)
```
  - isSendRefererHeader
```
public boolean isSendRefererHeader()
```
    Tells whether or not the "Referer" header should be sent in spider requests.
    
    Returns:
    
    true if the "Referer" header should be sent in spider requests, false otherwise
    
    Since:
    
    2.4.0
  - setSendRefererHeader
```
public void setSendRefererHeader(boolean send)
```
    Sets whether or not the "Referer" header should be sent in spider requests.
    
    Parameters:
    
    send - true if the "Referer" header should be sent in spider requests, false otherwise
    
    Since:
    
    2.4.0
  - getMaxDuration
```
public int getMaxDuration()
```
    Returns the maximum duration in minutes that the spider should run for. Zero means no limit.
    
    Returns:
    
    the maximum time, in minutes, that the spider should run
  - setMaxDuration
```
public void setMaxDuration(int maxDuration)
```
    Sets the maximum duration in minutes that the spider should run for. Zero means no limit.
    
    Parameters:
    
    maxDuration - the maximum time, in minutes, that the spider should run
  - getMaxChildren
```
public int getMaxChildren()
```
    Gets the maximum number of child nodes (per node) that can be crawled, 0 means no limit.
    
    Returns:
    
    the maximum number of child nodes that can be crawled.
    
    Since:
    
    2.6.0
  - setMaxChildren
```
public void setMaxChildren(int maxChildren)
```
    Sets the maximum number of child nodes (per node) that can be crawled, 0 means no limit.
    
    Parameters:
    
    maxChildren - the maximum number of child nodes that can be crawled.
    
    Since:
    
    2.6.0
  - setAcceptCookies
```
public void setAcceptCookies(boolean acceptCookies)
```
    Sets whether or not a spider process should accept cookies while spidering.
    For example, this might control whether or not the Spider uses the same session throughout a spidering process.
    Notes:
    - This option has low priority, the Spider will respect other (global) options related to the HTTP state. This option is ignored if, for example, a User was set or the option Session Tracking (Cookie) is enabled.
    - The cookies are not shared between spider processes, each process has its own cookie jar.
    Parameters:
    
    acceptCookies - true if the spider should accept cookies, false otherwise.
    
    Since:
    
    2.7.0
    
    See Also:
    
    isAcceptCookies()
  - isAcceptCookies
```
public boolean isAcceptCookies()
```
    Tells whether or not a spider process should accept cookies while spidering.
    For example, this might control whether or not the Spider uses the same session throughout a spidering process.
    
    Returns:
    
    true if the spider should accept cookies, false otherwise.
    
    Since:
    
    2.7.0
    
    See Also:
    
    setAcceptCookies(boolean)
  - setMaxParseSizeBytes
```
public void setMaxParseSizeBytes(int maxParseSizeBytes)
```
    Sets the maximum size, in bytes, that a response might have to be parsed.
    This allows the spider to skip big responses/files.
    
    Parameters:
    
    maxParseSizeBytes - the maximum size, in bytes, that a response might have to be parsed.
    
    Since:
    
    2.7.0
    
    See Also:
    
    getMaxParseSizeBytes()
  - getMaxParseSizeBytes
```
public int getMaxParseSizeBytes()
```
    Gets the maximum size, in bytes, that a response might have to be parsed.
    
    Returns:
    
    the maximum size, in bytes, that a response might have to be parsed.
    
    Since:
    
    2.7.0
    
    See Also:
    
    setMaxParseSizeBytes(int)

Class SpiderParam

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.parosproxy.paros.common.AbstractParam

Methods inherited from class java.lang.Object

Field Detail

UNLIMITED_DEPTH

Constructor Detail

SpiderParam

Method Detail

parse

getMaxDepth

setMaxDepth

getScopeText

getScope

setScopeString

getThreadCount

setThreadCount

isPostForm

setPostForm

isProcessForm

setProcessForm

setSkipURLString

getSkipURLString

isSkipURL

getRequestWaitTime

setRequestWaitTime

getUserAgent

setUserAgent

isParseComments

setParseComments

isParseRobotsTxt

isParseSitemapXml

isParseSVNEntries

isParseGit

setParseRobotsTxt

setParseSitemapXml

setParseSVNEntries

setParseGit

getHandleParameters

setHandleParameters

setHandleParameters

isHandleODataParametersVisited

setHandleODataParametersVisited

getDomainsAlwaysInScope

getDomainsAlwaysInScopeEnabled

setDomainsAlwaysInScope

isConfirmRemoveDomainAlwaysInScope

setConfirmRemoveDomainAlwaysInScope

getMaxScansInUI

setMaxScansInUI

isShowAdvancedDialog

setShowAdvancedDialog

isSendRefererHeader

setSendRefererHeader

getMaxDuration

setMaxDuration

getMaxChildren

setMaxChildren

setAcceptCookies

isAcceptCookies

setMaxParseSizeBytes

getMaxParseSizeBytes