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 obtain the number of occurrences of an individual keyword in a response. @param keyword The keyword whose count will be retrie

This method retrieves the name of the Burp Proxy listener that is processing the intercepted message. @return The name of the Burp Proxy listener tha

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 is used to retrieve the message editor tab factories that are registered by the extension. @return A list of message editor tab factories

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 retrieve the path for which the cookie is in scope. @return The path for which the cookie is in scope or null if none is set.

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

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 is used to retrieve a map containing all properties of the interaction. @return A map containing all properties of the interaction.

This method is used to retrieve a property of the interaction. Properties of all interactions are: interaction_id, type, client_ip, and time_stamp. Pr

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 is used to retrieve the Proxy listeners that are registered by the extension. @return A list of Proxy listeners that are currently regist

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 is used to retrieve the request message. @return The request message.

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 is used to retrieve the Scanner checks that are registered by the extension. @return A list of Scanner checks that are currently register

This method is used to retrieve the Scanner insertion point providers that are registered by the extension. @return A list of Scanner insertion point

This method is used to retrieve the Scanner listeners that are registered by the extension. @return A list of Scanner listeners that are currently re

This method is used to retrieve the scope change listeners that are registered by the extension. @return A list of scope change listeners that are cu

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 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 is used to retrieve the session handling actions that are registered by the extension. @return A list of session handling actions that ar

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 is used to obtain the MIME type of the response, as stated in the HTTP headers. @return A textual label for the stated MIME type, or an e

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

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

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 is used to obtain the URL in the request. @return The URL in the request.

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 to obtain the list of attributes that vary between the analyzed responses. @return The attributes that vary between the analyzed

This method is used to obtain the list of keywords whose counts vary between the analyzed responses. @return The keywords whose counts vary between t

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 determines whether the current extension was loaded as a BApp (a Burp App from the BApp Store). @return Returns true if the current exten

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 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 causes Burp to load a new project-level configuration from the JSON String provided. This is the same format that can be saved and loaded

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