Package burp.api.montoya.extension

Interface Extension

public interface Extension
Provides access to functionality related to your Extension.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    filename()
    Absolute path name of the file from which the current extension was loaded.
    boolean
    isBapp()
    Determines whether the current extension was loaded as a BApp.
    Registration
    registerUnloadingHandler(ExtensionUnloadingHandler handler)
    Register a handler which will be notified of changes to the extension's state.
    Note: Any extensions that start background threads or open system resources (such as files or database connections) should register a listener and terminate threads / close resources when the extension is unloaded.
    void
    setName(String extensionName)
    Set the display name for the current extension.
    This will be displayed within the user interface for the Extensions tool and will be used to identify persisted data.
    void
    unload()
    Unload the extension from Burp Suite.

  • Method Details

    • setName

      void setName(String extensionName)
      Set the display name for the current extension.
      This will be displayed within the user interface for the Extensions tool and will be used to identify persisted data.
      Parameters:
      extensionName - the name of the extension

    • filename

      String filename()
      Absolute path name of the file from which the current extension was loaded.
      Returns:
      The absolute path name of the file from which the current extension was loaded.

    • isBapp

      boolean isBapp()
      Determines whether the current extension was loaded as a BApp.
      Returns:
      Returns true if the current extension was loaded as a BApp.

    • unload

      void unload()
      Unload the extension from Burp Suite.

    • registerUnloadingHandler

      Registration registerUnloadingHandler(ExtensionUnloadingHandler handler)
      Register a handler which will be notified of changes to the extension's state.
      Note: Any extensions that start background threads or open system resources (such as files or database connections) should register a listener and terminate threads / close resources when the extension is unloaded.
      Parameters:
      handler - An object created by the extension that implements the ExtensionUnloadingHandler interface.
      Returns:
      The Registration for the handler.