ForestRequest (forest-码云(gitee.com))

java.lang.Object
- com.dtflys.forest.http.ForestRequest<T>

```
public class ForestRequest<T>
extends Object
```
Forest请求对象

Since:

2016-03-24

Author:

gongjun[dt_flys@hotmail.com]

Constructor Summary

Constructors
Constructor and Description
`ForestRequest(ForestConfiguration configuration)`
`ForestRequest(ForestConfiguration configuration, ForestMethod method)`
`ForestRequest(ForestConfiguration configuration, ForestMethod method, Object[] arguments)`
`ForestRequest(ForestConfiguration configuration, Object[] arguments)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`ForestRequest`	`addAttachment(String name, Object value)` 添加附件到请求中
`ForestRequest`	`addBody(ForestRequestBody body)` 添加Body数据
`ForestRequest`	`addBody(List<RequestNameValue> nameValueList)` Deprecated.
`ForestRequest`	`addBody(RequestNameValue nameValue)` Deprecated.
`ForestRequest`	`addBody(String stringBody)` 添加字符串Body数据
`ForestRequest`	`addBody(String name, Object value)` 添加键值对类型Body数据
`ForestRequest`	`addBody(String name, String contentType, Object value)` 添加键值对类型Body数据
`ForestRequest`	`addData(List<RequestNameValue> data)` Deprecated.
`ForestRequest`	`addData(RequestNameValue nameValue)` Deprecated.
`ForestRequest`	`addData(String name, Object value)` Deprecated.
`ForestRequest`	`addHeader(RequestNameValue nameValue)` 添加请求头到该请求中
`ForestRequest`	`addHeader(String name, Object value)` 添加请求头到该请求中
`ForestRequest`	`addHeaders(List<RequestNameValue> nameValues)` 批量添加请求头到该请求中
`ForestRequest<T>`	`addInterceptor(Interceptor interceptor)` 添加拦截器到该请求中
`ForestRequest`	`addInterceptorAttribute(Class interceptorClass, String attributeName, Object attributeValue)` 添加拦截器属性到该请求
`ForestRequest`	`addInterceptorAttributes(Class interceptorClass, InterceptorAttributes attributes)` 添加拦截器属性到该请求
`ForestRequest`	`addNameValue(List<RequestNameValue> nameValueList)` 添加键值对列表
`ForestRequest`	`addNameValue(RequestNameValue nameValue)` 添加键值对
`ForestRequest`	`addQuery(Collection<ForestQueryParameter> queryParameters)` 批量添加请求中的Query参数
`ForestRequest`	`addQuery(ForestQueryParameter queryParameter)` 添加请求中的Query参数
`ForestRequest`	`addQuery(ForestQueryParameter[] queryParameters)` 批量添加请求中的Query参数
`ForestRequest`	`addQuery(String name, Object value)` 添加请求中的Query参数
`ForestRequest`	`addQueryValues(String name, Collection queryValues)` 批量添加请求中的同名Query参数
`Object`	`execute()` 执行请求发送过程
`Object`	`execute(HttpBackend backend, LifeCycleHandler lifeCycleHandler)` 执行请求发送过程
`Object`	`getArgument(int index)` 根据参数下标获取该请求对应方法的参数值
`Object[]`	`getArguments()` 获取该请求对应方法的所有参数值
`Object`	`getAttachment(String name)` 根据名称获取该请求中的附件
`HttpBackend`	`getBackend()` 获取HTTP后端对象
`List<ForestRequestBody>`	`getBody()`
`List`	`getBodyList()` Deprecated.
`String`	`getCharset()`
`ForestConfiguration`	`getConfiguration()` 获取该请求的配置对象
`String`	`getContentEncoding()`
`String`	`getContentType()`
`Map<String,Object>`	`getData()` Deprecated.
`List<RequestNameValue>`	`getDataNameValueList()`
`ForestDataType`	`getDataType()`
`ForestConverter`	`getDecoder()` 获取反序列化器
`String`	`getFilename()`
`ForestHeader`	`getHeader(String name)` 根据请求头名称获取该请求的请求头信息
`List<RequestNameValue>`	`getHeaderNameValueList()`
`ForestHeaderMap`	`getHeaders()` 获取该请求的所有请求头信息
`String`	`getHeaderValue(String name)` 根据请求头名称获取该请求的请求头的值
`Object`	`getInterceptorAttribute(Class interceptorClass, String attributeName)` 根据拦截器类和拦截器属性名获取拦截器属性值
`Map<Class,InterceptorAttributes>`	`getInterceptorAttributes()` 获取拦截器属性表
`InterceptorAttributes`	`getInterceptorAttributes(Class interceptorClass)` 根据拦截器类获取拦截器属性集合对象
`InterceptorChain`	`getInterceptorChain()` 获取拦截器链对象
`SSLKeyStore`	`getKeyStore()` 获取SSL KeyStore信息
`LifeCycleHandler`	`getLifeCycleHandler()` 获取生命周期处理器
`LogConfiguration`	`getLogConfiguration()` 获取请求日志配置信息
`long`	`getMaxRetryInterval()`
`ForestMethod`	`getMethod()` 获取请求对应的Forest方法
`Object`	`getMethodReturnValue()` 获取该请求对应的方法返回值
`List<ForestMultipart>`	`getMultiparts()`
`OnError`	`getOnError()` 获取OnError回调函数，该回调函数在请求失败时被调用
`OnLoadCookie`	`getOnLoadCookie()` 获取回调函数: 加载Cookie时调用
`OnProgress`	`getOnProgress()` 获取进度回调函数：上传/下载进度监听时调用
`OnSaveCookie`	`getOnSaveCookie()` 获取回调函数: 需要保存Cookie时调用
`OnSuccess`	`getOnSuccess()` 获取OnSuccess回调函数，该回调函数在请求成功时被调用
`long`	`getProgressStep()` 获取上传/下载进度监听的步长
`String`	`getProtocol()` 获取请求协议
`ForestProxy`	`getProxy()` 获取正向代理
`ForestQueryMap`	`getQuery()` 获取请求的Query参数表
`Object`	`getQuery(String name)` 根据名称获取请求的Query参数值
`List<RequestNameValue>`	`getQueryNameValueList()` Deprecated.
`String`	`getQueryString()` 动态获取请求的URL Query参数字符串
`List<ForestQueryParameter>`	`getQueryValues()`
`RequestLogMessage`	`getRequestLogMessage()`
`String`	`getResponseEncode()`
`int`	`getRetryCount()`
`Retryer`	`getRetryer()` 获取Forest请求重试器
`String`	`getSslProtocol()`
`int`	`getTimeout()`
`ForestRequestType`	`getType()`
`List<ForestRequestType>`	`getTypeChangeHistory()` 获取请求类型变更历史列表
`List<String>`	`getTypeChangeHistoryString()` 获取请求类型变更历史字符串列表
`URI`	`getURI()` 获取请求URI
`String`	`getUrl()` 获取请求URL
`String`	`getUserAgent()`
`String`	`getUserInfo()`
`boolean`	`isAsync()`
`boolean`	`isDownloadFile()` 该请求是否下载文件
`boolean`	`isLogEnable()` Deprecated.
`ForestRequest`	`methodReturn(T result)` 设置该请求对应的方法返回值
`ForestRequest`	`replaceBody(ForestRequestBody body)` 替换Body数据，原有的Body数据将被清空
`ForestRequest`	`replaceBody(String stringbody)` 替换Body为新的字符串数据，原有的Body数据将被清空
`ForestRequest`	`replaceOrAddQuery(ForestQueryParameter queryParameter)` 替换或添加请求中的Query参数
`ForestRequest`	`replaceOrAddQuery(String name, String value)` 替换或添加请求中的Query参数
`ForestRequest`	`replaceQuery(ForestQueryParameter queryParameter)` 替换请求中的Query参数值
`ForestRequest`	`replaceQuery(String name, Object value)` 替换请求中的Query参数值
`ForestRequest`	`setAsync(boolean async)`
`ForestRequest`	`setBackend(HttpBackend backend)` 设置HTTP后端对象
`void`	`setBodyList(List bodyList)` Deprecated.
`ForestRequest`	`setCharset(String charset)`
`ForestRequest`	`setContentEncoding(String contentEncoding)`
`ForestRequest`	`setContentType(String contentType)`
`ForestRequest`	`setDataType(ForestDataType dataType)`
`ForestRequest`	`setDecoder(ForestConverter decoder)` 设置反序列化器
`ForestRequest`	`setDownloadFile(boolean downloadFile)` 设置该请求是否下载文件
`ForestRequest`	`setKeyStore(SSLKeyStore keyStore)` 设置SSL KeyStore信息
`ForestRequest`	`setLifeCycleHandler(LifeCycleHandler lifeCycleHandler)` 设置生命周期处理器
`ForestRequest`	`setLogConfiguration(LogConfiguration logConfiguration)`
`ForestRequest`	`setMaxRetryInterval(long maxRetryInterval)`
`ForestRequest`	`setMultiparts(List<ForestMultipart> multiparts)`
`ForestRequest`	`setOnError(OnError onError)` 设置OnError回调函数，该回调函数在请求成功时被调用
`ForestRequest`	`setOnLoadCookie(OnLoadCookie onLoadCookie)` 设置回调函数: 加载Cookie时调用
`ForestRequest`	`setOnProgress(OnProgress onProgress)` 设置进度回调函数：上传/下载进度监听时调用
`ForestRequest`	`setOnSaveCookie(OnSaveCookie onSaveCookie)` 设置回调函数: 需要保存Cookie时调用
`ForestRequest`	`setOnSuccess(OnSuccess onSuccess)` 设置OnSuccess回调函数，该回调函数在请求成功时被调用
`ForestRequest`	`setProgressStep(long progressStep)` 设置获取上传/下载进度监听的步长
`ForestRequest`	`setProtocol(String protocol)` 设置请求协议
`ForestRequest`	`setProxy(ForestProxy proxy)` 设置正向代理
`void`	`setRequestLogMessage(RequestLogMessage requestLogMessage)`
`ForestRequest<T>`	`setResponseEncode(String responseEncode)`
`ForestRequest`	`setRetryCount(int retryCount)`
`ForestRequest`	`setRetryer(Retryer retryer)` 设置Forest请求重试器
`ForestRequest`	`setSslProtocol(String sslProtocol)`
`ForestRequest`	`setTimeout(int timeout)`
`ForestRequest`	`setType(ForestRequestType type)`
`ForestRequest`	`setUrl(String url)` 设置请求的url地址
`ForestRequest`	`setUserAgent(String userAgent)`
`ForestRequest`	`setUserInfo(String userInfo)`

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

- Constructor Detail
  - ForestRequest
```
public ForestRequest(ForestConfiguration configuration,
                     ForestMethod method,
                     Object[] arguments)
```
  - ForestRequest
```
public ForestRequest(ForestConfiguration configuration,
                     ForestMethod method)
```
  - ForestRequest
```
public ForestRequest(ForestConfiguration configuration)
```
  - ForestRequest
```
public ForestRequest(ForestConfiguration configuration,
                     Object[] arguments)
```
- Method Detail
  - getConfiguration
```
public ForestConfiguration getConfiguration()
```
    获取该请求的配置对象
    
    Returns:
    
    配置对象
  - getProtocol
```
public String getProtocol()
```
    获取请求协议
    
    Returns:
    
    请求协议
  - setProtocol
```
public ForestRequest setProtocol(String protocol)
```
    设置请求协议
    
    Parameters:
    
    protocol - 请求协议
    
    Returns:
    
    ForestRequest对象实例
  - getUrl
```
public String getUrl()
```
    获取请求URL
    
    Returns:
    
    URL字符串
  - getURI
```
public URI getURI()
```
    获取请求URI
    
    Returns:
    
    URI类实例
  - setUrl
```
public ForestRequest setUrl(String url)
```
    设置请求的url地址
    每次设置请求的url地址时，都会解析传入的url参数字符串，
    
    然后从url中解析出Query参数，并将其替换调用原来的Query参数，或新增成新的Query参数
    
    Parameters:
    
    url - url地址字符串
    
    Returns:
    
    ForestRequest对象实例
  - getUserInfo
```
public String getUserInfo()
```
  - setUserInfo
```
public ForestRequest setUserInfo(String userInfo)
```
  - getMethod
```
public ForestMethod getMethod()
```
    获取请求对应的Forest方法
    
    Returns:
    
    Forest方法对象
  - getBackend
```
public HttpBackend getBackend()
```
    获取HTTP后端对象
    
    Returns:
    
    HTTP后端对象，HttpBackend接口实例
  - setBackend
```
public ForestRequest setBackend(HttpBackend backend)
```
    设置HTTP后端对象
    
    Parameters:
    
    backend - HTTP后端对象，HttpBackend接口实例
    
    Returns:
    
    ForestRequest对象实例
  - getLifeCycleHandler
```
public LifeCycleHandler getLifeCycleHandler()
```
    获取生命周期处理器
    
    Returns:
    
    生命周期处理器，LifeCycleHandler接口实例
  - setLifeCycleHandler
```
public ForestRequest setLifeCycleHandler(LifeCycleHandler lifeCycleHandler)
```
    设置生命周期处理器
    
    Parameters:
    
    lifeCycleHandler - 生命周期处理器，LifeCycleHandler接口实例
    
    Returns:
    
    ForestRequest对象实例
  - getQuery
```
public ForestQueryMap getQuery()
```
    获取请求的Query参数表
    
    Returns:
    
    Query参数表
  - getQuery
```
public Object getQuery(String name)
```
    根据名称获取请求的Query参数值
    
    Parameters:
    
    name - Query参数名称
    
    Returns:
    
    Query参数值
  - getQueryString
```
public String getQueryString()
```
    动态获取请求的URL Query参数字符串
    
    Returns:
    
    Query参数字符串
  - addQuery
```
public ForestRequest addQuery(String name,
                              Object value)
```
    添加请求中的Query参数
    
    Parameters:
    
    name - Query参数名
    
    value - Query参数值
    
    Returns:
    
    ForestRequest对象实例
  - addQuery
```
public ForestRequest addQuery(ForestQueryParameter queryParameter)
```
    添加请求中的Query参数
    
    Parameters:
    
    queryParameter - Query参数，ForestQueryParameter对象实例
    
    Returns:
    
    ForestRequest对象实例
  - addQuery
```
public ForestRequest addQuery(Collection<ForestQueryParameter> queryParameters)
```
    批量添加请求中的Query参数
    
    Parameters:
    
    queryParameters - Query参数集合，ForestQueryParameter对象实例集合
    
    Returns:
    
    ForestRequest对象实例
  - addQueryValues
```
public ForestRequest addQueryValues(String name,
                                    Collection queryValues)
```
    批量添加请求中的同名Query参数
    
    Parameters:
    
    name - Query参数名
    
    queryValues - Query参数值集合
    
    Returns:
    
    ForestRequest对象实例
  - addQuery
```
public ForestRequest addQuery(ForestQueryParameter[] queryParameters)
```
    批量添加请求中的Query参数
    
    Parameters:
    
    queryParameters - Query参数数组，ForestQueryParameter对象实例数组
    
    Returns:
    
    ForestRequest对象实例
  - replaceQuery
```
public ForestRequest replaceQuery(ForestQueryParameter queryParameter)
```
    替换请求中的Query参数值
    
    Parameters:
    
    queryParameter - Query参数，ForestQueryParameter对象实例
    
    Returns:
    
    ForestRequest对象实例
  - replaceQuery
```
public ForestRequest replaceQuery(String name,
                                  Object value)
```
    替换请求中的Query参数值
    
    Parameters:
    
    name - Query参数名
    
    value - Query参数值
    
    Returns:
    
    ForestRequest对象实例
  - replaceOrAddQuery
```
public ForestRequest replaceOrAddQuery(ForestQueryParameter queryParameter)
```
    替换或添加请求中的Query参数
    当请求中不存在与该方法调用时传递过来ForestQueryParameter对象中同名的Query参数时，会将ForestQueryParameter对象添加成新的Query参数到请求中，
    
    若请求中已存在同名Query参数名时，则会替换请求中的所有同名的Query参数值
    
    Parameters:
    
    queryParameter - Query参数，ForestQueryParameter对象实例
    
    Returns:
    
    ForestRequest对象实例
  - replaceOrAddQuery
```
public ForestRequest replaceOrAddQuery(String name,
                                       String value)
```
    替换或添加请求中的Query参数
    当请求中不存在与该方法调用时传递过来name参数同名的Query参数时，会将name参数和value参数添加成新的Query参数到请求中，
    
    若请求中已存在同名Query参数名时，则会替换请求中的所有同名的Query参数值
    
    Parameters:
    
    name - Query参数名
    
    value - Query参数值
    
    Returns:
    
    ForestRequest类实例
  - getType
```
public ForestRequestType getType()
```
  - setType
```
public ForestRequest setType(ForestRequestType type)
```
  - getTypeChangeHistory
```
public List<ForestRequestType> getTypeChangeHistory()
```
    获取请求类型变更历史列表
    
    Returns:
    
    请求类型列表
  - getTypeChangeHistoryString
```
public List<String> getTypeChangeHistoryString()
```
    获取请求类型变更历史字符串列表
    
    Returns:
    
    字符串列表
  - getRequestLogMessage
```
public RequestLogMessage getRequestLogMessage()
```
  - setRequestLogMessage
```
public void setRequestLogMessage(RequestLogMessage requestLogMessage)
```
  - getFilename
```
public String getFilename()
```
  - getContentEncoding
```
public String getContentEncoding()
```
  - setContentEncoding
```
public ForestRequest setContentEncoding(String contentEncoding)
```
  - getUserAgent
```
public String getUserAgent()
```
  - setUserAgent
```
public ForestRequest setUserAgent(String userAgent)
```
  - getCharset
```
public String getCharset()
```
  - setCharset
```
public ForestRequest setCharset(String charset)
```
  - getResponseEncode
```
public String getResponseEncode()
```
  - setResponseEncode
```
public ForestRequest<T> setResponseEncode(String responseEncode)
```
  - isAsync
```
public boolean isAsync()
```
  - setAsync
```
public ForestRequest setAsync(boolean async)
```
  - getBody
```
public List<ForestRequestBody> getBody()
```
  - getBodyList
```
@Deprecated
public List getBodyList()
```
    Deprecated.
  - setBodyList
```
@Deprecated
public void setBodyList(List bodyList)
```
    Deprecated.
  - getDataType
```
public ForestDataType getDataType()
```
  - setDataType
```
public ForestRequest setDataType(ForestDataType dataType)
```
  - getContentType
```
public String getContentType()
```
  - setContentType
```
public ForestRequest setContentType(String contentType)
```
  - getTimeout
```
public int getTimeout()
```
  - setTimeout
```
public ForestRequest setTimeout(int timeout)
```
  - getSslProtocol
```
public String getSslProtocol()
```
  - setSslProtocol
```
public ForestRequest setSslProtocol(String sslProtocol)
```
  - getRetryCount
```
public int getRetryCount()
```
  - setRetryCount
```
public ForestRequest setRetryCount(int retryCount)
```
  - getMaxRetryInterval
```
public long getMaxRetryInterval()
```
  - setMaxRetryInterval
```
public ForestRequest setMaxRetryInterval(long maxRetryInterval)
```
  - getData
```
@Deprecated
public Map<String,Object> getData()
```
    Deprecated.
    
    旧的获取Body数据的方法 [已不建议使用]
    
    Returns:
    
    请求中的数据，Map对象实例
  - addBody
```
public ForestRequest addBody(ForestRequestBody body)
```
    添加Body数据
    
    Parameters:
    
    body - Forest请求体，ForestRequestBody类实例
    
    Returns:
    
    ForestRequest类实例
  - addBody
```
public ForestRequest addBody(String stringBody)
```
    添加字符串Body数据
    
    Parameters:
    
    stringBody - 请求体字符串内容
    
    Returns:
    
    ForestRequest类实例
  - addBody
```
public ForestRequest addBody(String name,
                             Object value)
```
    添加键值对类型Body数据
    
    Parameters:
    
    name - 字段名
    
    value - 字段值
    
    Returns:
    
    ForestRequest类实例
  - addBody
```
public ForestRequest addBody(String name,
                             String contentType,
                             Object value)
```
    添加键值对类型Body数据
    
    Parameters:
    
    name - 字段名
    
    contentType - 该请求体项的Content-Type
    
    value - 字段值
    
    Returns:
    
    ForestRequest类实例
  - addBody
```
@Deprecated
public ForestRequest addBody(RequestNameValue nameValue)
```
    Deprecated.
    
    添加键值对类型Body数据
    
    Parameters:
    
    nameValue - 请求键值对对象
    
    Returns:
    
    ForestRequest类实例
  - addBody
```
@Deprecated
public ForestRequest addBody(List<RequestNameValue> nameValueList)
```
    Deprecated.
    
    批量添加键值对类型Body数据
    
    Parameters:
    
    nameValueList - 请求键值对对象列表
    
    Returns:
    
    ForestRequest类实例
  - addData
```
@Deprecated
public ForestRequest addData(String name,
                                         Object value)
```
    Deprecated.
    
    添加键值对类型Body数据, 已不再建议使用
    
    Parameters:
    
    name - 键值对名称
    
    value - 键值对的值
    
    Returns:
    
    ForestRequest类实例
  - addData
```
@Deprecated
public ForestRequest addData(RequestNameValue nameValue)
```
    Deprecated.
    
    添加键值对类型Body数据, 已不再建议使用
    
    Parameters:
    
    nameValue - 请求键值对对象
    
    Returns:
    
    ForestRequest类实例
  - addData
```
@Deprecated
public ForestRequest addData(List<RequestNameValue> data)
```
    Deprecated.
    
    批量添加键值对类型Body数据, 已不再建议使用
    
    Parameters:
    
    data - 请求键值对对象列表
    
    Returns:
    
    ForestRequest类实例
  - addNameValue
```
public ForestRequest addNameValue(RequestNameValue nameValue)
```
    添加键值对
    
    Parameters:
    
    nameValue - 键值对对象
    
    Returns:
    
    ForestRequest类实例
  - addNameValue
```
public ForestRequest addNameValue(List<RequestNameValue> nameValueList)
```
    添加键值对列表
    
    Parameters:
    
    nameValueList - 键值对列表
    
    Returns:
    
    ForestRequest类实例
  - replaceBody
```
public ForestRequest replaceBody(ForestRequestBody body)
```
    替换Body数据，原有的Body数据将被清空
    
    Parameters:
    
    body - 请求体对象
    
    Returns:
    
    ForestRequest类实例
  - replaceBody
```
public ForestRequest replaceBody(String stringbody)
```
    替换Body为新的字符串数据，原有的Body数据将被清空
    
    Parameters:
    
    stringbody - 字符串请求体
    
    Returns:
    
    ForestRequest类实例
  - getQueryNameValueList
```
@Deprecated
public List<RequestNameValue> getQueryNameValueList()
```
    Deprecated.
  - getQueryValues
```
public List<ForestQueryParameter> getQueryValues()
```
  - getDataNameValueList
```
public List<RequestNameValue> getDataNameValueList()
```
  - getHeaderNameValueList
```
public List<RequestNameValue> getHeaderNameValueList()
```
  - getArgument
```
public Object getArgument(int index)
```
    根据参数下标获取该请求对应方法的参数值
    
    Parameters:
    
    index - 对应方法的参数下标
    
    Returns:
    
    参数值
  - getArguments
```
public Object[] getArguments()
```
    获取该请求对应方法的所有参数值
    
    Returns:
    
    参数值列表
  - getHeaders
```
public ForestHeaderMap getHeaders()
```
    获取该请求的所有请求头信息
    
    Returns:
    
    请求头表，ForestHeaderMap类实例
  - getHeader
```
public ForestHeader getHeader(String name)
```
    根据请求头名称获取该请求的请求头信息
    
    Parameters:
    
    name - 请求头名称
    
    Returns:
    
    请求头，ForestHeader类实例
  - getHeaderValue
```
public String getHeaderValue(String name)
```
    根据请求头名称获取该请求的请求头的值
    
    Parameters:
    
    name - 请求头名称
    
    Returns:
    
    请求头的值
  - addHeader
```
public ForestRequest addHeader(String name,
                               Object value)
```
    添加请求头到该请求中
    
    Parameters:
    
    name - 请求头名称
    
    value - 请求头的值
    
    Returns:
    
    ForestRequest类实例
  - addHeader
```
public ForestRequest addHeader(RequestNameValue nameValue)
```
    添加请求头到该请求中
    
    Parameters:
    
    nameValue - 请求头键值对，RequestNameValue类实例
    
    Returns:
    
    ForestRequest类实例
  - addHeaders
```
public ForestRequest addHeaders(List<RequestNameValue> nameValues)
```
    批量添加请求头到该请求中
    
    Parameters:
    
    nameValues - 请求头键值对列表
    
    Returns:
    
    ForestRequest类实例
  - getMultiparts
```
public List<ForestMultipart> getMultiparts()
```
  - setMultiparts
```
public ForestRequest setMultiparts(List<ForestMultipart> multiparts)
```
  - getOnSuccess
```
public OnSuccess getOnSuccess()
```
    获取OnSuccess回调函数，该回调函数在请求成功时被调用
    
    Returns:
    
    OnSuccess接口实例
  - setOnSuccess
```
public ForestRequest setOnSuccess(OnSuccess onSuccess)
```
    设置OnSuccess回调函数，该回调函数在请求成功时被调用
    
    Parameters:
    
    onSuccess - OnSuccess接口实例
    
    Returns:
    
    ForestRequest类实例
  - getOnError
```
public OnError getOnError()
```
    获取OnError回调函数，该回调函数在请求失败时被调用
    
    Returns:
    
    OnError接口实例
  - setOnError
```
public ForestRequest setOnError(OnError onError)
```
    设置OnError回调函数，该回调函数在请求成功时被调用
    
    Parameters:
    
    onError - OnError接口实例
    
    Returns:
    
    ForestRequest类实例
  - isDownloadFile
```
public boolean isDownloadFile()
```
    该请求是否下载文件
    
    Returns:
    
    true: 下载文件，false: 不下载文件
  - setDownloadFile
```
public ForestRequest setDownloadFile(boolean downloadFile)
```
    设置该请求是否下载文件
    
    Parameters:
    
    downloadFile - true: 下载文件，false: 不下载文件
    
    Returns:
    
    ForestRequest类实例
  - getProgressStep
```
public long getProgressStep()
```
    获取上传/下载进度监听的步长
    每上传/下载一定的比特数，执行一次监听回调函数
    
    Returns:
    
    进度监听的步长，long类型数值
  - setProgressStep
```
public ForestRequest setProgressStep(long progressStep)
```
    设置获取上传/下载进度监听的步长
    每上传/下载一定的比特数，执行一次监听回调函数
    
    Parameters:
    
    progressStep - 进度监听的步长，long类型数值
    
    Returns:
    
    ForestRequest类实例
  - getOnProgress
```
public OnProgress getOnProgress()
```
    获取进度回调函数：上传/下载进度监听时调用
    每上传/下载传输 ${progressStep} 个比特数时，执行一次监听回调函数
    
    Returns:
    
    进度回调函数，OnProgress接口实例
  - setOnProgress
```
public ForestRequest setOnProgress(OnProgress onProgress)
```
    设置进度回调函数：上传/下载进度监听时调用
    每上传/下载传输 ${progressStep} 个比特数时，执行一次监听回调函数
    
    Parameters:
    
    onProgress - 进度回调函数，OnProgress接口实例
    
    Returns:
    
    ForestRequest类实例
  - getOnLoadCookie
```
public OnLoadCookie getOnLoadCookie()
```
    获取回调函数: 加载Cookie时调用
    
    Returns:
    
    OnLoadCookie接口实例
  - setOnLoadCookie
```
public ForestRequest setOnLoadCookie(OnLoadCookie onLoadCookie)
```
    设置回调函数: 加载Cookie时调用
    
    Parameters:
    
    onLoadCookie - OnLoadCookie接口实例
    
    Returns:
    
    ForestRequest类实例
  - getOnSaveCookie
```
public OnSaveCookie getOnSaveCookie()
```
    获取回调函数: 需要保存Cookie时调用
    
    Returns:
    
    OnSaveCookie接口实例
  - setOnSaveCookie
```
public ForestRequest setOnSaveCookie(OnSaveCookie onSaveCookie)
```
    设置回调函数: 需要保存Cookie时调用
    
    Parameters:
    
    onSaveCookie - OnSaveCookie接口实例
    
    Returns:
    
    ForestRequest类实例
  - addInterceptor
```
public ForestRequest<T> addInterceptor(Interceptor interceptor)
```
    添加拦截器到该请求中
    拦截器在请求的初始化、发送请求前、发送成功、发送失败等生命周期中都会被调用
    
    Parameters:
    
    interceptor - 拦截器，Interceptor接口实例
    
    Returns:
    
    ForestRequest类实例
  - getInterceptorChain
```
public InterceptorChain getInterceptorChain()
```
    获取拦截器链对象
    
    Returns:
    
    拦截器链对象，InterceptorChain类实例
  - addInterceptorAttributes
```
public ForestRequest addInterceptorAttributes(Class interceptorClass,
                                              InterceptorAttributes attributes)
```
    添加拦截器属性到该请求
    被添加的属性会被对应的请求所绑定，同时也会绑定到拦截器类，并且按不同的拦截器进行隔离。
    
    而且这些属性值不能通过网络请求传递到远端服务器。
    
    拦截器属性有两个特性：
    1. 按请求隔离：如有请求A和请求B，都有一个名为attr1的拦截器属性，但它们是两个互不影响的独立的属性。
    2. 按拦截器隔离：如果有拦截器T1和拦截器T2，同一个请求分别对着两个拦截器绑定了一个属性，都名为 attr1。但它们也是两个独立的互不干涉的属性。
    也就是说，在拦截器T1中访问的attr1属性和在拦截器T2中访问的attr1属性是不同的。
    
    Parameters:
    
    interceptorClass - 要绑定的拦截器类
    
    attributes - 拦截器属性，InterceptorAttributes类实例
    
    Returns:
    
    ForestRequest类实例
  - addInterceptorAttribute
```
public ForestRequest addInterceptorAttribute(Class interceptorClass,
                                             String attributeName,
                                             Object attributeValue)
```
    添加拦截器属性到该请求
    被添加的属性会被对应的请求所绑定，同时也会绑定到拦截器类，并且按不同的拦截器进行隔离。
    
    而且这些属性值不能通过网络请求传递到远端服务器。
    
    拦截器属性有两个特性：
    1. 按请求隔离：如有请求A和请求B，都有一个名为attr1的拦截器属性，但它们是两个互不影响的独立的属性。
    2. 按拦截器隔离：如果有拦截器T1和拦截器T2，同一个请求分别对着两个拦截器绑定了一个属性，都名为 attr1。但它们也是两个独立的互不干涉的属性。
    也就是说，在拦截器T1中访问的attr1属性和在拦截器T2中访问的attr1属性是不同的。
    
    Parameters:
    
    interceptorClass - 要绑定的拦截器类
    
    attributeName - 拦截器属性名
    
    attributeValue - 拦截器属性值
    
    Returns:
    
    ForestRequest类实例
  - getInterceptorAttributes
```
public Map<Class,InterceptorAttributes> getInterceptorAttributes()
```
    获取拦截器属性表
    拦截器属性有两个特性：
    1. 按请求隔离：如有请求A和请求B，都有一个名为attr1的拦截器属性，但它们是两个互不影响的独立的属性。
    2. 按拦截器隔离：如果有拦截器T1和拦截器T2，同一个请求分别对着两个拦截器绑定了一个属性，都名为 attr1。但它们也是两个独立的互不干涉的属性。
    也就是说，在拦截器T1中访问的attr1属性和在拦截器T2中访问的attr1属性是不同的。
    
    Returns:
    
    Map映射，Key: 拦截器类，Value: 拦截器属性集合对象，InterceptorAttributes类实例
  - getInterceptorAttributes
```
public InterceptorAttributes getInterceptorAttributes(Class interceptorClass)
```
    根据拦截器类获取拦截器属性集合对象
    拦截器属性有两个特性：
    1. 按请求隔离：如有请求A和请求B，都有一个名为attr1的拦截器属性，但它们是两个互不影响的独立的属性。
    2. 按拦截器隔离：如果有拦截器T1和拦截器T2，同一个请求分别对着两个拦截器绑定了一个属性，都名为 attr1。但它们也是两个独立的互不干涉的属性。
    也就是说，在拦截器T1中访问的attr1属性和在拦截器T2中访问的attr1属性是不同的。
    
    Parameters:
    
    interceptorClass - 拦截器类
    
    Returns:
    
    拦截器属性集合对象，InterceptorAttributes类实例
  - getInterceptorAttribute
```
public Object getInterceptorAttribute(Class interceptorClass,
                                      String attributeName)
```
    根据拦截器类和拦截器属性名获取拦截器属性值
    拦截器属性有两个特性：
    1. 按请求隔离：如有请求A和请求B，都有一个名为attr1的拦截器属性，但它们是两个互不影响的独立的属性。
    2. 按拦截器隔离：如果有拦截器T1和拦截器T2，同一个请求分别对着两个拦截器绑定了一个属性，都名为 attr1。但它们也是两个独立的互不干涉的属性。
    也就是说，在拦截器T1中访问的attr1属性和在拦截器T2中访问的attr1属性是不同的。
    
    Parameters:
    
    interceptorClass - 拦截器类
    
    attributeName - 拦截器属性名
    
    Returns:
    
    拦截器属性值
  - getRetryer
```
public Retryer getRetryer()
```
    获取Forest请求重试器
    
    Returns:
    
    Forest请求重试器，Retryer接口实例
  - setRetryer
```
public ForestRequest setRetryer(Retryer retryer)
```
    设置Forest请求重试器
    
    Parameters:
    
    retryer - Forest请求重试器，Retryer接口实例
    
    Returns:
    
    ForestRequest类实例
  - addAttachment
```
public ForestRequest addAttachment(String name,
                                   Object value)
```
    添加附件到请求中
    Attachment 是和请求绑定的附件属性值，这些值不能通过网络请求传递到远端服务器。
    
    不同请求的附件相互独立，即使名称相同，也互不影响。
    
    Parameters:
    
    name - 附件名
    
    value - 附件值
    
    Returns:
    
    ForestRequest类实例
  - getAttachment
```
public Object getAttachment(String name)
```
    根据名称获取该请求中的附件
    Attachment 是和请求绑定的附件属性值，这些值不能通过网络请求传递到远端服务器。
    
    不同请求的附件相互独立，即使名称相同，也互不影响。
    
    Parameters:
    
    name - 附件名
    
    Returns:
    
    附件值
  - getDecoder
```
public ForestConverter getDecoder()
```
    获取反序列化器
    
    Returns:
    
    反序列化器，ForestConverter接口实例
  - setDecoder
```
public ForestRequest setDecoder(ForestConverter decoder)
```
    设置反序列化器
    
    Parameters:
    
    decoder - 反序列化器，ForestConverter接口实例
    
    Returns:
    
    ForestRequest类实例
  - isLogEnable
```
@Deprecated
public boolean isLogEnable()
```
    Deprecated.
    
    是否允许打印请求/响应日志
    
    Returns:
    
    true：允许，false：不允许
  - getLogConfiguration
```
public LogConfiguration getLogConfiguration()
```
    获取请求日志配置信息
    
    Returns:
    
    请求日志配置信息，LogConfiguration类实例
  - setLogConfiguration
```
public ForestRequest setLogConfiguration(LogConfiguration logConfiguration)
```
  - getKeyStore
```
public SSLKeyStore getKeyStore()
```
    获取SSL KeyStore信息
    在双向HTTPS请求中使用的验证信息
    
    Returns:
    
    SSL KeyStore信息，SSLKeyStore类实例
  - setKeyStore
```
public ForestRequest setKeyStore(SSLKeyStore keyStore)
```
    设置SSL KeyStore信息
    在双向HTTPS请求中使用的验证信息
    
    Parameters:
    
    keyStore - SSL KeyStore信息，SSLKeyStore类实例
    
    Returns:
    
    ForestRequest类实例
  - getProxy
```
public ForestProxy getProxy()
```
    获取正向代理
    
    Returns:
    
    正向代理，ForestProxy类实例
  - setProxy
```
public ForestRequest setProxy(ForestProxy proxy)
```
    设置正向代理
    
    Parameters:
    
    proxy - 正向代理，ForestProxy类实例
    
    Returns:
    
    ForestRequest类实例
  - methodReturn
```
public ForestRequest methodReturn(T result)
```
    设置该请求对应的方法返回值
    
    Parameters:
    
    result - 方法返回值
    
    Returns:
    
    ForestRequest类实例
  - getMethodReturnValue
```
public Object getMethodReturnValue()
```
    获取该请求对应的方法返回值
    
    Returns:
    
    方法返回值
  - execute
```
public Object execute(HttpBackend backend,
                      LifeCycleHandler lifeCycleHandler)
```
    执行请求发送过程
    
    Parameters:
    
    backend - HTTP后端，HttpBackend接口实例
    
    lifeCycleHandler - 生命周期处理器，LifeCycleHandler接口实例
    
    Returns:
    
    接受到请求响应后，其响应内容反序列化成对象的结果
  - execute
```
public Object execute()
```
    执行请求发送过程
    
    Returns:
    
    接受到请求响应后，其响应内容反序列化成对象的结果

Class ForestRequest<T>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ForestRequest

ForestRequest

ForestRequest

ForestRequest

Method Detail

getConfiguration

getProtocol

setProtocol

getUrl

getURI

setUrl

getUserInfo

setUserInfo

getMethod

getBackend

setBackend

getLifeCycleHandler

setLifeCycleHandler

getQuery

getQuery

getQueryString

addQuery

addQuery

addQuery

addQueryValues

addQuery

replaceQuery

replaceQuery

replaceOrAddQuery

replaceOrAddQuery

getType

setType

getTypeChangeHistory

getTypeChangeHistoryString

getRequestLogMessage

setRequestLogMessage

getFilename

getContentEncoding

setContentEncoding

getUserAgent

setUserAgent

getCharset

setCharset

getResponseEncode

setResponseEncode

isAsync

setAsync

getBody

getBodyList

setBodyList

getDataType

setDataType

getContentType

setContentType

getTimeout

setTimeout

getSslProtocol

setSslProtocol

getRetryCount

setRetryCount

getMaxRetryInterval

setMaxRetryInterval

getData

addBody

addBody

addBody

addBody

addBody

addBody

addData

addData

addData

addNameValue

addNameValue

replaceBody