Modifier and Type	Class and Description
private static class	ServletRequestPathUtils.ServletRequestPath Simple wrapper around the default `RequestPath` implementation that supports a servletPath as an additional prefix to be omitted from `pathWithinApplication()`.

Modifier and Type	Field and Description
public static final String	PATH_ATTRIBUTE Name of Servlet request attribute that holds the parsed `RequestPath`.

Access	Constructor and Description
public	ServletRequestPathUtils()

Method Summary

Modifier and Type	Method and Description
public static void	clearParsedRequestPath(ServletRequest request) Remove the request attribute `PATH_ATTRIBUTE` that holds a `previously` parsed and cached `RequestPath`.
public static Object	Returns: a String lookupPath or a `RequestPath` getCachedPath(ServletRequest the current request request) Return either a `pre-resolved` String lookupPath or a `pre-parsed` `RequestPath`.
public static String	Returns: the full request mapping path as a String getCachedPathValue(ServletRequest the current request request) Variant of `getCachedPath(ServletRequest)` that returns the path for request mapping as a String.
public static RequestPath	getParsedRequestPath(ServletRequest request) Return a `previously` parsed and cached `RequestPath`.
public static boolean	Returns: whether a pre-resolved or pre-parsed path is available hasCachedPath(ServletRequest the current request request) Check for a previously `resolved` String lookupPath or a previously `parsed` `RequestPath`.
public static boolean	hasParsedRequestPath(ServletRequest request) Check for a `previously` parsed and cached `RequestPath`.
public static RequestPath	parseAndCache(HttpServletRequest request) Parse the `requestURI` to a `RequestPath` and save it in the request attribute `PATH_ATTRIBUTE` for subsequent use with `parsed patterns`.
public static void	setParsedRequestPath(RequestPath the value to set to, or if `null` the cache value is cleared. requestPath, ServletRequest the current request request) Set the cached, parsed `RequestPath` to the given value.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

PATH_ATTRIBUTE	back to summary
public static final String PATH_ATTRIBUTE Name of Servlet request attribute that holds the parsed `RequestPath`.

ServletRequestPathUtils	back to summary
public ServletRequestPathUtils()

Method Detail

clearParsedRequestPath	back to summary
public static void clearParsedRequestPath(ServletRequest request) Remove the request attribute `PATH_ATTRIBUTE` that holds a `previously` parsed and cached `RequestPath`.

getCachedPath back to summary

getCachedPath	back to summary
public static Object getCachedPath(ServletRequest request) Return either a `pre-resolved` String lookupPath or a `pre-parsed` `RequestPath`. In Spring MVC, when at least one `HandlerMapping` has parsed `PathPatterns` enabled, the `DispatcherServlet` parses and caches the `RequestPath` which can be also done even earlier with `ServletRequestPathFilter`. In other cases where `HandlerMapping`s use String pattern matching with `PathMatcher`, the String lookupPath is resolved separately in each `HandlerMapping`. Parameters request:ServletRequest the current request Returns:Object a String lookupPath or a `RequestPath` Exceptions IllegalArgumentException: if neither is available

public static Object getCachedPath(ServletRequest request)

Return either a pre-resolved String lookupPath or a pre-parsed RequestPath.

In Spring MVC, when at least one HandlerMapping has parsed PathPatterns enabled, the DispatcherServlet parses and caches the RequestPath which can be also done even earlier with ServletRequestPathFilter. In other cases where HandlerMappings use String pattern matching with PathMatcher, the String lookupPath is resolved separately in each HandlerMapping.

Parameters

request:ServletRequest: the current request

Returns:Object

a String lookupPath or a RequestPath

Exceptions

IllegalArgumentException:: if neither is available

getCachedPathValue back to summary

getCachedPathValue	back to summary
public static String getCachedPathValue(ServletRequest request) Variant of `getCachedPath(ServletRequest)` that returns the path for request mapping as a String. If the cached path is a `pre-parsed` `RequestPath` then the returned String path value is encoded and with path parameters removed. If the cached path is a `pre-resolved` String lookupPath, then the returned String path value depends on how `UrlPathHelper` that resolved is configured. Parameters request:ServletRequest the current request Returns:String the full request mapping path as a String

public static String getCachedPathValue(ServletRequest request)

Variant of getCachedPath(ServletRequest) that returns the path for request mapping as a String.

If the cached path is a pre-parsed RequestPath then the returned String path value is encoded and with path parameters removed.

If the cached path is a pre-resolved String lookupPath, then the returned String path value depends on how UrlPathHelper that resolved is configured.

Parameters

request:ServletRequest: the current request

Returns:String

the full request mapping path as a String

getParsedRequestPath back to summary

getParsedRequestPath	back to summary
public static RequestPath getParsedRequestPath(ServletRequest request) Return a `previously` parsed and cached `RequestPath`. Exceptions IllegalArgumentException: if not found

public static RequestPath getParsedRequestPath(ServletRequest request)

Return a previously parsed and cached RequestPath.

Exceptions

IllegalArgumentException:: if not found

hasCachedPath back to summary

hasCachedPath	back to summary
public static boolean hasCachedPath(ServletRequest request) Check for a previously `resolved` String lookupPath or a previously `parsed` `RequestPath`. Parameters request:ServletRequest the current request Returns:boolean whether a pre-resolved or pre-parsed path is available

public static boolean hasCachedPath(ServletRequest request)

Check for a previously resolved String lookupPath or a previously parsed RequestPath.

Parameters

request:ServletRequest: the current request

Returns:boolean

whether a pre-resolved or pre-parsed path is available

hasParsedRequestPath	back to summary
public static boolean hasParsedRequestPath(ServletRequest request) Check for a `previously` parsed and cached `RequestPath`.

parseAndCache back to summary

parseAndCache	back to summary
public static RequestPath parseAndCache(HttpServletRequest request) Parse the `requestURI` to a `RequestPath` and save it in the request attribute `PATH_ATTRIBUTE` for subsequent use with `parsed patterns`. The returned `RequestPath` will have both the contextPath and any servletPath prefix omitted from the `pathWithinApplication` it exposes. This method is typically called by the `DispatcherServlet` to determine if any `HandlerMapping` indicates that it uses parsed patterns. After that the pre-parsed and cached `RequestPath` can be accessed through `getParsedRequestPath(ServletRequest)`.

public static RequestPath parseAndCache(HttpServletRequest request)

Parse the requestURI to a RequestPath and save it in the request attribute PATH_ATTRIBUTE for subsequent use with parsed patterns.

The returned RequestPath will have both the contextPath and any servletPath prefix omitted from the pathWithinApplication it exposes.

This method is typically called by the DispatcherServlet to determine if any HandlerMapping indicates that it uses parsed patterns. After that the pre-parsed and cached RequestPath can be accessed through getParsedRequestPath(ServletRequest).

setParsedRequestPath back to summary

setParsedRequestPath	back to summary
public static void setParsedRequestPath(RequestPath requestPath, ServletRequest request) Set the cached, parsed `RequestPath` to the given value. Parameters requestPath:RequestPath the value to set to, or if `null` the cache value is cleared. request:ServletRequest the current request Since 5.3.3

public static void setParsedRequestPath(RequestPath requestPath, ServletRequest request)

Set the cached, parsed RequestPath to the given value.

Parameters

requestPath:RequestPath: the value to set to, or if null the cache value is cleared.
request:ServletRequest: the current request

Since

5.3.3

org.springframework.web.util back to summary

private final Class ServletRequestPathUtils.ServletRequestPath

Class Inheritance

extends Object
implements RequestPath

java.lang.Object
org.springframework.web.util.ServletRequestPathUtils.ServletRequestPath

All Implemented Interfaces

org.springframework.http.server.RequestPath, org.springframework.http.server.PathContainer

Simple wrapper around the default RequestPath implementation that supports a servletPath as an additional prefix to be omitted from pathWithinApplication().

Field Summary

Modifier and Type	Field and Description
private final PathContainer	contextPath
private final RequestPath	requestPath

Constructor Summary

Access	Constructor and Description
private	ServletRequestPath(String rawPath, String contextPath, String servletPathPrefix)

Method Summary

Modifier and Type	Method and Description
public PathContainer	contextPath() Implements org.springframework.http.server.RequestPath.contextPath. Returns the portion of the URL path that represents the application.
public List<PathContainer.Element>	elements() Implements org.springframework.http.server.PathContainer.elements. The contained path elements, either `Separator` or `PathSegment`.
public boolean	equals(Object the reference object with which to compare. other) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
private static String	getServletPathPrefix(HttpServletRequest request)
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public RequestPath	modifyContextPath(String the new context path contextPath) Implements org.springframework.http.server.RequestPath.modifyContextPath. Return a new `RequestPath` instance with a modified context path.
public static RequestPath	parse(HttpServletRequest request)
public PathContainer	pathWithinApplication() Implements org.springframework.http.server.RequestPath.pathWithinApplication. The portion of the request path after the context path which is typically used for request mapping within the application.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public String	value() Implements org.springframework.http.server.PathContainer.value. The original path from which this instance was parsed.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

contextPath	back to summary
private final PathContainer contextPath

requestPath	back to summary
private final RequestPath requestPath

Constructor Detail

ServletRequestPath	back to summary
private ServletRequestPath(String rawPath, String contextPath, String servletPathPrefix)

Method Detail

contextPath back to summary

contextPath	back to summary
public PathContainer contextPath() Implements org.springframework.http.server.RequestPath.contextPath. Doc from org.springframework.http.server.RequestPath.contextPath. Returns the portion of the URL path that represents the application. The context path is always at the beginning of the path and starts but does not end with "/". It is shared for URLs of the same application. The context path may come from the underlying runtime API such as when deploying as a WAR to a Servlet container or it may be assigned in a WebFlux application through the use of `ContextPathCompositeHandler`. Annotations @Override

public PathContainer contextPath()

Implements org.springframework.http.server.RequestPath.contextPath.

Doc from org.springframework.http.server.RequestPath.contextPath.

Returns the portion of the URL path that represents the application. The context path is always at the beginning of the path and starts but does not end with "/". It is shared for URLs of the same application.

The context path may come from the underlying runtime API such as when deploying as a WAR to a Servlet container or it may be assigned in a WebFlux application through the use of ContextPathCompositeHandler.

Annotations

@Override

elements back to summary

elements	back to summary
public List<PathContainer.Element> elements() Implements org.springframework.http.server.PathContainer.elements. Doc from org.springframework.http.server.PathContainer.elements. The contained path elements, either `Separator` or `PathSegment`. Annotations @Override

public List<PathContainer.Element> elements()

Implements org.springframework.http.server.PathContainer.elements.

Doc from org.springframework.http.server.PathContainer.elements.

The contained path elements, either Separator or PathSegment.

Annotations

@Override

equals back to summary

equals	back to summary
public boolean equals(Object other) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters other:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object other)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

other:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getServletPathPrefix	back to summary
private static String getServletPathPrefix(HttpServletRequest request) Annotations @Nullable

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

modifyContextPath back to summary

modifyContextPath	back to summary
public RequestPath modifyContextPath(String contextPath) Implements org.springframework.http.server.RequestPath.modifyContextPath. Doc from org.springframework.http.server.RequestPath.modifyContextPath. Return a new `RequestPath` instance with a modified context path. The new context path must match 0 or more path segments at the start. Parameters contextPath:String the new context path Returns:RequestPath a new `RequestPath` instance Annotations @Override

public RequestPath modifyContextPath(String contextPath)

Implements org.springframework.http.server.RequestPath.modifyContextPath.

Doc from org.springframework.http.server.RequestPath.modifyContextPath.

Return a new RequestPath instance with a modified context path. The new context path must match 0 or more path segments at the start.

Parameters

contextPath:String: the new context path

Returns:RequestPath

a new RequestPath instance

Annotations

@Override

parse	back to summary
public static RequestPath parse(HttpServletRequest request)

pathWithinApplication	back to summary
public PathContainer pathWithinApplication() Implements org.springframework.http.server.RequestPath.pathWithinApplication. Doc from org.springframework.http.server.RequestPath.pathWithinApplication. The portion of the request path after the context path which is typically used for request mapping within the application. Annotations @Override

pathWithinApplication

back to summary

public PathContainer pathWithinApplication()

Implements org.springframework.http.server.RequestPath.pathWithinApplication.

Doc from org.springframework.http.server.RequestPath.pathWithinApplication.

The portion of the request path after the context path which is typically used for request mapping within the application.

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

value	back to summary
public String value() Implements org.springframework.http.server.PathContainer.value. Doc from org.springframework.http.server.PathContainer.value. The original path from which this instance was parsed. Annotations @Override

value

back to summary

public String value()

Implements org.springframework.http.server.PathContainer.value.

Doc from org.springframework.http.server.PathContainer.value.

The original path from which this instance was parsed.

Annotations