Context (solon 3.3.1-M3 API)

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

Direct Known Subclasses:

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

Since:

1.0

Author:

noear

Field Summary

Fields
Modifier and Type	Field and Description
`protected Charset`	`charset`
`Throwable`	`errors` 用于在处理链中透传处理错误
`Object`	`result` 用于在处理链中透传处理结果
`protected SessionState`	`sessionState`

Constructor Summary

Constructors
Constructor and Description

Context()

Constructors
Constructor and Description
`Context()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`accept()` 获取 Accept 头信息
`void`	`accept(String acceptNew)`
`String`	`acceptNew()` 获取新的 Accept 头信息
`Action`	`action()` 获取当前动作
`abstract void`	`asyncComplete()` 异步完成
`abstract void`	`asyncListener(ContextAsyncListener listener)` 异步监听
`void`	`asyncStart()` 异步开始
`abstract void`	`asyncStart(long timeout, Runnable runnable)` 异步开始
`abstract boolean`	`asyncStarted()` 异步已开始
`abstract boolean`	`asyncSupported()` 是否支持异步
`<T> T`	`attr(String name)` 获取上下文特性
`Map<String,Object>`	`attrMap()` 获取自定义特性并转为Map
`Collection<String>`	`attrNames()` 获取上下文特性的名字集合
`<T> T`	`attrOrDefault(String name, T def)` 获取上下文特性
`void`	`attrsClear()` 清除所有上下文特性
`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`	`cacheControl(String strategy)` 设置缓存控制
`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
`abstract MultiMap<String>`	`cookieMap()` 获取小饼字典集合
`Collection<String>`	`cookieNames()` 获取所有小饼的名字集合
`String`	`cookieOrDefault(String name, String def)` 获取 cookie
`void`	`cookieRemove(String name)` 移徐 cookie
`abstract void`	`cookieSet(Cookie cookie)` 设置 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
`void`	`cookieSet(String name, String val, String domain, String path, int maxAge)` 设置 cookie
`String[]`	`cookieValues(String name)` 获取 cookie (多值)
`static Context`	`current()` 获取当前线程的上下文
`UploadedFile`	`file(String name)` 获取上传文件
`abstract MultiMap<UploadedFile>`	`fileMap()` 获取上传文件字典集合
`Set<String>`	`fileNames()` 获取所有文件的名字集合
`abstract void`	`filesDelete()` 删除所有上传文件
`UploadedFile[]`	`fileValues(String name)` 获取上传文件数组
`abstract void`	`flush()` 冲刷
`void`	`forward(String pathNew)` 转发
`boolean`	`getHandled()` 获取处理状态
`Locale`	`getLocale()` 获取地区
`boolean`	`getRendered()` 获取渲染状态
`String`	`header(String name)` 获取 header
`abstract void`	`headerAdd(String name, String val)` 添加 header
`abstract MultiMap<String>`	`headerMap()` 获取头字典集合
`Collection<String>`	`headerNames()` 获取所有头的名字集合
`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
`String[]`	`headerValues(String name)` 获取 header (多值)
`abstract Collection<String>`	`headerValuesOfResponse(String name)` 获取响应 header
`boolean`	`isFormUrlencoded()` 是否为编码窗体
`abstract boolean`	`isHeadersSent()` 是否头部已发送
`boolean`	`isMultipart()` 是否为分段内容
`boolean`	`isMultipartFormData()` 是否为分段表单数据
`abstract boolean`	`isSecure()` 是否为 ssl 请求
`void`	`keepAlive(int timeout)` 设置保持连接
`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()` 获取输出流
`abstract GZIPOutputStream`	`outputStreamAsGzip()` 获取输出流 gzip 模式
`String`	`param(String name)` 获取参数
`<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 MultiMap<String>`	`paramMap()` 获取参数字典集合
`Collection<String>`	`paramNames()` 获取所有参数的名字集合
`String`	`paramOrDefault(String key, String def)` 获取参数或默认
`String[]`	`paramValues(String name)` 获取参数数组
`abstract String`	`path()`
`String`	`pathAsLower()` 获取请求的URI路径并大写
`String`	`pathAsUpper()` 获取请求的URI路径并大写
`Map<String,String>`	`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)` 跳转地址
`String`	`referer()` 获取请求的Referer
`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()` 获取响应对象
`void`	`returnValue(Object obj)` 返回值
`Object`	`session(String name)`
`abstract <T> T`	`session(String name, Class<T> clz)` 获取 session 状态
`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`	`sessionReset()` 重置 session 状态
`abstract void`	`sessionSet(String name, Object val)` 设置 session 状态
`SessionState`	`sessionState()` 获取 sessionState
`SessionState`	`sessionState(boolean create)` 获取 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)`
`abstract URI`	`uri()` 获取请求的URI
`abstract String`	`url()` 获取请求的URL字符串
`String`	`userAgent()` 获取请求的UA

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

Field Detail

sessionState
```
protected SessionState sessionState
```

charset
```
protected Charset charset
```

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

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

Constructor Detail
- Context
```
public Context()
```

Method Detail

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()
```
获取渲染状态

isHeadersSent

public abstract boolean isHeadersSent()

是否头部已发送

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

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

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 abstract String path()
```

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

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

pathMap
```
public Map<String,String> 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

referer
```
public String referer()
```
获取请求的Referer

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内容

Throws:: IOException

body

public String body(String charset)
            throws IOException

获取body内容

Throws:: IOException

bodyNew

public String bodyNew()
               throws IOException

获取新的body

Throws:: IOException

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

bodyAsBytes

public byte[] bodyAsBytes()
                   throws IOException

获取body内容为byte[]

Throws:: IOException

bodyAsStream

public abstract InputStream bodyAsStream()
                                  throws IOException

获取body内容为Stream

Throws:: IOException

paramValues

@Nullable
public String[] paramValues(String name)

获取参数数组

param

@Nullable
public String param(String name)

获取参数

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

paramNames
```
public Collection<String> paramNames()
```
获取所有参数的名字集合

paramMap

public abstract MultiMap<String> paramMap()

获取参数字典集合

fileValues

@Nullable
public UploadedFile[] fileValues(String name)

获取上传文件数组

Parameters:: name - 文件名

file

@Nullable
public UploadedFile file(String name)
                            throws IOException

获取上传文件

Parameters:: name - 文件名
Throws:: IOException

filesDelete

public abstract void filesDelete()
                          throws IOException

删除所有上传文件

Throws:: IOException

fileNames
```
public Set<String> fileNames()
```
获取所有文件的名字集合

fileMap

public abstract MultiMap<UploadedFile> fileMap()

获取上传文件字典集合

cookie

@Nullable
public String cookie(String name)

获取 cookie

Parameters:: name - cookie名

cookieOrDefault

public String cookieOrDefault(String name,
                              String def)

获取 cookie

Parameters:: name - cookie名; def - 默认值

cookieValues

@Nullable
public String[] cookieValues(String name)

获取 cookie (多值)

cookieNames
```
public Collection<String> cookieNames()
```
获取所有小饼的名字集合

cookieMap

public abstract MultiMap<String> cookieMap()

获取小饼字典集合

header

@Nullable
public String header(String name)

获取 header

Parameters:: name - header名

headerOrDefault

public String headerOrDefault(String name,
                              String def)

获取 header

Parameters:: name - header名

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

Parameters:

name - header名

headerNames

public Collection<String> headerNames()

获取所有头的名字集合

headerMap

public abstract MultiMap<String> headerMap()

获取头字典集合

sessionState

public SessionState sessionState(boolean create)

获取 sessionState

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 状态

Parameters:: name - 状态名

sessionOrDefault

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

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

Parameters:: name - 状态名
Since:: 2.3

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

Parameters:

name - 状态名

Since:

1.6

sessionAsInt

public abstract int sessionAsInt(String name,
                                 int def)

获取 session 状态，并以 int 型输出

Parameters:: name - 状态名
Since:: 1.6

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

Parameters:

name - 状态名

Since:

1.6

sessionAsLong

public abstract long sessionAsLong(String name,
                                   long def)

获取 session 状态，并以 long 型输出

Parameters:: name - 状态名
Since:: 1.6

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

Parameters:

name - 状态名

Since:

1.6

sessionAsDouble

public abstract double sessionAsDouble(String name,
                                       double def)

获取 session 状态，并以 double 型输出

Parameters:: name - 状态名
Since:: 1.6

sessionSet

public abstract void sessionSet(String name,
                                Object val)

设置 session 状态

Parameters:: name - 状态名; val - 值

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

Parameters:

name - 状态名

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

sessionReset
```
public abstract void sessionReset()
```
重置 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)
```
设置内容长度

keepAlive
```
public void keepAlive(int timeout)
```
设置保持连接

Parameters:

timeout - 超时（单位：秒）

cacheControl
```
public void cacheControl(String strategy)
```
设置缓存控制

Parameters:

strategy - 策略

output

public abstract void output(byte[] bytes)

输出字节数组

output

public abstract void output(InputStream stream)

输出流对象

outputStream

public abstract OutputStream outputStream()
                                   throws IOException

获取输出流

Throws:: IOException

outputStreamAsGzip

public abstract GZIPOutputStream outputStreamAsGzip()
                                             throws IOException

获取输出流 gzip 模式

Throws:: 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

输出为文件

Throws:: IOException

outputAsFile

public abstract void outputAsFile(File file)
                           throws IOException

输出为文件

Throws:: 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 void cookieSet(String name,
                      String val,
                      String domain,
                      String path,
                      int maxAge)

设置 cookie

cookieSet

public abstract void cookieSet(Cookie cookie)

设置 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)
```
设置输出状态

statusDoSet

protected abstract void statusDoSet(int status)

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

attrOrDefault

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

获取上下文特性

attr

@Nullable
public <T> T attr(String name)

获取上下文特性

attrSet

public void attrSet(String name,
                    Object val)

设置上下文特性

attrSet

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

设置上下文特性

attrNames
```
public Collection<String> attrNames()
```
获取上下文特性的名字集合

attrsClear
```
public void attrsClear()
```
清除所有上下文特性

Since:

2.9

render

public final void render(Object obj)
                  throws Throwable

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

Throws:: Throwable

render

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

渲染数据

Throws:: Throwable

renderAndReturn

public final String renderAndReturn(Object obj)
                             throws Throwable

渲染数据并返回

Throws:: Throwable

returnValue

public void returnValue(Object obj)
                 throws Throwable

返回值

Throws:: Throwable

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

remotingSet

public void remotingSet(boolean remoting)

flush

public abstract void flush()
                    throws IOException

冲刷

Throws:: IOException

close

public abstract void close()
                    throws IOException

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

Throws:: IOException

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

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

mainHandler

@Nullable
public Handler mainHandler()

获取当前主处理器

asyncSupported

public abstract boolean asyncSupported()

是否支持异步

asyncListener

public abstract void asyncListener(ContextAsyncListener listener)

异步监听

asyncStart

public abstract void asyncStart(long timeout,
                                Runnable runnable)

异步开始

Parameters:: timeout - 超时; runnable - 运行器

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

asyncStarted

public abstract boolean asyncStarted()

异步已开始

asyncComplete
```
public abstract void asyncComplete()
```
异步完成

Class Context

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

sessionState

charset

result

errors

Constructor Detail

Context

Method Detail

current

getLocale

setLocale

setHandled

getHandled

setRendered

getRendered

isHeadersSent

pull

request

remoteIp

remotePort

realIp

autoMultipart

autoMultipart

isFormUrlencoded

isMultipart

isMultipartFormData

method

protocol

protocolAsUpper

uri

path

pathNew

pathNew

pathMap

pathAsUpper

pathAsLower

isSecure

userAgent

referer

url

contentLength

contentType

contentCharset

queryString

accept

accept

acceptNew

body

body

bodyNew

bodyNew

bodyAsBytes

bodyAsStream

paramValues

param

paramOrDefault

paramAsInt

paramAsInt

paramAsLong

paramAsLong

paramAsDouble

paramAsDouble

paramAsDecimal

paramAsDecimal

paramAsBean

paramNames

paramMap

fileValues

file

filesDelete

fileNames

fileMap

cookie

cookieOrDefault

cookieValues