Package burp.api.montoya.http.sessions

Interface SessionHandlingAction

public interface SessionHandlingAction
Extensions can implement this interface and then call Http.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

    Modifier and Type
    Method
    Description
    String
    name()
     
    ActionResult
    performAction(SessionHandlingActionData actionData)
    Invoked when the session handling action should be executed.
    This may happen as an action in its own right, or as a sub-action following execution of a macro.
    It can issue additional requests of its own if necessary, and can return a modified base request in the ActionResult

  • Method Details

    • name

      String name()
      Returns:
      Action name

    • performAction

      ActionResult performAction(SessionHandlingActionData actionData)
      Invoked when the session handling action should be executed.
      This may happen as an action in its own right, or as a sub-action following execution of a macro.
      It can issue additional requests of its own if necessary, and can return a modified base request in the ActionResult
      Parameters:
      actionData - SessionHandlingActionData The action can query this object to obtain details about the base request.
      Returns:
      A new ActionResult instance.