Package 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	Description
AjaxSpider(ClientApi api)

Method Summary

Modifier and Type	Method	Description
ApiResponse	addAllowedResource(java.lang.String regex, java.lang.String enabled)	Adds an allowed resource.
ApiResponse	addExcludedElement(java.lang.String contextname, java.lang.String description, java.lang.String element, java.lang.String xpath, java.lang.String text, java.lang.String attributename, java.lang.String attributevalue, java.lang.String enabled)	Adds an excluded element to a context.
ApiResponse	allowedResources()	Gets the allowed resources.
ApiResponse	excludedElements(java.lang.String contextname)	Gets the excluded elements.
ApiResponse	fullResults()	Gets the full crawled content detected by the AJAX Spider.
ApiResponse	modifyExcludedElement(java.lang.String contextname, java.lang.String description, java.lang.String element, java.lang.String descriptionnew, java.lang.String xpath, java.lang.String text, java.lang.String attributename, java.lang.String attributevalue, java.lang.String enabled)	Modifies an excluded element of a context.
ApiResponse	numberOfResults()	Gets the number of resources found.
ApiResponse	optionBrowserId()	Gets the configured browser to use for crawling.
ApiResponse	optionClickDefaultElems()	Gets the configured value for 'Click Default Elements Only', HTML elements such as 'a', 'button', 'input', all associated with some action or links on the page.
ApiResponse	optionClickElemsOnce()	Gets the value configured for the AJAX Spider to know if it should click on the elements only once.
ApiResponse	optionEventWait()	Gets the time to wait after an event (in milliseconds).
ApiResponse	optionMaxCrawlDepth()	Gets the configured value for the max crawl depth.
ApiResponse	optionMaxCrawlStates()	Gets the configured value for the maximum crawl states allowed.
ApiResponse	optionMaxDuration()	Gets the configured max duration of the crawl, the value is in minutes.
ApiResponse	optionNumberOfBrowsers()	Gets the configured number of browsers to be used.
ApiResponse	optionRandomInputs()	Gets if the AJAX Spider will use random values in form fields when crawling, if set to true.
ApiResponse	optionReloadWait()	Gets the configured time to wait after reloading the page, this value is in milliseconds.
ApiResponse	removeAllowedResource(java.lang.String regex)	Removes an allowed resource.
ApiResponse	removeExcludedElement(java.lang.String contextname, java.lang.String description)	Removes an excluded element from a context.
ApiResponse	results(java.lang.String start, java.lang.String count)	Gets the current results of the crawler.
ApiResponse	scan(java.lang.String url, java.lang.String inscope, java.lang.String contextname, java.lang.String subtreeonly)	Runs the AJAX Spider against a given target.
ApiResponse	scanAsUser(java.lang.String contextname, java.lang.String username, java.lang.String url, java.lang.String subtreeonly)	Runs the AJAX Spider from the perspective of a User of the web application.
ApiResponse	setEnabledAllowedResource(java.lang.String regex, java.lang.String enabled)	Sets whether or not an allowed resource is enabled.
ApiResponse	setOptionBrowserId(java.lang.String string)	Sets the configuration of the AJAX Spider to use one of the supported browsers.
ApiResponse	setOptionClickDefaultElems(boolean bool)	Sets whether or not the the AJAX Spider will only click on the default HTML elements.
ApiResponse	setOptionClickElemsOnce(boolean bool)	When enabled, the crawler attempts to interact with each element (e.g., by clicking) only once.
ApiResponse	setOptionEventWait(int i)	Sets the time to wait after an event (in milliseconds).
ApiResponse	setOptionMaxCrawlDepth(int i)	Sets the maximum depth that the crawler can reach.
ApiResponse	setOptionMaxCrawlStates(int i)	Sets the maximum number of states that the crawler should crawl.
ApiResponse	setOptionMaxDuration(int i)	The maximum time that the crawler is allowed to run.
ApiResponse	setOptionNumberOfBrowsers(int i)	Sets the number of windows to be used by AJAX Spider.
ApiResponse	setOptionRandomInputs(boolean bool)	When enabled, inserts random values into form fields.
ApiResponse	setOptionReloadWait(int i)	Sets the time to wait after the page is loaded before interacting with it.
ApiResponse	status()	Gets the current status of the crawler.
ApiResponse	stop()	Stops the AJAX Spider.

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

allowedResources

public ApiResponse allowedResources()
                             throws ClientApiException

Gets the allowed resources. The allowed resources are always fetched even if out of scope, allowing to include necessary resources (e.g. scripts) from 3rd-parties.

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

Throws:

ClientApiException

excludedElements

public ApiResponse excludedElements(java.lang.String contextname)
                             throws ClientApiException

Gets the excluded elements. The excluded elements are not clicked during crawling, for example, to prevent logging out.

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

Throws:

ClientApiException

status

public ApiResponse status()
                   throws ClientApiException

Gets the current status of the crawler. Actual values are Stopped and Running.

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

Gets the current results of the crawler.

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

Throws:

ClientApiException

numberOfResults

public ApiResponse numberOfResults()
                            throws ClientApiException

Gets the number of resources found.

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

Throws:

ClientApiException

fullResults

public ApiResponse fullResults()
                        throws ClientApiException

Gets the full crawled content detected by the AJAX Spider. Returns a set of values based on 'inScope' URLs, 'outOfScope' URLs, and 'errors' encountered during the last/current run of the AJAX Spider.

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

Throws:

ClientApiException

optionBrowserId

public ApiResponse optionBrowserId()
                            throws ClientApiException

Gets the configured browser to use for crawling.

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

Throws:

ClientApiException

optionEventWait

public ApiResponse optionEventWait()
                            throws ClientApiException

Gets the time to wait after an event (in milliseconds). For example: the wait delay after the cursor hovers over an element, in order for a menu to display, etc.

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

Throws:

ClientApiException

optionMaxCrawlDepth

public ApiResponse optionMaxCrawlDepth()
                                throws ClientApiException

Gets the configured value for the max crawl depth.

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

Throws:

ClientApiException

optionMaxCrawlStates

public ApiResponse optionMaxCrawlStates()
                                 throws ClientApiException

Gets the configured value for the maximum crawl states allowed.

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

Throws:

ClientApiException

optionMaxDuration

public ApiResponse optionMaxDuration()
                              throws ClientApiException

Gets the configured max duration of the crawl, the value is in minutes.

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

Throws:

ClientApiException

optionNumberOfBrowsers

public ApiResponse optionNumberOfBrowsers()
                                   throws ClientApiException

Gets the configured number of browsers to be used.

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

Throws:

ClientApiException

optionReloadWait

public ApiResponse optionReloadWait()
                             throws ClientApiException

Gets the configured time to wait after reloading the page, this value is in milliseconds.

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

Throws:

ClientApiException

optionClickDefaultElems

public ApiResponse optionClickDefaultElems()
                                    throws ClientApiException

Gets the configured value for 'Click Default Elements Only', HTML elements such as 'a', 'button', 'input', all associated with some action or links on the page.

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

Throws:

ClientApiException

optionClickElemsOnce

public ApiResponse optionClickElemsOnce()
                                 throws ClientApiException

Gets the value configured for the AJAX Spider to know if it should click on the elements only once.

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

Throws:

ClientApiException

optionRandomInputs

public ApiResponse optionRandomInputs()
                               throws ClientApiException

Gets if the AJAX Spider will use random values in form fields when crawling, if set to true.

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 AJAX Spider against a given target.

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 AJAX Spider from the perspective of a User of the web application.

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

Throws:

ClientApiException

stop

public ApiResponse stop()
                 throws ClientApiException

Stops the AJAX Spider.

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

Throws:

ClientApiException

addAllowedResource

public ApiResponse addAllowedResource(java.lang.String regex,
                                      java.lang.String enabled)
                               throws ClientApiException

Adds an allowed resource.

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

Throws:

ClientApiException

addExcludedElement

public ApiResponse addExcludedElement(java.lang.String contextname,
                                      java.lang.String description,
                                      java.lang.String element,
                                      java.lang.String xpath,
                                      java.lang.String text,
                                      java.lang.String attributename,
                                      java.lang.String attributevalue,
                                      java.lang.String enabled)
                               throws ClientApiException

Adds an excluded element to a context.

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

Throws:

ClientApiException

modifyExcludedElement

public ApiResponse modifyExcludedElement(java.lang.String contextname,
                                         java.lang.String description,
                                         java.lang.String element,
                                         java.lang.String descriptionnew,
                                         java.lang.String xpath,
                                         java.lang.String text,
                                         java.lang.String attributename,
                                         java.lang.String attributevalue,
                                         java.lang.String enabled)
                                  throws ClientApiException

Modifies an excluded element of a context.

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

Throws:

ClientApiException

removeExcludedElement

public ApiResponse removeExcludedElement(java.lang.String contextname,
                                         java.lang.String description)
                                  throws ClientApiException

Removes an excluded element from a context.

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

Throws:

ClientApiException

removeAllowedResource

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

Removes an allowed resource.

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

Throws:

ClientApiException

setEnabledAllowedResource

public ApiResponse setEnabledAllowedResource(java.lang.String regex,
                                             java.lang.String enabled)
                                      throws ClientApiException

Sets whether or not an allowed resource is enabled.

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

Sets the configuration of the AJAX Spider to use one of the supported browsers.

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

Sets whether or not the the AJAX Spider will only click on the default HTML elements.

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

When enabled, the crawler attempts to interact with each element (e.g., by clicking) only once.

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

Sets the time to wait after an event (in milliseconds). For example: the wait delay after the cursor hovers over an element, in order for a menu to display, etc.

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

Sets the maximum depth that the crawler can reach.

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

Sets the maximum number of states that the crawler should crawl.

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

The maximum time that the crawler is allowed to run.

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

Sets the number of windows to be used by AJAX Spider.

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

When enabled, inserts random values into form fields.

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

Sets the time to wait after the page is loaded before interacting with it.

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

Throws:

ClientApiException