Modul org.xbib.net.path
Package org.xbib.net.path.spring

Klasse PathPatternParser

java.lang.Object
org.xbib.net.path.spring.PathPatternParser
public class PathPatternParser extends Object
Parser for URI path patterns producing PathPattern instances that can then be matched to requests.

The PathPatternParser and PathPattern are specifically designed for use with HTTP URL paths in web applications where a large number of URI path patterns, continuously matched against incoming requests, motivates the need for efficient matching.

For details of the path pattern syntax see PathPattern.

  • Felddetails

    • defaultInstance

      public static final PathPatternParser defaultInstance
      Shared, read-only instance of PathPatternParser. Uses default settings:
      • matchOptionalTrailingSeparator=true
      • caseSensitivetrue
      • pathOptions=PathContainer.Options.HTTP_PATH

  • Konstruktordetails

    • PathPatternParser

      public PathPatternParser()

  • Methodendetails

    • match

      public boolean match(String pattern, String string)

    • setMatchOptionalTrailingSeparator

      public void setMatchOptionalTrailingSeparator(boolean matchOptionalTrailingSeparator)
      Whether a PathPattern produced by this parser should automatically match request paths with a trailing slash. If set to true a PathPattern without a trailing slash will also match request paths with a trailing slash. If set to false a PathPattern will only match request paths with a trailing slash. The default is true.

    • isMatchOptionalTrailingSeparator

      public boolean isMatchOptionalTrailingSeparator()
      Whether optional trailing slashing match is enabled.

    • setCaseSensitive

      public void setCaseSensitive(boolean caseSensitive)
      Whether path pattern matching should be case-sensitive. The default is true.

    • isCaseSensitive

      public boolean isCaseSensitive()
      Whether case-sensitive pattern matching is enabled.

    • setPathOptions

      public void setPathOptions(PathContainer.Options pathOptions)
      Set options for parsing patterns. These should be the same as the options used to parse input paths. org.springframework.http.server.PathContainer.Options#HTTP_PATH is used by default.

    • getPathOptions

      public PathContainer.Options getPathOptions()
      Return the configured pattern parsing options.

    • parse

      public PathPattern parse(String pathPattern) throws PatternParseException
      Process the path pattern content, a character at a time, breaking it into path elements around separator boundaries and verifying the structure at each stage. Produces a PathPattern object that can be used for fast matching against paths.
      Parameter:
      pathPattern - the input path pattern, e.g. /project/{name}
      Gibt zurück:
      a PathPattern for quickly matching paths against request paths
      Löst aus:
      PatternParseException - in case of parse errors