org.zaproxy.clientapi.core

Class ClientApi

java.lang.Object

org.zaproxy.clientapi.core.ClientApi

public class ClientApi
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
Acsrf	acsrf
AjaxSpider	ajaxSpider
Ascan	ascan
Authentication	authentication
Authorization	authorization
Autoupdate	autoupdate
Break	brk
Context	context
Core	core
ForcedUser	forcedUser
HttpSessions	httpSessions
ImportLogFiles	logImportFiles
Params	params
Pnh	pnh
Pscan	pscan
Reveal	reveal
Script	script
Search	search
Selenium	selenium
SessionManagement	sessionManagement
Spider	spider
Stats	stats
Users	users

Constructor Summary

Constructors

Constructor and Description
ClientApi(java.lang.String zapAddress, int zapPort)
ClientApi(java.lang.String zapAddress, int zapPort, boolean debug)

Method Summary

Modifier and Type	Method and Description
void	accessUrl(java.lang.String url)
void	activeScanSiteInScope(java.lang.String apikey, java.lang.String url)
void	addExcludeFromContext(java.lang.String apikey, java.lang.String contextName, java.lang.String regex)
void	addIncludeInContext(java.lang.String apikey, java.lang.String contextName, java.lang.String regex)
ApiResponse	callApi(java.lang.String component, java.lang.String type, java.lang.String method, java.util.Map<java.lang.String,java.lang.String> params)
byte[]	callApiOther(java.lang.String component, java.lang.String type, java.lang.String method, java.util.Map<java.lang.String,java.lang.String> params)
void	checkAlerts(java.util.List<Alert> ignoreAlerts, java.util.List<Alert> requireAlerts)
void	checkAlerts(java.util.List<Alert> ignoreAlerts, java.util.List<Alert> requireAlerts, java.io.File outputFile)
java.util.List<Alert>	getAlerts(java.lang.String baseUrl, int start, int count)
void	includeOneMatchingNodeInContext(java.lang.String apikey, java.lang.String contextName, java.lang.String regex)
void	setDebugStream(java.io.PrintStream debugStream)
void	waitForSuccessfulConnectionToZap(int timeoutInSeconds) Convenience method to wait for ZAP to be ready to receive API calls, when started programmatically.
void	waitForSuccessfulConnectionToZap(int timeoutInSeconds, int pollingIntervalInMs) Convenience method to wait for ZAP to be ready to receive API calls, when started programmatically.

Methods inherited from class java.lang.Object

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

Field Detail

acsrf

public Acsrf acsrf

ajaxSpider

public AjaxSpider ajaxSpider

ascan

public Ascan ascan

authentication

public Authentication authentication

authorization

public Authorization authorization

autoupdate

public Autoupdate autoupdate

brk

public Break brk

context

public Context context

core

public Core core

forcedUser

public ForcedUser forcedUser

httpSessions

public HttpSessions httpSessions

logImportFiles

public ImportLogFiles logImportFiles

params

public Params params

pnh

public Pnh pnh

pscan

public Pscan pscan

reveal

public Reveal reveal

search

public Search search

script

public Script script

selenium

public Selenium selenium

sessionManagement

public SessionManagement sessionManagement

spider

public Spider spider

stats

public Stats stats

users

public Users users

Constructor Detail

ClientApi

public ClientApi(java.lang.String zapAddress,
                 int zapPort)

ClientApi

public ClientApi(java.lang.String zapAddress,
                 int zapPort,
                 boolean debug)

Method Detail

setDebugStream

public void setDebugStream(java.io.PrintStream debugStream)

accessUrl

public void accessUrl(java.lang.String url)
               throws ClientApiException

Throws:

ClientApiException

checkAlerts

public void checkAlerts(java.util.List<Alert> ignoreAlerts,
                        java.util.List<Alert> requireAlerts)
                 throws ClientApiException

Throws:

ClientApiException

checkAlerts

public void checkAlerts(java.util.List<Alert> ignoreAlerts,
                        java.util.List<Alert> requireAlerts,
                        java.io.File outputFile)
                 throws ClientApiException

Throws:

ClientApiException

getAlerts

public java.util.List<Alert> getAlerts(java.lang.String baseUrl,
                                       int start,
                                       int count)
                                throws ClientApiException

Throws:

ClientApiException

callApi

public ApiResponse callApi(java.lang.String component,
                           java.lang.String type,
                           java.lang.String method,
                           java.util.Map<java.lang.String,java.lang.String> params)
                    throws ClientApiException

Throws:

ClientApiException

callApiOther

public byte[] callApiOther(java.lang.String component,
                           java.lang.String type,
                           java.lang.String method,
                           java.util.Map<java.lang.String,java.lang.String> params)
                    throws ClientApiException

Throws:

ClientApiException

addExcludeFromContext

public void addExcludeFromContext(java.lang.String apikey,
                                  java.lang.String contextName,
                                  java.lang.String regex)
                           throws java.lang.Exception

Throws:

java.lang.Exception

addIncludeInContext

public void addIncludeInContext(java.lang.String apikey,
                                java.lang.String contextName,
                                java.lang.String regex)
                         throws java.lang.Exception

Throws:

java.lang.Exception

includeOneMatchingNodeInContext

public void includeOneMatchingNodeInContext(java.lang.String apikey,
                                            java.lang.String contextName,
                                            java.lang.String regex)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

activeScanSiteInScope

public void activeScanSiteInScope(java.lang.String apikey,
                                  java.lang.String url)
                           throws java.lang.Exception

Throws:

java.lang.Exception

waitForSuccessfulConnectionToZap

public void waitForSuccessfulConnectionToZap(int timeoutInSeconds)
                                      throws ClientApiException

Convenience method to wait for ZAP to be ready to receive API calls, when started programmatically.

It attempts to establish a connection to ZAP's proxy, in the given time, throwing an exception if the connection is not successful. The connection attempts might be polled in one second interval.

Parameters:

timeoutInSeconds - the (maximum) number of seconds to wait for ZAP to start

Throws:

ClientApiException - if the timeout was reached or if the thread was interrupted while waiting

See Also:

waitForSuccessfulConnectionToZap(int, int)

waitForSuccessfulConnectionToZap

public void waitForSuccessfulConnectionToZap(int timeoutInSeconds,
                                             int pollingIntervalInMs)
                                      throws ClientApiException

Convenience method to wait for ZAP to be ready to receive API calls, when started programmatically.

It attempts to establish a connection to ZAP's proxy, in the given time, throwing an exception if the connection is not successful. The connection attempts are done with the given polling interval.

Parameters:

timeoutInSeconds - the (maximum) number of seconds to wait for ZAP to start

pollingIntervalInMs - the interval, in milliseconds, for connection polling

Throws:

ClientApiException - if the timeout was reached or if the thread was interrupted while waiting.

java.lang.IllegalArgumentException - if the interval for connection polling is negative.

See Also:

waitForSuccessfulConnectionToZap(int)