Package burp.api.montoya.ui.contextmenu

Interface MessageEditorHttpRequestResponse

public interface MessageEditorHttpRequestResponse

This class contains information about a user selection of a request or response within a Burp Suite message editor.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	MessageEditorHttpRequestResponse.SelectionContext

Method Summary

Modifier and Type	Method	Description
int	caretPosition()
HttpRequestResponse	getRequestResponse()
MessageEditorHttpRequestResponse.SelectionContext	selectionContext()
java.util.Optional<Range>	selectionOffsets()	This will return Optional.empty() if the user has not made a selection.
void	setMessageAnnotations(Annotations annotations)	Update the message editor with the annotations
void	setRequest(HttpRequest request)	Update the message editor with the HTTP request
void	setResponse(HttpResponse response)	Update the message editor with the HTTP response

Method Detail

selectionContext

MessageEditorHttpRequestResponse.SelectionContext selectionContext()

Returns:

An MessageEditorHttpRequestResponse.SelectionContext which indicates what data has been selected by the user and has focus.

selectionOffsets

java.util.Optional<Range> selectionOffsets()

This will return Optional.empty() if the user has not made a selection.

Returns:

An Optional range of indices that indicates the position of the users current selection.

caretPosition

int caretPosition()

Returns:

The index of the position for the carat within the current message editor.

getRequestResponse

HttpRequestResponse getRequestResponse()

Returns:

An instance of HttpRequestResponse which contains the information about the currently displayed or selected HTTP request/response.

setRequest

void setRequest(HttpRequest request)

Update the message editor with the HTTP request

Parameters:

request - the request to update the editor.

setResponse

void setResponse(HttpResponse response)

Update the message editor with the HTTP response

Parameters:

response - the response to update the editor.

setMessageAnnotations

void setMessageAnnotations(Annotations annotations)

Update the message editor with the annotations

Parameters:

annotations - the annotations to update.