Package org.zaproxy.clientapi.gen

Class ClientSpider

java.lang.Object

org.zaproxy.clientapi.gen.ClientSpider

public class ClientSpider
extends Object

This file was automatically generated.

Constructor Summary

Constructors

Constructor	Description
ClientSpider(ClientApi api)

Method Summary

Modifier and Type	Method	Description
ApiResponse	scan(String browser, String url, String contextname, String username, String subtreeonly, String maxcrawldepth, String pageloadtime, String numberofbrowsers, String scopecheck)	Starts a client spider scan.
ApiResponse	status(String scanid)	Gets the status of a client spider scan.
ApiResponse	stop(String scanid)	Stops a client spider scan.

Methods inherited from class java.lang.Object

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

Constructor Details

ClientSpider

public ClientSpider(ClientApi api)

Method Details

status

public ApiResponse status(String scanid)
                   throws ClientApiException

Gets the status of a client spider scan.

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

Throws:

ClientApiException

scan

public ApiResponse scan(String browser,
 String url,
 String contextname,
 String username,
 String subtreeonly,
 String maxcrawldepth,
 String pageloadtime,
 String numberofbrowsers,
 String scopecheck)
                 throws ClientApiException

Starts a client spider scan.

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

Stops a client spider scan.

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

Throws:

ClientApiException