burp

Interface IHttpRequestResponse

All Known Subinterfaces:

IHttpRequestResponsePersisted, IHttpRequestResponseWithMarkers

public interface IHttpRequestResponse

This interface is used to retrieve and update details about HTTP messages. Note: The setter methods generally can only be used before the message has been processed, and not in read-only contexts. The getter methods relating to response details can only be used after the request has been issued.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getComment() This method is used to retrieve the user-annotated comment for this item, if applicable.
java.lang.String	getHighlight() This method is used to retrieve the user-annotated highlight for this item, if applicable.
IHttpService	getHttpService() This method is used to retrieve the HTTP service for this request / response.
byte[]	getRequest() This method is used to retrieve the request message.
byte[]	getResponse() This method is used to retrieve the response message.
void	setComment(java.lang.String comment) This method is used to update the user-annotated comment for this item.
void	setHighlight(java.lang.String color) This method is used to update the user-annotated highlight for this item.
void	setHttpService(IHttpService httpService) This method is used to update the HTTP service for this request / response.
void	setRequest(byte[] message) This method is used to update the request message.
void	setResponse(byte[] message) This method is used to update the response message.

Method Detail

getRequest

byte[] getRequest()

This method is used to retrieve the request message.

Returns:

The request message.

setRequest

void setRequest(byte[] message)

This method is used to update the request message.

Parameters:

message - The new request message.

getResponse

byte[] getResponse()

This method is used to retrieve the response message.

Returns:

The response message.

setResponse

void setResponse(byte[] message)

This method is used to update the response message.

Parameters:

message - The new response message.

getComment

java.lang.String getComment()

This method is used to retrieve the user-annotated comment for this item, if applicable.

Returns:

The user-annotated comment for this item, or null if none is set.

setComment

void setComment(java.lang.String comment)

This method is used to update the user-annotated comment for this item.

Parameters:

comment - The comment to be assigned to this item.

getHighlight

java.lang.String getHighlight()

This method is used to retrieve the user-annotated highlight for this item, if applicable.

Returns:

The user-annotated highlight for this item, or null if none is set.

setHighlight

void setHighlight(java.lang.String color)

This method is used to update the user-annotated highlight for this item.

Parameters:

color - The highlight color to be assigned to this item. Accepted values are: red, orange, yellow, green, cyan, blue, pink, magenta, gray, or a null String to clear any existing highlight.

getHttpService

IHttpService getHttpService()

This method is used to retrieve the HTTP service for this request / response.

Returns:

An IHttpService object containing details of the HTTP service.

setHttpService

void setHttpService(IHttpService httpService)

This method is used to update the HTTP service for this request / response.

Parameters:

httpService - An IHttpService object containing details of the new HTTP service.