burp
Interface IResponseKeywords


public interface IResponseKeywords

This interface is used to represent the counts of keywords appearing in a number of HTTP responses.


Method Summary
 java.util.List<java.lang.String> getInvariantKeywords()
          This method is used to obtain the list of keywords whose counts do not vary between the analyzed responses.
 int getKeywordCount(java.lang.String keyword, int responseIndex)
          This method is used to obtain the number of occurrences of an individual keyword in a response.
 java.util.List<java.lang.String> getVariantKeywords()
          This method is used to obtain the list of keywords whose counts vary between the analyzed responses.
 void updateWith(byte[]... responses)
          This method is used to update the analysis based on additional responses.
 

Method Detail

getVariantKeywords

java.util.List<java.lang.String> getVariantKeywords()
This method is used to obtain the list of keywords whose counts vary between the analyzed responses.

Returns:
The keywords whose counts vary between the analyzed responses.

getInvariantKeywords

java.util.List<java.lang.String> getInvariantKeywords()
This method is used to obtain the list of keywords whose counts do not vary between the analyzed responses.

Returns:
The keywords whose counts do not vary between the analyzed responses.

getKeywordCount

int getKeywordCount(java.lang.String keyword,
                    int responseIndex)
This method is used to obtain the number of occurrences of an individual keyword in a response.

Parameters:
keyword - The keyword whose count will be retrieved.
responseIndex - The index of the response. Note responses are indexed from zero in the order they were originally supplied to the IExtensionHelpers.analyzeResponseKeywords() and IResponseKeywords.updateWith() methods.
Returns:
The number of occurrences of the specified keyword for the specified response.

updateWith

void updateWith(byte[]... responses)
This method is used to update the analysis based on additional responses.

Parameters:
responses - The new responses to include in the analysis.