Package burp.api.montoya.sitemap

Interface SiteMapFilter

public interface SiteMapFilter
This interface is used to filter items when querying Burp's site map.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    matches(SiteMapNode node)
    Invoked by Burp to check whether a given site map node matches the filter.
    static SiteMapFilter
    prefixFilter(String prefix)
    This method returns a site map filter object that matches site map nodes with URLs starting with the specified prefix.

  • Method Details

    • matches

      boolean matches(SiteMapNode node)
      Invoked by Burp to check whether a given site map node matches the filter.
      Parameters:
      node - Site map node to match.
      Returns:
      Returns true if the site map node matches the filter.

    • prefixFilter

      static SiteMapFilter prefixFilter(String prefix)
      This method returns a site map filter object that matches site map nodes with URLs starting with the specified prefix. Note that the prefix is case-sensitive.
      Parameters:
      prefix - Case-sensitive URL prefix used to match site tree nodes. If null is passed, the resulting filter will match all site map nodes.
      Returns:
      A site map filter object that matches nodes via a URL prefix