The Spring Framework

## org.springframework.web.util
Class UrlPathHelper

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

    public class UrlPathHelper

extends 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

Field Summary
`static String` `INCLUDE_CONTEXT_PATH_REQUEST_ATTRIBUTE` Deprecated. as of Spring 2.0, in favor of `WebUtils.INCLUDE_CONTEXT_PATH_ATTRIBUTE`
`static String` `INCLUDE_SERVLET_PATH_REQUEST_ATTRIBUTE` Deprecated. as of Spring 2.0, in favor of `WebUtils.INCLUDE_SERVLET_PATH_ATTRIBUTE`
`static String` `INCLUDE_URI_REQUEST_ATTRIBUTE` Deprecated. as of Spring 2.0, in favor of `WebUtils.INCLUDE_REQUEST_URI_ATTRIBUTE`

Constructor Summary
`UrlPathHelper()`

Method Summary
`String` `decodeRequestString(HttpServletRequest request, String source)` Decode the given source string with a URLDecoder.
`protected String` `determineEncoding(HttpServletRequest request)` Determine the encoding for the given request.
`String` `getContextPath(HttpServletRequest 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.
`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 request URI for root of the given request.
`String` `getOriginatingRequestUri(HttpServletRequest request)` Return the request URI for root of 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. 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.
`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.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

### INCLUDE_URI_REQUEST_ATTRIBUTE

    public static final String INCLUDE_URI_REQUEST_ATTRIBUTE

  Deprecated. as of Spring 2.0, in favor of `WebUtils.INCLUDE_REQUEST_URI_ATTRIBUTE`
  See Also:
    `WebUtils.INCLUDE_REQUEST_URI_ATTRIBUTE`, Constant Field Values

### INCLUDE_CONTEXT_PATH_REQUEST_ATTRIBUTE

    public static final String INCLUDE_CONTEXT_PATH_REQUEST_ATTRIBUTE

  Deprecated. as of Spring 2.0, in favor of `WebUtils.INCLUDE_CONTEXT_PATH_ATTRIBUTE`
  See Also:
    `WebUtils.INCLUDE_CONTEXT_PATH_ATTRIBUTE`, Constant Field Values

### INCLUDE_SERVLET_PATH_REQUEST_ATTRIBUTE

    public static final String INCLUDE_SERVLET_PATH_REQUEST_ATTRIBUTE

  Deprecated. as of Spring 2.0, in favor of `WebUtils.INCLUDE_SERVLET_PATH_ATTRIBUTE`
  See Also:
    `WebUtils.INCLUDE_SERVLET_PATH_ATTRIBUTE`, Constant Field Values

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(javax.servlet.http.HttpServletRequest)`, `getContextPath(javax.servlet.http.HttpServletRequest)`, `getRequestUri(javax.servlet.http.HttpServletRequest)`, `WebUtils.DEFAULT_CHARACTER_ENCODING`, `ServletRequest.getCharacterEncoding()`, `URLDecoder.decode(String, String)`

### setDefaultEncoding

    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:
    `determineEncoding(javax.servlet.http.HttpServletRequest)`, `ServletRequest.getCharacterEncoding()`, `ServletRequest.setCharacterEncoding(String)`, `WebUtils.DEFAULT_CHARACTER_ENCODING`

### getDefaultEncoding

    protected String getDefaultEncoding()

  Return the default character encoding to use for URL decoding.

### getLookupPathForRequest

    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:
    `getPathWithinApplication(javax.servlet.http.HttpServletRequest)`, `getPathWithinServletMapping(javax.servlet.http.HttpServletRequest)`

### getPathWithinServletMapping

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

### getPathWithinApplication

    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

### getRequestUri

    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

### getContextPath

    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

### getServletPath

    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

### getOriginatingRequestUri

    public String getOriginatingRequestUri(HttpServletRequest request)

  Return the request URI for root of the given request. If this is a forwarded request, correctly resolves to the request URI of the original request.

  Relies on the Servlet 2.4 'forward' attributes. These attributes may be set by other components when running in a Servlet 2.3 environment.

### getOriginatingContextPath

    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.

  Relies on the Servlet 2.4 'forward' attributes. These attributes may be set by other components when running in a Servlet 2.3 environment.

  Parameters:
    `request` - current HTTP request
  Returns:
    the context path

### getOriginatingQueryString

    public String getOriginatingQueryString(HttpServletRequest request)

  Return the request URI for root of the given request. If this is a forwarded request, correctly resolves to the request URI of the original request.

  Relies on the Servlet 2.4 'forward' attributes. These attributes may be set by other components when running in a Servlet 2.3 environment.

  Parameters:
    `request` - current HTTP request
  Returns:
    the query string

### decodeRequestString

    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:
    `WebUtils.DEFAULT_CHARACTER_ENCODING`, `ServletRequest.getCharacterEncoding()`, `URLDecoder.decode(String, String)`, `URLDecoder.decode(String)`

### determineEncoding

    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:
    `ServletRequest.getCharacterEncoding()`, `setDefaultEncoding(java.lang.String)`

The Spring Framework

Copyright © 2002-2008 The Spring Framework.