public interface IHttpRequestResponse
This interface is used to allow extensions to access details of HTTP messages that are processed within Burp. Note that the setter methods generally can only be used before the message has been forwarded to the application (e.g. using IBurpExtender.processHttpMessage()) and not in read-only contexts (e.g. using IBurpExtender.getProxyHistory()). Conversely, the getter methods relating to response details can only be used after the message has been forwarded to the application.
Method Summary | |
---|---|
java.lang.String |
getComment()
Returns the user-annotated comment for this item, if applicable. |
java.lang.String |
getHost()
Returns the name of the application host. |
int |
getPort()
Returns the port number used by the application. |
java.lang.String |
getProtocol()
Returns the protocol used by the application. |
byte[] |
getRequest()
Returns the full request contents. |
byte[] |
getResponse()
Returns the full response contents. |
short |
getStatusCode()
Returns the HTTP status code contained within the response. |
java.net.URL |
getUrl()
Returns the URL within the request. |
void |
setComment(java.lang.String comment)
Sets the user-annotated comment for this item. |
void |
setHost(java.lang.String host)
Sets the name of the application host to which the request should be sent. |
void |
setPort(int port)
Sets the port number to which the request should be sent. |
void |
setProtocol(java.lang.String protocol)
Sets the protocol which should be used by the request. |
void |
setRequest(byte[] message)
Sets the request contents which should be sent to the application. |
void |
setResponse(byte[] message)
Sets the response contents which should be processed by the invoking Burp tool. |
Method Detail |
---|
java.lang.String getHost()
int getPort()
java.lang.String getProtocol()
void setHost(java.lang.String host) throws java.lang.Exception
host
- The name of the application host to which the request should
be sent.
java.lang.Exception
void setPort(int port) throws java.lang.Exception
port
- The port number to which the request should be sent.
java.lang.Exception
void setProtocol(java.lang.String protocol) throws java.lang.Exception
protocol
- The protocol which should be used by the request. Valid
values are "http" and "https".
java.lang.Exception
byte[] getRequest() throws java.lang.Exception
java.lang.Exception
java.net.URL getUrl() throws java.lang.Exception
java.lang.Exception
void setRequest(byte[] message) throws java.lang.Exception
message
- The request contents which should be sent to the
application.
java.lang.Exception
byte[] getResponse() throws java.lang.Exception
java.lang.Exception
void setResponse(byte[] message) throws java.lang.Exception
message
- The response contents which should be processed by the
invoking Burp tool.
java.lang.Exception
short getStatusCode() throws java.lang.Exception
java.lang.Exception
java.lang.String getComment() throws java.lang.Exception
java.lang.Exception
void setComment(java.lang.String comment) throws java.lang.Exception
comment
- The comment to be associated with this item.
java.lang.Exception