Package burp.api.montoya.scanner

Interface Scan

public interface Scan

This interface represents an instance of a scan that can be configured before starting a crawl, audit or crawl and audit in the Burp Scanner tool.

Method Summary

Modifier and Type	Method	Description
void	addConfiguration(BuiltInScanConfiguration configuration)	This method can be used to add a built-in configuration to this scan.
default void	addRequest(HttpRequest request)	This method can be used to add an HTTP request to this scan.
void	addRequest(HttpRequest request, java.util.List<Range> insertionPointOffsets)	This method can be used to add an HTTP request to this scan.
void	addRequestResponse(HttpRequestResponse requestResponse)	This method can be used to add an HTTP request and response to this scan.
void	addUrl(java.lang.String url)	This method can be used to add a URL to this scan.
Audit	startAudit()	This method can be used to start an audit in the Burp Scanner tool.
Crawl	startCrawl()	This method can be used to start a crawl in the Burp Scanner tool.

Method Detail

addUrl

void addUrl(java.lang.String url)

This method can be used to add a URL to this scan.

Parameters:

url - The URL to add to this scan.

addRequest

default void addRequest(HttpRequest request)

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

Parameters:

request - The HttpRequest to add to this scan.

addRequest

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

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

Parameters:

request - The HttpRequest to add to this scan.

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 scan.

Parameters:

requestResponse - The HttpRequestResponse to add to this scan.

addConfiguration

void addConfiguration(BuiltInScanConfiguration configuration)

This method can be used to add a built-in configuration to this scan.

Parameters:

configuration - The BuiltInScanConfiguration to add to this scan.

startCrawl

Crawl startCrawl()
          throws InvalidLauncherConfigurationException

This method can be used to start a crawl in the Burp Scanner tool.

Returns:

The Crawl started in the Burp Scanner tool.

Throws:

InvalidLauncherConfigurationException - if the configuration for this scan is invalid.

startAudit

Audit startAudit()
          throws InvalidLauncherConfigurationException

This method can be used to start an audit in the Burp Scanner tool.

Returns:

The Audit started in the Burp Scanner tool.

Throws:

InvalidLauncherConfigurationException - if the configuration for this scan is invalid.