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 and Description
Spider(ClientApi api)

Method Summary

Modifier and Type	Method and Description
ApiResponse	addDomainAlwaysInScope(java.lang.String value, java.lang.String isregex, java.lang.String isenabled) Adds a new domain that's always in scope, using the specified value.
ApiResponse	addedNodes(java.lang.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(java.lang.String regex) Adds a regex of URLs that should be excluded from the spider scans.
ApiResponse	fullResults(java.lang.String scanid)
ApiResponse	modifyDomainAlwaysInScope(java.lang.String idx, java.lang.String value, java.lang.String isregex, java.lang.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()
ApiResponse	optionHandleParameters()
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()
ApiResponse	optionMaxParseSizeBytes() Gets the maximum size, in bytes, that a response might have to be parsed.
ApiResponse	optionMaxScansInUI()
ApiResponse	optionParseComments()
ApiResponse	optionParseGit()
ApiResponse	optionParseRobotsTxt()
ApiResponse	optionParseSitemapXml()
ApiResponse	optionParseSVNEntries()
ApiResponse	optionPostForm()
ApiResponse	optionProcessForm()
ApiResponse	optionRequestWaitTime()
ApiResponse	optionScope() Deprecated.
ApiResponse	optionScopeText() Deprecated.
ApiResponse	optionSendRefererHeader() Gets whether or not the 'Referer' header should be sent while spidering.
ApiResponse	optionShowAdvancedDialog()
ApiResponse	optionSkipURLString()
ApiResponse	optionThreadCount()
ApiResponse	optionUserAgent()
ApiResponse	pause(java.lang.String scanid)
ApiResponse	pauseAllScans()
ApiResponse	removeAllScans()
ApiResponse	removeDomainAlwaysInScope(java.lang.String idx) Removes a domain that's always in scope, with the given index.
ApiResponse	removeScan(java.lang.String scanid)
ApiResponse	results(java.lang.String scanid)
ApiResponse	resume(java.lang.String scanid)
ApiResponse	resumeAllScans()
ApiResponse	scan(java.lang.String url, java.lang.String maxchildren, java.lang.String recurse, java.lang.String contextname, java.lang.String subtreeonly) Runs the spider against the given URL (or context).
ApiResponse	scanAsUser(java.lang.String contextid, java.lang.String userid, java.lang.String url, java.lang.String maxchildren, java.lang.String recurse, java.lang.String subtreeonly) Runs the spider from the perspective of a User, obtained using the given Context ID and User ID.
ApiResponse	scans()
ApiResponse	setOptionAcceptCookies(boolean bool) Sets whether or not a spider process should accept cookies while spidering.
ApiResponse	setOptionHandleODataParametersVisited(boolean bool)
ApiResponse	setOptionHandleParameters(java.lang.String string)
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)
ApiResponse	setOptionMaxParseSizeBytes(int i) Sets the maximum size, in bytes, that a response might have to be parsed.
ApiResponse	setOptionMaxScansInUI(int i)
ApiResponse	setOptionParseComments(boolean bool)
ApiResponse	setOptionParseGit(boolean bool)
ApiResponse	setOptionParseRobotsTxt(boolean bool)
ApiResponse	setOptionParseSitemapXml(boolean bool)
ApiResponse	setOptionParseSVNEntries(boolean bool)
ApiResponse	setOptionPostForm(boolean bool)
ApiResponse	setOptionProcessForm(boolean bool)
ApiResponse	setOptionRequestWaitTime(int i)
ApiResponse	setOptionScopeString(java.lang.String string) Deprecated. Option no longer in effective use.
ApiResponse	setOptionSendRefererHeader(boolean bool) Sets whether or not the 'Referer' header should be sent while spidering.
ApiResponse	setOptionShowAdvancedDialog(boolean bool)
ApiResponse	setOptionSkipURLString(java.lang.String string)
ApiResponse	setOptionThreadCount(int i)
ApiResponse	setOptionUserAgent(java.lang.String string)
ApiResponse	status(java.lang.String scanid)
ApiResponse	stop(java.lang.String scanid)
ApiResponse	stopAllScans()

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

clearExcludedFromScan, excludeFromScan, pause, pauseAllScans, removeAllScans, removeScan, resume, resumeAllScans, scan, scanAsUser, setOptionHandleODataParametersVisited, setOptionHandleParameters, setOptionMaxDepth, setOptionMaxDuration, setOptionMaxScansInUI, setOptionParseComments, setOptionParseGit, setOptionParseRobotsTxt, setOptionParseSitemapXml, setOptionParseSVNEntries, setOptionPostForm, setOptionProcessForm, setOptionRequestWaitTime, 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 Detail

Spider

public Spider(ClientApi api)

Method Detail

status

public ApiResponse status(java.lang.String scanid)
                   throws ClientApiException

Throws:

ClientApiException

results

public ApiResponse results(java.lang.String scanid)
                    throws ClientApiException

Throws:

ClientApiException

fullResults

public ApiResponse fullResults(java.lang.String scanid)
                        throws ClientApiException

Throws:

ClientApiException

scans

public ApiResponse scans()
                  throws ClientApiException

Throws:

ClientApiException

excludedFromScan

public ApiResponse excludedFromScan()
                             throws ClientApiException

Gets the regexes of URLs excluded from the spider scans.

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.

Throws:

ClientApiException

addedNodes

public ApiResponse addedNodes(java.lang.String scanid)
                       throws ClientApiException

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

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.

Throws:

ClientApiException

optionDomainsAlwaysInScope

@Deprecated
public ApiResponse optionDomainsAlwaysInScope()
                                                   throws ClientApiException

Deprecated.

Use view domainsAlwaysInScope instead.

Throws:

ClientApiException

optionDomainsAlwaysInScopeEnabled

@Deprecated
public ApiResponse optionDomainsAlwaysInScopeEnabled()
                                                          throws ClientApiException

Deprecated.

Use view domainsAlwaysInScope instead.

Throws:

ClientApiException

optionHandleParameters

public ApiResponse optionHandleParameters()
                                   throws ClientApiException

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.

Throws:

ClientApiException

optionMaxDepth

public ApiResponse optionMaxDepth()
                           throws ClientApiException

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

Throws:

ClientApiException

optionMaxDuration

public ApiResponse optionMaxDuration()
                              throws ClientApiException

Throws:

ClientApiException

optionMaxParseSizeBytes

public ApiResponse optionMaxParseSizeBytes()
                                    throws ClientApiException

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

Throws:

ClientApiException

optionMaxScansInUI

public ApiResponse optionMaxScansInUI()
                               throws ClientApiException

Throws:

ClientApiException

optionRequestWaitTime

public ApiResponse optionRequestWaitTime()
                                  throws ClientApiException

Throws:

ClientApiException

optionScope

@Deprecated
public ApiResponse optionScope()
                                    throws ClientApiException

Deprecated.

Throws:

ClientApiException

optionScopeText

@Deprecated
public ApiResponse optionScopeText()
                                        throws ClientApiException

Deprecated.

Throws:

ClientApiException

optionSkipURLString

public ApiResponse optionSkipURLString()
                                throws ClientApiException

Throws:

ClientApiException

optionThreadCount

public ApiResponse optionThreadCount()
                              throws ClientApiException

Throws:

ClientApiException

optionUserAgent

public ApiResponse optionUserAgent()
                            throws ClientApiException

Throws:

ClientApiException

optionAcceptCookies

public ApiResponse optionAcceptCookies()
                                throws ClientApiException

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

Throws:

ClientApiException

optionHandleODataParametersVisited

public ApiResponse optionHandleODataParametersVisited()
                                               throws ClientApiException

Throws:

ClientApiException

optionParseComments

public ApiResponse optionParseComments()
                                throws ClientApiException

Throws:

ClientApiException

optionParseGit

public ApiResponse optionParseGit()
                           throws ClientApiException

Throws:

ClientApiException

optionParseRobotsTxt

public ApiResponse optionParseRobotsTxt()
                                 throws ClientApiException

Throws:

ClientApiException

optionParseSVNEntries

public ApiResponse optionParseSVNEntries()
                                  throws ClientApiException

Throws:

ClientApiException

optionParseSitemapXml

public ApiResponse optionParseSitemapXml()
                                  throws ClientApiException

Throws:

ClientApiException

optionPostForm

public ApiResponse optionPostForm()
                           throws ClientApiException

Throws:

ClientApiException

optionProcessForm

public ApiResponse optionProcessForm()
                              throws ClientApiException

Throws:

ClientApiException

optionSendRefererHeader

public ApiResponse optionSendRefererHeader()
                                    throws ClientApiException

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

Throws:

ClientApiException

optionShowAdvancedDialog

public ApiResponse optionShowAdvancedDialog()
                                     throws ClientApiException

Throws:

ClientApiException

scan

public ApiResponse scan(java.lang.String url,
                        java.lang.String maxchildren,
                        java.lang.String recurse,
                        java.lang.String contextname,
                        java.lang.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').

Throws:

ClientApiException

scanAsUser

public ApiResponse scanAsUser(java.lang.String contextid,
                              java.lang.String userid,
                              java.lang.String url,
                              java.lang.String maxchildren,
                              java.lang.String recurse,
                              java.lang.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.

Throws:

ClientApiException

pause

public ApiResponse pause(java.lang.String scanid)
                  throws ClientApiException

Throws:

ClientApiException

resume

public ApiResponse resume(java.lang.String scanid)
                   throws ClientApiException

Throws:

ClientApiException

stop

public ApiResponse stop(java.lang.String scanid)
                 throws ClientApiException

Throws:

ClientApiException

removeScan

public ApiResponse removeScan(java.lang.String scanid)
                       throws ClientApiException

Throws:

ClientApiException

pauseAllScans

public ApiResponse pauseAllScans()
                          throws ClientApiException

Throws:

ClientApiException

resumeAllScans

public ApiResponse resumeAllScans()
                           throws ClientApiException

Throws:

ClientApiException

stopAllScans

public ApiResponse stopAllScans()
                         throws ClientApiException

Throws:

ClientApiException

removeAllScans

public ApiResponse removeAllScans()
                           throws ClientApiException

Throws:

ClientApiException

clearExcludedFromScan

public ApiResponse clearExcludedFromScan()
                                  throws ClientApiException

Clears the regexes of URLs excluded from the spider scans.

Throws:

ClientApiException

excludeFromScan

public ApiResponse excludeFromScan(java.lang.String regex)
                            throws ClientApiException

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

Throws:

ClientApiException

addDomainAlwaysInScope

public ApiResponse addDomainAlwaysInScope(java.lang.String value,
                                          java.lang.String isregex,
                                          java.lang.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).

Throws:

ClientApiException

modifyDomainAlwaysInScope

public ApiResponse modifyDomainAlwaysInScope(java.lang.String idx,
                                             java.lang.String value,
                                             java.lang.String isregex,
                                             java.lang.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.

Throws:

ClientApiException

removeDomainAlwaysInScope

public ApiResponse removeDomainAlwaysInScope(java.lang.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.

Throws:

ClientApiException

enableAllDomainsAlwaysInScope

public ApiResponse enableAllDomainsAlwaysInScope()
                                          throws ClientApiException

Enables all domains that are always in scope.

Throws:

ClientApiException

disableAllDomainsAlwaysInScope

public ApiResponse disableAllDomainsAlwaysInScope()
                                           throws ClientApiException

Disables all domains that are always in scope.

Throws:

ClientApiException

setOptionHandleParameters

public ApiResponse setOptionHandleParameters(java.lang.String string)
                                      throws ClientApiException

Throws:

ClientApiException

setOptionScopeString

@Deprecated
public ApiResponse setOptionScopeString(java.lang.String string)
                                             throws ClientApiException

Deprecated. Option no longer in effective use.

Use actions [add|modify|remove]DomainAlwaysInScope instead.

Throws:

ClientApiException

setOptionSkipURLString

public ApiResponse setOptionSkipURLString(java.lang.String string)
                                   throws ClientApiException

Throws:

ClientApiException

setOptionUserAgent

public ApiResponse setOptionUserAgent(java.lang.String string)
                               throws ClientApiException

Throws:

ClientApiException

setOptionAcceptCookies

public ApiResponse setOptionAcceptCookies(boolean bool)
                                   throws ClientApiException

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

Throws:

ClientApiException

setOptionHandleODataParametersVisited

public ApiResponse setOptionHandleODataParametersVisited(boolean bool)
                                                  throws ClientApiException

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.

Throws:

ClientApiException

setOptionMaxDepth

public ApiResponse setOptionMaxDepth(int i)
                              throws ClientApiException

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

Throws:

ClientApiException

setOptionMaxDuration

public ApiResponse setOptionMaxDuration(int i)
                                 throws ClientApiException

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.

Throws:

ClientApiException

setOptionMaxScansInUI

public ApiResponse setOptionMaxScansInUI(int i)
                                  throws ClientApiException

Throws:

ClientApiException

setOptionParseComments

public ApiResponse setOptionParseComments(boolean bool)
                                   throws ClientApiException

Throws:

ClientApiException

setOptionParseGit

public ApiResponse setOptionParseGit(boolean bool)
                              throws ClientApiException

Throws:

ClientApiException

setOptionParseRobotsTxt

public ApiResponse setOptionParseRobotsTxt(boolean bool)
                                    throws ClientApiException

Throws:

ClientApiException

setOptionParseSVNEntries

public ApiResponse setOptionParseSVNEntries(boolean bool)
                                     throws ClientApiException

Throws:

ClientApiException

setOptionParseSitemapXml

public ApiResponse setOptionParseSitemapXml(boolean bool)
                                     throws ClientApiException

Throws:

ClientApiException

setOptionPostForm

public ApiResponse setOptionPostForm(boolean bool)
                              throws ClientApiException

Throws:

ClientApiException

setOptionProcessForm

public ApiResponse setOptionProcessForm(boolean bool)
                                 throws ClientApiException

Throws:

ClientApiException

setOptionRequestWaitTime

public ApiResponse setOptionRequestWaitTime(int i)
                                     throws ClientApiException

Throws:

ClientApiException

setOptionSendRefererHeader

public ApiResponse setOptionSendRefererHeader(boolean bool)
                                       throws ClientApiException

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

Throws:

ClientApiException

setOptionShowAdvancedDialog

public ApiResponse setOptionShowAdvancedDialog(boolean bool)
                                        throws ClientApiException

Throws:

ClientApiException

setOptionThreadCount

public ApiResponse setOptionThreadCount(int i)
                                 throws ClientApiException

Throws:

ClientApiException