org.zaproxy.clientapi.gen

Class Core

java.lang.Object

org.zaproxy.clientapi.gen.deprecated.CoreDeprecated

org.zaproxy.clientapi.gen.Core

public class Core
extends CoreDeprecated

This file was automatically generated.

Constructor Summary

Constructors

Constructor and Description
Core(ClientApi api)

Method Summary

Modifier and Type	Method and Description
ApiResponse	accessUrl(java.lang.String url, java.lang.String followredirects) Convenient and simple action to access a URL, optionally following redirections.
ApiResponse	addProxyChainExcludedDomain(java.lang.String value, java.lang.String isregex, java.lang.String isenabled) Adds a domain to be excluded from the outgoing proxy, using the specified value.
ApiResponse	alert(java.lang.String id) Gets the alert with the given ID, the corresponding HTTP message can be obtained with the 'messageId' field and 'message' API method
ApiResponse	alerts(java.lang.String baseurl, java.lang.String start, java.lang.String count) Gets the alerts raised by ZAP, optionally filtering by URL and paginating with 'start' position and 'count' of alerts
ApiResponse	clearExcludedFromProxy() Clears the regexes of URLs excluded from the proxy.
ApiResponse	deleteAllAlerts() Deletes all alerts of the current session.
ApiResponse	deleteSiteNode(java.lang.String url, java.lang.String method, java.lang.String postdata) Deletes the site node found in the Sites Tree on the basis of the URL, HTTP method, and post data (if applicable and specified).
ApiResponse	disableAllProxyChainExcludedDomains() Disables all domains excluded from the outgoing proxy.
ApiResponse	enableAllProxyChainExcludedDomains() Enables all domains excluded from the outgoing proxy.
ApiResponse	excludedFromProxy() Gets the regular expressions, applied to URLs, to exclude from the Proxy
ApiResponse	excludeFromProxy(java.lang.String regex) Adds a regex of URLs that should be excluded from the proxy.
ApiResponse	generateRootCA() Generates a new Root CA certificate for the Local Proxy.
ApiResponse	homeDirectory()
ApiResponse	hosts() Gets the name of the hosts accessed through/by ZAP
byte[]	htmlreport() Generates a report in HTML format
ApiResponse	loadSession(java.lang.String name) Loads the session with the given name.
byte[]	mdreport() Generates a report in Markdown format
ApiResponse	message(java.lang.String id) Gets the HTTP message with the given ID.
byte[]	messageHar(java.lang.String id) Gets the message with the given ID in HAR format
ApiResponse	messages(java.lang.String baseurl, java.lang.String start, java.lang.String count) Gets the HTTP messages sent by ZAP, request and response, optionally filtered by URL and paginated with 'start' position and 'count' of messages
byte[]	messagesHar(java.lang.String baseurl, java.lang.String start, java.lang.String count) Gets the HTTP messages sent through/by ZAP, in HAR format, optionally filtered by URL and paginated with 'start' position and 'count' of messages
ApiResponse	mode() Gets the mode
ApiResponse	modifyProxyChainExcludedDomain(java.lang.String idx, java.lang.String value, java.lang.String isregex, java.lang.String isenabled) Modifies a domain excluded from the outgoing proxy.
ApiResponse	newSession(java.lang.String name, java.lang.String overwrite) Creates a new session, optionally overwriting existing files.
ApiResponse	numberOfAlerts(java.lang.String baseurl) Gets the number of alerts, optionally filtering by URL
ApiResponse	numberOfMessages(java.lang.String baseurl) Gets the number of messages, optionally filtering by URL
ApiResponse	optionDefaultUserAgent()
ApiResponse	optionDnsTtlSuccessfulQueries() Gets the TTL (in seconds) of successful DNS queries.
ApiResponse	optionHttpState()
ApiResponse	optionHttpStateEnabled()
ApiResponse	optionProxyChainName()
ApiResponse	optionProxyChainPassword()
ApiResponse	optionProxyChainPort()
ApiResponse	optionProxyChainPrompt()
ApiResponse	optionProxyChainRealm()
ApiResponse	optionProxyChainSkipName() Deprecated.
ApiResponse	optionProxyChainUserName()
ApiResponse	optionProxyExcludedDomains() Deprecated.
ApiResponse	optionProxyExcludedDomainsEnabled() Deprecated.
ApiResponse	optionSingleCookieRequestHeader()
ApiResponse	optionTimeoutInSecs()
ApiResponse	optionUseProxyChain()
ApiResponse	optionUseProxyChainAuth()
ApiResponse	proxyChainExcludedDomains() Gets all the domains that are excluded from the outgoing proxy.
byte[]	proxypac()
ApiResponse	removeProxyChainExcludedDomain(java.lang.String idx) Removes a domain excluded from the outgoing proxy, with the given index.
byte[]	rootcert() Gets the Root CA certificate of the Local Proxy.
ApiResponse	runGarbageCollection()
ApiResponse	saveSession(java.lang.String name, java.lang.String overwrite) Saves the session with the name supplied, optionally overwriting existing files.
byte[]	sendHarRequest(java.lang.String request, java.lang.String followredirects) Sends the first HAR request entry, optionally following redirections.
ApiResponse	sendRequest(java.lang.String request, java.lang.String followredirects) Sends the HTTP request, optionally following redirections.
ApiResponse	sessionLocation() Gets the location of the current session file
ApiResponse	setHomeDirectory(java.lang.String dir)
ApiResponse	setMode(java.lang.String mode) Sets the mode, which may be one of [safe, protect, standard, attack]
ApiResponse	setOptionDefaultUserAgent(java.lang.String string)
ApiResponse	setOptionDnsTtlSuccessfulQueries(int i) Sets the TTL (in seconds) of successful DNS queries (applies after ZAP restart).
ApiResponse	setOptionHttpStateEnabled(boolean bool)
ApiResponse	setOptionProxyChainName(java.lang.String string)
ApiResponse	setOptionProxyChainPassword(java.lang.String string)
ApiResponse	setOptionProxyChainPort(int i)
ApiResponse	setOptionProxyChainPrompt(boolean bool)
ApiResponse	setOptionProxyChainRealm(java.lang.String string)
ApiResponse	setOptionProxyChainSkipName(java.lang.String string) Deprecated.
ApiResponse	setOptionProxyChainUserName(java.lang.String string)
ApiResponse	setOptionSingleCookieRequestHeader(boolean bool)
ApiResponse	setOptionTimeoutInSecs(int i)
ApiResponse	setOptionUseProxyChain(boolean bool)
ApiResponse	setOptionUseProxyChainAuth(boolean bool)
byte[]	setproxy(java.lang.String proxy)
ApiResponse	shutdown() Shuts down ZAP
ApiResponse	sites() Gets the sites accessed through/by ZAP (scheme and domain)
ApiResponse	snapshotSession()
ApiResponse	urls() Gets the URLs accessed through/by ZAP
ApiResponse	version() Gets ZAP version
byte[]	xmlreport() Generates a report in XML format

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

accessUrl, clearExcludedFromProxy, deleteAllAlerts, deleteSiteNode, excludeFromProxy, generateRootCA, htmlreport, loadSession, messageHar, messagesHar, newSession, proxypac, rootcert, runGarbageCollection, saveSession, sendHarRequest, sendRequest, setHomeDirectory, setMode, setOptionDefaultUserAgent, setOptionHttpStateEnabled, setOptionProxyChainName, setOptionProxyChainPassword, setOptionProxyChainPort, setOptionProxyChainPrompt, setOptionProxyChainRealm, setOptionProxyChainSkipName, setOptionProxyChainUserName, setOptionSingleCookieRequestHeader, setOptionTimeoutInSecs, setOptionUseProxyChain, setOptionUseProxyChainAuth, setproxy, shutdown, snapshotSession, xmlreport

Methods inherited from class java.lang.Object

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

Constructor Detail

Core

public Core(ClientApi api)

Method Detail

alert

public ApiResponse alert(java.lang.String id)
                  throws ClientApiException

Gets the alert with the given ID, the corresponding HTTP message can be obtained with the 'messageId' field and 'message' API method

Throws:

ClientApiException

alerts

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

Gets the alerts raised by ZAP, optionally filtering by URL and paginating with 'start' position and 'count' of alerts

Throws:

ClientApiException

numberOfAlerts

public ApiResponse numberOfAlerts(java.lang.String baseurl)
                           throws ClientApiException

Gets the number of alerts, optionally filtering by URL

Throws:

ClientApiException

hosts

public ApiResponse hosts()
                  throws ClientApiException

Gets the name of the hosts accessed through/by ZAP

Throws:

ClientApiException

sites

public ApiResponse sites()
                  throws ClientApiException

Gets the sites accessed through/by ZAP (scheme and domain)

Throws:

ClientApiException

urls

public ApiResponse urls()
                 throws ClientApiException

Gets the URLs accessed through/by ZAP

Throws:

ClientApiException

message

public ApiResponse message(java.lang.String id)
                    throws ClientApiException

Gets the HTTP message with the given ID. Returns the ID, request/response headers and bodies, cookies and note.

Throws:

ClientApiException

messages

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

Gets the HTTP messages sent by ZAP, request and response, optionally filtered by URL and paginated with 'start' position and 'count' of messages

Throws:

ClientApiException

numberOfMessages

public ApiResponse numberOfMessages(java.lang.String baseurl)
                             throws ClientApiException

Gets the number of messages, optionally filtering by URL

Throws:

ClientApiException

mode

public ApiResponse mode()
                 throws ClientApiException

Gets the mode

Throws:

ClientApiException

version

public ApiResponse version()
                    throws ClientApiException

Gets ZAP version

Throws:

ClientApiException

excludedFromProxy

public ApiResponse excludedFromProxy()
                              throws ClientApiException

Gets the regular expressions, applied to URLs, to exclude from the Proxy

Throws:

ClientApiException

homeDirectory

public ApiResponse homeDirectory()
                          throws ClientApiException

Throws:

ClientApiException

sessionLocation

public ApiResponse sessionLocation()
                            throws ClientApiException

Gets the location of the current session file

Throws:

ClientApiException

proxyChainExcludedDomains

public ApiResponse proxyChainExcludedDomains()
                                      throws ClientApiException

Gets all the domains that are excluded from the outgoing proxy. For each domain the following are shown: the index, the value (domain), if enabled, and if specified as a regex.

Throws:

ClientApiException

optionProxyChainSkipName

@Deprecated
public ApiResponse optionProxyChainSkipName()
                                                 throws ClientApiException

Deprecated.

Use view proxyChainExcludedDomains instead.

Throws:

ClientApiException

optionProxyExcludedDomains

@Deprecated
public ApiResponse optionProxyExcludedDomains()
                                                   throws ClientApiException

Deprecated.

Use view proxyChainExcludedDomains instead.

Throws:

ClientApiException

optionProxyExcludedDomainsEnabled

@Deprecated
public ApiResponse optionProxyExcludedDomainsEnabled()
                                                          throws ClientApiException

Deprecated.

Use view proxyChainExcludedDomains instead.

Throws:

ClientApiException

optionDefaultUserAgent

public ApiResponse optionDefaultUserAgent()
                                   throws ClientApiException

Throws:

ClientApiException

optionDnsTtlSuccessfulQueries

public ApiResponse optionDnsTtlSuccessfulQueries()
                                          throws ClientApiException

Gets the TTL (in seconds) of successful DNS queries.

Throws:

ClientApiException

optionHttpState

public ApiResponse optionHttpState()
                            throws ClientApiException

Throws:

ClientApiException

optionProxyChainName

public ApiResponse optionProxyChainName()
                                 throws ClientApiException

Throws:

ClientApiException

optionProxyChainPassword

public ApiResponse optionProxyChainPassword()
                                     throws ClientApiException

Throws:

ClientApiException

optionProxyChainPort

public ApiResponse optionProxyChainPort()
                                 throws ClientApiException

Throws:

ClientApiException

optionProxyChainRealm

public ApiResponse optionProxyChainRealm()
                                  throws ClientApiException

Throws:

ClientApiException

optionProxyChainUserName

public ApiResponse optionProxyChainUserName()
                                     throws ClientApiException

Throws:

ClientApiException

optionTimeoutInSecs

public ApiResponse optionTimeoutInSecs()
                                throws ClientApiException

Throws:

ClientApiException

optionHttpStateEnabled

public ApiResponse optionHttpStateEnabled()
                                   throws ClientApiException

Throws:

ClientApiException

optionProxyChainPrompt

public ApiResponse optionProxyChainPrompt()
                                   throws ClientApiException

Throws:

ClientApiException

optionSingleCookieRequestHeader

public ApiResponse optionSingleCookieRequestHeader()
                                            throws ClientApiException

Throws:

ClientApiException

optionUseProxyChain

public ApiResponse optionUseProxyChain()
                                throws ClientApiException

Throws:

ClientApiException

optionUseProxyChainAuth

public ApiResponse optionUseProxyChainAuth()
                                    throws ClientApiException

Throws:

ClientApiException

accessUrl

public ApiResponse accessUrl(java.lang.String url,
                             java.lang.String followredirects)
                      throws ClientApiException

Convenient and simple action to access a URL, optionally following redirections. Returns the request sent and response received and followed redirections, if any. Other actions are available which offer more control on what is sent, like, 'sendRequest' or 'sendHarRequest'.

Throws:

ClientApiException

shutdown

public ApiResponse shutdown()
                     throws ClientApiException

Shuts down ZAP

Throws:

ClientApiException

newSession

public ApiResponse newSession(java.lang.String name,
                              java.lang.String overwrite)
                       throws ClientApiException

Creates a new session, optionally overwriting existing files. If a relative path is specified it will be resolved against the "session" directory in ZAP "home" dir.

Throws:

ClientApiException

loadSession

public ApiResponse loadSession(java.lang.String name)
                        throws ClientApiException

Loads the session with the given name. If a relative path is specified it will be resolved against the "session" directory in ZAP "home" dir.

Throws:

ClientApiException

saveSession

public ApiResponse saveSession(java.lang.String name,
                               java.lang.String overwrite)
                        throws ClientApiException

Saves the session with the name supplied, optionally overwriting existing files. If a relative path is specified it will be resolved against the "session" directory in ZAP "home" dir.

Throws:

ClientApiException

snapshotSession

public ApiResponse snapshotSession()
                            throws ClientApiException

Throws:

ClientApiException

clearExcludedFromProxy

public ApiResponse clearExcludedFromProxy()
                                   throws ClientApiException

Clears the regexes of URLs excluded from the proxy.

Throws:

ClientApiException

excludeFromProxy

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

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

Throws:

ClientApiException

setHomeDirectory

public ApiResponse setHomeDirectory(java.lang.String dir)
                             throws ClientApiException

Throws:

ClientApiException

setMode

public ApiResponse setMode(java.lang.String mode)
                    throws ClientApiException

Sets the mode, which may be one of [safe, protect, standard, attack]

Throws:

ClientApiException

generateRootCA

public ApiResponse generateRootCA()
                           throws ClientApiException

Generates a new Root CA certificate for the Local Proxy.

Throws:

ClientApiException

sendRequest

public ApiResponse sendRequest(java.lang.String request,
                               java.lang.String followredirects)
                        throws ClientApiException

Sends the HTTP request, optionally following redirections. Returns the request sent and response received and followed redirections, if any. The Mode is enforced when sending the request (and following redirections), custom manual requests are not allowed in 'Safe' mode nor in 'Protected' mode if out of scope.

Throws:

ClientApiException

deleteAllAlerts

public ApiResponse deleteAllAlerts()
                            throws ClientApiException

Deletes all alerts of the current session.

Throws:

ClientApiException

runGarbageCollection

public ApiResponse runGarbageCollection()
                                 throws ClientApiException

Throws:

ClientApiException

deleteSiteNode

public ApiResponse deleteSiteNode(java.lang.String url,
                                  java.lang.String method,
                                  java.lang.String postdata)
                           throws ClientApiException

Deletes the site node found in the Sites Tree on the basis of the URL, HTTP method, and post data (if applicable and specified).

Throws:

ClientApiException

addProxyChainExcludedDomain

public ApiResponse addProxyChainExcludedDomain(java.lang.String value,
                                               java.lang.String isregex,
                                               java.lang.String isenabled)
                                        throws ClientApiException

Adds a domain to be excluded from the outgoing proxy, 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

modifyProxyChainExcludedDomain

public ApiResponse modifyProxyChainExcludedDomain(java.lang.String idx,
                                                  java.lang.String value,
                                                  java.lang.String isregex,
                                                  java.lang.String isenabled)
                                           throws ClientApiException

Modifies a domain excluded from the outgoing proxy. 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 proxyChainExcludedDomains.

Throws:

ClientApiException

removeProxyChainExcludedDomain

public ApiResponse removeProxyChainExcludedDomain(java.lang.String idx)
                                           throws ClientApiException

Removes a domain excluded from the outgoing proxy, with the given index. The index can be obtained with the view proxyChainExcludedDomains.

Throws:

ClientApiException

enableAllProxyChainExcludedDomains

public ApiResponse enableAllProxyChainExcludedDomains()
                                               throws ClientApiException

Enables all domains excluded from the outgoing proxy.

Throws:

ClientApiException

disableAllProxyChainExcludedDomains

public ApiResponse disableAllProxyChainExcludedDomains()
                                                throws ClientApiException

Disables all domains excluded from the outgoing proxy.

Throws:

ClientApiException

setOptionDefaultUserAgent

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

Throws:

ClientApiException

setOptionProxyChainName

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

Throws:

ClientApiException

setOptionProxyChainPassword

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

Throws:

ClientApiException

setOptionProxyChainRealm

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

Throws:

ClientApiException

setOptionProxyChainSkipName

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

Deprecated.

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

Throws:

ClientApiException

setOptionProxyChainUserName

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

Throws:

ClientApiException

setOptionDnsTtlSuccessfulQueries

public ApiResponse setOptionDnsTtlSuccessfulQueries(int i)
                                             throws ClientApiException

Sets the TTL (in seconds) of successful DNS queries (applies after ZAP restart).

Throws:

ClientApiException

setOptionHttpStateEnabled

public ApiResponse setOptionHttpStateEnabled(boolean bool)
                                      throws ClientApiException

Throws:

ClientApiException

setOptionProxyChainPort

public ApiResponse setOptionProxyChainPort(int i)
                                    throws ClientApiException

Throws:

ClientApiException

setOptionProxyChainPrompt

public ApiResponse setOptionProxyChainPrompt(boolean bool)
                                      throws ClientApiException

Throws:

ClientApiException

setOptionSingleCookieRequestHeader

public ApiResponse setOptionSingleCookieRequestHeader(boolean bool)
                                               throws ClientApiException

Throws:

ClientApiException

setOptionTimeoutInSecs

public ApiResponse setOptionTimeoutInSecs(int i)
                                   throws ClientApiException

Throws:

ClientApiException

setOptionUseProxyChain

public ApiResponse setOptionUseProxyChain(boolean bool)
                                   throws ClientApiException

Throws:

ClientApiException

setOptionUseProxyChainAuth

public ApiResponse setOptionUseProxyChainAuth(boolean bool)
                                       throws ClientApiException

Throws:

ClientApiException

proxypac

public byte[] proxypac()
                throws ClientApiException

Throws:

ClientApiException

rootcert

public byte[] rootcert()
                throws ClientApiException

Gets the Root CA certificate of the Local Proxy.

Throws:

ClientApiException

setproxy

public byte[] setproxy(java.lang.String proxy)
                throws ClientApiException

Throws:

ClientApiException

xmlreport

public byte[] xmlreport()
                 throws ClientApiException

Generates a report in XML format

Throws:

ClientApiException

htmlreport

public byte[] htmlreport()
                  throws ClientApiException

Generates a report in HTML format

Throws:

ClientApiException

mdreport

public byte[] mdreport()
                throws ClientApiException

Generates a report in Markdown format

Throws:

ClientApiException

messageHar

public byte[] messageHar(java.lang.String id)
                  throws ClientApiException

Gets the message with the given ID in HAR format

Throws:

ClientApiException

messagesHar

public byte[] messagesHar(java.lang.String baseurl,
                          java.lang.String start,
                          java.lang.String count)
                   throws ClientApiException

Gets the HTTP messages sent through/by ZAP, in HAR format, optionally filtered by URL and paginated with 'start' position and 'count' of messages

Throws:

ClientApiException

sendHarRequest

public byte[] sendHarRequest(java.lang.String request,
                             java.lang.String followredirects)
                      throws ClientApiException

Sends the first HAR request entry, optionally following redirections. Returns, in HAR format, the request sent and response received and followed redirections, if any. The Mode is enforced when sending the request (and following redirections), custom manual requests are not allowed in 'Safe' mode nor in 'Protected' mode if out of scope.

Throws:

ClientApiException