ParserWebContext (tiny-码云(gitee.com))

All Superinterfaces:

BaseContext, Context, Serializable, WebContext

All Known Implementing Classes:

ParserWebContextImpl
```
public interface ParserWebContext
extends WebContext
```
自动解析request parameters和cookie parameters，并透明地处理upload请求的web context实现。

Author:

renhui

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_CHARSET_ENCODING` 默认的编码字符集。
`static String`	`UPLOAD_FAILED` 在parameters中表示upload失败，请求被忽略。
`static String`	`UPLOAD_SIZE_LIMIT_EXCEEDED` 在parameters中表示upload文件尺寸超过限制值，请求被忽略。
`static String`	`URL_CASE_FOLDING_LOWER` 配置文件属性可选项：将parameters和cookies的名称转换成小写。
`static String`	`URL_CASE_FOLDING_LOWER_WITH_UNDERSCORES` 配置文件属性可选项：将parameters和cookies的名称转换成小写加下划线。
`static String`	`URL_CASE_FOLDING_NONE` 配置文件属性可选项：不对parameters和cookies的名称进行大小写转换。
`static String`	`URL_CASE_FOLDING_UPPER` 配置文件属性可选项：将parameters和cookies的名称转换成大写。
`static String`	`URL_CASE_FOLDING_UPPER_WITH_UNDERSCORES` 配置文件属性可选项：将parameters和cookies的名称转换成大写加下划线。

Fields inherited from interface org.tinygroup.weblayer.WebContext
REQUEST_ATTRIBUTE_FROM_WEBCONTEXT

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`convertCase(String str)` 将指定的字符串根据`getCaseFolding()`的设置，转换成指定大小写形式。
`String`	`getCaseFolding()` 按照指定的风格转换parameters和cookies的名称，默认为“小写加下划线”。
`CookieParser`	`getCookies()` 取得所有cookie。第一次执行此方法时，将会解析request，从中取得所有cookies。
`String`	`getHtmlFieldSuffix()` 取得代表HTML字段的后缀。
`ParameterParser`	`getParameters()` 取得所有query参数。第一次执行此方法时，将会解析request，从中取得所有的参数。
`org.springframework.beans.PropertyEditorRegistrar`	`getPropertyEditorRegistrar()` 取得用来转换参数类型的propertyEditor注册器。
`UploadService`	`getUploadService()` 返回上传服务
`String`	`getURIEncoding()` 当`useServletEngineParser==false`并且 `useBodyEncodingForURI=false`时，用该编码来解释GET请求的参数。
`boolean`	`isAutoUpload()` 是否自动执行Upload。
`boolean`	`isConverterQuiet()` 类型转换出现异常时，是否不报错，而是返回默认值。
`boolean`	`isTrimming()` 是否对输入参数进行trimming。默认为`true`。
`boolean`	`isUnescapeParameters()` 是否对参数进行HTML entities解码，默认为`true`。
`boolean`	`isUseBodyEncodingForURI()` 是否以request.setCharacterEncoding所指定的编码来解析query，默认为`true`。
`boolean`	`isUseServletEngineParser()` 是否使用servlet引擎的parser，默认为`false`。

Methods inherited from interface org.tinygroup.weblayer.WebContext
getObject, getRequest, getResponse, getServletContext, getWrappedWebContext, init, isRequestFinished, setObject, setRequest, setResponse, setServletContext

Methods inherited from interface org.tinygroup.context.Context
clearSubContext, createSubContext, getInSubContext, getItemMap, getParent, getSubContext, getSubContextMap, getTotalItemMap, put, putSubContext, remove, removeSubContext, setParent

Methods inherited from interface org.tinygroup.context.BaseContext
clear, contain, exist, get, get, put, putAll, remove, renameKey, size

- Field Detail
  - URL_CASE_FOLDING_NONE
```
static final String URL_CASE_FOLDING_NONE
```
    配置文件属性可选项：不对parameters和cookies的名称进行大小写转换。
    
    See Also:
    
    Constant Field Values
  - URL_CASE_FOLDING_LOWER
```
static final String URL_CASE_FOLDING_LOWER
```
    配置文件属性可选项：将parameters和cookies的名称转换成小写。
    
    See Also:
    
    Constant Field Values
  - URL_CASE_FOLDING_LOWER_WITH_UNDERSCORES
```
static final String URL_CASE_FOLDING_LOWER_WITH_UNDERSCORES
```
    配置文件属性可选项：将parameters和cookies的名称转换成小写加下划线。
    
    See Also:
    
    Constant Field Values
  - URL_CASE_FOLDING_UPPER
```
static final String URL_CASE_FOLDING_UPPER
```
    配置文件属性可选项：将parameters和cookies的名称转换成大写。
    
    See Also:
    
    Constant Field Values
  - URL_CASE_FOLDING_UPPER_WITH_UNDERSCORES
```
static final String URL_CASE_FOLDING_UPPER_WITH_UNDERSCORES
```
    配置文件属性可选项：将parameters和cookies的名称转换成大写加下划线。
    
    See Also:
    
    Constant Field Values
  - DEFAULT_CHARSET_ENCODING
```
static final String DEFAULT_CHARSET_ENCODING
```
    默认的编码字符集。
    
    See Also:
    
    Constant Field Values
  - UPLOAD_FAILED
```
static final String UPLOAD_FAILED
```
    在parameters中表示upload失败，请求被忽略。
    
    See Also:
    
    Constant Field Values
  - UPLOAD_SIZE_LIMIT_EXCEEDED
```
static final String UPLOAD_SIZE_LIMIT_EXCEEDED
```
    在parameters中表示upload文件尺寸超过限制值，请求被忽略。
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getPropertyEditorRegistrar
```
org.springframework.beans.PropertyEditorRegistrar getPropertyEditorRegistrar()
```
    取得用来转换参数类型的propertyEditor注册器。
  - isConverterQuiet
```
boolean isConverterQuiet()
```
    类型转换出现异常时，是否不报错，而是返回默认值。
  - isAutoUpload
```
boolean isAutoUpload()
```
    是否自动执行Upload。
  - getHtmlFieldSuffix
```
String getHtmlFieldSuffix()
```
    取得代表HTML字段的后缀。
  - getCaseFolding
```
String getCaseFolding()
```
    按照指定的风格转换parameters和cookies的名称，默认为“小写加下划线”。
  - isUnescapeParameters
```
boolean isUnescapeParameters()
```
    是否对参数进行HTML entities解码，默认为true。
  - isUseServletEngineParser
```
boolean isUseServletEngineParser()
```
    是否使用servlet引擎的parser，默认为false。
  - isUseBodyEncodingForURI
```
boolean isUseBodyEncodingForURI()
```
    是否以request.setCharacterEncoding所指定的编码来解析query，默认为true。
    只有当useServletEngineParser==false时，此选项才有效。
  - getURIEncoding
```
String getURIEncoding()
```
    当useServletEngineParser==false并且 useBodyEncodingForURI=false时，用该编码来解释GET请求的参数。
  - isTrimming
```
boolean isTrimming()
```
    是否对输入参数进行trimming。默认为true。
  - getParameters
```
ParameterParser getParameters()
```
    取得所有query参数。第一次执行此方法时，将会解析request，从中取得所有的参数。
    
    Returns:
    
    ParameterParser实例
  - getCookies
```
CookieParser getCookies()
```
    取得所有cookie。第一次执行此方法时，将会解析request，从中取得所有cookies。
    
    Returns:
    
    CookieParser实例
  - convertCase
```
String convertCase(String str)
```
    将指定的字符串根据getCaseFolding()的设置，转换成指定大小写形式。
    
    Parameters:
    
    str - 要转换的字符串
    
    Returns:
    
    转换后的字符串
  - getUploadService
```
UploadService getUploadService()
```
    返回上传服务
    
    Returns:

Interface ParserWebContext

Field Summary

Fields inherited from interface org.tinygroup.weblayer.WebContext

Method Summary

Methods inherited from interface org.tinygroup.weblayer.WebContext

Methods inherited from interface org.tinygroup.context.Context

Methods inherited from interface org.tinygroup.context.BaseContext

Field Detail

URL_CASE_FOLDING_NONE

URL_CASE_FOLDING_LOWER

URL_CASE_FOLDING_LOWER_WITH_UNDERSCORES

URL_CASE_FOLDING_UPPER

URL_CASE_FOLDING_UPPER_WITH_UNDERSCORES

DEFAULT_CHARSET_ENCODING

UPLOAD_FAILED

UPLOAD_SIZE_LIMIT_EXCEEDED

Method Detail

getPropertyEditorRegistrar

isConverterQuiet

isAutoUpload

getHtmlFieldSuffix

getCaseFolding

isUnescapeParameters

isUseServletEngineParser

isUseBodyEncodingForURI

getURIEncoding

isTrimming

getParameters

getCookies

convertCase

getUploadService