Class ServletPathSpec

    • Constructor Summary

      Constructors 
      Constructor Description
      ServletPathSpec​(java.lang.String servletPathSpec)  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getDeclaration()
      The as-provided path spec.
      PathSpecGroup getGroup()
      The spec group.
      int getPathDepth()
      Get the number of path elements that this path spec declares.
      java.lang.String getPathInfo​(java.lang.String path)
      Return the portion of the path that is after the path spec.
      java.lang.String getPathMatch​(java.lang.String path)
      Return the portion of the path that matches a path spec.
      java.lang.String getPrefix()
      A simple prefix match for the pathspec or null
      int getSpecLength()
      The length of the spec.
      java.lang.String getSuffix()
      A simple suffix match for the pathspec or null
      boolean matches​(java.lang.String path)
      Test to see if the provided path matches this path spec
      static java.lang.String normalize​(java.lang.String pathSpec)
      If a servlet or filter path mapping isn't a suffix mapping, ensure it starts with '/'
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • ServletPathSpec

        public ServletPathSpec​(java.lang.String servletPathSpec)
    • Method Detail

      • normalize

        public static java.lang.String normalize​(java.lang.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
      • 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 java.lang.String getPathInfo​(java.lang.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 java.lang.String getPathMatch​(java.lang.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 java.lang.String getDeclaration()
        Description copied from interface: PathSpec
        The as-provided path spec.
        Returns:
        the as-provided path spec
      • getPrefix

        public java.lang.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 java.lang.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
      • matches

        public boolean matches​(java.lang.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