Package burp.api.montoya.logging

Interface Logging

public interface Logging

Provides access to the functionality related to logging and events.

Method Summary

Modifier and Type	Method	Description
PrintStream	error()	Deprecated. Use logToError(java.lang.String) instead.
void	logToError(String message)	This method prints a line of output to the current extension's standard error stream.
void	logToError(String message, Throwable cause)	This method prints a message and a stack trace to the current extension's standard error stream.
void	logToError(Throwable cause)	This method prints a stack trace to the current extension's standard error stream.
void	logToOutput(String message)	This method prints a line of output to the current extension's standard output stream.
PrintStream	output()	Deprecated. Use logToOutput(java.lang.String) instead.
void	raiseCriticalEvent(String message)	This method can be used to display a critical event in the Burp Suite event log.
void	raiseDebugEvent(String message)	This method can be used to display a debug event in the Burp Suite event log.
void	raiseErrorEvent(String message)	This method can be used to display an error event in the Burp Suite event log.
void	raiseInfoEvent(String message)	This method can be used to display an informational event in the Burp Suite event log.

Method Details

output

@Deprecated
PrintStream output()

Deprecated.

Use logToOutput(java.lang.String) instead.

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

@Deprecated
PrintStream error()

Deprecated.

Use logToError(java.lang.String) instead.

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(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(String message)

This method prints a line of output to the current extension's standard error stream.

Parameters:

message - The message to print.

logToError

void logToError(String message,
 Throwable cause)

This method prints a message and a stack trace to the current extension's standard error stream.

Parameters:

message - The message to print.

cause - The cause of the error being logged.

logToError

void logToError(Throwable cause)

This method prints a stack trace to the current extension's standard error stream.

Parameters:

cause - The cause of the error being logged.

raiseDebugEvent

void raiseDebugEvent(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(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(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(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.