org.zaproxy.zap.extension.search

Interface HttpSearcher

public interface HttpSearcher

Interface for search for patterns in contents of HTTP messages.

Since:

2.4.0

Method Summary

Modifier and Type	Method and Description
String	getName() Returns a descriptive name of the searcher, to be shown in UI components.
List<SearchResult>	search(Pattern pattern, boolean inverse) Searches the given pattern in the messages, possibly returning the inverse of the matches.
List<SearchResult>	search(Pattern pattern, boolean inverse, int maximumMatches) Searches the given pattern in the messages, possibly returning the inverse of the matches, up to the given maximum of matches.

Method Detail

getName

String getName()

Returns a descriptive name of the searcher, to be shown in UI components. The name must be internationalised.

Returns:

the name of the searcher, never null

search

List<SearchResult> search(Pattern pattern,
                          boolean inverse)

Searches the given pattern in the messages, possibly returning the inverse of the matches.

The exact HTTP message contents that will be matched depend on the implementations, for example, some might search only in requests others in responses.

Parameters:

pattern - the pattern to search in the messages

inverse - if should return the inverse of the matches

Returns:

a List containing the results of the search

search

List<SearchResult> search(Pattern pattern,
                          boolean inverse,
                          int maximumMatches)

Searches the given pattern in the messages, possibly returning the inverse of the matches, up to the given maximum of matches.

The exact HTTP message contents that will be matched depend on the implementations, for example, some might search only in requests others in responses.

Parameters:

pattern - the pattern to search in the messages

inverse - if should return the inverse of the matches

maximumMatches - the maximum of matches that should be returned

Returns:

a List containing the results of the search