org.springframework.web.util

Class ParsingPathMatcher

java.lang.Object

org.springframework.web.util.ParsingPathMatcher

All Implemented Interfaces:

PathMatcher

public class ParsingPathMatcher
extends java.lang.Object
implements PathMatcher

PathMatcher implementation for path patterns parsed as PathPatternParser and compiled as PathPatterns.

Once parsed, PathPatterns are tailored for fast matching and quick comparison.

Since:

5.0

Author:

Andy Clement

See Also:

PathPattern

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	ParsingPathMatcher.PathPatternStringComparatorConsideringPath

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.concurrent.ConcurrentMap<java.lang.String,PathPattern>	cache
private PathPatternParser	parser

Constructor Summary

Constructors

Constructor and Description
ParsingPathMatcher()

Method Summary

Modifier and Type	Method and Description
java.lang.String	combine(java.lang.String pattern1, java.lang.String pattern2) Combines two patterns into a new pattern that is returned.
java.lang.String	extractPathWithinPattern(java.lang.String pattern, java.lang.String path) Given a pattern and a full path, determine the pattern-mapped part.
java.util.Map<java.lang.String,java.lang.String>	extractUriTemplateVariables(java.lang.String pattern, java.lang.String path) Given a pattern and a full path, extract the URI template variables.
private PathPattern	getPathPattern(java.lang.String pattern)
java.util.Comparator<java.lang.String>	getPatternComparator(java.lang.String path) Given a full path, returns a Comparator suitable for sorting patterns in order of explicitness for that path.
boolean	isPattern(java.lang.String path) Does the given path represent a pattern that can be matched by an implementation of this interface?
boolean	match(java.lang.String pattern, java.lang.String path) Match the given path against the given pattern, according to this PathMatcher's matching strategy.
boolean	matchStart(java.lang.String pattern, java.lang.String path) Match the given path against the corresponding part of the given pattern, according to this PathMatcher's matching strategy.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

cache

private final java.util.concurrent.ConcurrentMap<java.lang.String,PathPattern> cache

parser

private final PathPatternParser parser

Constructor Detail

ParsingPathMatcher

public ParsingPathMatcher()

Method Detail

match

public boolean match(java.lang.String pattern,
                     java.lang.String path)

Description copied from interface: PathMatcher

Match the given path against the given pattern, according to this PathMatcher's matching strategy.

Specified by:

match in interface PathMatcher

Parameters:

pattern - the pattern to match against

path - the path String to test

Returns:

true if the supplied path matched, false if it didn't

matchStart

public boolean matchStart(java.lang.String pattern,
                          java.lang.String path)

Description copied from interface: PathMatcher

Match the given path against the corresponding part of the given pattern, according to this PathMatcher's matching strategy.

Determines whether the pattern at least matches as far as the given base path goes, assuming that a full path may then match as well.

Specified by:

matchStart in interface PathMatcher

Parameters:

pattern - the pattern to match against

path - the path String to test

Returns:

true if the supplied path matched, false if it didn't

extractPathWithinPattern

public java.lang.String extractPathWithinPattern(java.lang.String pattern,
                                                 java.lang.String path)

Description copied from interface: PathMatcher

Given a pattern and a full path, determine the pattern-mapped part.

This method is supposed to find out which part of the path is matched dynamically through an actual pattern, that is, it strips off a statically defined leading path from the given full path, returning only the actually pattern-matched part of the path.

For example: For "myroot/*.html" as pattern and "myroot/myfile.html" as full path, this method should return "myfile.html". The detailed determination rules are specified to this PathMatcher's matching strategy.

A simple implementation may return the given full path as-is in case of an actual pattern, and the empty String in case of the pattern not containing any dynamic parts (i.e. the pattern parameter being a static path that wouldn't qualify as an actual pattern). A sophisticated implementation will differentiate between the static parts and the dynamic parts of the given path pattern.

Specified by:

extractPathWithinPattern in interface PathMatcher

Parameters:

pattern - the path pattern

path - the full path to introspect

Returns:

the pattern-mapped part of the given path (never null)

extractUriTemplateVariables

public java.util.Map<java.lang.String,java.lang.String> extractUriTemplateVariables(java.lang.String pattern,
                                                                                    java.lang.String path)

Description copied from interface: PathMatcher

Given a pattern and a full path, extract the URI template variables. URI template variables are expressed through curly brackets ('{' and '}').

For example: For pattern "/hotels/{hotel}" and path "/hotels/1", this method will return a map containing "hotel"->"1".

Specified by:

extractUriTemplateVariables in interface PathMatcher

Parameters:

pattern - the path pattern, possibly containing URI templates

path - the full path to extract template variables from

Returns:

a map, containing variable names as keys; variables values as values

combine

public java.lang.String combine(java.lang.String pattern1,
                                java.lang.String pattern2)

Description copied from interface: PathMatcher

Combines two patterns into a new pattern that is returned.

The full algorithm used for combining the two pattern depends on the underlying implementation.

Specified by:

combine in interface PathMatcher

Parameters:

pattern1 - the first pattern

pattern2 - the second pattern

Returns:

the combination of the two patterns

getPatternComparator

public java.util.Comparator<java.lang.String> getPatternComparator(java.lang.String path)

Description copied from interface: PathMatcher

Given a full path, returns a Comparator suitable for sorting patterns in order of explicitness for that path.

The full algorithm used depends on the underlying implementation, but generally, the returned Comparator will sort a list so that more specific patterns come before generic patterns.

Specified by:

getPatternComparator in interface PathMatcher

Parameters:

path - the full path to use for comparison

Returns:

a comparator capable of sorting patterns in order of explicitness

isPattern

public boolean isPattern(java.lang.String path)

Description copied from interface: PathMatcher

Does the given path represent a pattern that can be matched by an implementation of this interface?

If the return value is false, then the PathMatcher.match(java.lang.String, java.lang.String) method does not have to be used because direct equality comparisons on the static path Strings will lead to the same result.

Specified by:

isPattern in interface PathMatcher

Parameters:

path - the path String to check

Returns:

true if the given path represents a pattern

getPathPattern

private PathPattern getPathPattern(java.lang.String pattern)