Package org.zaproxy.clientapi.gen

Class Break

java.lang.Object

org.zaproxy.clientapi.gen.deprecated.BreakDeprecated

org.zaproxy.clientapi.gen.Break

public class Break
extends BreakDeprecated

This file was automatically generated.

Constructor Summary

Constructors

Constructor	Description
Break(ClientApi api)

Method Summary

Modifier and Type	Method	Description
ApiResponse	addHttpBreakpoint(String string, String location, String match, String inverse, String ignorecase)	Adds a custom HTTP breakpoint.
ApiResponse	brk(String type, String state, String scope)	Controls the global break functionality.
ApiResponse	cont()	Submits the currently intercepted message and unsets the global request/response breakpoints
ApiResponse	drop()	Drops the currently intercepted message
ApiResponse	httpMessage()	Returns the HTTP message currently intercepted (if any)
ApiResponse	isBreakAll()	Returns True if ZAP will break on both requests and responses
ApiResponse	isBreakRequest()	Returns True if ZAP will break on requests
ApiResponse	isBreakResponse()	Returns True if ZAP will break on responses
ApiResponse	removeHttpBreakpoint(String string, String location, String match, String inverse, String ignorecase)	Removes the specified breakpoint
ApiResponse	setHttpMessage(String httpheader, String httpbody)	Overwrites the currently intercepted message with the data provided
ApiResponse	step()	Submits the currently intercepted message, the next request or response will automatically be intercepted

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

addHttpBreakpoint, brk, removeHttpBreakpoint

Methods inherited from class java.lang.Object

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

Constructor Details

Break

public Break(ClientApi api)

Method Details

isBreakAll

public ApiResponse isBreakAll()
                       throws ClientApiException

Returns True if ZAP will break on both requests and responses

Throws:

ClientApiException

isBreakRequest

public ApiResponse isBreakRequest()
                           throws ClientApiException

Returns True if ZAP will break on requests

Throws:

ClientApiException

isBreakResponse

public ApiResponse isBreakResponse()
                            throws ClientApiException

Returns True if ZAP will break on responses

Throws:

ClientApiException

httpMessage

public ApiResponse httpMessage()
                        throws ClientApiException

Returns the HTTP message currently intercepted (if any)

Throws:

ClientApiException

brk

public ApiResponse brk(String type,
 String state,
 String scope)
                throws ClientApiException

Controls the global break functionality. The type may be one of: http-all, http-request or http-response. The state may be true (for turning break on for the specified type) or false (for turning break off). Scope is not currently used.

Throws:

ClientApiException

setHttpMessage

public ApiResponse setHttpMessage(String httpheader,
 String httpbody)
                           throws ClientApiException

Overwrites the currently intercepted message with the data provided

Throws:

ClientApiException

cont

public ApiResponse cont()
                 throws ClientApiException

Submits the currently intercepted message and unsets the global request/response breakpoints

Throws:

ClientApiException

step

public ApiResponse step()
                 throws ClientApiException

Submits the currently intercepted message, the next request or response will automatically be intercepted

Throws:

ClientApiException

drop

public ApiResponse drop()
                 throws ClientApiException

Drops the currently intercepted message

Throws:

ClientApiException

addHttpBreakpoint

public ApiResponse addHttpBreakpoint(String string,
 String location,
 String match,
 String inverse,
 String ignorecase)
                              throws ClientApiException

Adds a custom HTTP breakpoint. The string is the string to match. Location may be one of: url, request_header, request_body, response_header or response_body. Match may be: contains or regex. Inverse (match) may be true or false. Lastly, ignorecase (when matching the string) may be true or false.

Throws:

ClientApiException

removeHttpBreakpoint

public ApiResponse removeHttpBreakpoint(String string,
 String location,
 String match,
 String inverse,
 String ignorecase)
                                 throws ClientApiException

Removes the specified breakpoint

Throws:

ClientApiException