Package org.zaproxy.clientapi.gen

Class AlertFilter

java.lang.Object

org.zaproxy.clientapi.gen.deprecated.AlertFilterDeprecated

org.zaproxy.clientapi.gen.AlertFilter

public class AlertFilter
extends AlertFilterDeprecated

This file was automatically generated.

Constructor Summary

Constructors

Constructor	Description
AlertFilter(ClientApi api)

Method Summary

Modifier and Type	Method	Description
ApiResponse	addAlertFilter(java.lang.String contextid, java.lang.String ruleid, java.lang.String newlevel, java.lang.String url, java.lang.String urlisregex, java.lang.String parameter, java.lang.String enabled, java.lang.String parameterisregex, java.lang.String attack, java.lang.String attackisregex, java.lang.String evidence, java.lang.String evidenceisregex, java.lang.String methods)	Adds a new alert filter for the context with the given ID.
ApiResponse	addGlobalAlertFilter(java.lang.String ruleid, java.lang.String newlevel, java.lang.String url, java.lang.String urlisregex, java.lang.String parameter, java.lang.String enabled, java.lang.String parameterisregex, java.lang.String attack, java.lang.String attackisregex, java.lang.String evidence, java.lang.String evidenceisregex, java.lang.String methods)	Adds a new global alert filter.
ApiResponse	alertFilterList(java.lang.String contextid)	Lists the alert filters of the context with the given ID.
ApiResponse	applyAll()	Applies all currently enabled Global and Context alert filters.
ApiResponse	applyContext()	Applies all currently enabled Context alert filters.
ApiResponse	applyGlobal()	Applies all currently enabled Global alert filters.
ApiResponse	globalAlertFilterList()	Lists the global alert filters.
ApiResponse	removeAlertFilter(java.lang.String contextid, java.lang.String ruleid, java.lang.String newlevel, java.lang.String url, java.lang.String urlisregex, java.lang.String parameter, java.lang.String enabled, java.lang.String parameterisregex, java.lang.String attack, java.lang.String attackisregex, java.lang.String evidence, java.lang.String evidenceisregex, java.lang.String methods)	Removes an alert filter from the context with the given ID.
ApiResponse	removeGlobalAlertFilter(java.lang.String ruleid, java.lang.String newlevel, java.lang.String url, java.lang.String urlisregex, java.lang.String parameter, java.lang.String enabled, java.lang.String parameterisregex, java.lang.String attack, java.lang.String attackisregex, java.lang.String evidence, java.lang.String evidenceisregex, java.lang.String methods)	Removes a global alert filter.
ApiResponse	testAll()	Tests all currently enabled Global and Context alert filters.
ApiResponse	testContext()	Tests all currently enabled Context alert filters.
ApiResponse	testGlobal()	Tests all currently enabled Global alert filters.

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

addAlertFilter, addAlertFilter, addGlobalAlertFilter, removeAlertFilter, removeAlertFilter, removeGlobalAlertFilter

Methods inherited from class java.lang.Object

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

Constructor Detail

AlertFilter

public AlertFilter(ClientApi api)

Method Detail

alertFilterList

public ApiResponse alertFilterList(java.lang.String contextid)
                            throws ClientApiException

Lists the alert filters of the context with the given ID.

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

Throws:

ClientApiException

globalAlertFilterList

public ApiResponse globalAlertFilterList()
                                  throws ClientApiException

Lists the global alert filters.

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

Throws:

ClientApiException

addAlertFilter

public ApiResponse addAlertFilter(java.lang.String contextid,
                                  java.lang.String ruleid,
                                  java.lang.String newlevel,
                                  java.lang.String url,
                                  java.lang.String urlisregex,
                                  java.lang.String parameter,
                                  java.lang.String enabled,
                                  java.lang.String parameterisregex,
                                  java.lang.String attack,
                                  java.lang.String attackisregex,
                                  java.lang.String evidence,
                                  java.lang.String evidenceisregex,
                                  java.lang.String methods)
                           throws ClientApiException

Adds a new alert filter for the context with the given ID.

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

Specified by:

addAlertFilter in class AlertFilterDeprecated

Throws:

ClientApiException

removeAlertFilter

public ApiResponse removeAlertFilter(java.lang.String contextid,
                                     java.lang.String ruleid,
                                     java.lang.String newlevel,
                                     java.lang.String url,
                                     java.lang.String urlisregex,
                                     java.lang.String parameter,
                                     java.lang.String enabled,
                                     java.lang.String parameterisregex,
                                     java.lang.String attack,
                                     java.lang.String attackisregex,
                                     java.lang.String evidence,
                                     java.lang.String evidenceisregex,
                                     java.lang.String methods)
                              throws ClientApiException

Removes an alert filter from the context with the given ID.

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

Specified by:

removeAlertFilter in class AlertFilterDeprecated

Throws:

ClientApiException

addGlobalAlertFilter

public ApiResponse addGlobalAlertFilter(java.lang.String ruleid,
                                        java.lang.String newlevel,
                                        java.lang.String url,
                                        java.lang.String urlisregex,
                                        java.lang.String parameter,
                                        java.lang.String enabled,
                                        java.lang.String parameterisregex,
                                        java.lang.String attack,
                                        java.lang.String attackisregex,
                                        java.lang.String evidence,
                                        java.lang.String evidenceisregex,
                                        java.lang.String methods)
                                 throws ClientApiException

Adds a new global alert filter.

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

Specified by:

addGlobalAlertFilter in class AlertFilterDeprecated

Throws:

ClientApiException

removeGlobalAlertFilter

public ApiResponse removeGlobalAlertFilter(java.lang.String ruleid,
                                           java.lang.String newlevel,
                                           java.lang.String url,
                                           java.lang.String urlisregex,
                                           java.lang.String parameter,
                                           java.lang.String enabled,
                                           java.lang.String parameterisregex,
                                           java.lang.String attack,
                                           java.lang.String attackisregex,
                                           java.lang.String evidence,
                                           java.lang.String evidenceisregex,
                                           java.lang.String methods)
                                    throws ClientApiException

Removes a global alert filter.

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

Specified by:

removeGlobalAlertFilter in class AlertFilterDeprecated

Throws:

ClientApiException

applyAll

public ApiResponse applyAll()
                     throws ClientApiException

Applies all currently enabled Global and Context alert filters.

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

Throws:

ClientApiException

applyContext

public ApiResponse applyContext()
                         throws ClientApiException

Applies all currently enabled Context alert filters.

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

Throws:

ClientApiException

applyGlobal

public ApiResponse applyGlobal()
                        throws ClientApiException

Applies all currently enabled Global alert filters.

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

Throws:

ClientApiException

testAll

public ApiResponse testAll()
                    throws ClientApiException

Tests all currently enabled Global and Context alert filters.

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

Throws:

ClientApiException

testContext

public ApiResponse testContext()
                        throws ClientApiException

Tests all currently enabled Context alert filters.

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

Throws:

ClientApiException

testGlobal

public ApiResponse testGlobal()
                       throws ClientApiException

Tests all currently enabled Global alert filters.

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

Throws:

ClientApiException