Package org.zaproxy.clientapi.gen

Class Network

java.lang.Object

org.zaproxy.clientapi.gen.Network

public class Network
extends Object

This file was automatically generated.

Constructor Summary

Constructors

Constructor	Description
Network(ClientApi api)

Method Summary

Modifier and Type	Method	Description
ApiResponse	addAlias(String name, String enabled)	Adds an alias for the local servers/proxies.
ApiResponse	addHttpProxyExclusion(String host, String enabled)	Adds a host to be excluded from the HTTP proxy.
ApiResponse	addLocalServer(String address, String port, String api, String proxy, String behindnat, String decoderesponse, String removeacceptencoding)	Adds a local server/proxy.
ApiResponse	addPassThrough(String authority, String enabled)	Adds an authority to pass-through the local proxies.
ApiResponse	addPkcs12ClientCertificate(String filepath, String password, String index)	Adds a client certificate contained in a PKCS#12 file, the certificate is automatically set as active and used.
ApiResponse	addRateLimitRule(String description, String enabled, String matchregex, String matchstring, String requestspersecond, String groupby)	Adds a rate limit rule
ApiResponse	generateRootCaCert()	Generates a new Root CA certificate, used to issue server certificates.
ApiResponse	getAliases()	Gets the aliases used to identify the local servers/proxies.
ApiResponse	getConnectionTimeout()	Gets the connection timeout, in seconds.
ApiResponse	getDefaultUserAgent()	Gets the default user-agent.
ApiResponse	getDnsTtlSuccessfulQueries()	Gets the TTL (in seconds) of successful DNS queries.
ApiResponse	getHttpProxy()	Gets the HTTP proxy.
ApiResponse	getHttpProxyExclusions()	Gets the HTTP proxy exclusions.
ApiResponse	getLocalServers()	Gets the local servers/proxies.
ApiResponse	getPassThroughs()	Gets the authorities that will pass-through the local proxies.
ApiResponse	getRateLimitRules()	List of rate limit rules.
ApiResponse	getRootCaCertValidity()	Gets the Root CA certificate validity, in days.
ApiResponse	getServerCertValidity()	Gets the server certificate validity, in days.
ApiResponse	getSocksProxy()	Gets the SOCKS proxy.
ApiResponse	importRootCaCert(String filepath)	Imports a Root CA certificate to be used to issue server certificates.
ApiResponse	isHttpProxyAuthEnabled()	Tells whether or not the HTTP proxy authentication is enabled.
ApiResponse	isHttpProxyEnabled()	Tells whether or not the HTTP proxy is enabled.
ApiResponse	isSocksProxyEnabled()	Tells whether or not the SOCKS proxy is enabled.
ApiResponse	isUseGlobalHttpState()	Tells whether or not to use global HTTP state.
byte[]	proxypac()	Provides a PAC file, proxying through the main proxy.
ApiResponse	removeAlias(String name)	Removes an alias.
ApiResponse	removeHttpProxyExclusion(String host)	Removes an HTTP proxy exclusion.
ApiResponse	removeLocalServer(String address, String port)	Removes a local server/proxy.
ApiResponse	removePassThrough(String authority)	Removes a pass-through.
ApiResponse	removeRateLimitRule(String description)	Remove a rate limit rule
byte[]	rootCaCert()	Gets the Root CA certificate used to issue server certificates.
ApiResponse	setAliasEnabled(String name, String enabled)	Sets whether or not an alias is enabled.
ApiResponse	setConnectionTimeout(String timeout)	Sets the timeout, for reads and connects.
ApiResponse	setDefaultUserAgent(String useragent)	Sets the default user-agent.
ApiResponse	setDnsTtlSuccessfulQueries(String ttl)	Sets the TTL of successful DNS queries.
ApiResponse	setHttpProxy(String host, String port, String realm, String username, String password)	Sets the HTTP proxy configuration.
ApiResponse	setHttpProxyAuthEnabled(String enabled)	Sets whether or not the HTTP proxy authentication is enabled.
ApiResponse	setHttpProxyEnabled(String enabled)	Sets whether or not the HTTP proxy is enabled.
ApiResponse	setHttpProxyExclusionEnabled(String host, String enabled)	Sets whether or not an HTTP proxy exclusion is enabled.
ApiResponse	setPassThroughEnabled(String authority, String enabled)	Sets whether or not a pass-through is enabled.
byte[]	setProxy(String proxy)	Sets the HTTP proxy configuration.
ApiResponse	setRateLimitRuleEnabled(String description, String enabled)	Set enabled state for a rate limit rule.
ApiResponse	setRootCaCertValidity(String validity)	Sets the Root CA certificate validity.
ApiResponse	setServerCertValidity(String validity)	Sets the server certificate validity.
ApiResponse	setSocksProxy(String host, String port, String version, String usedns, String username, String password)	Sets the SOCKS proxy configuration.
ApiResponse	setSocksProxyEnabled(String enabled)	Sets whether or not the SOCKS proxy is enabled.
ApiResponse	setUseClientCertificate(String use)	Sets whether or not to use the active client certificate.
ApiResponse	setUseGlobalHttpState(String use)	Sets whether or not to use the global HTTP state.

Methods inherited from class java.lang.Object

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

Constructor Details

Network

public Network(ClientApi api)

Method Details

getRootCaCertValidity

public ApiResponse getRootCaCertValidity()
                                  throws ClientApiException

Gets the Root CA certificate validity, in days. Used when generating a new Root CA certificate.

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

Throws:

ClientApiException

getServerCertValidity

public ApiResponse getServerCertValidity()
                                  throws ClientApiException

Gets the server certificate validity, in days. Used when generating server certificates.

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

Throws:

ClientApiException

getAliases

public ApiResponse getAliases()
                       throws ClientApiException

Gets the aliases used to identify the local servers/proxies.

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

Throws:

ClientApiException

getLocalServers

public ApiResponse getLocalServers()
                            throws ClientApiException

Gets the local servers/proxies.

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

Throws:

ClientApiException

getPassThroughs

public ApiResponse getPassThroughs()
                            throws ClientApiException

Gets the authorities that will pass-through the local proxies.

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

Throws:

ClientApiException

getConnectionTimeout

public ApiResponse getConnectionTimeout()
                                 throws ClientApiException

Gets the connection timeout, in seconds.

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

Throws:

ClientApiException

getDefaultUserAgent

public ApiResponse getDefaultUserAgent()
                                throws ClientApiException

Gets the default user-agent.

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

Throws:

ClientApiException

getDnsTtlSuccessfulQueries

public ApiResponse getDnsTtlSuccessfulQueries()
                                       throws ClientApiException

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

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

Throws:

ClientApiException

getHttpProxy

public ApiResponse getHttpProxy()
                         throws ClientApiException

Gets the HTTP proxy.

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

Throws:

ClientApiException

getHttpProxyExclusions

public ApiResponse getHttpProxyExclusions()
                                   throws ClientApiException

Gets the HTTP proxy exclusions.

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

Throws:

ClientApiException

getSocksProxy

public ApiResponse getSocksProxy()
                          throws ClientApiException

Gets the SOCKS proxy.

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

Throws:

ClientApiException

isHttpProxyAuthEnabled

public ApiResponse isHttpProxyAuthEnabled()
                                   throws ClientApiException

Tells whether or not the HTTP proxy authentication is enabled.

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

Throws:

ClientApiException

isHttpProxyEnabled

public ApiResponse isHttpProxyEnabled()
                               throws ClientApiException

Tells whether or not the HTTP proxy is enabled.

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

Throws:

ClientApiException

isSocksProxyEnabled

public ApiResponse isSocksProxyEnabled()
                                throws ClientApiException

Tells whether or not the SOCKS proxy is enabled.

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

Throws:

ClientApiException

isUseGlobalHttpState

public ApiResponse isUseGlobalHttpState()
                                 throws ClientApiException

Tells whether or not to use global HTTP state.

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

Throws:

ClientApiException

getRateLimitRules

public ApiResponse getRateLimitRules()
                              throws ClientApiException

List of rate limit rules.

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

Throws:

ClientApiException

generateRootCaCert

public ApiResponse generateRootCaCert()
                               throws ClientApiException

Generates a new Root CA certificate, used to issue server certificates.

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

Throws:

ClientApiException

importRootCaCert

public ApiResponse importRootCaCert(String filepath)
                             throws ClientApiException

Imports a Root CA certificate to be used to issue server certificates.

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

Throws:

ClientApiException

setRootCaCertValidity

public ApiResponse setRootCaCertValidity(String validity)
                                  throws ClientApiException

Sets the Root CA certificate validity. Used when generating a new Root CA certificate.

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

Throws:

ClientApiException

setServerCertValidity

public ApiResponse setServerCertValidity(String validity)
                                  throws ClientApiException

Sets the server certificate validity. Used when generating server certificates.

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

Throws:

ClientApiException

addAlias

public ApiResponse addAlias(String name,
 String enabled)
                     throws ClientApiException

Adds an alias for the local servers/proxies.

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

Throws:

ClientApiException

addLocalServer

public ApiResponse addLocalServer(String address,
 String port,
 String api,
 String proxy,
 String behindnat,
 String decoderesponse,
 String removeacceptencoding)
                           throws ClientApiException

Adds a local server/proxy.

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

Throws:

ClientApiException

addPassThrough

public ApiResponse addPassThrough(String authority,
 String enabled)
                           throws ClientApiException

Adds an authority to pass-through the local proxies.

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

Throws:

ClientApiException

removeAlias

public ApiResponse removeAlias(String name)
                        throws ClientApiException

Removes an alias.

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

Throws:

ClientApiException

removeLocalServer

public ApiResponse removeLocalServer(String address,
 String port)
                              throws ClientApiException

Removes a local server/proxy.

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

Throws:

ClientApiException

removePassThrough

public ApiResponse removePassThrough(String authority)
                              throws ClientApiException

Removes a pass-through.

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

Throws:

ClientApiException

setAliasEnabled

public ApiResponse setAliasEnabled(String name,
 String enabled)
                            throws ClientApiException

Sets whether or not an alias is enabled.

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

Throws:

ClientApiException

setPassThroughEnabled

public ApiResponse setPassThroughEnabled(String authority,
 String enabled)
                                  throws ClientApiException

Sets whether or not a pass-through is enabled.

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

Throws:

ClientApiException

setConnectionTimeout

public ApiResponse setConnectionTimeout(String timeout)
                                 throws ClientApiException

Sets the timeout, for reads and connects.

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

Throws:

ClientApiException

setDefaultUserAgent

public ApiResponse setDefaultUserAgent(String useragent)
                                throws ClientApiException

Sets the default user-agent.

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

Throws:

ClientApiException

setDnsTtlSuccessfulQueries

public ApiResponse setDnsTtlSuccessfulQueries(String ttl)
                                       throws ClientApiException

Sets the TTL of successful DNS queries.

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

Throws:

ClientApiException

addHttpProxyExclusion

public ApiResponse addHttpProxyExclusion(String host,
 String enabled)
                                  throws ClientApiException

Adds a host to be excluded from the HTTP proxy.

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

Throws:

ClientApiException

removeHttpProxyExclusion

public ApiResponse removeHttpProxyExclusion(String host)
                                     throws ClientApiException

Removes an HTTP proxy exclusion.

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

Throws:

ClientApiException

setHttpProxy

public ApiResponse setHttpProxy(String host,
 String port,
 String realm,
 String username,
 String password)
                         throws ClientApiException

Sets the HTTP proxy configuration.

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

Throws:

ClientApiException

setHttpProxyAuthEnabled

public ApiResponse setHttpProxyAuthEnabled(String enabled)
                                    throws ClientApiException

Sets whether or not the HTTP proxy authentication is enabled.

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

Throws:

ClientApiException

setHttpProxyEnabled

public ApiResponse setHttpProxyEnabled(String enabled)
                                throws ClientApiException

Sets whether or not the HTTP proxy is enabled.

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

Throws:

ClientApiException

setHttpProxyExclusionEnabled

public ApiResponse setHttpProxyExclusionEnabled(String host,
 String enabled)
                                         throws ClientApiException

Sets whether or not an HTTP proxy exclusion is enabled.

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

Throws:

ClientApiException

setSocksProxy

public ApiResponse setSocksProxy(String host,
 String port,
 String version,
 String usedns,
 String username,
 String password)
                          throws ClientApiException

Sets the SOCKS proxy configuration.

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

Throws:

ClientApiException

setSocksProxyEnabled

public ApiResponse setSocksProxyEnabled(String enabled)
                                 throws ClientApiException

Sets whether or not the SOCKS proxy is enabled.

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

Throws:

ClientApiException

setUseGlobalHttpState

public ApiResponse setUseGlobalHttpState(String use)
                                  throws ClientApiException

Sets whether or not to use the global HTTP state.

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

Throws:

ClientApiException

addPkcs12ClientCertificate

public ApiResponse addPkcs12ClientCertificate(String filepath,
 String password,
 String index)
                                       throws ClientApiException

Adds a client certificate contained in a PKCS#12 file, the certificate is automatically set as active and used.

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

Throws:

ClientApiException

setUseClientCertificate

public ApiResponse setUseClientCertificate(String use)
                                    throws ClientApiException

Sets whether or not to use the active client certificate.

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

Throws:

ClientApiException

addRateLimitRule

public ApiResponse addRateLimitRule(String description,
 String enabled,
 String matchregex,
 String matchstring,
 String requestspersecond,
 String groupby)
                             throws ClientApiException

Adds a rate limit rule

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

Throws:

ClientApiException

removeRateLimitRule

public ApiResponse removeRateLimitRule(String description)
                                throws ClientApiException

Remove a rate limit rule

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

Throws:

ClientApiException

setRateLimitRuleEnabled

public ApiResponse setRateLimitRuleEnabled(String description,
 String enabled)
                                    throws ClientApiException

Set enabled state for a rate limit rule.

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

Throws:

ClientApiException

proxypac

public byte[] proxypac()
                throws ClientApiException

Provides a PAC file, proxying through the main proxy.

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

Throws:

ClientApiException

setProxy

public byte[] setProxy(String proxy)
                throws ClientApiException

Sets the HTTP proxy configuration.

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

Throws:

ClientApiException

rootCaCert

public byte[] rootCaCert()
                  throws ClientApiException

Gets the Root CA certificate used to issue server certificates. Suitable to import into client applications (e.g. browsers).

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

Throws:

ClientApiException