org.springframework.web.util

Class UrlPathHelper

java.lang.Object

org.springframework.web.util.UrlPathHelper

public class UrlPathHelper
extends java.lang.Object

Helper class for URL path matching. Provides support for URL paths in RequestDispatcher includes and support for consistent URL decoding.

Used by AbstractUrlHandlerMapping, AbstractUrlMethodNameResolver and RequestContext for path matching and/or URI determination.

Since:

14.01.2004

Author:

Juergen Hoeller, Rob Harrop, Rossen Stoyanchev

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	alwaysUseFullPath
private java.lang.String	defaultEncoding
private static Log	logger
private boolean	removeSemicolonContent
private boolean	urlDecode
private static java.lang.String	WEBSPHERE_URI_ATTRIBUTE Special WebSphere request attribute, indicating the original request URI.
(package private) static java.lang.Boolean	websphereComplianceFlag

Constructor Summary

Constructors

Constructor and Description
UrlPathHelper()

Method Summary

Modifier and Type	Method and Description
private java.lang.String	decodeAndCleanUriString(HttpServletRequest request, java.lang.String uri) Decode the supplied URI string and strips any extraneous portion after a ';'.
private java.lang.String	decodeInternal(HttpServletRequest request, java.lang.String source)
MultiValueMap<java.lang.String,java.lang.String>	decodeMatrixVariables(HttpServletRequest request, MultiValueMap<java.lang.String,java.lang.String> vars) Decode the given matrix variables via decodeRequestString(HttpServletRequest, String) unless setUrlDecode(boolean) 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).
java.util.Map<java.lang.String,java.lang.String>	decodePathVariables(HttpServletRequest request, java.util.Map<java.lang.String,java.lang.String> vars) Decode the given URI path variables via decodeRequestString(HttpServletRequest, String) unless setUrlDecode(boolean) 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).
java.lang.String	decodeRequestString(HttpServletRequest request, java.lang.String source) Decode the given source string with a URLDecoder.
protected java.lang.String	determineEncoding(HttpServletRequest request) Determine the encoding for the given request.
java.lang.String	getContextPath(HttpServletRequest request) Return the context path for the given request, detecting an include request URL if called within a RequestDispatcher include.
protected java.lang.String	getDefaultEncoding() Return the default character encoding to use for URL decoding.
java.lang.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.
java.lang.String	getOriginatingContextPath(HttpServletRequest request) Return the context path for the given request, detecting an include request URL if called within a RequestDispatcher include.
java.lang.String	getOriginatingQueryString(HttpServletRequest request) Return the query string part of the given request's URL.
java.lang.String	getOriginatingRequestUri(HttpServletRequest request) Return the request URI for the given request.
java.lang.String	getOriginatingServletPath(HttpServletRequest request) Return the servlet path for the given request, detecting an include request URL if called within a RequestDispatcher include.
java.lang.String	getPathWithinApplication(HttpServletRequest request) Return the path within the web application for the given request.
java.lang.String	getPathWithinServletMapping(HttpServletRequest request) Return the path within the servlet mapping for the given request, i.e.
private java.lang.String	getRemainingPath(java.lang.String requestUri, java.lang.String mapping, boolean ignoreCase) Match the given "mapping" to the start of the "requestUri" and if there is a match return the extra part.
java.lang.String	getRequestUri(HttpServletRequest request) Return the request URI for the given request, detecting an include request URL if called within a RequestDispatcher include.
private java.lang.String	getSanitizedPath(java.lang.String path) Sanitize the given path with the following rules: replace all "//" by "/"
java.lang.String	getServletPath(HttpServletRequest request) Return the servlet path for the given request, regarding an include request URL if called within a RequestDispatcher include.
private java.lang.String	removeJsessionid(java.lang.String requestUri)
java.lang.String	removeSemicolonContent(java.lang.String requestUri) Remove ";" (semicolon) content from the given request URI if the removeSemicolonContent property is set to "true".
private java.lang.String	removeSemicolonContentInternal(java.lang.String requestUri)
void	setAlwaysUseFullPath(boolean alwaysUseFullPath) Set if URL lookup should always use full path within current servlet context.
void	setDefaultEncoding(java.lang.String defaultEncoding) Set the default character encoding to use for URL decoding.
void	setRemoveSemicolonContent(boolean removeSemicolonContent) Set if ";" (semicolon) content should be stripped from the request URI.
void	setUrlDecode(boolean urlDecode) Set if context path and request URI should be URL-decoded.
boolean	shouldRemoveSemicolonContent() Whether configured to remove ";" (semicolon) content from the request URI.
private boolean	shouldRemoveTrailingServletPathSlash(HttpServletRequest request)

Methods inherited from class java.lang.Object

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

Field Detail

WEBSPHERE_URI_ATTRIBUTE

private static final java.lang.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.

See Also:

Constant Field Values

logger

private static final Log logger

websphereComplianceFlag

static volatile java.lang.Boolean websphereComplianceFlag

alwaysUseFullPath

private boolean alwaysUseFullPath

urlDecode

private boolean urlDecode

removeSemicolonContent

private boolean removeSemicolonContent

defaultEncoding

private java.lang.String defaultEncoding

Constructor Detail

UrlPathHelper

public UrlPathHelper()

Method Detail

setAlwaysUseFullPath

public void setAlwaysUseFullPath(boolean alwaysUseFullPath)

Set if URL lookup should always use full path within current servlet context. Else, the path within the current servlet mapping is used if applicable (i.e. in the case of a ".../*" servlet mapping in web.xml). Default is "false".

setUrlDecode

public void setUrlDecode(boolean urlDecode)

Set if context path and request URI should be URL-decoded. Both are returned undecoded by the Servlet API, in contrast to the servlet path.

Uses either the request encoding or the default encoding according to the Servlet spec (ISO-8859-1).

Default is "true", as of Spring 2.5.

See Also:

getServletPath(HttpServletRequest), getContextPath(HttpServletRequest), getRequestUri(HttpServletRequest), WebUtils.DEFAULT_CHARACTER_ENCODING, javax.servlet.ServletRequest#getCharacterEncoding(), URLDecoder.decode(String, String)

setRemoveSemicolonContent

public void setRemoveSemicolonContent(boolean removeSemicolonContent)

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

Default is "true".

shouldRemoveSemicolonContent

public boolean shouldRemoveSemicolonContent()

Whether configured to remove ";" (semicolon) content from the request URI.

setDefaultEncoding

public void setDefaultEncoding(java.lang.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 - the character encoding to use

See Also:

determineEncoding(HttpServletRequest), javax.servlet.ServletRequest#getCharacterEncoding(), javax.servlet.ServletRequest#setCharacterEncoding(String), WebUtils.DEFAULT_CHARACTER_ENCODING

getDefaultEncoding

protected java.lang.String getDefaultEncoding()

Return the default character encoding to use for URL decoding.

getLookupPathForRequest

public java.lang.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 - current HTTP request

Returns:

the lookup path

See Also:

getPathWithinApplication(HttpServletRequest), getPathWithinServletMapping(HttpServletRequest)

getPathWithinServletMapping

public java.lang.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.

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 - current HTTP request

Returns:

the path within the servlet mapping, or ""

getPathWithinApplication

public java.lang.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 - current HTTP request

Returns:

the path within the web application

getRemainingPath

private java.lang.String getRemainingPath(java.lang.String requestUri,
                                          java.lang.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 requesUri.

getSanitizedPath

private java.lang.String getSanitizedPath(java.lang.String path)

Sanitize the given path with the following rules:

• replace all "//" by "/"

getRequestUri

public java.lang.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 - current HTTP request

Returns:

the request URI

getContextPath

public java.lang.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 - current HTTP request

Returns:

the context path

getServletPath

public java.lang.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 - current HTTP request

Returns:

the servlet path

getOriginatingRequestUri

public java.lang.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.

getOriginatingContextPath

public java.lang.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 - current HTTP request

Returns:

the context path

getOriginatingServletPath

public java.lang.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 - current HTTP request

Returns:

the servlet path

getOriginatingQueryString

public java.lang.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 - current HTTP request

Returns:

the query string

decodeAndCleanUriString

private java.lang.String decodeAndCleanUriString(HttpServletRequest request,
                                                 java.lang.String uri)

Decode the supplied URI string and strips any extraneous portion after a ';'.

decodeRequestString

public java.lang.String decodeRequestString(HttpServletRequest request,
                                            java.lang.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 - current HTTP request

source - the String to decode

Returns:

the decoded String

See Also:

WebUtils.DEFAULT_CHARACTER_ENCODING, javax.servlet.ServletRequest#getCharacterEncoding, URLDecoder.decode(String, String), URLDecoder.decode(String)

decodeInternal

private java.lang.String decodeInternal(HttpServletRequest request,
                                        java.lang.String source)

determineEncoding

protected java.lang.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 - current HTTP request

Returns:

the encoding for the request (never null)

See Also:

javax.servlet.ServletRequest#getCharacterEncoding(), setDefaultEncoding(java.lang.String)

removeSemicolonContent

public java.lang.String removeSemicolonContent(java.lang.String requestUri)

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

Parameters:

requestUri - the request URI string to remove ";" content from

Returns:

the updated URI string

removeSemicolonContentInternal

private java.lang.String removeSemicolonContentInternal(java.lang.String requestUri)

removeJsessionid

private java.lang.String removeJsessionid(java.lang.String requestUri)

decodePathVariables

public java.util.Map<java.lang.String,java.lang.String> decodePathVariables(HttpServletRequest request,
                                                                            java.util.Map<java.lang.String,java.lang.String> vars)

Decode the given URI path variables via decodeRequestString(HttpServletRequest, String) unless setUrlDecode(boolean) 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 - current HTTP request

vars - URI variables extracted from the URL path

Returns:

the same Map or a new Map instance

decodeMatrixVariables

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

Decode the given matrix variables via decodeRequestString(HttpServletRequest, String) unless setUrlDecode(boolean) 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 - current HTTP request

vars - URI variables extracted from the URL path

Returns:

the same Map or a new Map instance

shouldRemoveTrailingServletPathSlash

private boolean shouldRemoveTrailingServletPathSlash(HttpServletRequest request)