Module org.eclipse.jetty.http

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:

java.lang.Comparable<PathSpec>, PathSpec

public class ServletPathSpec
extends AbstractPathSpec

Constructor Summary

Constructors

Constructor	Description
ServletPathSpec(java.lang.String servletPathSpec)

Method Summary

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
static boolean	match(java.lang.String pathSpec, java.lang.String path)
static boolean	match(java.lang.String pathSpec, java.lang.String path, boolean noDefault)
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 '/'
static java.lang.String	pathInfo(java.lang.String pathSpec, java.lang.String path)	Return the portion of a path that is after a path spec.
static java.lang.String	pathMatch(java.lang.String pathSpec, java.lang.String path)	Return the portion of a path that matches a path spec.
static java.lang.String	relativePath(java.lang.String base, java.lang.String pathSpec, java.lang.String path)	Relative path.

Methods inherited from class org.eclipse.jetty.http.pathmap.AbstractPathSpec

compareTo, equals, hashCode, toString

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

match

public static boolean match(java.lang.String pathSpec,
                            java.lang.String path)

Parameters:

pathSpec - the path spec

path - the path

Returns:

true if match.

match

public static boolean match(java.lang.String pathSpec,
                            java.lang.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 java.lang.String pathMatch(java.lang.String pathSpec,
                                         java.lang.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 java.lang.String pathInfo(java.lang.String pathSpec,
                                        java.lang.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 java.lang.String relativePath(java.lang.String base,
                                            java.lang.String pathSpec,
                                            java.lang.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

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