burp

Interface IScanQueueItem

public interface IScanQueueItem

This interface is used to retrieve details of items in the Burp Scanner active scan queue. Extensions can obtain references to scan queue items by calling IBurpExtenderCallbacks.doActiveScan().

Method Summary

Modifier and Type	Method and Description
void	cancel() This method allows the scan queue item to be canceled.
IScanIssue[]	getIssues() This method returns details of the issues generated for the scan queue item.
int	getNumErrors() This method returns the number of network errors that have occurred for the scan queue item.
int	getNumInsertionPoints() This method returns the number of attack insertion points being used for the scan queue item.
int	getNumRequests() This method returns the number of requests that have been made for the scan queue item.
byte	getPercentageComplete() Deprecated.
java.lang.String	getStatus() This method returns a description of the status of the scan queue item.

Method Detail

getStatus

java.lang.String getStatus()

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

Returns:

A description of the status of the scan queue item.

getPercentageComplete

@Deprecated
byte getPercentageComplete()

Deprecated.

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

Returns:

An indication of the percentage completed for the scan queue item.

getNumRequests

int getNumRequests()

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

Returns:

The number of requests that have been made for the scan queue item.

getNumErrors

int getNumErrors()

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

Returns:

The number of network errors that have occurred for the scan queue item.

getNumInsertionPoints

int getNumInsertionPoints()

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

Returns:

The number of attack insertion points being used for the scan queue item.

cancel

void cancel()

This method allows the scan queue item to be canceled.

getIssues

IScanIssue[] getIssues()

This method returns details of the issues generated for the scan queue item. Note: different items within the scan queue may contain duplicated versions of the same issues - for example, if the same request has been scanned multiple times. Duplicated issues are consolidated in the main view of scan results. Extensions can register an IScannerListener to get details only of unique, newly discovered Scanner issues post-consolidation.

Returns:

Details of the issues generated for the scan queue item.