burp
Interface IParameter


public interface IParameter

This interface is used to hold details about an HTTP request parameter.


Field Summary
static byte PARAM_BODY
          Used to indicate a parameter within the message body.
static byte PARAM_COOKIE
          Used to indicate an HTTP cookie.
static byte PARAM_JSON
          Used to indicate an item of data within a JSON structure.
static byte PARAM_MULTIPART_ATTR
          Used to indicate the value of a parameter attribute within a multi-part message body (such as the name of an uploaded file).
static byte PARAM_URL
          Used to indicate a parameter within the URL query string.
static byte PARAM_XML
          Used to indicate an item of data within an XML structure.
static byte PARAM_XML_ATTR
          Used to indicate the value of a tag attribute within an XML structure.
 
Method Summary
 java.lang.String getName()
          This method is used to retrieve the parameter name.
 int getNameEnd()
          This method is used to retrieve the end offset of the parameter name within the HTTP request.
 int getNameStart()
          This method is used to retrieve the start offset of the parameter name within the HTTP request.
 byte getType()
          This method is used to retrieve the parameter type.
 java.lang.String getValue()
          This method is used to retrieve the parameter value.
 int getValueEnd()
          This method is used to retrieve the end offset of the parameter value within the HTTP request.
 int getValueStart()
          This method is used to retrieve the start offset of the parameter value within the HTTP request.
 

Field Detail

PARAM_URL

static final byte PARAM_URL
Used to indicate a parameter within the URL query string.

See Also:
Constant Field Values

PARAM_BODY

static final byte PARAM_BODY
Used to indicate a parameter within the message body.

See Also:
Constant Field Values

PARAM_COOKIE

static final byte PARAM_COOKIE
Used to indicate an HTTP cookie.

See Also:
Constant Field Values

PARAM_XML

static final byte PARAM_XML
Used to indicate an item of data within an XML structure.

See Also:
Constant Field Values

PARAM_XML_ATTR

static final byte PARAM_XML_ATTR
Used to indicate the value of a tag attribute within an XML structure.

See Also:
Constant Field Values

PARAM_MULTIPART_ATTR

static final byte PARAM_MULTIPART_ATTR
Used to indicate the value of a parameter attribute within a multi-part message body (such as the name of an uploaded file).

See Also:
Constant Field Values

PARAM_JSON

static final byte PARAM_JSON
Used to indicate an item of data within a JSON structure.

See Also:
Constant Field Values
Method Detail

getType

byte getType()
This method is used to retrieve the parameter type.

Returns:
The parameter type. The available types are defined within this interface.

getName

java.lang.String getName()
This method is used to retrieve the parameter name.

Returns:
The parameter name.

getValue

java.lang.String getValue()
This method is used to retrieve the parameter value.

Returns:
The parameter value.

getNameStart

int getNameStart()
This method is used to retrieve the start offset of the parameter name within the HTTP request.

Returns:
The start offset of the parameter name within the HTTP request, or -1 if the parameter is not associated with a specific request.

getNameEnd

int getNameEnd()
This method is used to retrieve the end offset of the parameter name within the HTTP request.

Returns:
The end offset of the parameter name within the HTTP request, or -1 if the parameter is not associated with a specific request.

getValueStart

int getValueStart()
This method is used to retrieve the start offset of the parameter value within the HTTP request.

Returns:
The start offset of the parameter value within the HTTP request, or -1 if the parameter is not associated with a specific request.

getValueEnd

int getValueEnd()
This method is used to retrieve the end offset of the parameter value within the HTTP request.

Returns:
The end offset of the parameter value within the HTTP request, or -1 if the parameter is not associated with a specific request.