Class UriTemplatePathSpec

java.lang.Object
org.eclipse.jetty.http.pathmap.AbstractPathSpec
org.eclipse.jetty.http.pathmap.UriTemplatePathSpec
All Implemented Interfaces:
Comparable<PathSpec>, PathSpec
public class UriTemplatePathSpec extends AbstractPathSpec
PathSpec for URI Template based declarations
See Also:

  • Field Details

    • LOG

      private static final Logger LOG

    • VARIABLE_PATTERN

      private static final Pattern VARIABLE_PATTERN

    • VARIABLE_RESERVED

      private static final String VARIABLE_RESERVED
      Reserved Symbols in URI Template variable
      See Also:

    • VARIABLE_SYMBOLS

      private static final String VARIABLE_SYMBOLS
      Allowed Symbols in a URI Template variable
      See Also:

    • FORBIDDEN_SEGMENTS

      private static final Set<String> FORBIDDEN_SEGMENTS

    • _declaration

      private final String _declaration

    • _group

      private final PathSpecGroup _group

    • _pathDepth

      private final int _pathDepth

    • _specLength

      private final int _specLength

    • _pattern

      private final Pattern _pattern

    • _variables

      private final String[] _variables

    • _logicalDeclaration

      private final String _logicalDeclaration
      The logical (simplified) declaration

  • Constructor Details

    • UriTemplatePathSpec

      public UriTemplatePathSpec(String rawSpec)

  • Method Details

    • assertIsValidVariableLiteral

      private static void assertIsValidVariableLiteral(String variable, String declaration)
      Validate variable literal name, per RFC6570, Section 2.1 Literals

    • isValidBasicLiteralCodepoint

      private static boolean isValidBasicLiteralCodepoint(int codepoint, String declaration)

    • compareTo

      public int compareTo(PathSpec other)
      Specified by:
      compareTo in interface Comparable<PathSpec>
      Overrides:
      compareTo in class AbstractPathSpec

    • getPathParams

      public Map<String,String> getPathParams(String path)

    • getMatcher

      protected Matcher getMatcher(String path)

    • getSpecLength

      public int getSpecLength()
      Description copied from interface: PathSpec
      The length of the spec.
      Returns:
      the length of the spec.

    • getGroup

      public PathSpecGroup getGroup()
      Description copied from interface: PathSpec
      The spec group.
      Returns:
      the spec group.

    • getPathDepth

      public int getPathDepth()
      Description copied from interface: PathSpec
      Get the number of path elements that this path spec declares.

      This is used to determine longest match logic.

      Returns:
      the depth of the path segments that this spec declares

    • getPathInfo

      public String getPathInfo(String path)
      Description copied from interface: PathSpec
      Return the portion of the path that is after the path spec.
      Parameters:
      path - the path to match against
      Returns:
      the path info portion of the string

    • getPathMatch

      public String getPathMatch(String path)
      Description copied from interface: PathSpec
      Return the portion of the path that matches a path spec.
      Parameters:
      path - the path to match against
      Returns:
      the match, or null if no match at all

    • getDeclaration

      public String getDeclaration()
      Description copied from interface: PathSpec
      The as-provided path spec.
      Returns:
      the as-provided path spec

    • getPrefix

      public String getPrefix()
      Description copied from interface: PathSpec
      A simple prefix match for the pathspec or null
      Returns:
      A simple prefix match for the pathspec or null

    • getSuffix

      public String getSuffix()
      Description copied from interface: PathSpec
      A simple suffix match for the pathspec or null
      Returns:
      A simple suffix match for the pathspec or null

    • getPattern

      public Pattern getPattern()

    • matches

      public boolean matches(String path)
      Description copied from interface: PathSpec
      Test to see if the provided path matches this path spec
      Parameters:
      path - the path to test
      Returns:
      true if the path matches this path spec, false otherwise

    • matched

      public MatchedPath matched(String path)
      Description copied from interface: PathSpec
      Get the complete matched details of the provided path.
      Parameters:
      path - the path to test
      Returns:
      the matched details, if a match was possible, or null if not able to be matched.

    • getVariableCount

      public int getVariableCount()

    • getVariables

      public String[] getVariables()