Package org.zaproxy.clientapi.gen

Class Spider

java.lang.Object

org.zaproxy.clientapi.gen.deprecated.SpiderDeprecated

org.zaproxy.clientapi.gen.Spider

public class Spider
extends SpiderDeprecated

This file was automatically generated.

Constructor Summary

Constructors

Constructor	Description
Spider(ClientApi api)

Method Summary

Modifier and Type	Method	Description
ApiResponse	addDomainAlwaysInScope(String value, String isregex, String isenabled)	Adds a new domain that's always in scope, using the specified value.
ApiResponse	addedNodes(String scanid)	Returns a list of the names of the nodes added to the Sites tree by the specified scan.
ApiResponse	allUrls()	Returns a list of unique URLs from the history table based on HTTP messages added by the Spider.
ApiResponse	clearExcludedFromScan()	Clears the regexes of URLs excluded from the spider scans.
ApiResponse	disableAllDomainsAlwaysInScope()	Disables all domains that are always in scope.
ApiResponse	domainsAlwaysInScope()	Gets all the domains that are always in scope.
ApiResponse	enableAllDomainsAlwaysInScope()	Enables all domains that are always in scope.
ApiResponse	excludedFromScan()	Gets the regexes of URLs excluded from the spider scans.
ApiResponse	excludeFromScan(String regex)	Adds a regex of URLs that should be excluded from the spider scans.
ApiResponse	fullResults(String scanid)	This component is optional and therefore the API will only work if it is installed
ApiResponse	modifyDomainAlwaysInScope(String idx, String value, String isregex, String isenabled)	Modifies a domain that's always in scope.
ApiResponse	optionAcceptCookies()	Gets whether or not a spider process should accept cookies while spidering.
ApiResponse	optionDomainsAlwaysInScope()	Deprecated.
ApiResponse	optionDomainsAlwaysInScopeEnabled()	Deprecated.
ApiResponse	optionHandleODataParametersVisited()	This component is optional and therefore the API will only work if it is installed
ApiResponse	optionHandleParameters()	This component is optional and therefore the API will only work if it is installed
ApiResponse	optionMaxChildren()	Gets the maximum number of child nodes (per node) that can be crawled, 0 means no limit.
ApiResponse	optionMaxDepth()	Gets the maximum depth the spider can crawl, 0 if unlimited.
ApiResponse	optionMaxDuration()	This component is optional and therefore the API will only work if it is installed
ApiResponse	optionMaxParseSizeBytes()	Gets the maximum size, in bytes, that a response might have to be parsed.
ApiResponse	optionMaxScansInUI()	This component is optional and therefore the API will only work if it is installed
ApiResponse	optionParseComments()	This component is optional and therefore the API will only work if it is installed
ApiResponse	optionParseDsStore()	This component is optional and therefore the API will only work if it is installed
ApiResponse	optionParseGit()	This component is optional and therefore the API will only work if it is installed
ApiResponse	optionParseRobotsTxt()	This component is optional and therefore the API will only work if it is installed
ApiResponse	optionParseSitemapXml()	This component is optional and therefore the API will only work if it is installed
ApiResponse	optionParseSVNEntries()	This component is optional and therefore the API will only work if it is installed
ApiResponse	optionPostForm()	This component is optional and therefore the API will only work if it is installed
ApiResponse	optionProcessForm()	This component is optional and therefore the API will only work if it is installed
ApiResponse	optionRequestWaitTime()	Deprecated.
ApiResponse	optionSendRefererHeader()	Gets whether or not the 'Referer' header should be sent while spidering.
ApiResponse	optionShowAdvancedDialog()	This component is optional and therefore the API will only work if it is installed
ApiResponse	optionSkipURLString()	This component is optional and therefore the API will only work if it is installed
ApiResponse	optionThreadCount()	This component is optional and therefore the API will only work if it is installed
ApiResponse	optionUserAgent()	This component is optional and therefore the API will only work if it is installed
ApiResponse	pause(String scanid)	This component is optional and therefore the API will only work if it is installed
ApiResponse	pauseAllScans()	This component is optional and therefore the API will only work if it is installed
ApiResponse	removeAllScans()	This component is optional and therefore the API will only work if it is installed
ApiResponse	removeDomainAlwaysInScope(String idx)	Removes a domain that's always in scope, with the given index.
ApiResponse	removeScan(String scanid)	This component is optional and therefore the API will only work if it is installed
ApiResponse	results(String scanid)	This component is optional and therefore the API will only work if it is installed
ApiResponse	resume(String scanid)	This component is optional and therefore the API will only work if it is installed
ApiResponse	resumeAllScans()	This component is optional and therefore the API will only work if it is installed
ApiResponse	scan(String url, String maxchildren, String recurse, String contextname, String subtreeonly)	Runs the spider against the given URL (or context).
ApiResponse	scanAsUser(String contextid, String userid, String url, String maxchildren, String recurse, String subtreeonly)	Runs the spider from the perspective of a User, obtained using the given Context ID and User ID.
ApiResponse	scans()	This component is optional and therefore the API will only work if it is installed
ApiResponse	setOptionAcceptCookies(boolean bool)	Sets whether or not a spider process should accept cookies while spidering.
ApiResponse	setOptionHandleODataParametersVisited(boolean bool)	This component is optional and therefore the API will only work if it is installed
ApiResponse	setOptionHandleParameters(String string)	This component is optional and therefore the API will only work if it is installed
ApiResponse	setOptionMaxChildren(int i)	Sets the maximum number of child nodes (per node) that can be crawled, 0 means no limit.
ApiResponse	setOptionMaxDepth(int i)	Sets the maximum depth the spider can crawl, 0 for unlimited depth.
ApiResponse	setOptionMaxDuration(int i)	This component is optional and therefore the API will only work if it is installed
ApiResponse	setOptionMaxParseSizeBytes(int i)	Sets the maximum size, in bytes, that a response might have to be parsed.
ApiResponse	setOptionMaxScansInUI(int i)	This component is optional and therefore the API will only work if it is installed
ApiResponse	setOptionParseComments(boolean bool)	This component is optional and therefore the API will only work if it is installed
ApiResponse	setOptionParseDsStore(boolean bool)	This component is optional and therefore the API will only work if it is installed
ApiResponse	setOptionParseGit(boolean bool)	This component is optional and therefore the API will only work if it is installed
ApiResponse	setOptionParseRobotsTxt(boolean bool)	This component is optional and therefore the API will only work if it is installed
ApiResponse	setOptionParseSitemapXml(boolean bool)	This component is optional and therefore the API will only work if it is installed
ApiResponse	setOptionParseSVNEntries(boolean bool)	This component is optional and therefore the API will only work if it is installed
ApiResponse	setOptionPostForm(boolean bool)	This component is optional and therefore the API will only work if it is installed
ApiResponse	setOptionProcessForm(boolean bool)	This component is optional and therefore the API will only work if it is installed
ApiResponse	setOptionRequestWaitTime(int i)	Deprecated.
ApiResponse	setOptionSendRefererHeader(boolean bool)	Sets whether or not the 'Referer' header should be sent while spidering.
ApiResponse	setOptionShowAdvancedDialog(boolean bool)	This component is optional and therefore the API will only work if it is installed
ApiResponse	setOptionSkipURLString(String string)	This component is optional and therefore the API will only work if it is installed
ApiResponse	setOptionThreadCount(int i)	This component is optional and therefore the API will only work if it is installed
ApiResponse	setOptionUserAgent(String string)	This component is optional and therefore the API will only work if it is installed
ApiResponse	status(String scanid)	This component is optional and therefore the API will only work if it is installed
ApiResponse	stop(String scanid)	This component is optional and therefore the API will only work if it is installed
ApiResponse	stopAllScans()	This component is optional and therefore the API will only work if it is installed

Methods inherited from class org.zaproxy.clientapi.gen.deprecated.SpiderDeprecated

clearExcludedFromScan, excludeFromScan, optionScope, optionScopeText, pause, pauseAllScans, removeAllScans, removeScan, resume, resumeAllScans, scan, scanAsUser, setOptionHandleODataParametersVisited, setOptionHandleParameters, setOptionMaxDepth, setOptionMaxDuration, setOptionMaxScansInUI, setOptionParseComments, setOptionParseGit, setOptionParseRobotsTxt, setOptionParseSitemapXml, setOptionParseSVNEntries, setOptionPostForm, setOptionProcessForm, setOptionRequestWaitTime, setOptionScopeString, setOptionScopeString, setOptionSendRefererHeader, setOptionShowAdvancedDialog, setOptionSkipURLString, setOptionThreadCount, setOptionUserAgent, stop, stopAllScans

Methods inherited from class java.lang.Object

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

Constructor Details

Spider

public Spider(ClientApi api)

Method Details

status

public ApiResponse status(String scanid)
                   throws ClientApiException

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

results

public ApiResponse results(String scanid)
                    throws ClientApiException

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

fullResults

public ApiResponse fullResults(String scanid)
                        throws ClientApiException

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

scans

public ApiResponse scans()
                  throws ClientApiException

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

excludedFromScan

public ApiResponse excludedFromScan()
                             throws ClientApiException

Gets the regexes of URLs excluded from the spider scans.

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

allUrls

public ApiResponse allUrls()
                    throws ClientApiException

Returns a list of unique URLs from the history table based on HTTP messages added by the Spider.

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

addedNodes

public ApiResponse addedNodes(String scanid)
                       throws ClientApiException

Returns a list of the names of the nodes added to the Sites tree by the specified scan.

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

domainsAlwaysInScope

public ApiResponse domainsAlwaysInScope()
                                 throws ClientApiException

Gets all the domains that are always in scope. For each domain the following are shown: the index, the value (domain), if enabled, and if specified as a regex.

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

optionDomainsAlwaysInScope

@Deprecated
public ApiResponse optionDomainsAlwaysInScope()
                                       throws ClientApiException

Deprecated.

Use view domainsAlwaysInScope instead.

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

optionDomainsAlwaysInScopeEnabled

@Deprecated
public ApiResponse optionDomainsAlwaysInScopeEnabled()
                                              throws ClientApiException

Deprecated.

Use view domainsAlwaysInScope instead.

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

optionHandleParameters

public ApiResponse optionHandleParameters()
                                   throws ClientApiException

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

optionMaxChildren

public ApiResponse optionMaxChildren()
                              throws ClientApiException

Gets the maximum number of child nodes (per node) that can be crawled, 0 means no limit.

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

optionMaxDepth

public ApiResponse optionMaxDepth()
                           throws ClientApiException

Gets the maximum depth the spider can crawl, 0 if unlimited.

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

optionMaxDuration

public ApiResponse optionMaxDuration()
                              throws ClientApiException

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

optionMaxParseSizeBytes

public ApiResponse optionMaxParseSizeBytes()
                                    throws ClientApiException

Gets the maximum size, in bytes, that a response might have to be parsed.

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

optionMaxScansInUI

public ApiResponse optionMaxScansInUI()
                               throws ClientApiException

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

optionRequestWaitTime

@Deprecated
public ApiResponse optionRequestWaitTime()
                                  throws ClientApiException

Deprecated.

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

optionSkipURLString

public ApiResponse optionSkipURLString()
                                throws ClientApiException

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

optionThreadCount

public ApiResponse optionThreadCount()
                              throws ClientApiException

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

optionUserAgent

public ApiResponse optionUserAgent()
                            throws ClientApiException

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

optionAcceptCookies

public ApiResponse optionAcceptCookies()
                                throws ClientApiException

Gets whether or not a spider process should accept cookies while spidering.

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

optionHandleODataParametersVisited

public ApiResponse optionHandleODataParametersVisited()
                                               throws ClientApiException

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

optionParseComments

public ApiResponse optionParseComments()
                                throws ClientApiException

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

optionParseDsStore

public ApiResponse optionParseDsStore()
                               throws ClientApiException

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

optionParseGit

public ApiResponse optionParseGit()
                           throws ClientApiException

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

optionParseRobotsTxt

public ApiResponse optionParseRobotsTxt()
                                 throws ClientApiException

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

optionParseSVNEntries

public ApiResponse optionParseSVNEntries()
                                  throws ClientApiException

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

optionParseSitemapXml

public ApiResponse optionParseSitemapXml()
                                  throws ClientApiException

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

optionPostForm

public ApiResponse optionPostForm()
                           throws ClientApiException

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

optionProcessForm

public ApiResponse optionProcessForm()
                              throws ClientApiException

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

optionSendRefererHeader

public ApiResponse optionSendRefererHeader()
                                    throws ClientApiException

Gets whether or not the 'Referer' header should be sent while spidering.

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

optionShowAdvancedDialog

public ApiResponse optionShowAdvancedDialog()
                                     throws ClientApiException

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

scan

public ApiResponse scan(String url,
 String maxchildren,
 String recurse,
 String contextname,
 String subtreeonly)
                 throws ClientApiException

Runs the spider against the given URL (or context). Optionally, the 'maxChildren' parameter can be set to limit the number of children scanned, the 'recurse' parameter can be used to prevent the spider from seeding recursively, the parameter 'contextName' can be used to constrain the scan to a Context and the parameter 'subtreeOnly' allows to restrict the spider under a site's subtree (using the specified 'url').

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

scanAsUser

public ApiResponse scanAsUser(String contextid,
 String userid,
 String url,
 String maxchildren,
 String recurse,
 String subtreeonly)
                       throws ClientApiException

Runs the spider from the perspective of a User, obtained using the given Context ID and User ID. See 'scan' action for more details.

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

pause

public ApiResponse pause(String scanid)
                  throws ClientApiException

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

resume

public ApiResponse resume(String scanid)
                   throws ClientApiException

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

stop

public ApiResponse stop(String scanid)
                 throws ClientApiException

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

removeScan

public ApiResponse removeScan(String scanid)
                       throws ClientApiException

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

pauseAllScans

public ApiResponse pauseAllScans()
                          throws ClientApiException

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

resumeAllScans

public ApiResponse resumeAllScans()
                           throws ClientApiException

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

stopAllScans

public ApiResponse stopAllScans()
                         throws ClientApiException

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

removeAllScans

public ApiResponse removeAllScans()
                           throws ClientApiException

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

clearExcludedFromScan

public ApiResponse clearExcludedFromScan()
                                  throws ClientApiException

Clears the regexes of URLs excluded from the spider scans.

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

excludeFromScan

public ApiResponse excludeFromScan(String regex)
                            throws ClientApiException

Adds a regex of URLs that should be excluded from the spider scans.

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

addDomainAlwaysInScope

public ApiResponse addDomainAlwaysInScope(String value,
 String isregex,
 String isenabled)
                                   throws ClientApiException

Adds a new domain that's always in scope, using the specified value. Optionally sets if the new entry is enabled (default, true) and whether or not the new value is specified as a regex (default, false).

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

modifyDomainAlwaysInScope

public ApiResponse modifyDomainAlwaysInScope(String idx,
 String value,
 String isregex,
 String isenabled)
                                      throws ClientApiException

Modifies a domain that's always in scope. Allows to modify the value, if enabled or if a regex. The domain is selected with its index, which can be obtained with the view domainsAlwaysInScope.

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

removeDomainAlwaysInScope

public ApiResponse removeDomainAlwaysInScope(String idx)
                                      throws ClientApiException

Removes a domain that's always in scope, with the given index. The index can be obtained with the view domainsAlwaysInScope.

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

enableAllDomainsAlwaysInScope

public ApiResponse enableAllDomainsAlwaysInScope()
                                          throws ClientApiException

Enables all domains that are always in scope.

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

disableAllDomainsAlwaysInScope

public ApiResponse disableAllDomainsAlwaysInScope()
                                           throws ClientApiException

Disables all domains that are always in scope.

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

setOptionHandleParameters

public ApiResponse setOptionHandleParameters(String string)
                                      throws ClientApiException

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

setOptionSkipURLString

public ApiResponse setOptionSkipURLString(String string)
                                   throws ClientApiException

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

setOptionUserAgent

public ApiResponse setOptionUserAgent(String string)
                               throws ClientApiException

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

setOptionAcceptCookies

public ApiResponse setOptionAcceptCookies(boolean bool)
                                   throws ClientApiException

Sets whether or not a spider process should accept cookies while spidering.

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

setOptionHandleODataParametersVisited

public ApiResponse setOptionHandleODataParametersVisited(boolean bool)
                                                  throws ClientApiException

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

setOptionMaxChildren

public ApiResponse setOptionMaxChildren(int i)
                                 throws ClientApiException

Sets the maximum number of child nodes (per node) that can be crawled, 0 means no limit.

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

setOptionMaxDepth

public ApiResponse setOptionMaxDepth(int i)
                              throws ClientApiException

Sets the maximum depth the spider can crawl, 0 for unlimited depth.

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

setOptionMaxDuration

public ApiResponse setOptionMaxDuration(int i)
                                 throws ClientApiException

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

setOptionMaxParseSizeBytes

public ApiResponse setOptionMaxParseSizeBytes(int i)
                                       throws ClientApiException

Sets the maximum size, in bytes, that a response might have to be parsed. This allows the spider to skip big responses/files.

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

setOptionMaxScansInUI

public ApiResponse setOptionMaxScansInUI(int i)
                                  throws ClientApiException

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

setOptionParseComments

public ApiResponse setOptionParseComments(boolean bool)
                                   throws ClientApiException

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

setOptionParseDsStore

public ApiResponse setOptionParseDsStore(boolean bool)
                                  throws ClientApiException

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

setOptionParseGit

public ApiResponse setOptionParseGit(boolean bool)
                              throws ClientApiException

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

setOptionParseRobotsTxt

public ApiResponse setOptionParseRobotsTxt(boolean bool)
                                    throws ClientApiException

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

setOptionParseSVNEntries

public ApiResponse setOptionParseSVNEntries(boolean bool)
                                     throws ClientApiException

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

setOptionParseSitemapXml

public ApiResponse setOptionParseSitemapXml(boolean bool)
                                     throws ClientApiException

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

setOptionPostForm

public ApiResponse setOptionPostForm(boolean bool)
                              throws ClientApiException

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

setOptionProcessForm

public ApiResponse setOptionProcessForm(boolean bool)
                                 throws ClientApiException

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

setOptionRequestWaitTime

@Deprecated
public ApiResponse setOptionRequestWaitTime(int i)
                                     throws ClientApiException

Deprecated.

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

setOptionSendRefererHeader

public ApiResponse setOptionSendRefererHeader(boolean bool)
                                       throws ClientApiException

Sets whether or not the 'Referer' header should be sent while spidering.

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

setOptionShowAdvancedDialog

public ApiResponse setOptionShowAdvancedDialog(boolean bool)
                                        throws ClientApiException

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

setOptionThreadCount

public ApiResponse setOptionThreadCount(int i)
                                 throws ClientApiException

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException