Package burp.api.montoya.ui.contextmenu
Interface ContextMenuEvent
-
- All Superinterfaces:
ComponentEvent,InvocationSource,ToolSource
public interface ContextMenuEvent extends ComponentEvent, ToolSource, InvocationSource
This interface provides useful information when generating context menu items from aContextMenuItemsProvider.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.Optional<MessageEditorHttpRequestResponse>messageEditorRequestResponse()This method can be used to retrieve details of the currently selected HTTP request/response when the context menu was invoked.java.util.List<AuditIssue>selectedIssues()This method can be used to retrieve details of the Scanner issues that were selected by the user when the context menu was invoked.java.util.List<HttpRequestResponse>selectedRequestResponses()This method can be used to retrieve details of the currently selected HTTP request/response pair that was selected by the user when the context menu was invoked.-
Methods inherited from interface burp.api.montoya.ui.contextmenu.ComponentEvent
inputEvent
-
Methods inherited from interface burp.api.montoya.ui.contextmenu.InvocationSource
invocationType, isFrom
-
Methods inherited from interface burp.api.montoya.core.ToolSource
isFromTool, toolType
-
-
-
-
Method Detail
-
messageEditorRequestResponse
java.util.Optional<MessageEditorHttpRequestResponse> messageEditorRequestResponse()
This method can be used to retrieve details of the currently selected HTTP request/response when the context menu was invoked.- Returns:
- an
Optionaldescribing the currently selected request response with selection metadata.
-
selectedRequestResponses
java.util.List<HttpRequestResponse> selectedRequestResponses()
This method can be used to retrieve details of the currently selected HTTP request/response pair that was selected by the user when the context menu was invoked. This will return an empty list if the user has not made a selection.- Returns:
- A list of request responses that have been selected by the user.
-
selectedIssues
java.util.List<AuditIssue> selectedIssues()
This method can be used to retrieve details of the Scanner issues that were selected by the user when the context menu was invoked. This will return an empty list if no issues are applicable to the invocation.- Returns:
- a List of
AuditIssueobjects representing the items that were shown or selected by the user when the context menu was invoked.
-
-