Package burp.api.montoya.logger

Interface LoggerCaptureHttpRequestResponse

public interface LoggerCaptureHttpRequestResponse

This interface is used to define a coupling between HttpRequest and HttpResponse that could potentially be recorded in the Logger.

Method Summary

Modifier and Type	Method	Description
boolean	contains(String searchTerm, boolean caseSensitive)	Searches the data in the HTTP request and response for the specified search term.
boolean	contains(Pattern pattern)	Searches the data in the HTTP request, response and notes for the specified regular expression.
boolean	hasResponse()
HttpService	httpService()	HTTP service for the request.
boolean	isSessionHandlingEvent()
MimeType	mimeType()	Obtain the MIME type of the response or request, as determined by Burp Suite.
String	pageTitle()	The page title for the response.
HttpRequest	request()
HttpResponse	response()
ZonedDateTime	time()	Returns the date and time at which Burp Logger received the request.
TimingData	timingData()	Retrieve the timing data associated with this request.
ToolSource	toolSource()	The tool that issued the request.

Method Details

request

HttpRequest request()

Returns:

The HTTP request message.

response

HttpResponse response()

Returns:

The HTTP response message.

httpService

HttpService httpService()

HTTP service for the request.

Returns:

An HttpService object containing details of the HTTP service.

time

ZonedDateTime time()

Returns the date and time at which Burp Logger received the request.

Returns:

The time at which Burp Logger received the request.

mimeType

MimeType mimeType()

Obtain the MIME type of the response or request, as determined by Burp Suite. If there is no response the mime type will be determined from the request url.

Returns:

The MIME type.

hasResponse

boolean hasResponse()

Returns:

True if there is a response.

timingData

TimingData timingData()

Retrieve the timing data associated with this request.

Returns:

The timing data.

pageTitle

String pageTitle()

The page title for the response.

Returns:

The page title, or an empty string if none exists.

toolSource

ToolSource toolSource()

The tool that issued the request.

Returns:

ToolSource which indicates which Burp tool sent the request.

contains

boolean contains(String searchTerm,
 boolean caseSensitive)

Searches the data in the HTTP request and response for the specified search term.

Parameters:

searchTerm - The value to be searched for.

caseSensitive - Flags whether the search is case-sensitive.

Returns:

True if the search term is found.

contains

boolean contains(Pattern pattern)

Searches the data in the HTTP request, response and notes for the specified regular expression.

Parameters:

pattern - The regular expression to be searched for.

Returns:

True if the pattern is matched.

isSessionHandlingEvent

boolean isSessionHandlingEvent()

Returns:

True if the item is a session handling request.