Package burp.api.montoya.ui.editor

Interface HttpRequestEditor

All Superinterfaces:

Editor

public interface HttpRequestEditor
extends Editor

Provides extensions with an instance of Burp Suites HTTP request editor to use in their own user interface.

Method Summary

Modifier and Type	Method	Description
int	caretPosition()
HttpRequest	getRequest()
boolean	isModified()
Optional<Selection>	selection()	This will return Optional.empty() if the user has not made a selection.
void	setRequest(HttpRequest request)	Display the contents of an HTTP request in the editor.
void	setSearchExpression(String expression)	Update the search expression that is shown in the search bar below the editor.
Component	uiComponent()

Method Details

getRequest

HttpRequest getRequest()

Returns:

an instance of HttpRequest derived from the contents of the editor.

setRequest

void setRequest(HttpRequest request)

Display the contents of an HTTP request in the editor.

Parameters:

request - The HTTP request to be set.

setSearchExpression

void setSearchExpression(String expression)

Update the search expression that is shown in the search bar below the editor.

Specified by:

setSearchExpression in interface Editor

Parameters:

expression - The search expression.

isModified

boolean isModified()

Specified by:

isModified in interface Editor

Returns:

True if the user has modified the contents of the editor since the last time the content was set programmatically.

caretPosition

int caretPosition()

Specified by:

caretPosition in interface Editor

Returns:

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

selection

Optional<Selection> selection()

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

Specified by:

selection in interface Editor

Returns:

An Optional containing the users current selection in the editor.

uiComponent

Component uiComponent()

Specified by:

uiComponent in interface Editor

Returns:

UI component of the editor, for extensions to add to their own UI.