Package org.zaproxy.clientapi.gen

Class Replacer

java.lang.Object

org.zaproxy.clientapi.gen.deprecated.ReplacerDeprecated

org.zaproxy.clientapi.gen.Replacer

public class Replacer
extends ReplacerDeprecated

This file was automatically generated.

Constructor Summary

Constructors

Constructor	Description
Replacer(ClientApi api)

Method Summary

Modifier and Type	Method	Description
ApiResponse	addRule(java.lang.String description, java.lang.String enabled, java.lang.String matchtype, java.lang.String matchregex, java.lang.String matchstring, java.lang.String replacement, java.lang.String initiators, java.lang.String url)	Adds a replacer rule.
ApiResponse	removeRule(java.lang.String description)	Removes the rule with the given description
ApiResponse	rules()	Returns full details of all of the rules
ApiResponse	setEnabled(java.lang.String description, java.lang.String bool)	Enables or disables the rule with the given description based on the bool parameter

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

addRule

Methods inherited from class java.lang.Object

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

Constructor Detail

Replacer

public Replacer(ClientApi api)

Method Detail

rules

public ApiResponse rules()
                  throws ClientApiException

Returns full details of all of the rules

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

Throws:

ClientApiException

addRule

public ApiResponse addRule(java.lang.String description,
                           java.lang.String enabled,
                           java.lang.String matchtype,
                           java.lang.String matchregex,
                           java.lang.String matchstring,
                           java.lang.String replacement,
                           java.lang.String initiators,
                           java.lang.String url)
                    throws ClientApiException

Adds a replacer rule. For the parameters: desc is a user friendly description, enabled is true or false, matchType is one of [REQ_HEADER, REQ_HEADER_STR, REQ_BODY_STR, RESP_HEADER, RESP_HEADER_STR, RESP_BODY_STR], matchRegex should be true if the matchString should be treated as a regex otherwise false, matchString is the string that will be matched against, replacement is the replacement string, initiators may be blank (for all initiators) or a comma separated list of integers as defined in HttpSender

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

Throws:

ClientApiException

removeRule

public ApiResponse removeRule(java.lang.String description)
                       throws ClientApiException

Removes the rule with the given description

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

Throws:

ClientApiException

setEnabled

public ApiResponse setEnabled(java.lang.String description,
                              java.lang.String bool)
                       throws ClientApiException

Enables or disables the rule with the given description based on the bool parameter

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

Throws:

ClientApiException