Jetty 12.0.6 · org.eclipse.jetty.http.pathmap.ServletPathSpec

Modifier and Type	Field and Description
private final String	_declaration
private final PathSpecGroup	_group
private final int	_matchLength
private final int	_pathDepth
private final String	_prefix
private final MatchedPath	_preMatchedPath
private final int	_specLength
private final String	_suffix
private static final Logger	LOG

Access	Constructor and Description
public	ServletPathSpec(String servletPathSpec)

Method Summary

Modifier and Type	Method and Description
private static void	assertValidServletPathSpec(String servletPathSpec)
public String	getDeclaration() Implements org.eclipse.jetty.http.pathmap.PathSpec.getDeclaration. The as-provided path spec.
public PathSpecGroup	getGroup() Implements org.eclipse.jetty.http.pathmap.PathSpec.getGroup. The spec group.
public int	getPathDepth() Implements org.eclipse.jetty.http.pathmap.PathSpec.getPathDepth. Get the number of path elements that this path spec declares.
public String	getPathInfo(String the path to match against path) Implements org.eclipse.jetty.http.pathmap.PathSpec.getPathInfo. Deprecated use `matched(String)`#`MatchedPath#getPathInfo()` instead. Return the portion of the path that is after the path spec.
public String	getPathMatch(String the path to match against path) Implements org.eclipse.jetty.http.pathmap.PathSpec.getPathMatch. Deprecated use `matched(String)`#`MatchedPath#getPathMatch()` instead. Return the portion of the path that matches a path spec.
public String	getPrefix() Implements org.eclipse.jetty.http.pathmap.PathSpec.getPrefix. A simple prefix match for the pathspec or null
public int	getSpecLength() Implements org.eclipse.jetty.http.pathmap.PathSpec.getSpecLength. The length of the spec.
public String	getSuffix() Implements org.eclipse.jetty.http.pathmap.PathSpec.getSuffix. A simple suffix match for the pathspec or null
private static boolean	isPathWildcardMatch(String pathSpec, String path)
private boolean	isWildcardMatch(String path)
public static boolean	match(String the path spec pathSpec, String the path path) Returns: true if match.
public static boolean	match(String the path spec pathSpec, String the path path, boolean true to not handle the default path "/" special, false to allow matcher rules to run noDefault) Returns: true if match.
public MatchedPath	matched(String the path to test path) Implements org.eclipse.jetty.http.pathmap.PathSpec.matched. Get the complete matched details of the provided path.
public boolean	matches(String the path to test path) Overrides default org.eclipse.jetty.http.pathmap.PathSpec.matches. Test to see if the provided path matches this path spec.
public static String	Returns: the pathSpec prefixed by '/' if appropriate normalize(String the servlet or filter mapping pattern pathSpec) If a servlet or filter path mapping isn't a suffix mapping, ensure it starts with '/'
public static String	Returns: The path info string pathInfo(String the path spec pathSpec, String the path path) Return the portion of a path that is after a path spec.
public static String	Returns: null if no match at all. pathMatch(String the path spec pathSpec, String the path path) Return the portion of a path that matches a path spec.
public static String	Returns: base plus path with pathspec removed relativePath(String The base the path is relative to. base, String The spec of the path segment to ignore. pathSpec, String the additional path path) Relative path.

Inherited from org.eclipse.jetty.http.pathmap.AbstractPathSpec:: compareTo equals hashCode toString

_declaration	back to summary
private final String _declaration

_group	back to summary
private final PathSpecGroup _group

_matchLength	back to summary
private final int _matchLength

_pathDepth	back to summary
private final int _pathDepth

_prefix	back to summary
private final String _prefix

_preMatchedPath	back to summary
private final MatchedPath _preMatchedPath

_specLength	back to summary
private final int _specLength

_suffix	back to summary
private final String _suffix

LOG	back to summary
private static final Logger LOG

ServletPathSpec	back to summary
public ServletPathSpec(String servletPathSpec)

Method Detail

assertValidServletPathSpec	back to summary
private static void assertValidServletPathSpec(String servletPathSpec)

getDeclaration	back to summary
public String getDeclaration() Implements org.eclipse.jetty.http.pathmap.PathSpec.getDeclaration. Doc from org.eclipse.jetty.http.pathmap.PathSpec.getDeclaration. The as-provided path spec. Returns:String the as-provided path spec Annotations @Override

getDeclaration

back to summary

public String getDeclaration()

Implements org.eclipse.jetty.http.pathmap.PathSpec.getDeclaration.

Doc from org.eclipse.jetty.http.pathmap.PathSpec.getDeclaration.

The as-provided path spec.

Returns:String

the as-provided path spec

Annotations

@Override

getGroup	back to summary
public PathSpecGroup getGroup() Implements org.eclipse.jetty.http.pathmap.PathSpec.getGroup. Doc from org.eclipse.jetty.http.pathmap.PathSpec.getGroup. The spec group. Returns:PathSpecGroup the spec group. Annotations @Override

getGroup

back to summary

public PathSpecGroup getGroup()

Implements org.eclipse.jetty.http.pathmap.PathSpec.getGroup.

Doc from org.eclipse.jetty.http.pathmap.PathSpec.getGroup.

The spec group.

Returns:PathSpecGroup

the spec group.

Annotations

@Override

getPathDepth	back to summary
public int getPathDepth() Implements org.eclipse.jetty.http.pathmap.PathSpec.getPathDepth. Doc from org.eclipse.jetty.http.pathmap.PathSpec.getPathDepth. Get the number of path elements that this path spec declares. This is used to determine longest match logic. Returns:int the depth of the path segments that this spec declares Annotations @Override

getPathDepth

back to summary

public int getPathDepth()

Implements org.eclipse.jetty.http.pathmap.PathSpec.getPathDepth.

Doc from org.eclipse.jetty.http.pathmap.PathSpec.getPathDepth.

Get the number of path elements that this path spec declares.

This is used to determine longest match logic.

Returns:int

the depth of the path segments that this spec declares

Annotations

@Override

getPathInfo back to summary

getPathInfo	back to summary
public String getPathInfo(String path) Implements org.eclipse.jetty.http.pathmap.PathSpec.getPathInfo. Doc from org.eclipse.jetty.http.pathmap.PathSpec.getPathInfo. Deprecated use `matched(String)`#`MatchedPath#getPathInfo()` instead. Return the portion of the path that is after the path spec. Parameters path:String the path to match against Returns:String the path info portion of the string Annotations @Deprecated @Override

public String getPathInfo(String path)

Implements org.eclipse.jetty.http.pathmap.PathSpec.getPathInfo.

Doc from org.eclipse.jetty.http.pathmap.PathSpec.getPathInfo.

Deprecated

use matched(String)#MatchedPath#getPathInfo() instead.

Return the portion of the path that is after the path spec.

Parameters

path:String: the path to match against

Returns:String

the path info portion of the string

Annotations

@Deprecated
@Override

getPathMatch back to summary

getPathMatch	back to summary
public String getPathMatch(String path) Implements org.eclipse.jetty.http.pathmap.PathSpec.getPathMatch. Doc from org.eclipse.jetty.http.pathmap.PathSpec.getPathMatch. Deprecated use `matched(String)`#`MatchedPath#getPathMatch()` instead. Return the portion of the path that matches a path spec. Parameters path:String the path to match against Returns:String the match, or null if no match at all Annotations @Deprecated @Override

public String getPathMatch(String path)

Implements org.eclipse.jetty.http.pathmap.PathSpec.getPathMatch.

Doc from org.eclipse.jetty.http.pathmap.PathSpec.getPathMatch.

Deprecated

use matched(String)#MatchedPath#getPathMatch() instead.

Return the portion of the path that matches a path spec.

Parameters

path:String: the path to match against

Returns:String

the match, or null if no match at all

Annotations

@Deprecated
@Override

getPrefix	back to summary
public String getPrefix() Implements org.eclipse.jetty.http.pathmap.PathSpec.getPrefix. Doc from org.eclipse.jetty.http.pathmap.PathSpec.getPrefix. A simple prefix match for the pathspec or null Returns:String A simple prefix match for the pathspec or null Annotations @Override

getPrefix

back to summary

public String getPrefix()

Implements org.eclipse.jetty.http.pathmap.PathSpec.getPrefix.

Doc from org.eclipse.jetty.http.pathmap.PathSpec.getPrefix.

A simple prefix match for the pathspec or null

Returns:String

A simple prefix match for the pathspec or null

Annotations

@Override

getSpecLength	back to summary
public int getSpecLength() Implements org.eclipse.jetty.http.pathmap.PathSpec.getSpecLength. Doc from org.eclipse.jetty.http.pathmap.PathSpec.getSpecLength. The length of the spec. Returns:int the length of the spec. Annotations @Override

getSpecLength

back to summary

public int getSpecLength()

Implements org.eclipse.jetty.http.pathmap.PathSpec.getSpecLength.

Doc from org.eclipse.jetty.http.pathmap.PathSpec.getSpecLength.

The length of the spec.

Returns:int

the length of the spec.

Annotations

@Override

getSuffix	back to summary
public String getSuffix() Implements org.eclipse.jetty.http.pathmap.PathSpec.getSuffix. Doc from org.eclipse.jetty.http.pathmap.PathSpec.getSuffix. A simple suffix match for the pathspec or null Returns:String A simple suffix match for the pathspec or null Annotations @Override

getSuffix

back to summary

public String getSuffix()

Implements org.eclipse.jetty.http.pathmap.PathSpec.getSuffix.

Doc from org.eclipse.jetty.http.pathmap.PathSpec.getSuffix.

A simple suffix match for the pathspec or null

Returns:String

A simple suffix match for the pathspec or null

Annotations

@Override

isPathWildcardMatch	back to summary
private static boolean isPathWildcardMatch(String pathSpec, String path)

isWildcardMatch	back to summary
private boolean isWildcardMatch(String path)

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

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

matched	back to summary
public MatchedPath matched(String path) Implements org.eclipse.jetty.http.pathmap.PathSpec.matched. Doc from org.eclipse.jetty.http.pathmap.PathSpec.matched. Get the complete matched details of the provided path. Parameters path:String the path to test Returns:MatchedPath the matched details, if a match was possible, or null if not able to be matched. Annotations @Override

matched

back to summary

public MatchedPath matched(String path)

Implements org.eclipse.jetty.http.pathmap.PathSpec.matched.

Doc from org.eclipse.jetty.http.pathmap.PathSpec.matched.

Get the complete matched details of the provided path.

Parameters

path:String: the path to test

Returns:MatchedPath

the matched details, if a match was possible, or null if not able to be matched.

Annotations

@Override

matches back to summary

matches	back to summary
public boolean matches(String path) Overrides default org.eclipse.jetty.http.pathmap.PathSpec.matches. Doc from org.eclipse.jetty.http.pathmap.PathSpec.matches. Test to see if the provided path matches this path spec. This can be more efficient that `matched(String)` if the details of the match are not required. Parameters path:String the path to test Returns:boolean true if the path matches this path spec, false otherwise Annotations @Override

public boolean matches(String path)

Overrides default org.eclipse.jetty.http.pathmap.PathSpec.matches.

Doc from org.eclipse.jetty.http.pathmap.PathSpec.matches.

Test to see if the provided path matches this path spec. This can be more efficient that matched(String) if the details of the match are not required.

Parameters

path:String: the path to test

Returns:boolean

true if the path matches this path spec, false otherwise

Annotations

@Override

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

normalize

back to summary

public static String normalize(String pathSpec)

If a servlet or filter path mapping isn't a suffix mapping, ensure it starts with '/'

Parameters

pathSpec:String: the servlet or filter mapping pattern

Returns:String

the pathSpec prefixed by '/' if appropriate

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

pathInfo

back to summary

public static String pathInfo(String pathSpec, String path)

Return the portion of a path that is after a path spec.

Parameters

pathSpec:String: the path spec
path:String: the path

Returns:String

The path info string

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

pathMatch

back to summary

public static String pathMatch(String pathSpec, String path)

Return the portion of a path that matches a path spec.

Parameters

pathSpec:String: the path spec
path:String: the path

Returns:String

null if no match at all.

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

relativePath

back to summary

public static String relativePath(String base, String pathSpec, String path)

Relative path.

Parameters

base:String: The base the path is relative to.
pathSpec:String: The spec of the path segment to ignore.
path:String: the additional path

Returns:String

base plus path with pathspec removed

public Class ServletPathSpec

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail