This method returns the port number for the service. @return The port number for the service.

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

This method returns the protocol for the service. @return The protocol for the service. Expected values are "http" or "https".

This method returns details of all items in the Proxy history. @return The contents of the Proxy history.

This method returns a background description of the remediation for this type of issue. @return A background description of the remediation for this

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

This method is used to retrieve the HTTP request associated with the current message (which may itself be a response). @return The HTTP request assoc

This method returns the details of the request markers. @return A list of index pairs representing the offsets of markers for the request message. Ea

This method can be used to retrieve details of a specified parameter within an HTTP request. <b>Note:</b> Use <code>analyzeRequest()</code> to obtain

This method is used to retrieve the request template for the attack. @return The request template for the attack.

This method is used to retrieve the HTTP response associated with the current message (which may itself be a request). @return The HTTP response asso

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

This method returns the details of the response markers. @return A list of index pairs representing the offsets of markers for the response message.

This method returns all of the current scan issues for URLs matching the specified literal prefix. @param urlPrefix This parameter can be used to spe

This method returns the data that is currently selected by the user. @return The data that is currently selected by the user, or <code>null</code> if

This method is used to retrieve the data that is currently selected by the user. @return The data that is currently selected by the user. This may be

This method can be used to retrieve details of the Scanner issues that were selected by the user when the context menu was invoked. @return An array

This method can be used to retrieve details of the HTTP requests / responses that were shown or selected by the user when the context menu was invoked

This method is used to obtain the currently selected text. @return The currently selected text, or <code>null</code> if the user has not made any sel

This method can be used to retrieve the bounds of the user's selection into the displayed text, if applicable. @return An int[2] array containing the

This method can be used to retrieve the bounds of the user's selection into the current message, if applicable. @return An int[2] array containing th

This method returns the issue severity level. @return The issue severity level. Expected values are "High", "Medium", "Low", "Information" or "False

This method returns details of items in the site map. @param urlPrefix This parameter can be used to specify a URL prefix, in order to extract a spec

This method returns a description of the status of the scan queue item. @return A description of the status of the scan queue item.

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

This method is used to obtain the current extension's standard error stream. Extensions should write all error messages to this stream, allowing the B

Burp uses this method to obtain the caption that should appear on the custom tab when it is displayed. @return The caption that should appear on the

This method returns the caption that should appear on the custom tab when it is displayed. <b>Note:</b> Burp invokes this method once when the tab is

This method can be used to retrieve the Burp tool within which the context menu was invoked. @return A flag indicating the Burp tool within which the

This method is used to obtain the descriptive name for the Burp tool identified by the tool flag provided. @param toolFlag A flag identifying a Burp

This method is used to retrieve the parameter type. @return The parameter type. The available types are defined within this interface.

Burp uses this method to obtain the component that should be used as the contents of the custom tab when it is displayed. @return The component that

This method returns the component that should be used as the contents of the custom tab when it is displayed. <b>Note:</b> Burp invokes this method on

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

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

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

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

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

This method is used by Burp to determine whether the payload generator is able to provide any further payloads. @return Extensions should return <cod

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

This method searches a piece of data for the first occurrence of a specified pattern. It works on byte-based data in a way that is similar to the way

The hosting editor will invoke this method before it displays a new HTTP message, so that the custom tab can indicate whether it should be enabled for

This method can be used to query whether a specified URL is within the current Suite-wide scope. @param url The URL to query. @return Returns <code>t

This method is used to determine whether the current message has been modified by the user. @return An indication of whether the current message has

This method is used to determine whether the currently displayed message has been modified by the user. The hosting editor will always call <code>getM

This method is used to determine whether the user has modified the contents of the editor. @return An indication of whether the user has modified the

This method can be used to display a specified message in the Burp Suite alerts tab. @param message The alert message to display.

This method causes Burp to load a new configuration from the Map of name/value Strings provided. Any settings not specified in the Map will be restore

This method is used to load configuration settings for the extension that were saved using the method <code>saveExtensionSetting()</code>. @param nam

This method can be used to issue HTTP requests and retrieve their responses. @param httpService The HTTP service to which the request should be sent.

This method constructs an <code>IScannerInsertionPoint</code> object based on the details provided. It can be used to quickly create a simple insertio

This method is invoked by Burp Suite when the user clicks on a custom menu item which the extension has registered with Burp. @param menuItemCaption

This method is invoked when a new issue is added to Burp Scanner's results. @param issue An <code>IScanIssue</code> object that the extension can que

This method is invoked when the session handling action should be executed. This may happen as an action in its own right, or as a sub-action followin

This method is invoked when an HTTP request is about to be issued, and when an HTTP response has been received. @param toolFlag A flag indicating the

This method is invoked by Burp each time the processor should be applied to an Intruder payload. @param currentPayload The value of the payload to be

This method is invoked when an HTTP message is being processed by the Proxy. @param messageIsRequest Indicates whether the HTTP message is a request

This method is used to register a factory for custom context menu items. When the user invokes a context menu anywhere within Burp, the factory will b

This method is invoked when the extension is loaded. It registers an instance of the <code>IBurpExtenderCallbacks</code> interface, providing methods

This method is used to register a listener which will be notified of changes to the extension's state. <b>Note:</b> Any extensions that start backgrou

This method is used to register a listener which will be notified of requests and responses made by any Burp tool. Extensions can perform custom analy

This method is used to register a factory for Intruder payloads. Each registered factory will be available within the Intruder UI for the user to sele

This method is used to register a custom Intruder payload processor. Each registered processor will be available within the Intruder UI for the user t

This method can be used to register a new menu item which will appear on the various context menus that are used throughout Burp Suite to handle user-

This method is used to register a factory for custom message editor tabs. For each message editor that already exists, or is subsequently created, wit

This method is used to register a listener which will be notified of requests and responses being processed by the Proxy tool. Extensions can perform

This method is used to register a custom Scanner check. When performing scanning, Burp will ask the check to perform active or passive scanning on the

This method is used to register a provider of Scanner insertion points. For each base request that is actively scanned, Burp will ask the provider to

This method is used to register a listener which will be notified of new issues that are reported by the Scanner tool. Extensions can perform custom a

This method is used to register a listener which will be notified of changes to Burp's suite-wide target scope. @param listener An object created by

This method removes a parameter from an HTTP request, and if appropriate updates the Content-Length header. @param request The request from which the

This method is used to remove a previously-added tab from the main Burp Suite window. @param tab An object created by the extension that implements t

This method is used by Burp to reset the state of the payload generator so that the next call to <code>getNextPayload()</code> returns the first paylo

This method can be used to restore Burp's state from a specified saved state file. This method blocks until the restore operation is completed, and mu

This method is used to save the request and response of an <code>IHttpRequestResponse</code> object to temporary files, so that they are no longer hel

This method causes Burp to save all of its current configuration as a Map of name/value Strings. @return A Map of name/value Strings reflecting Burp'

This method is used to save configuration settings for the extension in a persistent way that survives reloads of the extension and of Burp Suite. Sav

This method can be used to save Burp's state to a specified file. This method blocks until the save operation is completed, and must not be called fro

This method is used to create a temporary file on disk containing the provided data. Extensions can use temporary files for long-term storage of runti

This method is invoked whenever a change occurs to Burp's suite-wide target scope.

This method can be used to send an HTTP request to the Burp Intruder tool. The request will be displayed in the user interface, and markers for attack

This method can be used to send an HTTP request to the Burp Repeater tool. The request will be displayed in the user interface, but will not be issued

This method can be used to send a seed URL to the Burp Spider tool. If the URL is not within the current Spider scope, the user will be asked if they

This method is used to update the user-annotated comment for this item. @param comment The comment to be assigned to this item.

This method is used to control whether the editor is currently editable. This status can be toggled on and off as required. @param editable Indicates

This method is used to update the user-annotated highlight for this item. @param color The highlight color to be assigned to this item. Accepted valu

This method is used to update the HTTP service for this request / response. @param httpService An <code>IHttpService</code> object containing details

This method is used to update the interception action. @param interceptAction The new interception action. Possible values are defined within this in

This method is used to display an HTTP message in the editor. @param message The HTTP message to be displayed. @param isRequest Flags whether the mes

The hosting editor will invoke this method to display a new message or to clear the existing message. This method will only be called with a new messa

This method sets the master interception mode for Burp Proxy. @param enabled Indicates whether interception of Proxy messages should be enabled.

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

This method is used to update the search expression that is shown in the search bar below the editor. The editor will automatically highlight any regi

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