Package burp.api.montoya.http.sessions
Interface SessionHandlingAction
-
public interface SessionHandlingActionExtensions can implement this interface and then callHttp.registerSessionHandlingAction(burp.api.montoya.http.sessions.SessionHandlingAction)to register a custom session handling action. Each registered action will be available within the session handling rule UI for the user to select as a rule action. Users can choose to invoke an action directly in its own right, or following execution of a macro.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description RequestResulthandle(HttpRequest currentRequest, Annotations annotations, java.util.List<HttpRequestResponse> macroRequestResponses)This method is invoked when the session handling action should be executed.java.lang.Stringname()
-
-
-
Method Detail
-
name
java.lang.String name()
- Returns:
- Action name
-
handle
RequestResult handle(HttpRequest currentRequest, Annotations annotations, java.util.List<HttpRequestResponse> macroRequestResponses)
This method is invoked when the session handling action should be executed.- Parameters:
currentRequest- The base request that is currently being processed. The action can query this object to obtain details about the base request.annotations- The message annotation on the request.macroRequestResponses- If the action is invoked following execution of a macro, this parameter contains the result of executing the macro. Otherwise, it is an empty list. Actions can use the details of the macro items to perform custom analysis of the macro to derive values of non-standard session handling tokens, etc.- Returns:
- A new
RequestResultinstance.
-
-