public class

UrlPathHelper

extends Object
java.lang.Object
   ↳ org.springframework.web.util.UrlPathHelper

Class Overview

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.

Summary

Public Constructors
UrlPathHelper()
Public Methods
String decodeRequestString(HttpServletRequest request, String source)
Decode the given source string with a URLDecoder.
String getContextPath(HttpServletRequest request)
Return the context path for the given request, detecting an include request URL if called within a RequestDispatcher include.
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.
String getOriginatingContextPath(HttpServletRequest request)
Return the context path for the given request, detecting an include request URL if called within a RequestDispatcher include.
String getOriginatingQueryString(HttpServletRequest request)
Return the query string part of the given request's URL.
String getOriginatingRequestUri(HttpServletRequest request)
Return the request URI for the given request.
String getPathWithinApplication(HttpServletRequest request)
Return the path within the web application for the given request.
String getPathWithinServletMapping(HttpServletRequest request)
Return the path within the servlet mapping for the given request, i.e.
String getRequestUri(HttpServletRequest request)
Return the request URI for the given request, detecting an include request URL if called within a RequestDispatcher include.
String getServletPath(HttpServletRequest request)
Return the servlet path for the given request, regarding an include request URL if called within a RequestDispatcher include.
void setAlwaysUseFullPath(boolean alwaysUseFullPath)
Set if URL lookup should always use full path within current servlet context.
void setDefaultEncoding(String defaultEncoding)
Set the default character encoding to use for URL decoding.
void setUrlDecode(boolean urlDecode)
Set if context path and request URI should be URL-decoded.
Protected Methods
String determineEncoding(HttpServletRequest request)
Determine the encoding for the given request.
String getDefaultEncoding()
Return the default character encoding to use for URL decoding.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public UrlPathHelper ()

Public Methods

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 current HTTP request
source the String to decode
Returns
  • the decoded String
See Also

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 current HTTP request
Returns
  • the context path

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 current HTTP request
Returns
  • the lookup path
See Also

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 current HTTP request
Returns
  • the context path

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 current HTTP request
Returns
  • the query string

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.

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 current HTTP request
Returns
  • the path within the web application

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.

Detects include request URL if called within a RequestDispatcher include.

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 ""

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 current HTTP request
Returns
  • the request URI

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 current HTTP request
Returns
  • the servlet path

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".

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 the character encoding to use
See Also

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

Protected Methods

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 current HTTP request
Returns
  • the encoding for the request (never null)
See Also

protected String getDefaultEncoding ()

Return the default character encoding to use for URL decoding.