Package 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

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getName()
      Returns a descriptive name of the searcher, to be shown in UI components.
      java.util.List<SearchResult> search​(java.util.regex.Pattern pattern, boolean inverse)
      Searches the given pattern in the messages, possibly returning the inverse of the matches.
      java.util.List<SearchResult> search​(java.util.regex.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

        java.lang.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

        java.util.List<SearchResult> search​(java.util.regex.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

        java.util.List<SearchResult> search​(java.util.regex.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