Interface HttpRequestEditor
- All Superinterfaces:
Editor
Provides extensions with an instance of Burp Suites HTTP request editor to use in their own user interface.
-
Method Summary
Modifier and TypeMethodDescriptionint
boolean
This will returnOptional.empty()
if the user has not made a selection.void
setCaretPosition
(int position) Set the position of the caret within the current message editor.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.
-
Method Details
-
getRequest
HttpRequest getRequest()- Returns:
- an instance of
HttpRequest
derived from the contents of the editor.
-
setRequest
Display the contents of an HTTP request in the editor.- Parameters:
request
- The HTTP request to be set.
-
setSearchExpression
Update the search expression that is shown in the search bar below the editor.- Specified by:
setSearchExpression
in interfaceEditor
- Parameters:
expression
- The search expression.
-
isModified
boolean isModified()- Specified by:
isModified
in interfaceEditor
- 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 interfaceEditor
- Returns:
- The index of the position for the carat within the current message editor.
-
setCaretPosition
void setCaretPosition(int position) Description copied from interface:Editor
Set the position of the caret within the current message editor.- Specified by:
setCaretPosition
in interfaceEditor
- Parameters:
position
- The index to set the caret position to.
-
selection
-
uiComponent
Component uiComponent()- Specified by:
uiComponent
in interfaceEditor
- Returns:
- UI component of the editor, for extensions to add to their own UI.
-