This method is used to update the currently displayed text in the editor. @param text The text to be displayed.

This method is used to retrieve the currently displayed text. @return The currently displayed text.

This method is used to obtain the URL in the request. @return The URL in the request.

This method can be used to analyze an HTTP request, and obtain various key details about it. @param request An <code>IHttpRequestResponse</code> obje

This method builds an HTTP message containing the specified headers and message body. If applicable, the Content-Length header will be added or update

This method is used to obtain the offset within the request where the message body begins. @return The offset within the request where the message bo

This method is used to obtain the HTTP headers contained in the request. @return The HTTP headers contained in the request.

This method is used to obtain an <code>IExtensionHelpers</code> object, which can be used by the extension to perform numerous useful tasks. @return

This method is used to retrieve the request message. @return The request message.

This method is used to register a custom session handling action. Each registered action will be available within the session handling rule UI for the

This method is used to set the display name for the current extension, which will be displayed within the user interface for the Extender tool. @para

This method is used to update the request message. @param message The new request message.

This method is used to add a custom tab to the main Burp Suite window. @param tab An object created by the extension that implements the <code>ITab</

This method is used to customize UI components in line with Burp's UI style, including font size, colors, table line spacing, etc. @param component T

This method is used to obtain the current extension's standard output stream. Extensions should write all output to this stream, allowing the Burp use

This method adds a new parameter to an HTTP request, and if appropriate updates the Content-Length header. @param request The request to which the pa

This method is used to register a new Scanner issue. <b>Note:</b> Wherever possible, extensions should implement custom Scanner checks using <code>ISc

This method can be used to add an item to Burp's site map with the specified request/response details. This will overwrite the details of any existing

This method can be used to analyze an HTTP response, and obtain various key details about it. @param response The response to be analyzed. @return An

This method is used to apply markers to an HTTP request or response, at offsets into the message that are relevant for some particular purpose. Marker

This method can be used to Base64-decode the specified data. @param data The data to be decoded. @return The decoded data.

This method can be used to Base64-encode the specified data. @param data The data to be encoded. @return The encoded data.

This method creates a GET request to the specified URL. The headers used in the request are determined by the Request headers settings as configured i

This method constructs an <code>IHttpService</code> object based on the details provided. @param host The HTTP service host. @param port The HTTP ser

This method constructs an <code>IParameter</code> object based on the details provided. @param name The parameter name. @param value The parameter va

This method is used to build a request with the specified payload placed into the insertion point. Any necessary adjustments to the Content-Length hea

This method can be used to convert data from an array of bytes into String form. The conversion does not reflect any particular character set, and a b

This method allows the scan queue item to be canceled.

The Scanner invokes this method when the custom Scanner check has reported multiple issues for the same URL path. This can arise either because there

This method will be called by Burp when the user invokes a context menu anywhere within Burp. The factory can then provide any custom context menu ite

This method is used to create a new instance of Burp's HTTP message editor, for the extension to use in its own UI. @param controller An object creat

Burp will call this method once for each HTTP message editor, and the factory should provide a new instance of an <code>IMessageEditorTab</code> objec

This method is used by Burp when the user starts an Intruder attack that uses this payload generator. @param attack An <code>IIntruderAttack</code> o

This method is used to create a new instance of Burp's plain text editor, for the extension to use in its own UI. @return An object that implements t

This method is used to permanently delete the temporary file when it is no longer required.

This method is used to permanently delete the saved temporary files. It will no longer be possible to retrieve the request or response for this item.

The Scanner invokes this method for each insertion point that is actively scanned. Extensions may issue HTTP requests as required to carry out active

This method can be used to send an HTTP request to the Burp Scanner tool to perform an active vulnerability scan. If the request is not within the cur

The Scanner invokes this method for each base request / response that is passively scanned. <b>Note:</b> Extensions should not only analyze the HTTP m

This method can be used to send an HTTP request to the Burp Scanner tool to perform a passive vulnerability scan. @param host The hostname of the rem

This method can be used to exclude the specified URL from the Suite-wide scope. @param url The URL to exclude from the Suite-wide scope.

This method can be used to shut down Burp programmatically, with an optional prompt to the user. If the method returns, the user canceled the shutdown

This method is called when the extension is unloaded.

This method is used by Burp to obtain the name of the session handling action. This will be displayed as an option within the session handling rule ed

This method returns the base value for this insertion point. @return the base value that appears in this insertion point in the base request being sc

This method is used to obtain the offset within the response where the message body begins. @return The offset within the response where the message

This method is used to retrieve the contents of the buffer that was saved in the temporary file. @return The contents of the buffer that was saved in

This method retrieves information about the version of Burp in which the extension is running. It can be used by extensions to dynamically adjust thei

This method is used to retrieve the user-annotated comment for this item, if applicable. @return The user-annotated comment for this item, or null if

This method returns the UI component of the editor, for extensions to add to their own UI. @return The UI component of the editor.

This method returns the UI component of the editor, for extensions to add to their own UI. @return The UI component of the editor.

This method returns the issue confidence level. @return The issue confidence level. Expected values are "Certain", "Firm" or "Tentative".

This method is used to obtain the content type of the message body. @return An indication of the content type of the message body. Available types ar

This method is used to retrieve the contents of Burp's session handling cookie jar. Extensions that provide an <code>ISessionHandlingAction</code> can

This method is used to obtain details of the HTTP cookies set in the response. @return A list of <code>ICookie</code> objects representing the cookie

This method is used to retrieve the domain for which the cookie is in scope. @return The domain for which the cookie is in scope. <b>Note:</b> For co

This method is used to retrieve the expiration time for the cookie. @return The expiration time for the cookie, or <code>null</code> if none is set (

This method is used by Burp to obtain the name of the payload generator. This will be displayed as an option within the Intruder UI when the user sele

This method parses the specified request and returns details of each HTTP header. @param message The request to be parsed. @return An array of HTTP h

This method is used to obtain the HTTP headers contained in the response. @return The HTTP headers contained in the response.

This method is used to retrieve the user-annotated highlight for this item, if applicable. @return The user-annotated highlight for this item, or nul

This method returns the hostname or IP address for the service. @return The hostname or IP address for the service.

This method returns the HTTP messages on the basis of which the issue was generated. @return The HTTP messages on the basis of which the issue was ge

This method is used to retrieve the HTTP service for the attack. @return The HTTP service for the attack.

This method returns the HTTP service for which the issue was generated. @return The HTTP service for which the issue was generated.

This method is used to retrieve the HTTP service for the current message. @return The HTTP service for the current message.

This method is used to retrieve the HTTP service for this request / response. @return An <code>IHttpService</code> object containing details of the H

This method can be used to retrieve the native Java input event that was the trigger for the context menu invocation. @return The <code>InputEvent</c

This method returns the name of the insertion point. @return The name of the insertion point (for example, a description of a particular request para

This method returns the type of the insertion point. @return The type of the insertion point. Available types are defined in this interface.

When a request is actively scanned, the Scanner will invoke this method, and the provider should provide a list of custom insertion points that will b

This method retrieves the currently defined interception action. The default action is <code>ACTION_FOLLOW_RULES</code>. If multiple proxy listeners a

This method can be used to retrieve the context within which the menu was invoked. @return An index indicating the context within which the menu was

This method returns a background description for this type of issue. @return A background description for this type of issue, or <code>null</code> if

This method returns detailed information about this specific instance of the issue. @return Detailed information about this specific instance of the

This method returns the name of the issue type. @return The name of the issue type (e.g. "SQL injection").

This method returns a numeric identifier of the issue type. See the Burp Scanner help documentation for a listing of all the issue types. @return A n

This method returns details of the issues generated for the scan queue item. <b>Note:</b> different items within the scan queue may contain duplicated

This method is used to retrieve the currently displayed message, which may have been modified by the user. @return The currently displayed HTTP messa

This method returns the currently displayed message. @return The currently displayed message.

This method retrieves details of the intercepted message. @return An <code>IHttpRequestResponse</code> object containing details of the intercepted m

This method retrieves a unique reference number for this request/response. @return An identifier that is unique to a single request/response pair. Ex

This method is used to obtain the HTTP method used in the request. @return The HTTP method used in the request.

This method is used to retrieve the parameter name. @return The parameter name.

This method is used to retrieve the name of the cookie. @return The name of the cookie.

This method is used to retrieve the end offset of the parameter name within the HTTP request. @return The end offset of the parameter name within the

This method is used to retrieve the start offset of the parameter name within the HTTP request. @return The start offset of the parameter name within

This method is used by Burp to obtain the value of the next payload. @param baseValue The base value of the current payload position. This value may

This method returns the number of network errors that have occurred for the scan queue item. @return The number of network errors that have occurred

This method returns the number of attack insertion points being used for the scan queue item. @return The number of attack insertion points being use

This method returns the number of requests that have been made for the scan queue item. @return The number of requests that have been made for the sc

This method is used to obtain the parameters contained in the request. @return The parameters contained in the request.

This method parses the specified request and returns details of each request parameter. @param request The request to be parsed. @return An array of:

This method is used to determine the offsets of the payload value within the request, when it is placed into the insertion point. Scan checks may invo

This method returns an indication of the percentage completed for the scan queue item. @return An indication of the percentage completed for the scan