WebUtils (x-common 1.1.0 API)

java.lang.Object
- cn.ocoop.framework.common.util.WebUtils

```
public class WebUtils
extends Object
```

字段概要

字段
限定符和类型	字段和说明
`static String`	`DEFAULT_CHARACTER_ENCODING` Default character encoding to use when `request.getCharacterEncoding` returns `null`, according to the Servlet spec.
`static String`	`FORWARD_CONTEXT_PATH_ATTRIBUTE`
`static String`	`FORWARD_PATH_INFO_ATTRIBUTE`
`static String`	`FORWARD_QUERY_STRING_ATTRIBUTE`
`static String`	`FORWARD_REQUEST_URI_ATTRIBUTE` Standard Servlet 2.4+ spec request attributes for forward URI and paths.
`static String`	`FORWARD_SERVLET_PATH_ATTRIBUTE`
`static String`	`INCLUDE_CONTEXT_PATH_ATTRIBUTE`
`static String`	`INCLUDE_PATH_INFO_ATTRIBUTE`
`static String`	`INCLUDE_QUERY_STRING_ATTRIBUTE`
`static String`	`INCLUDE_REQUEST_URI_ATTRIBUTE`
`static String`	`INCLUDE_SERVLET_PATH_ATTRIBUTE`

构造器概要

构造器
构造器和说明

WebUtils()

构造器
构造器和说明
`WebUtils()`

方法概要

所有方法静态方法具体方法
限定符和类型	方法和说明
`static String`	`decodeRequestString(javax.servlet.http.HttpServletRequest request, String source)` Decode the given source string with a URLDecoder.
`protected static String`	`determineEncoding(javax.servlet.http.HttpServletRequest request)` Determine the encoding for the given request.
`static String`	`getCleanParam(javax.servlet.ServletRequest request, String paramName)` Convenience method that returns a request parameter value, first running it through
`static String`	`getContextPath(javax.servlet.http.HttpServletRequest request)` Return the context path for the given request, detecting an include request URL if called within a RequestDispatcher include.
`static String`	`getPathWithinApplication(javax.servlet.http.HttpServletRequest request)` Return the path within the web application for the given request.
`static String`	`getRequestUri(javax.servlet.http.HttpServletRequest request)` Return the request URI for the given request, detecting an include request URL if called within a RequestDispatcher include.
`static String`	`normalize(String path)` Normalize a relative URI path that may have relative values ("/./", "/../", and so on ) it it.
`static String`	`removeParam(String queryString, String name)`
`static javax.servlet.http.HttpServletRequest`	`toHttp(javax.servlet.ServletRequest request)` A convenience method that merely casts the incoming `ServletRequest` to an `HttpServletRequest`: `return (HttpServletRequest)request;` Logic could be changed in the future for logging or throwing an meaningful exception in non HTTP request environments (e.g.
`static javax.servlet.http.HttpServletResponse`	`toHttp(javax.servlet.ServletResponse response)` A convenience method that merely casts the incoming `ServletResponse` to an `HttpServletResponse`: `return (HttpServletResponse)response;` Logic could be changed in the future for logging or throwing an meaningful exception in non HTTP request environments (e.g.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - INCLUDE_REQUEST_URI_ATTRIBUTE
```
public static final String INCLUDE_REQUEST_URI_ATTRIBUTE
```
    另请参阅:
    
    常量字段值
  - INCLUDE_CONTEXT_PATH_ATTRIBUTE
```
public static final String INCLUDE_CONTEXT_PATH_ATTRIBUTE
```
    另请参阅:
    
    常量字段值
  - INCLUDE_SERVLET_PATH_ATTRIBUTE
```
public static final String INCLUDE_SERVLET_PATH_ATTRIBUTE
```
    另请参阅:
    
    常量字段值
  - INCLUDE_PATH_INFO_ATTRIBUTE
```
public static final String INCLUDE_PATH_INFO_ATTRIBUTE
```
    另请参阅:
    
    常量字段值
  - INCLUDE_QUERY_STRING_ATTRIBUTE
```
public static final String INCLUDE_QUERY_STRING_ATTRIBUTE
```
    另请参阅:
    
    常量字段值
  - FORWARD_REQUEST_URI_ATTRIBUTE
```
public static final String FORWARD_REQUEST_URI_ATTRIBUTE
```
    Standard Servlet 2.4+ spec request attributes for forward URI and paths.
    If forwarded to via a RequestDispatcher, the current resource will see its own URI and paths. The originating URI and paths are exposed as request attributes.
    
    另请参阅:
    
    常量字段值
  - FORWARD_CONTEXT_PATH_ATTRIBUTE
```
public static final String FORWARD_CONTEXT_PATH_ATTRIBUTE
```
    另请参阅:
    
    常量字段值
  - FORWARD_SERVLET_PATH_ATTRIBUTE
```
public static final String FORWARD_SERVLET_PATH_ATTRIBUTE
```
    另请参阅:
    
    常量字段值
  - FORWARD_PATH_INFO_ATTRIBUTE
```
public static final String FORWARD_PATH_INFO_ATTRIBUTE
```
    另请参阅:
    
    常量字段值
  - FORWARD_QUERY_STRING_ATTRIBUTE
```
public static final String FORWARD_QUERY_STRING_ATTRIBUTE
```
    另请参阅:
    
    常量字段值
  - DEFAULT_CHARACTER_ENCODING
```
public static final String DEFAULT_CHARACTER_ENCODING
```
    Default character encoding to use when request.getCharacterEncoding returns null, according to the Servlet spec.
    
    另请参阅:
    
    ServletRequest.getCharacterEncoding(), 常量字段值
- 构造器详细资料
  - WebUtils
```
public WebUtils()
```
- 方法详细资料
  - getPathWithinApplication
```
public static String getPathWithinApplication(javax.servlet.http.HttpServletRequest request)
```
    Return the path within the web application for the given request. Detects include request URL if called within a RequestDispatcher include.
    For example, for a request to URL
    http://www.somehost.com/myapp/my/url.jsp,
    for an application deployed to /mayapp (the application's context path), this method would return
    /my/url.jsp.
    
    参数:
    
    request - current HTTP request
    
    返回:
    
    the path within the web application
  - getRequestUri
```
public static String getRequestUri(javax.servlet.http.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.
    
    参数:
    
    request - current HTTP request
    
    返回:
    
    the request URI
  - normalize
```
public static String normalize(String path)
```
    Normalize a relative URI path that may have relative values ("/./", "/../", and so on ) it it. WARNING - This method is useful only for normalizing application-generated paths. It does not try to perform security checks for malicious input. Normalize operations were was happily taken from org.apache.catalina.util.RequestUtil in Tomcat trunk, r939305
    
    参数:
    
    path - Relative path to be normalized
    
    返回:
    
    normalized path
  - getContextPath
```
public static String getContextPath(javax.servlet.http.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.
    
    参数:
    
    request - current HTTP request
    
    返回:
    
    the context path
  - decodeRequestString
```
public static String decodeRequestString(javax.servlet.http.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).
    
    参数:
    
    request - current HTTP request
    
    source - the String to decode
    
    返回:
    
    the decoded String
    
    另请参阅:
    
    DEFAULT_CHARACTER_ENCODING, ServletRequest.getCharacterEncoding(), URLDecoder.decode(String, String), URLDecoder.decode(String)
  - determineEncoding
```
protected static String determineEncoding(javax.servlet.http.HttpServletRequest request)
```
    Determine the encoding for the given request. Can be overridden in subclasses.
    The default implementation checks the request's character encoding, and if that null, falls back to the DEFAULT_CHARACTER_ENCODING.
    
    参数:
    
    request - current HTTP request
    
    返回:
    
    the encoding for the request (never null)
    
    另请参阅:
    
    ServletRequest.getCharacterEncoding()
  - toHttp
```
public static javax.servlet.http.HttpServletRequest toHttp(javax.servlet.ServletRequest request)
```
    A convenience method that merely casts the incoming ServletRequest to an HttpServletRequest:
    return (HttpServletRequest)request;
    Logic could be changed in the future for logging or throwing an meaningful exception in non HTTP request environments (e.g. Portlet API).
    
    参数:
    
    request - the incoming ServletRequest
    
    返回:
    
    the request argument casted to an HttpServletRequest.
  - toHttp
```
public static javax.servlet.http.HttpServletResponse toHttp(javax.servlet.ServletResponse response)
```
    A convenience method that merely casts the incoming ServletResponse to an HttpServletResponse:
    return (HttpServletResponse)response;
    Logic could be changed in the future for logging or throwing an meaningful exception in non HTTP request environments (e.g. Portlet API).
    
    参数:
    
    response - the outgoing ServletResponse
    
    返回:
    
    the response argument casted to an HttpServletResponse.
  - getCleanParam
```
public static String getCleanParam(javax.servlet.ServletRequest request,
                                   String paramName)
```
    Convenience method that returns a request parameter value, first running it through
    
    参数:
    
    request - the servlet request.
    
    paramName - the parameter name.
    
    返回:
    
    the clean param value, or null if the param does not exist or is empty.
  - removeParam
```
public static String removeParam(String queryString,
                                 String name)
```

类 WebUtils

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

INCLUDE_REQUEST_URI_ATTRIBUTE

INCLUDE_CONTEXT_PATH_ATTRIBUTE

INCLUDE_SERVLET_PATH_ATTRIBUTE

INCLUDE_PATH_INFO_ATTRIBUTE

INCLUDE_QUERY_STRING_ATTRIBUTE

FORWARD_REQUEST_URI_ATTRIBUTE

FORWARD_CONTEXT_PATH_ATTRIBUTE

FORWARD_SERVLET_PATH_ATTRIBUTE

FORWARD_PATH_INFO_ATTRIBUTE

FORWARD_QUERY_STRING_ATTRIBUTE

DEFAULT_CHARACTER_ENCODING

构造器详细资料

WebUtils

方法详细资料

getPathWithinApplication

getRequestUri

normalize

getContextPath

decodeRequestString

determineEncoding

toHttp

toHttp

getCleanParam

removeParam