Package burp.api.montoya.scanner.audit

Interface Audit

All Superinterfaces:

ScanTask, Task

public interface Audit
extends ScanTask

Audit in the Burp Scanner tool.

Method Summary

Modifier and Type	Method	Description
void	addRequest(HttpRequest request)	This method can be used to add an HTTP request to this audit.
void	addRequest(HttpRequest request, List<Range> insertionPointOffsets)	This method can be used to add an HTTP request to this audit.
void	addRequestResponse(HttpRequestResponse requestResponse)	This method can be used to add an HTTP request and response to this audit.
void	delete()	Delete the task.
int	errorCount()	Number of network errors that have occurred for the scan task.
int	insertionPointCount()	This method retrieves the number of insertion points.
List<AuditIssue>	issues()	This method retrieves the audit issues found by this audit.
int	requestCount()	Number of requests that have been made for the scan task.
String	statusMessage()

Method Details

insertionPointCount

int insertionPointCount()

This method retrieves the number of insertion points.

Returns:

The number of insertion points.

issues

List<AuditIssue> issues()

This method retrieves the audit issues found by this audit.

Returns:

The list of AuditIssues found by this audit.

addRequest

void addRequest(HttpRequest request)

This method can be used to add an HTTP request to this audit.

Parameters:

request - The HttpRequest to add to this audit.

addRequest

void addRequest(HttpRequest request,
 List<Range> insertionPointOffsets)

This method can be used to add an HTTP request to this audit.

Parameters:

request - The HttpRequest to add to this audit.

insertionPointOffsets - The list of Ranges representing the insertion point offsets.

addRequestResponse

void addRequestResponse(HttpRequestResponse requestResponse)

This method can be used to add an HTTP request and response to this audit.

Parameters:

requestResponse - The HttpRequestResponse to add to this audit.

requestCount

int requestCount()

Number of requests that have been made for the scan task.

Specified by:

requestCount in interface ScanTask

Returns:

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

errorCount

int errorCount()

Number of network errors that have occurred for the scan task.

Specified by:

errorCount in interface ScanTask

Returns:

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

delete

void delete()

Delete the task.

Specified by:

delete in interface ScanTask

Specified by:

delete in interface Task

statusMessage

String statusMessage()

Specified by:

statusMessage in interface ScanTask

Specified by:

statusMessage in interface Task

Returns:

the current status message of the task