org.zaproxy.clientapi.gen

Class AjaxSpider

java.lang.Object

org.zaproxy.clientapi.gen.deprecated.AjaxSpiderDeprecated

org.zaproxy.clientapi.gen.AjaxSpider

public class AjaxSpider
extends AjaxSpiderDeprecated

This file was automatically generated.

Constructor Summary

Constructors

Constructor and Description
AjaxSpider(ClientApi api)

Method Summary

Modifier and Type	Method and Description
ApiResponse	fullResults() This component is optional and therefore the API will only work if it is installed
ApiResponse	numberOfResults() This component is optional and therefore the API will only work if it is installed
ApiResponse	optionBrowserId() This component is optional and therefore the API will only work if it is installed
ApiResponse	optionClickDefaultElems() This component is optional and therefore the API will only work if it is installed
ApiResponse	optionClickElemsOnce() This component is optional and therefore the API will only work if it is installed
ApiResponse	optionEventWait() This component is optional and therefore the API will only work if it is installed
ApiResponse	optionMaxCrawlDepth() This component is optional and therefore the API will only work if it is installed
ApiResponse	optionMaxCrawlStates() This component is optional and therefore the API will only work if it is installed
ApiResponse	optionMaxDuration() This component is optional and therefore the API will only work if it is installed
ApiResponse	optionNumberOfBrowsers() This component is optional and therefore the API will only work if it is installed
ApiResponse	optionRandomInputs() This component is optional and therefore the API will only work if it is installed
ApiResponse	optionReloadWait() This component is optional and therefore the API will only work if it is installed
ApiResponse	results(java.lang.String start, java.lang.String count) This component is optional and therefore the API will only work if it is installed
ApiResponse	scan(java.lang.String url, java.lang.String inscope, java.lang.String contextname, java.lang.String subtreeonly) Runs the spider against the given URL and/or context, optionally, spidering everything in scope.
ApiResponse	scanAsUser(java.lang.String contextname, java.lang.String username, java.lang.String url, java.lang.String subtreeonly) Runs the spider from the perspective of a User, obtained using the given context name and user name.
ApiResponse	setOptionBrowserId(java.lang.String string) This component is optional and therefore the API will only work if it is installed
ApiResponse	setOptionClickDefaultElems(boolean bool) This component is optional and therefore the API will only work if it is installed
ApiResponse	setOptionClickElemsOnce(boolean bool) This component is optional and therefore the API will only work if it is installed
ApiResponse	setOptionEventWait(int i) This component is optional and therefore the API will only work if it is installed
ApiResponse	setOptionMaxCrawlDepth(int i) This component is optional and therefore the API will only work if it is installed
ApiResponse	setOptionMaxCrawlStates(int i) This component is optional and therefore the API will only work if it is installed
ApiResponse	setOptionMaxDuration(int i) This component is optional and therefore the API will only work if it is installed
ApiResponse	setOptionNumberOfBrowsers(int i) This component is optional and therefore the API will only work if it is installed
ApiResponse	setOptionRandomInputs(boolean bool) This component is optional and therefore the API will only work if it is installed
ApiResponse	setOptionReloadWait(int i) This component is optional and therefore the API will only work if it is installed
ApiResponse	status() This component is optional and therefore the API will only work if it is installed
ApiResponse	stop() This component is optional and therefore the API will only work if it is installed

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

scan, setOptionBrowserId, setOptionClickDefaultElems, setOptionClickElemsOnce, setOptionEventWait, setOptionMaxCrawlDepth, setOptionMaxCrawlStates, setOptionMaxDuration, setOptionNumberOfBrowsers, setOptionRandomInputs, setOptionReloadWait, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

AjaxSpider

public AjaxSpider(ClientApi api)

Method Detail

status

public ApiResponse status()
                   throws ClientApiException

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

Throws:

ClientApiException

results

public ApiResponse results(java.lang.String start,
                           java.lang.String count)
                    throws ClientApiException

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

Throws:

ClientApiException

numberOfResults

public ApiResponse numberOfResults()
                            throws ClientApiException

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

Throws:

ClientApiException

fullResults

public ApiResponse fullResults()
                        throws ClientApiException

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

Throws:

ClientApiException

optionBrowserId

public ApiResponse optionBrowserId()
                            throws ClientApiException

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

Throws:

ClientApiException

optionEventWait

public ApiResponse optionEventWait()
                            throws ClientApiException

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

Throws:

ClientApiException

optionMaxCrawlDepth

public ApiResponse optionMaxCrawlDepth()
                                throws ClientApiException

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

Throws:

ClientApiException

optionMaxCrawlStates

public ApiResponse optionMaxCrawlStates()
                                 throws ClientApiException

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

optionNumberOfBrowsers

public ApiResponse optionNumberOfBrowsers()
                                   throws ClientApiException

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

Throws:

ClientApiException

optionReloadWait

public ApiResponse optionReloadWait()
                             throws ClientApiException

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

Throws:

ClientApiException

optionClickDefaultElems

public ApiResponse optionClickDefaultElems()
                                    throws ClientApiException

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

Throws:

ClientApiException

optionClickElemsOnce

public ApiResponse optionClickElemsOnce()
                                 throws ClientApiException

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

Throws:

ClientApiException

optionRandomInputs

public ApiResponse optionRandomInputs()
                               throws ClientApiException

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

Throws:

ClientApiException

scan

public ApiResponse scan(java.lang.String url,
                        java.lang.String inscope,
                        java.lang.String contextname,
                        java.lang.String subtreeonly)
                 throws ClientApiException

Runs the spider against the given URL and/or context, optionally, spidering everything in scope. The parameter 'contextName' can be used to constrain the scan to a Context, the option 'in scope' is ignored if a context was also specified. 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(java.lang.String contextname,
                              java.lang.String username,
                              java.lang.String url,
                              java.lang.String subtreeonly)
                       throws ClientApiException

Runs the spider from the perspective of a User, obtained using the given context name and user name. The parameter 'url' allows to specify the starting point for the spider, otherwise it's used an existing URL from the context (if any). 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

stop

public ApiResponse stop()
                 throws ClientApiException

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

Throws:

ClientApiException

setOptionBrowserId

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

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

Throws:

ClientApiException

setOptionClickDefaultElems

public ApiResponse setOptionClickDefaultElems(boolean bool)
                                       throws ClientApiException

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

Throws:

ClientApiException

setOptionClickElemsOnce

public ApiResponse setOptionClickElemsOnce(boolean bool)
                                    throws ClientApiException

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

Throws:

ClientApiException

setOptionEventWait

public ApiResponse setOptionEventWait(int i)
                               throws ClientApiException

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

Throws:

ClientApiException

setOptionMaxCrawlDepth

public ApiResponse setOptionMaxCrawlDepth(int i)
                                   throws ClientApiException

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

Throws:

ClientApiException

setOptionMaxCrawlStates

public ApiResponse setOptionMaxCrawlStates(int i)
                                    throws ClientApiException

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

setOptionNumberOfBrowsers

public ApiResponse setOptionNumberOfBrowsers(int i)
                                      throws ClientApiException

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

Throws:

ClientApiException

setOptionRandomInputs

public ApiResponse setOptionRandomInputs(boolean bool)
                                  throws ClientApiException

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

Throws:

ClientApiException

setOptionReloadWait

public ApiResponse setOptionReloadWait(int i)
                                throws ClientApiException

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

Throws:

ClientApiException