Package burp.api.montoya.logging

Interface Logging

  • public interface Logging
    This interface provides access to the functionality related to logging and events.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.io.PrintStream error()
      This method is used to obtain the current extension's standard error stream.
      void logToError​(java.lang.String message)
      This method prints a line of output to the current extension's standard error stream.
      void logToOutput​(java.lang.String message)
      This method prints a line of output to the current extension's standard output stream.
      java.io.PrintStream output()
      This method is used to obtain the current extension's standard output stream.
      void raiseCriticalEvent​(java.lang.String message)
      This method can be used to display a critical event in the Burp Suite event log.
      void raiseDebugEvent​(java.lang.String message)
      This method can be used to display a debug event in the Burp Suite event log.
      void raiseErrorEvent​(java.lang.String message)
      This method can be used to display an error event in the Burp Suite event log.
      void raiseInfoEvent​(java.lang.String message)
      This method can be used to display an informational event in the Burp Suite event log.

    • Method Detail

      • output

        java.io.PrintStream output()
        This method is used to obtain the current extension's standard output stream. Extensions should write all output to this stream, allowing the Burp user to configure how that output is handled from within the UI.
        Returns:
        The extension's standard output stream.

      • error

        java.io.PrintStream error()
        This method is used to obtain the current extension's standard error stream. Extensions should write all error messages to this stream, allowing the Burp user to configure how that output is handled from within the UI.
        Returns:
        The extension's standard error stream.

      • logToOutput

        void logToOutput​(java.lang.String message)
        This method prints a line of output to the current extension's standard output stream.
        Parameters:
        message - The message to print.

      • logToError

        void logToError​(java.lang.String message)
        This method prints a line of output to the current extension's standard error stream.
        Parameters:
        message - The message to print.

      • raiseDebugEvent

        void raiseDebugEvent​(java.lang.String message)
        This method can be used to display a debug event in the Burp Suite event log.
        Parameters:
        message - The debug message to display.

      • raiseInfoEvent

        void raiseInfoEvent​(java.lang.String message)
        This method can be used to display an informational event in the Burp Suite event log.
        Parameters:
        message - The informational message to display.

      • raiseErrorEvent

        void raiseErrorEvent​(java.lang.String message)
        This method can be used to display an error event in the Burp Suite event log.
        Parameters:
        message - The error message to display.

      • raiseCriticalEvent

        void raiseCriticalEvent​(java.lang.String message)
        This method can be used to display a critical event in the Burp Suite event log.
        Parameters:
        message - The critical message to display.