Context (solon 2.8.4-M2 API)

java.lang.Object
- org.noear.solon.core.handle.Context

直接已知子类:

ContextEmpty
```
public abstract class Context
extends Object
```
通用上下文接口（实现：Context + Handler 架构）

从以下版本开始:

1.0

作者:

noear

字段概要

字段
限定符和类型	字段和说明
`protected Charset`	`charset`
`Throwable`	`errors` 用于在处理链中透传处理错误
`Object`	`result` 用于在处理链中透传处理结果
`protected SessionState`	`sessionState`

构造器概要

构造器
构造器和说明

Context()

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

方法概要

所有方法静态方法实例方法抽象方法具体方法已过时的方法
限定符和类型	方法和说明
`String`	`accept()` 获取 Accept 头信息
`void`	`accept(String acceptNew)`
`String`	`acceptNew()` 获取新的 Accept 头信息
`Action`	`action()` 获取当前动作
`abstract void`	`asyncComplete()` 异步完成
`void`	`asyncStart()` 异步开始
`abstract void`	`asyncStart(long timeout, ContextAsyncListener listener)` 异步开始
`abstract boolean`	`asyncSupported()` 是否支持异步
`<T> T`	`attr(String name)` 获取上下文特性
`<T> T`	`attr(String name, T def)` 已过时。
`void`	`attrClear()` 清除上下文特性
`Map<String,Object>`	`attrMap()` 获取自定义特性并转为Map
`<T> T`	`attrOrDefault(String name, T def)` 获取上下文特性
`void`	`attrSet(Map<String,Object> map)` 设置上下文特性
`void`	`attrSet(String name, Object val)` 设置上下文特性
`boolean`	`autoMultipart()` 是否自动解析分段内容
`void`	`autoMultipart(boolean auto)` 设置是否自动解析分段内容
`String`	`body()` 获取body内容
`String`	`body(String charset)` 获取body内容
`byte[]`	`bodyAsBytes()` 获取body内容为byte[]
`abstract InputStream`	`bodyAsStream()` 获取body内容为Stream
`String`	`bodyNew()` 获取新的body
`void`	`bodyNew(String bodyNew)` 设置新的body
`void`	`charset(String charset)` 设置字符集
`abstract void`	`close()` 关闭响应（一些特殊的boot才有效）
`abstract String`	`contentCharset()` 获取获取编码类型
`abstract long`	`contentLength()` 获取内容长度
`void`	`contentLength(long size)` 设置内容长度
`abstract String`	`contentType()` 获取内容类型
`void`	`contentType(String contentType)` 设置内容类型
`protected abstract void`	`contentTypeDoSet(String contentType)`
`String`	`contentTypeNew()` 获取设置的新内容类型
`Object`	`controller()` 获取当前控制器
`String`	`cookie(String name)` 获取 cookie
`String`	`cookie(String name, String def)` 已过时。 2.5
`abstract NvMap`	`cookieMap()` 获取 cookieMap
`String`	`cookieOrDefault(String name, String def)` 获取 cookie
`void`	`cookieRemove(String name)` 移徐 cookie
`void`	`cookieSet(String name, String val)` 设置 cookie
`void`	`cookieSet(String name, String val, int maxAge)` 设置 cookie
`void`	`cookieSet(String name, String val, String domain, int maxAge)` 设置 cookie
`abstract void`	`cookieSet(String name, String val, String domain, String path, int maxAge)` 设置 cookie
`static Context`	`current()` 获取当前线程的上下文
`UploadedFile`	`file(String name)` 获取上传文件
`List<UploadedFile>`	`files(String name)` 获取上传文件数组
`abstract void`	`filesDelete()` 删除所有上传文件
`abstract Map<String,List<UploadedFile>>`	`filesMap()`
`abstract void`	`flush()` 冲刷
`void`	`forward(String pathNew)` 转发
`boolean`	`getHandled()` 获取处理状态
`Locale`	`getLocale()` 获取地区
`boolean`	`getRendered()` 获取渲染状态
`String`	`header(String name)` 获取 header
`String`	`header(String name, String def)` 已过时。 2.3
`abstract void`	`headerAdd(String name, String val)` 添加 header
`abstract NvMap`	`headerMap()` 获取 headerMap
`abstract Collection<String>`	`headerNamesOfResponse()` 获取响应 headerNames
`abstract String`	`headerOfResponse(String name)` 获取响应 header
`String`	`headerOrDefault(String name, String def)` 获取 header
`abstract void`	`headerSet(String name, String val)` 设置 header
`abstract Map<String,List<String>>`	`headersMap()` 获取 headersMap
`String[]`	`headerValues(String name)` 获取 header (多值)
`abstract Collection<String>`	`headerValuesOfResponse(String name)` 获取响应 header
`String`	`ip()` 已过时。 2.5
`boolean`	`isFormUrlencoded()` 是否为编码窗体
`boolean`	`isMultipart()` 是否为分段内容
`boolean`	`isMultipartFormData()` 是否为分段表单数据
`abstract boolean`	`isSecure()` 是否为 ssl 请求
`Handler`	`mainHandler()` 获取当前主处理器
`abstract String`	`method()` 获取请求方法
`abstract void`	`output(byte[] bytes)` 输出字节数组
`abstract void`	`output(InputStream stream)` 输出流对象
`void`	`output(String str)` 输出字符串
`void`	`output(Throwable ex)` 输出异常对象
`abstract void`	`outputAsFile(DownloadedFile file)` 输出为文件
`abstract void`	`outputAsFile(File file)` 输出为文件
`void`	`outputAsHtml(String html)` 输出为html文本
`void`	`outputAsJson(String json)` 输出为json文本
`abstract OutputStream`	`outputStream()` 获取输出流
`String`	`param(String name)` 获取参数
`String`	`param(String key, String def)` 已过时。 2.3
`<T> T`	`paramAsBean(Class<T> type)` 获取参数并转为Bean
`BigDecimal`	`paramAsDecimal(String name)` 获取参数并转为BigDecimal
`BigDecimal`	`paramAsDecimal(String name, BigDecimal def)` 获取参数并转为BigDecimal
`double`	`paramAsDouble(String name)` 获取参数并转为double
`double`	`paramAsDouble(String name, double def)` 获取参数并转为double
`int`	`paramAsInt(String name)` 获取参数并转为int
`int`	`paramAsInt(String name, int def)` 获取参数并转为int
`long`	`paramAsLong(String name)` 获取参数并转为long
`long`	`paramAsLong(String name, long def)` 获取参数并转为long
`abstract NvMap`	`paramMap()` 获取所有参数并转为map
`String`	`paramOrDefault(String key, String def)` 获取参数或默认
`void`	`paramsAdd(String name, String val)` 添加参数
`void`	`paramSet(String name, String val)` 设置参数
`abstract Map<String,List<String>>`	`paramsMap()` 获取所有参数并转为Map
`String[]`	`paramValues(String name)` 获取参数数组
`String`	`path()` 获取请求的URI路径
`String`	`pathAsLower()` 获取请求的URI路径并大写
`String`	`pathAsUpper()` 获取请求的URI路径并大写
`NvMap`	`pathMap(String expr)` 获取请求的URI路径变量,根据路径表达式
`String`	`pathNew()` 获取新路径，不存在则返回原路径
`void`	`pathNew(String pathNew)` 设置新路径
`abstract String`	`protocol()` 获取请求协议
`String`	`protocolAsUpper()` 获取请求协议并大写
`Object`	`pull(Class<?> clz)` 拉取
`abstract String`	`queryString()` 获取查询字符串
`String`	`realIp()` 获取客户端真实IP
`void`	`redirect(String url)` 跳转地址
`abstract void`	`redirect(String url, int code)` 跳转地址
`abstract String`	`remoteIp()` 获取远程IP
`abstract int`	`remotePort()` 获取远程Port
`boolean`	`remoting()` 是否为远程调用
`void`	`remotingSet(boolean remoting)`
`void`	`render(Object obj)` 渲染数据（不能重写，避免死循环）
`void`	`render(String view, Map<String,?> data)` 渲染数据
`String`	`renderAndReturn(Object obj)` 渲染数据并返回
`abstract Object`	`request()` 获取请求对象
`abstract Object`	`response()` 获取响应对象
`Object`	`session(String name)`
`abstract <T> T`	`session(String name, Class<T> clz)` 获取 session 状态
`<T> T`	`session(String name, T def)` 已过时。 2.3
`abstract double`	`sessionAsDouble(String name)` 获取 session 状态，并以 double 型输出
`abstract double`	`sessionAsDouble(String name, double def)` 获取 session 状态，并以 double 型输出
`abstract int`	`sessionAsInt(String name)` 获取 session 状态，并以 int 型输出
`abstract int`	`sessionAsInt(String name, int def)` 获取 session 状态，并以 int 型输出
`abstract long`	`sessionAsLong(String name)` 获取 session 状态，并以 long 型输出
`abstract long`	`sessionAsLong(String name, long def)` 获取 session 状态，并以 long 型输出
`abstract void`	`sessionClear()` 清空 session 状态
`abstract String`	`sessionId()` 获取 sessionId
`abstract <T> T`	`sessionOrDefault(String name, T def)` 获取 session 状态（类型转换，存在风险）
`abstract void`	`sessionRemove(String name)` 移除 session 状态
`abstract void`	`sessionSet(String name, Object val)` 设置 session 状态
`SessionState`	`sessionState()` 获取 sessionState
`void`	`setHandled(boolean handled)` 设置处理状态
`void`	`setLocale(Locale locale)` 设置地区
`void`	`setRendered(boolean rendered)` 设置渲染状态
`abstract int`	`status()` 获取输出状态
`void`	`status(int status)` 设置输出状态
`protected abstract void`	`statusDoSet(int status)`
`void`	`statusSet(int status)` 已过时。 1.8
`abstract URI`	`uri()` 获取请求的URI
`abstract String`	`url()` 获取请求的URL字符串
`String`	`userAgent()` 获取请求的UA

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

字段详细资料

sessionState
```
protected SessionState sessionState
```

charset
```
protected Charset charset
```

result
```
@Nullable
public Object result
```
用于在处理链中透传处理结果

errors
```
@Nullable
public Throwable errors
```
用于在处理链中透传处理错误

构造器详细资料
- Context
```
public Context()
```

方法详细资料

current
```
public static Context current()
```
获取当前线程的上下文

getLocale
```
public Locale getLocale()
```
获取地区

setLocale
```
public void setLocale(Locale locale)
```
设置地区

setHandled

public void setHandled(boolean handled)

设置处理状态

getHandled
```
public boolean getHandled()
```
获取处理状态

setRendered

public void setRendered(boolean rendered)

设置渲染状态

getRendered
```
public boolean getRendered()
```
获取渲染状态

pull
```
public Object pull(Class<?> clz)
```
拉取

request
```
public abstract Object request()
```
获取请求对象

ip
```
@Deprecated
public String ip()
```
已过时。 2.5

获取远程IP

remoteIp
```
public abstract String remoteIp()
```
获取远程IP

remotePort
```
public abstract int remotePort()
```
获取远程Port

realIp
```
public String realIp()
```
获取客户端真实IP

autoMultipart
```
public boolean autoMultipart()
```
是否自动解析分段内容

autoMultipart
```
public void autoMultipart(boolean auto)
```
设置是否自动解析分段内容

isFormUrlencoded
```
public boolean isFormUrlencoded()
```
是否为编码窗体

isMultipart
```
public boolean isMultipart()
```
是否为分段内容

isMultipartFormData
```
public boolean isMultipartFormData()
```
是否为分段表单数据

method
```
public abstract String method()
```
获取请求方法

protocol
```
public abstract String protocol()
```
获取请求协议

protocolAsUpper
```
public String protocolAsUpper()
```
获取请求协议并大写

uri
```
public abstract URI uri()
```
获取请求的URI

path
```
public String path()
```
获取请求的URI路径

pathNew
```
public void pathNew(String pathNew)
```
设置新路径

pathNew
```
public String pathNew()
```
获取新路径，不存在则返回原路径

pathMap
```
public NvMap pathMap(String expr)
```
获取请求的URI路径变量,根据路径表达式

pathAsUpper
```
public String pathAsUpper()
```
获取请求的URI路径并大写

pathAsLower
```
public String pathAsLower()
```
获取请求的URI路径并大写

isSecure
```
public abstract boolean isSecure()
```
是否为 ssl 请求

userAgent
```
public String userAgent()
```
获取请求的UA

url
```
public abstract String url()
```
获取请求的URL字符串

contentLength
```
public abstract long contentLength()
```
获取内容长度

contentType
```
public abstract String contentType()
```
获取内容类型

contentCharset

public abstract String contentCharset()

获取获取编码类型

queryString
```
public abstract String queryString()
```
获取查询字符串

accept
```
public String accept()
```
获取 Accept 头信息

accept
```
public void accept(String acceptNew)
```

acceptNew
```
public String acceptNew()
```
获取新的 Accept 头信息

body

public String body()
            throws IOException

获取body内容

抛出:: IOException

body

public String body(String charset)
            throws IOException

获取body内容

抛出:: IOException

bodyNew

public String bodyNew()
               throws IOException

获取新的body

抛出:: IOException

bodyNew
```
public void bodyNew(String bodyNew)
```
设置新的body

bodyAsBytes

public byte[] bodyAsBytes()
                   throws IOException

获取body内容为byte[]

抛出:: IOException

bodyAsStream

public abstract InputStream bodyAsStream()
                                  throws IOException

获取body内容为Stream

抛出:: IOException

paramValues

public String[] paramValues(String name)

获取参数数组

param
```
public String param(String name)
```
获取参数

param

@Deprecated
public String param(String key,
                                String def)

已过时。 2.3

获取参数

paramOrDefault

public String paramOrDefault(String key,
                             String def)

获取参数或默认

paramAsInt
```
public int paramAsInt(String name)
```
获取参数并转为int

paramAsInt

public int paramAsInt(String name,
                      int def)

获取参数并转为int

paramAsLong
```
public long paramAsLong(String name)
```
获取参数并转为long

paramAsLong

public long paramAsLong(String name,
                        long def)

获取参数并转为long

paramAsDouble

public double paramAsDouble(String name)

获取参数并转为double

paramAsDouble

public double paramAsDouble(String name,
                            double def)

获取参数并转为double

paramAsDecimal

public BigDecimal paramAsDecimal(String name)

获取参数并转为BigDecimal

paramAsDecimal

public BigDecimal paramAsDecimal(String name,
                                 BigDecimal def)

获取参数并转为BigDecimal

paramAsBean

public <T> T paramAsBean(Class<T> type)

获取参数并转为Bean

paramMap
```
public abstract NvMap paramMap()
```
获取所有参数并转为map

paramSet

public void paramSet(String name,
                     String val)

设置参数

paramsMap

public abstract Map<String,List<String>> paramsMap()

获取所有参数并转为Map

paramsAdd

public void paramsAdd(String name,
                      String val)

添加参数

filesMap

public abstract Map<String,List<UploadedFile>> filesMap()
                                                 throws IOException

抛出:: IOException

filesDelete

public abstract void filesDelete()
                          throws IOException

删除所有上传文件

抛出:: IOException

files

public List<UploadedFile> files(String name)
                         throws IOException

获取上传文件数组

参数:: name - 文件名
抛出:: IOException

file

public UploadedFile file(String name)
                  throws IOException

获取上传文件

参数:: name - 文件名
抛出:: IOException

cookie
```
public String cookie(String name)
```
获取 cookie

参数:

name - cookie名

cookie

@Deprecated
public String cookie(String name,
                                 String def)

已过时。 2.5

获取 cookie

参数:: name - cookie名; def - 默认值

cookieOrDefault

public String cookieOrDefault(String name,
                              String def)

获取 cookie

参数:: name - cookie名; def - 默认值

cookieMap
```
public abstract NvMap cookieMap()
```
获取 cookieMap

header
```
public String header(String name)
```
获取 header

参数:

name - header名

header

@Deprecated
public String header(String name,
                                 String def)

已过时。 2.3

获取 header

参数:: name - header名; def - 默认值

headerOrDefault

public String headerOrDefault(String name,
                              String def)

获取 header

参数:: name - header名

headerMap
```
public abstract NvMap headerMap()
```
获取 headerMap

headerValues
```
public String[] headerValues(String name)
```
获取 header (多值)

参数:

name - header名

headersMap

public abstract Map<String,List<String>> headersMap()

获取 headersMap

sessionState
```
public SessionState sessionState()
```
获取 sessionState

sessionId
```
public abstract String sessionId()
```
获取 sessionId

session

public final Object session(String name)

session

public abstract <T> T session(String name,
                              Class<T> clz)

获取 session 状态

参数:: name - 状态名

session

@Deprecated
public <T> T session(String name,
                                 @NonNull
                                 T def)

已过时。 2.3

获取 session 状态（类型转换，存在风险）

参数:: name - 状态名

sessionOrDefault

public abstract <T> T sessionOrDefault(String name,
                                       @NonNull
                                       T def)

获取 session 状态（类型转换，存在风险）

参数:: name - 状态名
从以下版本开始:: 2.3

sessionAsInt
```
public abstract int sessionAsInt(String name)
```
获取 session 状态，并以 int 型输出

参数:

name - 状态名

从以下版本开始:

1.6

sessionAsInt
```
public abstract int sessionAsInt(String name,
                                 int def)
```
获取 session 状态，并以 int 型输出

参数:

name - 状态名

从以下版本开始:

1.6

sessionAsLong
```
public abstract long sessionAsLong(String name)
```
获取 session 状态，并以 long 型输出

参数:

name - 状态名

从以下版本开始:

1.6

sessionAsLong
```
public abstract long sessionAsLong(String name,
                                   long def)
```
获取 session 状态，并以 long 型输出

参数:

name - 状态名

从以下版本开始:

1.6

sessionAsDouble
```
public abstract double sessionAsDouble(String name)
```
获取 session 状态，并以 double 型输出

参数:

name - 状态名

从以下版本开始:

1.6

sessionAsDouble
```
public abstract double sessionAsDouble(String name,
                                       double def)
```
获取 session 状态，并以 double 型输出

参数:

name - 状态名

从以下版本开始:

1.6

sessionSet

public abstract void sessionSet(String name,
                                Object val)

设置 session 状态

参数:: name - 状态名; val - 值

sessionRemove
```
public abstract void sessionRemove(String name)
```
移除 session 状态

参数:

name - 状态名

sessionClear
```
public abstract void sessionClear()
```
清空 session 状态

response
```
public abstract Object response()
```
获取响应对象

charset
```
public void charset(String charset)
```
设置字符集

contentType

public void contentType(String contentType)

设置内容类型

contentTypeNew
```
public String contentTypeNew()
```
获取设置的新内容类型

contentTypeDoSet

protected abstract void contentTypeDoSet(String contentType)

contentLength
```
public void contentLength(long size)
```
设置内容长度

output

public abstract void output(byte[] bytes)

输出字节数组

output

public abstract void output(InputStream stream)

输出流对象

outputStream

public abstract OutputStream outputStream()
                                   throws IOException

获取输出流

抛出:: IOException

output
```
public void output(String str)
```
输出字符串

output
```
public void output(Throwable ex)
```
输出异常对象

outputAsJson

public void outputAsJson(String json)

输出为json文本

outputAsHtml

public void outputAsHtml(String html)

输出为html文本

outputAsFile

public abstract void outputAsFile(DownloadedFile file)
                           throws IOException

输出为文件

抛出:: IOException

outputAsFile

public abstract void outputAsFile(File file)
                           throws IOException

输出为文件

抛出:: IOException

headerSet

public abstract void headerSet(String name,
                               String val)

设置 header

headerAdd

public abstract void headerAdd(String name,
                               String val)

添加 header

headerOfResponse

public abstract String headerOfResponse(String name)

获取响应 header

headerValuesOfResponse

public abstract Collection<String> headerValuesOfResponse(String name)

获取响应 header

headerNamesOfResponse

public abstract Collection<String> headerNamesOfResponse()

获取响应 headerNames

cookieSet

public void cookieSet(String name,
                      String val)

设置 cookie

cookieSet

public void cookieSet(String name,
                      String val,
                      int maxAge)

设置 cookie

cookieSet

public void cookieSet(String name,
                      String val,
                      String domain,
                      int maxAge)

设置 cookie

cookieSet

public abstract void cookieSet(String name,
                               String val,
                               String domain,
                               String path,
                               int maxAge)

设置 cookie

cookieRemove

public void cookieRemove(String name)

移徐 cookie

redirect
```
public void redirect(String url)
```
跳转地址

redirect

public abstract void redirect(String url,
                              int code)

跳转地址

forward
```
public void forward(String pathNew)
```
转发

status
```
public abstract int status()
```
获取输出状态

status
```
public void status(int status)
```
设置输出状态

statusSet

@Deprecated
public void statusSet(int status)

已过时。 1.8

statusDoSet

protected abstract void statusDoSet(int status)

attrMap
```
public Map<String,Object> attrMap()
```
获取自定义特性并转为Map

attrOrDefault

public <T> T attrOrDefault(String name,
                           T def)

获取上下文特性

attr

@Deprecated
public <T> T attr(String name,
                              T def)

已过时。

获取上下文特性

attr
```
public <T> T attr(String name)
```
获取上下文特性

attrSet

public void attrSet(String name,
                    Object val)

设置上下文特性

attrSet

public void attrSet(Map<String,Object> map)

设置上下文特性

attrClear
```
public void attrClear()
```
清除上下文特性

render

public final void render(Object obj)
                  throws Throwable

渲染数据（不能重写，避免死循环）

抛出:: Throwable

render

public final void render(String view,
                         Map<String,?> data)
                  throws Throwable

渲染数据

抛出:: Throwable

renderAndReturn

public final String renderAndReturn(Object obj)
                             throws Throwable

渲染数据并返回

抛出:: Throwable

remoting
```
public boolean remoting()
```
是否为远程调用

remotingSet

public void remotingSet(boolean remoting)

flush

public abstract void flush()
                    throws IOException

冲刷

抛出:: IOException

close

public abstract void close()
                    throws IOException

关闭响应（一些特殊的boot才有效）

抛出:: IOException

asyncSupported

public abstract boolean asyncSupported()

是否支持异步

asyncStart

public abstract void asyncStart(long timeout,
                                ContextAsyncListener listener)

异步开始

asyncStart
```
public void asyncStart()
```
异步开始

asyncComplete

public abstract void asyncComplete()
                            throws IOException

异步完成

抛出:: IOException

controller
```
@Nullable
public Object controller()
```
获取当前控制器

action
```
@Nullable
public Action action()
```
获取当前动作

mainHandler

@Nullable
public Handler mainHandler()

获取当前主处理器

类 Context

字段概要

构造器概要

方法概要

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

字段详细资料

sessionState

charset

result

errors

构造器详细资料

Context

方法详细资料

current

getLocale

setLocale

setHandled

getHandled

setRendered

getRendered

pull

request

ip

remoteIp

remotePort

realIp

autoMultipart

autoMultipart

isFormUrlencoded

isMultipart

isMultipartFormData

method

protocol

protocolAsUpper

uri

path

pathNew

pathNew

pathMap

pathAsUpper

pathAsLower

isSecure

userAgent

url

contentLength

contentType

contentCharset

queryString

accept

accept

acceptNew

body

body

bodyNew

bodyNew

bodyAsBytes

bodyAsStream

paramValues

param

param

paramOrDefault

paramAsInt

paramAsInt

paramAsLong

paramAsLong

paramAsDouble

paramAsDouble

paramAsDecimal

paramAsDecimal

paramAsBean

paramMap

paramSet

paramsMap

paramsAdd

filesMap

filesDelete

files

file

cookie

cookie