Package burp.api.montoya.extension

Interface Extension

  • public interface Extension
    This interface provides access to functionality related to your Extension.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String filename()
      This method retrieves the absolute path name of the file from which the current extension was loaded.
      boolean isBapp()
      This method determines whether the current extension was loaded as a BApp.
      Registration registerUnloadingHandler​(ExtensionUnloadingHandler handler)
      This method is used to register a handler which will be notified of changes to the extension's state.
      void setName​(java.lang.String extensionName)
      This method is used to set the display name for the current extension, which will be displayed within the user interface for the Extensions tool.
      void unload()
      This method is used to unload the extension from Burp Suite.

    • Method Detail

      • setName

        void setName​(java.lang.String extensionName)
        This method is used to set the display name for the current extension, which will be displayed within the user interface for the Extensions tool.
        Parameters:
        extensionName - the name of the extension

      • filename

        java.lang.String filename()
        This method retrieves the 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()
        This method 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()
        This method is used to unload the extension from Burp Suite.

      • registerUnloadingHandler

        Registration registerUnloadingHandler​(ExtensionUnloadingHandler handler)
        This method is used to 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.