XContext (org.noear:solon 1.0.2.8 API)

java.lang.Object
- org.noear.solon.core.XContext

public abstract class XContext
extends Object

通用上下文接口

构造器概要

构造器
构造器和说明

XContext()

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

方法概要

所有方法静态方法实例方法抽象方法具体方法
限定符和类型	方法和说明
`<T> T`	`attr(String key, T def)` 获取自定义特性
`void`	`attrClear()` 清除上下文特性
`void`	`attrSet(String key, Object val)` 设置上下文特性
`abstract String`	`body()` 获取RAW内容
`abstract InputStream`	`bodyAsStream()` 获取RAW内容为Stream
`abstract void`	`charset(String charset)` 设置字符集
`abstract long`	`contentLength()` 获取内容长度
`abstract String`	`contentType()` 获取内容类型
`abstract void`	`contentType(String contentType)` 设置内容类型
`abstract String`	`cookie(String key)` 获取COOKIE
`abstract String`	`cookie(String key, String def)`
`abstract XMap`	`cookieMap()`
`abstract void`	`cookieRemove(String key)` 移徐COOKIE
`abstract void`	`cookieSet(String key, String val, int maxAge)` 设置COOKIE
`abstract void`	`cookieSet(String key, String val, String domain, int maxAge)`
`abstract void`	`cookieSet(String key, String val, String domain, String path, int maxAge)`
`static XContext`	`current()` 获取当前线程的上下文
`XFile`	`file(String key)`
`abstract List<XFile>`	`files(String key)` 获取文件
`boolean`	`getHandled()`
`abstract String`	`header(String key)` 获取HEADER
`abstract String`	`header(String key, String def)`
`abstract XMap`	`headerMap()`
`abstract void`	`headerSet(String key, String val)` 设置HEADER
`abstract String`	`ip()` 获取远程IP
`boolean`	`isMultipart()` 是否为分段上传
`boolean`	`isMultipartFormData()`
`abstract String`	`method()` 获取请求方法
`void`	`output(Exception ex)`
`abstract void`	`output(InputStream stream)`
`abstract void`	`output(String str)` 输出内容
`void`	`outputAsHtml(String html)`
`void`	`outputAsJson(String json)`
`abstract OutputStream`	`outputStream()`
`abstract String`	`param(String key)`
`abstract String`	`param(String key, String def)`
`abstract double`	`paramAsDouble(String key)`
`double`	`paramAsDouble(String key, double def)`
`<T> T`	`paramAsEntity(Class<T> clz)`
`abstract int`	`paramAsInt(String key)`
`int`	`paramAsInt(String key, int def)`
`abstract long`	`paramAsLong(String key)`
`long`	`paramAsLong(String key, long def)`
`abstract XMap`	`paramMap()`
`abstract void`	`paramSet(String key, String val)`
`abstract String[]`	`paramValues(String key)` 获取参数
`abstract String`	`path()` 获取请求的URI路径
`String`	`pathAsUpper()`
`XMap`	`pathMap(String expr)` 获取请求的URI路径变量,根据路径表达式
`abstract String`	`protocol()` 获取请求协议
`String`	`protocolAsUpper()`
`abstract void`	`redirect(String url)` 跳转地址
`abstract void`	`redirect(String url, int code)`
`abstract Object`	`request()` 获取请求对象
`abstract Object`	`response()` 获取输出对象
`abstract Object`	`session(String key)` 获取SESSION状态
`abstract String`	`sessionId()` 获取SESSION_ID
`abstract void`	`sessionSet(String key, Object val)` 设置SESSION状态
`void`	`setHandled(boolean handled)`
`abstract int`	`status()` 获取输出状态
`abstract void`	`status(int status)` 设置输出状态
`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

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

方法详细资料

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

setHandled

public void setHandled(boolean handled)

getHandled
```
public boolean getHandled()
```

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

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

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()
```
获取请求的URI路径

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

pathAsUpper
```
public String pathAsUpper()
```

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

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

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

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

body

public abstract String body()
                     throws IOException

获取RAW内容

抛出:: IOException

bodyAsStream

public abstract InputStream bodyAsStream()
                                  throws IOException

获取RAW内容为Stream

抛出:: IOException

paramValues

public abstract String[] paramValues(String key)

获取参数

param

public abstract String param(String key)

param

public abstract String param(String key,
                             String def)

paramAsInt

public abstract int paramAsInt(String key)

paramAsInt

public int paramAsInt(String key,
                      int def)

paramAsLong

public abstract long paramAsLong(String key)

paramAsLong

public long paramAsLong(String key,
                        long def)

paramAsDouble

public abstract double paramAsDouble(String key)

paramAsDouble

public double paramAsDouble(String key,
                            double def)

paramMap
```
public abstract XMap paramMap()
```

paramSet

public abstract void paramSet(String key,
                              String val)

paramAsEntity

public <T> T paramAsEntity(Class<T> clz)
                    throws Exception

抛出:: Exception

files

public abstract List<XFile> files(String key)
                           throws Exception

获取文件

抛出:: Exception

file

public XFile file(String key)
           throws Exception

抛出:: Exception

cookie

public abstract String cookie(String key)

获取COOKIE

cookie

public abstract String cookie(String key,
                              String def)

cookieMap
```
public abstract XMap cookieMap()
```

header

public abstract String header(String key)

获取HEADER

header

public abstract String header(String key,
                              String def)

headerMap
```
public abstract XMap headerMap()
```

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

session

public abstract Object session(String key)

获取SESSION状态

sessionSet

public abstract void sessionSet(String key,
                                Object val)

设置SESSION状态

response
```
public abstract Object response()
```
获取输出对象

charset

public abstract void charset(String charset)

设置字符集

contentType

public abstract void contentType(String contentType)

设置内容类型

output

public abstract void output(String str)
                     throws IOException

输出内容

抛出:: IOException

output

public void output(Exception ex)
            throws IOException

抛出:: IOException

output

public abstract void output(InputStream stream)
                     throws IOException

抛出:: IOException

outputStream

public abstract OutputStream outputStream()
                                   throws IOException

抛出:: IOException

outputAsJson

public void outputAsJson(String json)
                  throws IOException

抛出:: IOException

outputAsHtml

public void outputAsHtml(String html)
                  throws IOException

抛出:: IOException

headerSet

public abstract void headerSet(String key,
                               String val)

设置HEADER

cookieSet

public abstract void cookieSet(String key,
                               String val,
                               int maxAge)

设置COOKIE

cookieSet

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

cookieSet

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

cookieRemove

public abstract void cookieRemove(String key)

移徐COOKIE

redirect

public abstract void redirect(String url)
                       throws IOException

跳转地址

抛出:: IOException

redirect

public abstract void redirect(String url,
                              int code)
                       throws IOException

抛出:: IOException

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

status

public abstract void status(int status)
                     throws IOException

设置输出状态

抛出:: IOException

attr

public <T> T attr(String key,
                  T def)

获取自定义特性

attrSet

public void attrSet(String key,
                    Object val)

设置上下文特性

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

类 XContext

构造器概要

方法概要

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

构造器详细资料

XContext

方法详细资料

current

setHandled

getHandled

request

ip

isMultipart

isMultipartFormData

method

protocol

protocolAsUpper

uri

path

pathMap

pathAsUpper

userAgent

url

contentLength

contentType

body

bodyAsStream

paramValues

param

param

paramAsInt

paramAsInt

paramAsLong

paramAsLong

paramAsDouble

paramAsDouble

paramMap

paramSet

paramAsEntity

files

file

cookie

cookie

cookieMap

header

header

headerMap

sessionId

session

sessionSet

response

charset

contentType

output

output

output

outputStream

outputAsJson

outputAsHtml

headerSet

cookieSet

cookieSet

cookieSet

cookieRemove

redirect

redirect

status

status

attr

attrSet

attrClear