Package org.eclipse.jetty.http.pathmap

Class ServletPathSpec

java.lang.Object
org.eclipse.jetty.http.pathmap.AbstractPathSpec
org.eclipse.jetty.http.pathmap.ServletPathSpec
All Implemented Interfaces:
Comparable<PathSpec>, PathSpec
public class ServletPathSpec extends AbstractPathSpec

  • Constructor Details

    • ServletPathSpec

      public ServletPathSpec(String servletPathSpec)

  • Method Details

    • normalize

      public static String normalize(String pathSpec)
      If a servlet or filter path mapping isn't a suffix mapping, ensure it starts with '/'
      Parameters:
      pathSpec - the servlet or filter mapping pattern
      Returns:
      the pathSpec prefixed by '/' if appropriate

    • match

      public static boolean match(String pathSpec, String path)
      Parameters:
      pathSpec - the path spec
      path - the path
      Returns:
      true if match.

    • match

      public static boolean match(String pathSpec, String path, boolean noDefault)
      Parameters:
      pathSpec - the path spec
      path - the path
      noDefault - true to not handle the default path "/" special, false to allow matcher rules to run
      Returns:
      true if match.

    • pathMatch

      public static String pathMatch(String pathSpec, String path)
      Return the portion of a path that matches a path spec.
      Parameters:
      pathSpec - the path spec
      path - the path
      Returns:
      null if no match at all.

    • pathInfo

      public static String pathInfo(String pathSpec, String path)
      Return the portion of a path that is after a path spec.
      Parameters:
      pathSpec - the path spec
      path - the path
      Returns:
      The path info string

    • relativePath

      public static String relativePath(String base, String pathSpec, String path)
      Relative path.
      Parameters:
      base - The base the path is relative to.
      pathSpec - The spec of the path segment to ignore.
      path - the additional path
      Returns:
      base plus path with pathspec removed

    • 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

      @Deprecated public String getPathInfo(String path)
      Deprecated.
      use matched(String)#MatchedPath.getPathInfo() instead.
      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

      @Deprecated public String getPathMatch(String path)
      Deprecated.
      use matched(String)#MatchedPath.getPathMatch() instead.
      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

    • 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.

    • 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