Package burp.api.montoya.ui.editor.extension

Interface ExtensionProvidedHttpResponseEditor

All Superinterfaces:

ExtensionProvidedEditor

public interface ExtensionProvidedHttpResponseEditor
extends ExtensionProvidedEditor

Extensions that register an HttpResponseEditorProvider must return an instance of this interface.
Burp will then use that instance to create custom tabs within its HTTP response editor.

Method Summary

Modifier and Type	Method	Description
String	caption()
HttpResponse	getResponse()
boolean	isEnabledFor(HttpRequestResponse requestResponse)	A check to determine if the HTTP message editor is enabled for a specific HttpRequestResponse
boolean	isModified()
Selection	selectedData()	The method should return null if no data has been selected.
void	setRequestResponse(HttpRequestResponse requestResponse)	Sets the provided HttpRequestResponse object within the editor component.
Component	uiComponent()

Method Details

getResponse

HttpResponse getResponse()

Returns:

An instance of HttpResponse derived from the content of the HTTP response editor.

setRequestResponse

void setRequestResponse(HttpRequestResponse requestResponse)

Sets the provided HttpRequestResponse object within the editor component.

Specified by:

setRequestResponse in interface ExtensionProvidedEditor

Parameters:

requestResponse - The request and response to set in the editor.

isEnabledFor

boolean isEnabledFor(HttpRequestResponse requestResponse)

A check to determine if the HTTP message editor is enabled for a specific HttpRequestResponse

Specified by:

isEnabledFor in interface ExtensionProvidedEditor

Parameters:

requestResponse - The HttpRequestResponse to check.

Returns:

True if the HTTP message editor is enabled for the provided request and response.

caption

String caption()

Specified by:

caption in interface ExtensionProvidedEditor

Returns:

The caption located in the message editor tab header.

uiComponent

Component uiComponent()

Specified by:

uiComponent in interface ExtensionProvidedEditor

Returns:

The component that is rendered within the message editor tab.

selectedData

Selection selectedData()

The method should return null if no data has been selected.

Specified by:

selectedData in interface ExtensionProvidedEditor

Returns:

The data that is currently selected by the user.

isModified

boolean isModified()

Specified by:

isModified in interface ExtensionProvidedEditor

Returns:

True if the user has modified the current message within the editor.