RpcInvokeContext (com.alipay.sofa:sofa-rpc-all 5.4.0 API)

java.lang.Object
- com.alipay.sofa.rpc.context.RpcInvokeContext

```
public class RpcInvokeContext
extends Object
```
基于ThreadLocal的面向业务开发者使用的上下文传递对象

字段概要

字段
限定符和类型	字段和说明
`protected ResponseFuture<?>`	`future` The Future.
`protected static ThreadLocal<RpcInvokeContext>`	`LOCAL` 线程上下文变量
`protected ConcurrentMap<String,Object>`	`map` 自定义属性
`protected Map<String,String>`	`requestBaggage` 请求上的透传数据
`protected Map<String,String>`	`responseBaggage` 响应上的透传数据
`protected SofaResponseCallback`	`responseCallback` 用户自定义Callback，单次调用生效
`protected String`	`targetGroup` 用户自定义对方分组
`protected String`	`targetURL` 用户自定义对方地址，单次调用生效
`protected Integer`	`timeout` 用户自定义超时时间，单次调用生效

构造器概要

构造器
构造器和说明

RpcInvokeContext()

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

方法概要

方法
限定符和类型	方法和说明
`Object`	`get(String key)` 获取一个调用上下文数据
`Map<String,String>`	`getAllRequestBaggage()` 得到全部请求透传数据
`Map<String,String>`	`getAllResponseBaggage()` 得到全部响应透传数据
`static RpcInvokeContext`	`getContext()` 得到上下文，没有则初始化
`<T> ResponseFuture<T>`	`getFuture()` 得到单次请求返回的异步Future对象
`String`	`getRequestBaggage(String key)` 得到请求透传数据
`String`	`getResponseBaggage(String key)` 得到响应透传数据
`SofaResponseCallback`	`getResponseCallback()` 获取单次请求的指定回调方法
`String`	`getTargetGroup()` 获取单次请求的指定分组
`String`	`getTargetURL()` 获取单次请求的指定地址
`Integer`	`getTimeout()` 得到调用级别超时时间
`static boolean`	`isBaggageEnable()` 是否启用RPC透传功能
`static RpcInvokeContext`	`peekContext()` 查看上下文
`void`	`put(String key, Object value)` 设置一个调用上下文数据
`void`	`putAllRequestBaggage(Map<String,String> requestBaggage)` 设置全部请求透传数据
`void`	`putAllResponseBaggage(Map<String,String> responseBaggage)` 设置全部响应透传数据
`void`	`putRequestBaggage(String key, String value)` 放入请求透传数据
`void`	`putResponseBaggage(String key, String value)` 放入响应透传数据
`Object`	`remove(String key)` 删除一个调用上下文数据
`static void`	`removeContext()` 删除上下文
`String`	`removeRequestBaggage(String key)` 删除请求透传数据
`String`	`removeResponseBaggage(String key)` 删除响应透传数据
`static void`	`setContext(RpcInvokeContext context)` 设置上下文
`RpcInvokeContext`	`setFuture(ResponseFuture<?> future)` 设置单次请求返回的异步Future对象
`RpcInvokeContext`	`setResponseCallback(SofaResponseCallback responseCallback)` 设置单次请求的指定回调方法
`RpcInvokeContext`	`setTargetGroup(String targetGroup)` 设置单次请求的指定分组
`RpcInvokeContext`	`setTargetURL(String targetURL)` 设置单次请求的指定地址
`RpcInvokeContext`	`setTimeout(Integer timeout)` 设置调用级别超时时间
`String`	`toString()`

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

- 字段详细资料
  - LOCAL
```
protected static final ThreadLocal<RpcInvokeContext> LOCAL
```
    线程上下文变量
  - timeout
```
protected Integer timeout
```
    用户自定义超时时间，单次调用生效
  - targetURL
```
protected String targetURL
```
    用户自定义对方地址，单次调用生效
  - targetGroup
```
protected String targetGroup
```
    用户自定义对方分组
  - responseCallback
```
protected SofaResponseCallback responseCallback
```
    用户自定义Callback，单次调用生效
  - future
```
protected ResponseFuture<?> future
```
    The Future.
  - map
```
protected ConcurrentMap<String,Object> map
```
    自定义属性
  - requestBaggage
```
protected Map<String,String> requestBaggage
```
    请求上的透传数据
    
    从以下版本开始:
    
    5.1.2
  - responseBaggage
```
protected Map<String,String> responseBaggage
```
    响应上的透传数据
    
    从以下版本开始:
    
    5.1.2
- 构造器详细资料
  - RpcInvokeContext
```
public RpcInvokeContext()
```
- 方法详细资料
  - getContext
```
public static RpcInvokeContext getContext()
```
    得到上下文，没有则初始化
    
    返回:
    调用上下文
  - peekContext
```
public static RpcInvokeContext peekContext()
```
    查看上下文
    
    返回:
    调用上下文，可能为空
  - removeContext
```
public static void removeContext()
```
    删除上下文
  - setContext
```
public static void setContext(RpcInvokeContext context)
```
    设置上下文
    
    参数:
    context - 调用上下文
  - isBaggageEnable
```
public static boolean isBaggageEnable()
```
    是否启用RPC透传功能
    
    返回:
    是否
  - getTimeout
```
public Integer getTimeout()
```
    得到调用级别超时时间
    
    返回:
    超时时间
  - setTimeout
```
public RpcInvokeContext setTimeout(Integer timeout)
```
    设置调用级别超时时间
    
    参数:
    timeout - 超时时间
    
    返回:
    当前
  - put
```
public void put(String key,
       Object value)
```
    设置一个调用上下文数据
    
    参数:
    key - Key
    value - Value
  - get
```
public Object get(String key)
```
    获取一个调用上下文数据
    
    参数:
    key - Key
    
    返回:
    值
  - remove
```
public Object remove(String key)
```
    删除一个调用上下文数据
    
    参数:
    key - Key
    
    返回:
    删除前的值
  - putRequestBaggage
```
public void putRequestBaggage(String key,
                     String value)
```
    放入请求透传数据
    
    参数:
    key - Key
    value - Value
  - getRequestBaggage
```
public String getRequestBaggage(String key)
```
    得到请求透传数据
    
    参数:
    key - Key
    
    返回:
    Value
  - removeRequestBaggage
```
public String removeRequestBaggage(String key)
```
    删除请求透传数据
    
    参数:
    key - Key
    
    返回:
    Value 删掉的值
  - getAllRequestBaggage
```
public Map<String,String> getAllRequestBaggage()
```
    得到全部请求透传数据
    
    返回:
    全部响应透传数据
  - putAllRequestBaggage
```
public void putAllRequestBaggage(Map<String,String> requestBaggage)
```
    设置全部请求透传数据
    
    参数:
    requestBaggage - 请求透传数据
  - putResponseBaggage
```
public void putResponseBaggage(String key,
                      String value)
```
    放入响应透传数据
    
    参数:
    key - Key
    value - Value
  - getResponseBaggage
```
public String getResponseBaggage(String key)
```
    得到响应透传数据
    
    参数:
    key - Key
    
    返回:
    Value
  - removeResponseBaggage
```
public String removeResponseBaggage(String key)
```
    删除响应透传数据
    
    参数:
    key - Key
    
    返回:
    Value 删掉的值
  - getAllResponseBaggage
```
public Map<String,String> getAllResponseBaggage()
```
    得到全部响应透传数据
    
    返回:
    全部响应透传数据
  - putAllResponseBaggage
```
public void putAllResponseBaggage(Map<String,String> responseBaggage)
```
    设置全部响应透传数据
    
    参数:
    responseBaggage - 响应透传数据
  - getTargetURL
```
public String getTargetURL()
```
    获取单次请求的指定地址
    
    返回:
    单次请求的指定地址
  - setTargetURL
```
public RpcInvokeContext setTargetURL(String targetURL)
```
    设置单次请求的指定地址
    
    参数:
    targetURL - 单次请求的指定地址
    
    返回:
    RpcInvokeContext
  - getTargetGroup
```
public String getTargetGroup()
```
    获取单次请求的指定分组
    
    返回:
    单次请求的指定分组
  - setTargetGroup
```
public RpcInvokeContext setTargetGroup(String targetGroup)
```
    设置单次请求的指定分组
    
    参数:
    targetGroup - 单次请求的指定分组
    
    返回:
    RpcInvokeContext
  - getResponseCallback
```
public SofaResponseCallback getResponseCallback()
```
    获取单次请求的指定回调方法
    
    返回:
    单次请求的指定回调方法
  - setResponseCallback
```
public RpcInvokeContext setResponseCallback(SofaResponseCallback responseCallback)
```
    设置单次请求的指定回调方法
    
    参数:
    responseCallback - 单次请求的指定回调方法
    
    返回:
    RpcInvokeContext
  - getFuture
```
public <T> ResponseFuture<T> getFuture()
```
    得到单次请求返回的异步Future对象
    
    类型参数:
    T - 返回值类型
    
    返回:
    异步Future对象
  - setFuture
```
public RpcInvokeContext setFuture(ResponseFuture<?> future)
```
    设置单次请求返回的异步Future对象
    
    参数:
    future - Future对象
    
    返回:
    RpcInvokeContext
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 Object

类 RpcInvokeContext

字段概要

构造器概要

方法概要

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

字段详细资料

LOCAL

timeout

targetURL

targetGroup

responseCallback

future

map

requestBaggage

responseBaggage

构造器详细资料

RpcInvokeContext

方法详细资料

getContext

peekContext

removeContext

setContext

isBaggageEnable

getTimeout

setTimeout

put

get

remove

putRequestBaggage

getRequestBaggage

removeRequestBaggage

getAllRequestBaggage

putAllRequestBaggage

putResponseBaggage

getResponseBaggage

removeResponseBaggage

getAllResponseBaggage

putAllResponseBaggage

getTargetURL

setTargetURL

getTargetGroup

setTargetGroup

getResponseCallback

setResponseCallback

getFuture

setFuture

toString