Spring Web 6.1.4 · org.springframework.web.util.UrlPathHelper

Modifier and Type	Field and Description
private boolean	alwaysUseFullPath
private String	defaultEncoding
public static final UrlPathHelper	defaultInstance Shared, read-only instance with defaults.
private static final Log	logger
public static final String	PATH_ATTRIBUTE Name of Servlet request attribute that holds a `resolved` lookupPath.
public static final UrlPathHelper	rawPathInstance Shared, read-only instance for the full, encoded path.
private boolean	readOnly
private boolean	removeSemicolonContent
private boolean	urlDecode
private static final String	WEBSPHERE_URI_ATTRIBUTE Special WebSphere request attribute, indicating the original request URI.
pack-priv static volatile Boolean	websphereComplianceFlag

Access	Constructor and Description
public	UrlPathHelper()

Method Summary

Modifier and Type	Method and Description
private void	checkReadOnly()
private String	decodeAndCleanUriString(HttpServletRequest request, String uri) Decode the supplied URI string and strips any extraneous portion after a ';'.
private String	decodeInternal(HttpServletRequest request, String source)
public MultiValueMap<String, String>	Returns: the same Map or a new Map instance decodeMatrixVariables(HttpServletRequest current HTTP request request, MultiValueMap<String, String> the URI variables extracted from the URL path vars) Decode the given matrix variables via `decodeRequestString` unless `setUrlDecode` is set to `true` in which case it is assumed the URL path from which the variables were extracted is already decoded through a call to `getLookupPathForRequest(HttpServletRequest)`.
public Map<String, String>	Returns: the same Map or a new Map instance decodePathVariables(HttpServletRequest current HTTP request request, Map<String, String> the URI variables extracted from the URL path vars) Decode the given URI path variables via `decodeRequestString` unless `setUrlDecode` is set to `true` in which case it is assumed the URL path from which the variables were extracted is already decoded through a call to `getLookupPathForRequest(HttpServletRequest)`.
public String	Returns: the decoded String decodeRequestString(HttpServletRequest current HTTP request request, String the String to decode source) Decode the given source string with a URLDecoder.
protected String	Returns: the encoding for the request (never `null`) determineEncoding(HttpServletRequest current HTTP request request) Determine the encoding for the given request.
public String	Returns: the context path getContextPath(HttpServletRequest current HTTP request request) Return the context path for the given request, detecting an include request URL if called within a RequestDispatcher include.
protected String	getDefaultEncoding() Return the default character encoding to use for URL decoding.
public String	Returns: the lookup path getLookupPathForRequest(HttpServletRequest current HTTP request request, String the request attribute that holds the lookupPath name) Deprecated as of 5.3 in favor of using `resolveAndCacheLookupPath(HttpServletRequest)` and `getResolvedLookupPath(ServletRequest)`. Variant of `getLookupPathForRequest(HttpServletRequest)` that automates checking for a previously computed lookupPath saved as a request attribute.
public String	Returns: the lookup path getLookupPathForRequest(HttpServletRequest current HTTP request request) Return the mapping lookup path for the given request, within the current servlet mapping if applicable, else within the web application.
public String	Returns: the context path getOriginatingContextPath(HttpServletRequest current HTTP request request) Return the context path for the given request, detecting an include request URL if called within a RequestDispatcher include.
public String	Returns: the query string getOriginatingQueryString(HttpServletRequest current HTTP request request) Return the query string part of the given request's URL.
public String	getOriginatingRequestUri(HttpServletRequest request) Return the request URI for the given request.
public String	Returns: the servlet path getOriginatingServletPath(HttpServletRequest current HTTP request request) Return the servlet path for the given request, detecting an include request URL if called within a RequestDispatcher include.
public String	Returns: the path within the web application getPathWithinApplication(HttpServletRequest current HTTP request request) Return the path within the web application for the given request.
public String	Returns: the path within the servlet mapping, or "" getPathWithinServletMapping(HttpServletRequest current HTTP request request) Return the path within the servlet mapping for the given request, i.e. the part of the request's URL beyond the part that called the servlet, or "" if the whole URL has been used to identify the servlet.
protected String	Returns: the path within the servlet mapping, or "" getPathWithinServletMapping(HttpServletRequest current HTTP request request, String a precomputed path within the application pathWithinApp) Return the path within the servlet mapping for the given request, i.e. the part of the request's URL beyond the part that called the servlet, or "" if the whole URL has been used to identify the servlet.
private String	getRemainingPath(String requestUri, String mapping, boolean ignoreCase) Match the given "mapping" to the start of the "requestUri" and if there is a match return the extra part.
public String	Returns: the request URI getRequestUri(HttpServletRequest current HTTP request request) Return the request URI for the given request, detecting an include request URL if called within a RequestDispatcher include.
public static String	Returns: the previously resolved lookupPath getResolvedLookupPath(ServletRequest the current request request) Return a previously `resolved` lookupPath.
private static String	getSanitizedPath(final String path) Sanitize the given path.
public String	Returns: the servlet path getServletPath(HttpServletRequest current HTTP request request) Return the servlet path for the given request, regarding an include request URL if called within a RequestDispatcher include.
private boolean	ignoreServletPath(HttpServletRequest request) Whether we can ignore the servletPath and pathInfo for mapping purposes, which is the case when we can establish that the Servlet is not mapped by servletPath prefix.
public boolean	isUrlDecode() Whether to decode the request URI when determining the lookup path.
private String	removeJsessionid(String requestUri)
public String	Returns: the updated URI string removeSemicolonContent(String the request URI string to remove ";" content from requestUri) Remove ";" (semicolon) content from the given request URI if the removeSemicolonContent property is set to "true".
private static String	removeSemicolonContentInternal(String requestUri)
public String	Returns: the resolved path resolveAndCacheLookupPath(HttpServletRequest the current request request) `Resolve` the lookupPath and cache it in a request attribute with the key `PATH_ATTRIBUTE` for subsequent access via `getResolvedLookupPath(ServletRequest)`.
public void	setAlwaysUseFullPath(boolean alwaysUseFullPath) Whether URL lookups should always use the full path within the current web application context, i.e. within `jakarta.servlet.ServletContext#getContextPath()`.
public void	setDefaultEncoding(String the character encoding to use defaultEncoding) Set the default character encoding to use for URL decoding.
private void	setReadOnly() Switch to read-only mode where further configuration changes are not allowed.
public void	setRemoveSemicolonContent(boolean removeSemicolonContent) Set if ";" (semicolon) content should be stripped from the request URI.
public void	setUrlDecode(boolean urlDecode) Whether the context path and request URI should be decoded -- both of which are returned undecoded by the Servlet API, in contrast to the servlet path.
public boolean	shouldRemoveSemicolonContent() Whether configured to remove ";" (semicolon) content from the request URI.
private boolean	shouldRemoveTrailingServletPathSlash(HttpServletRequest request)

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

alwaysUseFullPath	back to summary
private boolean alwaysUseFullPath

defaultEncoding	back to summary
private String defaultEncoding

defaultInstance	back to summary
public static final UrlPathHelper defaultInstance Shared, read-only instance with defaults. The following apply: `alwaysUseFullPath=false` `urlDecode=true` `removeSemicolon=true` `defaultEncoding=WebUtils#DEFAULT_CHARACTER_ENCODING`

logger	back to summary
private static final Log logger

PATH_ATTRIBUTE	back to summary
public static final String PATH_ATTRIBUTE Name of Servlet request attribute that holds a `resolved` lookupPath. Since 5.3

rawPathInstance	back to summary
public static final UrlPathHelper rawPathInstance Shared, read-only instance for the full, encoded path. The following apply: `alwaysUseFullPath=true` `urlDecode=false` `removeSemicolon=false` `defaultEncoding=WebUtils#DEFAULT_CHARACTER_ENCODING`

readOnly	back to summary
private boolean readOnly

removeSemicolonContent	back to summary
private boolean removeSemicolonContent

urlDecode	back to summary
private boolean urlDecode

WEBSPHERE_URI_ATTRIBUTE	back to summary
private static final String WEBSPHERE_URI_ATTRIBUTE Special WebSphere request attribute, indicating the original request URI. Preferable over the standard Servlet 2.4 forward attribute on WebSphere, simply because we need the very first URI in the request forwarding chain.

websphereComplianceFlag	back to summary
pack-priv static volatile Boolean websphereComplianceFlag Annotations @Nullable

UrlPathHelper	back to summary
public UrlPathHelper()

Method Detail

checkReadOnly	back to summary
private void checkReadOnly()

decodeAndCleanUriString	back to summary
private String decodeAndCleanUriString(HttpServletRequest request, String uri) Decode the supplied URI string and strips any extraneous portion after a ';'.

decodeInternal	back to summary
private String decodeInternal(HttpServletRequest request, String source) Annotations @SuppressWarnings:deprecation

decodeMatrixVariables back to summary

decodeMatrixVariables	back to summary
public MultiValueMap<String, String> decodeMatrixVariables(HttpServletRequest request, MultiValueMap<String, String> vars) Decode the given matrix variables via `decodeRequestString` unless `setUrlDecode` is set to `true` in which case it is assumed the URL path from which the variables were extracted is already decoded through a call to `getLookupPathForRequest(HttpServletRequest)`. Parameters request:HttpServletRequest current HTTP request vars:MultiValueMap<String, String> the URI variables extracted from the URL path Returns:MultiValueMap<String, String> the same Map or a new Map instance

public MultiValueMap<String, String> decodeMatrixVariables(HttpServletRequest request, MultiValueMap<String, String> vars)

Decode the given matrix variables via decodeRequestString unless setUrlDecode is set to true in which case it is assumed the URL path from which the variables were extracted is already decoded through a call to getLookupPathForRequest(HttpServletRequest).

Parameters

request:HttpServletRequest: current HTTP request
vars:MultiValueMap<String, String>: the URI variables extracted from the URL path

Returns:MultiValueMap<String, String>

the same Map or a new Map instance

decodePathVariables back to summary

decodePathVariables	back to summary
public Map<String, String> decodePathVariables(HttpServletRequest request, Map<String, String> vars) Decode the given URI path variables via `decodeRequestString` unless `setUrlDecode` is set to `true` in which case it is assumed the URL path from which the variables were extracted is already decoded through a call to `getLookupPathForRequest(HttpServletRequest)`. Parameters request:HttpServletRequest current HTTP request vars:Map<String, String> the URI variables extracted from the URL path Returns:Map<String, String> the same Map or a new Map instance

public Map<String, String> decodePathVariables(HttpServletRequest request, Map<String, String> vars)

Decode the given URI path variables via decodeRequestString unless setUrlDecode is set to true in which case it is assumed the URL path from which the variables were extracted is already decoded through a call to getLookupPathForRequest(HttpServletRequest).

Parameters

request:HttpServletRequest: current HTTP request
vars:Map<String, String>: the URI variables extracted from the URL path

Returns:Map<String, String>

the same Map or a new Map instance

decodeRequestString back to summary

decodeRequestString	back to summary
public String decodeRequestString(HttpServletRequest request, String source) Decode the given source string with a URLDecoder. The encoding will be taken from the request, falling back to the default "ISO-8859-1". The default implementation uses `URLDecoder.decode(input, enc)`. Parameters request:HttpServletRequest current HTTP request source:String the String to decode Returns:String the decoded String See Also `WebUtils#DEFAULT_CHARACTER_ENCODING`, `jakarta.servlet.ServletRequest#getCharacterEncoding`, `java.net.URLDecoder#decode(String, String)`, `java.net.URLDecoder#decode(String)`

public String decodeRequestString(HttpServletRequest request, String source)

Decode the given source string with a URLDecoder. The encoding will be taken from the request, falling back to the default "ISO-8859-1".

The default implementation uses URLDecoder.decode(input, enc).

Parameters

request:HttpServletRequest: current HTTP request
source:String: the String to decode

Returns:String

the decoded String

determineEncoding back to summary

determineEncoding	back to summary
protected String determineEncoding(HttpServletRequest request) Determine the encoding for the given request. Can be overridden in subclasses. The default implementation checks the request encoding, falling back to the default encoding specified for this resolver. Parameters request:HttpServletRequest current HTTP request Returns:String the encoding for the request (never `null`) See Also `jakarta.servlet.ServletRequest#getCharacterEncoding()`, `setDefaultEncoding`

protected String determineEncoding(HttpServletRequest request)

Determine the encoding for the given request. Can be overridden in subclasses.

The default implementation checks the request encoding, falling back to the default encoding specified for this resolver.

Parameters

request:HttpServletRequest: current HTTP request

Returns:String

the encoding for the request (never null)

getContextPath back to summary

getContextPath	back to summary
public String getContextPath(HttpServletRequest request) Return the context path for the given request, detecting an include request URL if called within a RequestDispatcher include. As the value returned by `request.getContextPath()` is not decoded by the servlet container, this method will decode it. Parameters request:HttpServletRequest current HTTP request Returns:String the context path

public String getContextPath(HttpServletRequest request)

Return the context path for the given request, detecting an include request URL if called within a RequestDispatcher include.

As the value returned by request.getContextPath() is not decoded by the servlet container, this method will decode it.

Parameters

request:HttpServletRequest: current HTTP request

Returns:String

the context path

getDefaultEncoding	back to summary
protected String getDefaultEncoding() Return the default character encoding to use for URL decoding.

getLookupPathForRequest back to summary

getLookupPathForRequest	back to summary
public String getLookupPathForRequest(HttpServletRequest request, String name) Deprecated as of 5.3 in favor of using `resolveAndCacheLookupPath(HttpServletRequest)` and `getResolvedLookupPath(ServletRequest)`. Variant of `getLookupPathForRequest(HttpServletRequest)` that automates checking for a previously computed lookupPath saved as a request attribute. The attribute is only used for lookup purposes. Parameters request:HttpServletRequest current HTTP request name:String the request attribute that holds the lookupPath Returns:String the lookup path Annotations @Deprecated Since 5.2

public String getLookupPathForRequest(HttpServletRequest request, String name)

Deprecated

as of 5.3 in favor of using resolveAndCacheLookupPath(HttpServletRequest) and getResolvedLookupPath(ServletRequest).

Variant of getLookupPathForRequest(HttpServletRequest) that automates checking for a previously computed lookupPath saved as a request attribute. The attribute is only used for lookup purposes.

Parameters

request:HttpServletRequest: current HTTP request
name:String: the request attribute that holds the lookupPath

Returns:String

the lookup path

Annotations

@Deprecated

Since

5.2

getLookupPathForRequest back to summary

getLookupPathForRequest	back to summary
public String getLookupPathForRequest(HttpServletRequest request) Return the mapping lookup path for the given request, within the current servlet mapping if applicable, else within the web application. Detects include request URL if called within a RequestDispatcher include. Parameters request:HttpServletRequest current HTTP request Returns:String the lookup path See Also `getPathWithinServletMapping`, `getPathWithinApplication`

public String getLookupPathForRequest(HttpServletRequest request)

Return the mapping lookup path for the given request, within the current servlet mapping if applicable, else within the web application.

Detects include request URL if called within a RequestDispatcher include.

Parameters

request:HttpServletRequest: current HTTP request

Returns:String

the lookup path

getOriginatingContextPath back to summary

getOriginatingContextPath	back to summary
public String getOriginatingContextPath(HttpServletRequest request) Return the context path for the given request, detecting an include request URL if called within a RequestDispatcher include. As the value returned by `request.getContextPath()` is not decoded by the servlet container, this method will decode it. Parameters request:HttpServletRequest current HTTP request Returns:String the context path

public String getOriginatingContextPath(HttpServletRequest request)

Return the context path for the given request, detecting an include request URL if called within a RequestDispatcher include.

As the value returned by request.getContextPath() is not decoded by the servlet container, this method will decode it.

Parameters

request:HttpServletRequest: current HTTP request

Returns:String

the context path

getOriginatingQueryString	back to summary
public String getOriginatingQueryString(HttpServletRequest request) Return the query string part of the given request's URL. If this is a forwarded request, correctly resolves to the query string of the original request. Parameters request:HttpServletRequest current HTTP request Returns:String the query string

getOriginatingQueryString

back to summary

public String getOriginatingQueryString(HttpServletRequest request)

Return the query string part of the given request's URL. If this is a forwarded request, correctly resolves to the query string of the original request.

Parameters

request:HttpServletRequest: current HTTP request

Returns:String

the query string

getOriginatingRequestUri	back to summary
public String getOriginatingRequestUri(HttpServletRequest request) Return the request URI for the given request. If this is a forwarded request, correctly resolves to the request URI of the original request.

getOriginatingServletPath	back to summary
public String getOriginatingServletPath(HttpServletRequest request) Return the servlet path for the given request, detecting an include request URL if called within a RequestDispatcher include. Parameters request:HttpServletRequest current HTTP request Returns:String the servlet path

getOriginatingServletPath

back to summary

public String getOriginatingServletPath(HttpServletRequest request)

Return the servlet path for the given request, detecting an include request URL if called within a RequestDispatcher include.

Parameters

request:HttpServletRequest: current HTTP request

Returns:String

the servlet path

getPathWithinApplication back to summary

getPathWithinApplication	back to summary
public String getPathWithinApplication(HttpServletRequest request) Return the path within the web application for the given request. Detects include request URL if called within a RequestDispatcher include. Parameters request:HttpServletRequest current HTTP request Returns:String the path within the web application See Also `getLookupPathForRequest`

public String getPathWithinApplication(HttpServletRequest request)

Return the path within the web application for the given request.

Detects include request URL if called within a RequestDispatcher include.

Parameters

request:HttpServletRequest: current HTTP request

Returns:String

the path within the web application

See Also

getLookupPathForRequest

getPathWithinServletMapping back to summary

getPathWithinServletMapping	back to summary
public String getPathWithinServletMapping(HttpServletRequest request) Return the path within the servlet mapping for the given request, i.e. the part of the request's URL beyond the part that called the servlet, or "" if the whole URL has been used to identify the servlet. Parameters request:HttpServletRequest current HTTP request Returns:String the path within the servlet mapping, or "" See Also `getPathWithinServletMapping(HttpServletRequest, String)`

public String getPathWithinServletMapping(HttpServletRequest request)

Return the path within the servlet mapping for the given request, i.e. the part of the request's URL beyond the part that called the servlet, or "" if the whole URL has been used to identify the servlet.

Parameters

request:HttpServletRequest: current HTTP request

Returns:String

the path within the servlet mapping, or ""

getPathWithinServletMapping back to summary

getPathWithinServletMapping	back to summary
protected String getPathWithinServletMapping(HttpServletRequest request, String pathWithinApp) Return the path within the servlet mapping for the given request, i.e. the part of the request's URL beyond the part that called the servlet, or "" if the whole URL has been used to identify the servlet. Detects include request URL if called within a RequestDispatcher include. E.g.: servlet mapping = "/"; request URI = "/test/a" → "/test/a". E.g.: servlet mapping = "/"; request URI = "/test/a" → "/test/a". E.g.: servlet mapping = "/test/"; request URI = "/test/a" → "/a". E.g.: servlet mapping = "/test"; request URI = "/test" → "". E.g.: servlet mapping = "/*.test"; request URI = "/a.test" → "". Parameters request:HttpServletRequest current HTTP request pathWithinApp:String a precomputed path within the application Returns:String the path within the servlet mapping, or "" Since 5.2.9 See Also `getLookupPathForRequest`

protected String getPathWithinServletMapping(HttpServletRequest request, String pathWithinApp)

Detects include request URL if called within a RequestDispatcher include.

E.g.: servlet mapping = "/*"; request URI = "/test/a" → "/test/a".

E.g.: servlet mapping = "/"; request URI = "/test/a" → "/test/a".

E.g.: servlet mapping = "/test/*"; request URI = "/test/a" → "/a".

E.g.: servlet mapping = "/test"; request URI = "/test" → "".

E.g.: servlet mapping = "/*.test"; request URI = "/a.test" → "".

Parameters

request:HttpServletRequest: current HTTP request
pathWithinApp:String: a precomputed path within the application

Returns:String

the path within the servlet mapping, or ""

Since

5.2.9

See Also

getLookupPathForRequest

getRemainingPath	back to summary
private String getRemainingPath(String requestUri, String mapping, boolean ignoreCase) Match the given "mapping" to the start of the "requestUri" and if there is a match return the extra part. This method is needed because the context path and the servlet path returned by the HttpServletRequest are stripped of semicolon content unlike the requestUri. Annotations @Nullable

getRemainingPath

back to summary

private String getRemainingPath(String requestUri, String mapping, boolean ignoreCase)

Match the given "mapping" to the start of the "requestUri" and if there is a match return the extra part. This method is needed because the context path and the servlet path returned by the HttpServletRequest are stripped of semicolon content unlike the requestUri.

Annotations

@Nullable

getRequestUri back to summary

getRequestUri	back to summary
public String getRequestUri(HttpServletRequest request) Return the request URI for the given request, detecting an include request URL if called within a RequestDispatcher include. As the value returned by `request.getRequestURI()` is not decoded by the servlet container, this method will decode it. The URI that the web container resolves should be correct, but some containers like JBoss/Jetty incorrectly include ";" strings like ";jsessionid" in the URI. This method cuts off such incorrect appendices. Parameters request:HttpServletRequest current HTTP request Returns:String the request URI

public String getRequestUri(HttpServletRequest request)

Return the request URI for the given request, detecting an include request URL if called within a RequestDispatcher include.

As the value returned by request.getRequestURI() is not decoded by the servlet container, this method will decode it.

The URI that the web container resolves should be correct, but some containers like JBoss/Jetty incorrectly include ";" strings like ";jsessionid" in the URI. This method cuts off such incorrect appendices.

Parameters

request:HttpServletRequest: current HTTP request

Returns:String

the request URI

getResolvedLookupPath back to summary

getResolvedLookupPath	back to summary
public static String getResolvedLookupPath(ServletRequest request) Return a previously `resolved` lookupPath. Parameters request:ServletRequest the current request Returns:String the previously resolved lookupPath Exceptions IllegalArgumentException: if the lookup path is not found Since 5.3

public static String getResolvedLookupPath(ServletRequest request)

Return a previously resolved lookupPath.

Parameters

request:ServletRequest: the current request

Returns:String

the previously resolved lookupPath

Exceptions

IllegalArgumentException:: if the lookup path is not found

Since

5.3

getSanitizedPath	back to summary
private static String getSanitizedPath(final String path) Sanitize the given path. Uses the following rules: replace all "//" by "/"

getSanitizedPath

back to summary

private static String getSanitizedPath(final String path)

Sanitize the given path. Uses the following rules:

replace all "//" by "/"

getServletPath back to summary

getServletPath	back to summary
public String getServletPath(HttpServletRequest request) Return the servlet path for the given request, regarding an include request URL if called within a RequestDispatcher include. As the value returned by `request.getServletPath()` is already decoded by the servlet container, this method will not attempt to decode it. Parameters request:HttpServletRequest current HTTP request Returns:String the servlet path

public String getServletPath(HttpServletRequest request)

Return the servlet path for the given request, regarding an include request URL if called within a RequestDispatcher include.

As the value returned by request.getServletPath() is already decoded by the servlet container, this method will not attempt to decode it.

Parameters

request:HttpServletRequest: current HTTP request

Returns:String

the servlet path

ignoreServletPath	back to summary
private boolean ignoreServletPath(HttpServletRequest request) Whether we can ignore the servletPath and pathInfo for mapping purposes, which is the case when we can establish that the Servlet is not mapped by servletPath prefix.

isUrlDecode	back to summary
public boolean isUrlDecode() Whether to decode the request URI when determining the lookup path. Since 4.3.13

isUrlDecode

back to summary

public boolean isUrlDecode()

Whether to decode the request URI when determining the lookup path.

Since: 4.3.13

removeJsessionid	back to summary
private String removeJsessionid(String requestUri)

removeSemicolonContent	back to summary
public String removeSemicolonContent(String requestUri) Remove ";" (semicolon) content from the given request URI if the removeSemicolonContent property is set to "true". Note that "jsessionid" is always removed. Parameters requestUri:String the request URI string to remove ";" content from Returns:String the updated URI string

removeSemicolonContent

back to summary

public String removeSemicolonContent(String requestUri)

Remove ";" (semicolon) content from the given request URI if the removeSemicolonContent property is set to "true". Note that "jsessionid" is always removed.

Parameters

requestUri:String: the request URI string to remove ";" content from

Returns:String

the updated URI string

removeSemicolonContentInternal	back to summary
private static String removeSemicolonContentInternal(String requestUri)

resolveAndCacheLookupPath back to summary

resolveAndCacheLookupPath	back to summary
public String resolveAndCacheLookupPath(HttpServletRequest request) `Resolve` the lookupPath and cache it in a request attribute with the key `PATH_ATTRIBUTE` for subsequent access via `getResolvedLookupPath(ServletRequest)`. Parameters request:HttpServletRequest the current request Returns:String the resolved path Since 5.3

public String resolveAndCacheLookupPath(HttpServletRequest request)

Resolve the lookupPath and cache it in a request attribute with the key PATH_ATTRIBUTE for subsequent access via getResolvedLookupPath(ServletRequest).

Parameters

request:HttpServletRequest: the current request

Returns:String

the resolved path

Since

5.3

setAlwaysUseFullPath back to summary

setAlwaysUseFullPath	back to summary
public void setAlwaysUseFullPath(boolean alwaysUseFullPath) Whether URL lookups should always use the full path within the current web application context, i.e. within `jakarta.servlet.ServletContext#getContextPath()`. If set to false the path within the current servlet mapping is used instead if applicable (i.e. in the case of a prefix based Servlet mapping such as "/myServlet/*"). By default this is set to "false".

public void setAlwaysUseFullPath(boolean alwaysUseFullPath)

Whether URL lookups should always use the full path within the current web application context, i.e. within jakarta.servlet.ServletContext#getContextPath().

If set to false the path within the current servlet mapping is used instead if applicable (i.e. in the case of a prefix based Servlet mapping such as "/myServlet/*").

By default this is set to "false".

setDefaultEncoding back to summary

setDefaultEncoding	back to summary
public void setDefaultEncoding(String defaultEncoding) Set the default character encoding to use for URL decoding. Default is ISO-8859-1, according to the Servlet spec. If the request specifies a character encoding itself, the request encoding will override this setting. This also allows for generically overriding the character encoding in a filter that invokes the `ServletRequest.setCharacterEncoding` method. Parameters defaultEncoding:String the character encoding to use See Also `determineEncoding`, `jakarta.servlet.ServletRequest#getCharacterEncoding()`, `jakarta.servlet.ServletRequest#setCharacterEncoding(String)`, `WebUtils#DEFAULT_CHARACTER_ENCODING`

public void setDefaultEncoding(String defaultEncoding)

Set the default character encoding to use for URL decoding. Default is ISO-8859-1, according to the Servlet spec.

If the request specifies a character encoding itself, the request encoding will override this setting. This also allows for generically overriding the character encoding in a filter that invokes the ServletRequest.setCharacterEncoding method.

Parameters

defaultEncoding:String: the character encoding to use

setReadOnly	back to summary
private void setReadOnly() Switch to read-only mode where further configuration changes are not allowed.

setRemoveSemicolonContent	back to summary
public void setRemoveSemicolonContent(boolean removeSemicolonContent) Set if ";" (semicolon) content should be stripped from the request URI. Default is "true".

setRemoveSemicolonContent

back to summary

public void setRemoveSemicolonContent(boolean removeSemicolonContent)

Set if ";" (semicolon) content should be stripped from the request URI.

Default is "true".

setUrlDecode back to summary

setUrlDecode	back to summary
public void setUrlDecode(boolean urlDecode) Whether the context path and request URI should be decoded -- both of which are returned undecoded by the Servlet API, in contrast to the servlet path. Either the request encoding or the default Servlet spec encoding (ISO-8859-1) is used when set to "true". By default this is set to true. Note Be aware the servlet path will not match when compared to encoded paths. Therefore use of `urlDecode=false` is not compatible with a prefix-based Servlet mapping and likewise implies also setting `alwaysUseFullPath=true`. See Also `getServletPath`, `getContextPath`, `getRequestUri`, `WebUtils#DEFAULT_CHARACTER_ENCODING`, `jakarta.servlet.ServletRequest#getCharacterEncoding()`, `java.net.URLDecoder#decode(String, String)`

public void setUrlDecode(boolean urlDecode)

Whether the context path and request URI should be decoded -- both of which are returned undecoded by the Servlet API, in contrast to the servlet path.

Either the request encoding or the default Servlet spec encoding (ISO-8859-1) is used when set to "true".

By default this is set to true.

Note

Be aware the servlet path will not match when compared to encoded paths. Therefore use of urlDecode=false is not compatible with a prefix-based Servlet mapping and likewise implies also setting alwaysUseFullPath=true.

See Also: getServletPath, getContextPath, getRequestUri, WebUtils#DEFAULT_CHARACTER_ENCODING, jakarta.servlet.ServletRequest#getCharacterEncoding(), java.net.URLDecoder#decode(String, String)

shouldRemoveSemicolonContent	back to summary
public boolean shouldRemoveSemicolonContent() Whether configured to remove ";" (semicolon) content from the request URI.

shouldRemoveTrailingServletPathSlash	back to summary
private boolean shouldRemoveTrailingServletPathSlash(HttpServletRequest request)

public Class UrlPathHelper

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail