DefaultRequest (lucky-httpclient 2.0.0 API)

java.lang.Object
- com.luckyframework.httpclient.core.impl.DefaultRequest

所有已实现的接口:

HttpHeaderManager, Request, RequestParameter
```
public class DefaultRequest
extends Object
implements Request
```
请求的实现类

版本:

1.0

作者:

fk7075

字段概要
- 从接口继承的字段 com.luckyframework.httpclient.core.Request
  DEF_CONNECTION_TIME_OUT, DEF_READ_TIME_OUT, DEF_WRITER_TIME_OUT

构造器概要

构造器
构造器和说明
`DefaultRequest(String url, RequestMethod requestMethod)`
`DefaultRequest(String url, RequestMethod requestMethod, HttpHeaderManager httpHeaderManager, RequestParameter requestParameter)`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`DefaultRequest`	`addCookie(String name, String value)`
`DefaultRequest`	`addFiles(String name, File... files)` 添加一组文件参数
`DefaultRequest`	`addFiles(String name, String... filePaths)` 添加一组文件参数
`DefaultRequest`	`addFormParameter(String name, Object value)` 添加一个表单参数
`DefaultRequest`	`addHeader(String name, Object header)` 添加一个请求头
`DefaultRequest`	`addHttpFiles(String name, HttpFile... httpFiles)` 添加一个组Http文件参数
`DefaultRequest`	`addInputStream(String name, String fileName, InputStream inputStream)` 添加一个流式参数
`DefaultRequest`	`addMultipartFiles(String name, com.luckyframework.io.MultipartFile... multipartFiles)` 添加一组MultipartFile参数
`DefaultRequest`	`addPathParameter(String name, Object value)` 添加一个Rest参数
`DefaultRequest`	`addQueryParameter(String name, Object value)` 添加一个URL参数
`DefaultRequest`	`addRequestParameter(String name, Object value)` 添加一个请求参数
`DefaultRequest`	`addResources(String name, org.springframework.core.io.Resource... resources)` 添加一组资源参数
`DefaultRequest`	`addResources(String name, String... resourcePaths)` 添加一组资源参数
`BodyObject`	`getBody()` 返回请求体参数
`static Proxy`	`getCommonProxy()`
`Integer`	`getConnectTimeout()` 获取连接超时时间
`List<Header>`	`getHeader(String name)` 获取匹配的头信息
`HttpHeaderManager`	`getHeaderManager()` 请求头管理器
`Map<String,List<Header>>`	`getHeaderMap()` 获取所有请求头名称和请求头信息的Map
`Map<String,Object>`	`getPathParameters()` rest风格参数，在URL中以占位符形式的存在的参数
`Proxy`	`getProxy()` 获取代理对象
`Map<String,List<Object>>`	`getQueryParameters()` URL参数，这些参数将以字符串的形式拼接到URL中
`Integer`	`getReadTimeout()` 获取数据读取的超时时间
`RequestMethod`	`getRequestMethod()` 请求方式(GET、POST、DELETE、PUT...)
`RequestParameter`	`getRequestParameter()` 请求参数
`Map<String,Object>`	`getRequestParameters()` 请求的参数
`String`	`getUrl()` 目标资源的完整URL地址
`String`	`getUrlTemplate()`
`Integer`	`getWriterTimeout()` 获取数据写入的超时时间
`void`	`init()`
`DefaultRequest`	`putHeader(String name, Object header)`
`DefaultRequest`	`removeCookie(String name)`
`DefaultRequest`	`removerFirstHeader(String name)` 移除第一个匹配的头信息
`DefaultRequest`	`removerHeader(String name)` 移除一个请求头
`DefaultRequest`	`removerHeader(String name, int index)` 移除指定索引处的头信息
`DefaultRequest`	`removerLastHeader(String name)` 移除最后一个匹配的头信息
`DefaultRequest`	`removerPathParameter(String name)` 移除一个Rest参数
`DefaultRequest`	`removerQueryParameter(String name)` 移除一个URL参数
`DefaultRequest`	`removerQueryParameter(String name, int index)` 移除指定位置处的URL参数
`DefaultRequest`	`removerRequestParameter(String name)` 移除一个请求参数
`DefaultRequest`	`setAuthorization(String username, String password)` 添加基于Basic Auth方式的权限认证
`DefaultRequest`	`setBody(BodyObject body)` 设置请求体参数
`static void`	`setCommonConnectTimeout(Integer commonConnectTimeout)`
`static void`	`setCommonHttpHeaderManager(HttpHeaderManager commonHttpHeaderManager)`
`static void`	`setCommonProxy(Proxy commonProxy)`
`static void`	`setCommonReadTimeout(Integer commonReadTimeout)`
`static void`	`setCommonRequestParameter(RequestParameter commonRequestParameter)`
`static void`	`setCommonWriterTimeout(Integer commonWriterTimeout)`
`DefaultRequest`	`setConnectTimeout(Integer connectionTime)` 设置连接超时时间(单位：ms；默认值: 2000ms)
`DefaultRequest`	`setContentType(ContentType contentType)`
`DefaultRequest`	`setContentType(String contentType)`
`DefaultRequest`	`setHeader(String name, Object header)` 设置一个请求头
`DefaultRequest`	`setHeaders(Map<String,List<Header>> headers)`
`DefaultRequest`	`setJsonBody(Object jsonBody)` 设置一个JSON类型的Body参数
`DefaultRequest`	`setJsonBody(String jsonBodyString)` 设置一个JSON类型的Body参数
`DefaultRequest`	`setPathParameter(Map<String,Object> pathParamMap)` 设置请求参数
`DefaultRequest`	`setProxy(Proxy proxy)` 设置代理
`DefaultRequest`	`setProxy(String ip, int port)` 设置代理
`DefaultRequest`	`setQueryParameter(String name, Object value)` 设置一个URL参数
`DefaultRequest`	`setQueryParameters(Map<String,List<Object>> queryParameters)`
`DefaultRequest`	`setReadTimeout(Integer readTimeout)` 设置数据读取的超时时间(单位：ms；默认值: 2000ms)
`DefaultRequest`	`setRequestParameter(Map<String,Object> requestParamMap)` 设置请求参数
`void`	`setUrlTemplate(String urlTemplate)`
`DefaultRequest`	`setWriterTimeout(Integer writerTimeout)` 设置数据写入的超时时间(单位：ms；默认值: 2000ms)
`DefaultRequest`	`setXmlBody(Object xmlBody)` 设置一个XML类型的Body参数
`DefaultRequest`	`setXmlBody(String xmlBodyString)` 设置一个JSON类型的Body参数
`String`	`toString()`

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

从接口继承的方法 com.luckyframework.httpclient.core.Request
builder, connect, delete, get, getCookie, getCookies, head, options, patch, post, put, trace

从接口继承的方法 com.luckyframework.httpclient.core.HttpHeaderManager
check, checkHeaderName, checkHeaderValue, getContentType, getFirstHeader, getHeaders, getLastHeader

- 构造器详细资料
  - DefaultRequest
```
public DefaultRequest(@NonNull
                      String url,
                      @NonNull
                      RequestMethod requestMethod,
                      @NonNull
                      HttpHeaderManager httpHeaderManager,
                      @NonNull
                      RequestParameter requestParameter)
```
  - DefaultRequest
```
public DefaultRequest(@NonNull
                      String url,
                      @NonNull
                      RequestMethod requestMethod)
```
- 方法详细资料
  - setCommonConnectTimeout
```
public static void setCommonConnectTimeout(Integer commonConnectTimeout)
```
  - setCommonReadTimeout
```
public static void setCommonReadTimeout(Integer commonReadTimeout)
```
  - setCommonWriterTimeout
```
public static void setCommonWriterTimeout(Integer commonWriterTimeout)
```
  - setCommonHttpHeaderManager
```
public static void setCommonHttpHeaderManager(HttpHeaderManager commonHttpHeaderManager)
```
  - setCommonRequestParameter
```
public static void setCommonRequestParameter(RequestParameter commonRequestParameter)
```
  - getCommonProxy
```
public static Proxy getCommonProxy()
```
  - setCommonProxy
```
public static void setCommonProxy(Proxy commonProxy)
```
  - init
```
public void init()
```
  - setUrlTemplate
```
public void setUrlTemplate(String urlTemplate)
```
  - getUrlTemplate
```
public String getUrlTemplate()
```
  - getUrl
```
public String getUrl()
```
    从接口复制的说明: Request
    
    目标资源的完整URL地址
    
    指定者:
    
    getUrl 在接口中 Request
  - getRequestMethod
```
public RequestMethod getRequestMethod()
```
    从接口复制的说明: Request
    
    请求方式(GET、POST、DELETE、PUT...)
    
    指定者:
    
    getRequestMethod 在接口中 Request
  - getHeaderManager
```
public HttpHeaderManager getHeaderManager()
```
    从接口复制的说明: Request
    
    请求头管理器
    
    指定者:
    
    getHeaderManager 在接口中 Request
  - getRequestParameter
```
public RequestParameter getRequestParameter()
```
    从接口复制的说明: Request
    
    请求参数
    
    指定者:
    
    getRequestParameter 在接口中 Request
  - getConnectTimeout
```
public Integer getConnectTimeout()
```
    从接口复制的说明: Request
    
    获取连接超时时间
    
    指定者:
    
    getConnectTimeout 在接口中 Request
    
    返回:
    
    连接超时时间 (单位：ms；默认值: 6000ms)
  - setConnectTimeout
```
public DefaultRequest setConnectTimeout(Integer connectionTime)
```
    从接口复制的说明: Request
    
    设置连接超时时间(单位：ms；默认值: 2000ms)
    
    指定者:
    
    setConnectTimeout 在接口中 Request
    
    参数:
    
    connectionTime - 连接超时时间 ,单位：ms
  - getReadTimeout
```
public Integer getReadTimeout()
```
    从接口复制的说明: Request
    
    获取数据读取的超时时间
    
    指定者:
    
    getReadTimeout 在接口中 Request
    
    返回:
    
    数据读取的超时时间 (单位：ms；默认值: 2000ms)
  - setReadTimeout
```
public DefaultRequest setReadTimeout(Integer readTimeout)
```
    从接口复制的说明: Request
    
    设置数据读取的超时时间(单位：ms；默认值: 2000ms)
    
    指定者:
    
    setReadTimeout 在接口中 Request
    
    参数:
    
    readTimeout - 响应数据的超时时间,单位：ms
  - getWriterTimeout
```
public Integer getWriterTimeout()
```
    从接口复制的说明: Request
    
    获取数据写入的超时时间
    
    指定者:
    
    getWriterTimeout 在接口中 Request
    
    返回:
    
    据写入的超时时间 (单位：ms；默认值: 2000ms)
  - setWriterTimeout
```
public DefaultRequest setWriterTimeout(Integer writerTimeout)
```
    从接口复制的说明: Request
    
    设置数据写入的超时时间(单位：ms；默认值: 2000ms)
    
    指定者:
    
    setWriterTimeout 在接口中 Request
    
    参数:
    
    writerTimeout - 响应数据的超时时间,单位：ms
  - setProxy
```
public DefaultRequest setProxy(Proxy proxy)
```
    从接口复制的说明: Request
    
    设置代理
    
    指定者:
    
    setProxy 在接口中 Request
    
    参数:
    
    proxy - 代理
  - setProxy
```
public DefaultRequest setProxy(String ip,
                               int port)
```
    从接口复制的说明: Request
    
    设置代理
    
    指定者:
    
    setProxy 在接口中 Request
    
    参数:
    
    ip - 代理IP
    
    port - 代理端口
  - getProxy
```
public Proxy getProxy()
```
    从接口复制的说明: Request
    
    获取代理对象
    
    指定者:
    
    getProxy 在接口中 Request
    
    返回:
    
    代理对象
  - addCookie
```
public DefaultRequest addCookie(String name,
                                String value)
```
    指定者:
    
    addCookie 在接口中 Request
  - removeCookie
```
public DefaultRequest removeCookie(String name)
```
    指定者:
    
    removeCookie 在接口中 Request
  - addHeader
```
public DefaultRequest addHeader(String name,
                                Object header)
```
    从接口复制的说明: HttpHeaderManager
    
    添加一个请求头
    
    指定者:
    
    addHeader 在接口中 HttpHeaderManager
    
    参数:
    
    name - 名称
    
    header - 值
  - setHeader
```
public DefaultRequest setHeader(String name,
                                Object header)
```
    从接口复制的说明: HttpHeaderManager
    
    设置一个请求头
    
    指定者:
    
    setHeader 在接口中 HttpHeaderManager
    
    参数:
    
    name - 名称
    
    header - 值
  - putHeader
```
public DefaultRequest putHeader(String name,
                                Object header)
```
    指定者:
    
    putHeader 在接口中 HttpHeaderManager
  - setHeaders
```
public DefaultRequest setHeaders(Map<String,List<Header>> headers)
```
    指定者:
    
    setHeaders 在接口中 HttpHeaderManager
  - getHeader
```
public List<Header> getHeader(String name)
```
    从接口复制的说明: HttpHeaderManager
    
    获取匹配的头信息
    
    指定者:
    
    getHeader 在接口中 HttpHeaderManager
    
    参数:
    
    name - 名称
    
    返回:
    
    头信息
  - removerHeader
```
public DefaultRequest removerHeader(String name)
```
    从接口复制的说明: HttpHeaderManager
    
    移除一个请求头
    
    指定者:
    
    removerHeader 在接口中 HttpHeaderManager
    
    参数:
    
    name - 名称
  - removerFirstHeader
```
public DefaultRequest removerFirstHeader(String name)
```
    从接口复制的说明: HttpHeaderManager
    
    移除第一个匹配的头信息
    
    指定者:
    
    removerFirstHeader 在接口中 HttpHeaderManager
    
    参数:
    
    name - 名称
  - removerLastHeader
```
public DefaultRequest removerLastHeader(String name)
```
    从接口复制的说明: HttpHeaderManager
    
    移除最后一个匹配的头信息
    
    指定者:
    
    removerLastHeader 在接口中 HttpHeaderManager
    
    参数:
    
    name - 名称
  - removerHeader
```
public DefaultRequest removerHeader(String name,
                                    int index)
```
    从接口复制的说明: HttpHeaderManager
    
    移除指定索引处的头信息
    
    指定者:
    
    removerHeader 在接口中 HttpHeaderManager
    
    参数:
    
    name - 名称
  - getHeaderMap
```
public Map<String,List<Header>> getHeaderMap()
```
    从接口复制的说明: HttpHeaderManager
    
    获取所有请求头名称和请求头信息的Map
    
    指定者:
    
    getHeaderMap 在接口中 HttpHeaderManager
    
    返回:
  - setContentType
```
public DefaultRequest setContentType(String contentType)
```
    指定者:
    
    setContentType 在接口中 HttpHeaderManager
  - setContentType
```
public DefaultRequest setContentType(ContentType contentType)
```
    指定者:
    
    setContentType 在接口中 HttpHeaderManager
  - setAuthorization
```
public DefaultRequest setAuthorization(String username,
                                       String password)
```
    从接口复制的说明: HttpHeaderManager
    
    添加基于Basic Auth方式的权限认证
    
    指定者:
    
    setAuthorization 在接口中 HttpHeaderManager
    
    参数:
    
    username - 用户名
    
    password - 密码
  - getRequestParameters
```
public Map<String,Object> getRequestParameters()
```
    从接口复制的说明: RequestParameter
    
    请求的参数
    
    指定者:
    
    getRequestParameters 在接口中 RequestParameter
  - getPathParameters
```
public Map<String,Object> getPathParameters()
```
    从接口复制的说明: RequestParameter
    
    rest风格参数，在URL中以占位符形式的存在的参数
    
    指定者:
    
    getPathParameters 在接口中 RequestParameter
  - getQueryParameters
```
public Map<String,List<Object>> getQueryParameters()
```
    从接口复制的说明: RequestParameter
    
    URL参数，这些参数将以字符串的形式拼接到URL中
    
    指定者:
    
    getQueryParameters 在接口中 RequestParameter
  - setBody
```
public DefaultRequest setBody(BodyObject body)
```
    从接口复制的说明: RequestParameter
    
    设置请求体参数
    
    指定者:
    
    setBody 在接口中 RequestParameter
  - getBody
```
public BodyObject getBody()
```
    从接口复制的说明: RequestParameter
    
    返回请求体参数
    
    指定者:
    
    getBody 在接口中 RequestParameter
  - addPathParameter
```
public DefaultRequest addPathParameter(String name,
                                       Object value)
```
    从接口复制的说明: RequestParameter
    
    添加一个Rest参数
    
    指定者:
    
    addPathParameter 在接口中 RequestParameter
  - setPathParameter
```
public DefaultRequest setPathParameter(Map<String,Object> pathParamMap)
```
    从接口复制的说明: RequestParameter
    
    设置请求参数
    
    指定者:
    
    setPathParameter 在接口中 RequestParameter
  - addRequestParameter
```
public DefaultRequest addRequestParameter(String name,
                                          Object value)
```
    从接口复制的说明: RequestParameter
    
    添加一个请求参数
    
    指定者:
    
    addRequestParameter 在接口中 RequestParameter
  - setRequestParameter
```
public DefaultRequest setRequestParameter(Map<String,Object> requestParamMap)
```
    从接口复制的说明: RequestParameter
    
    设置请求参数
    
    指定者:
    
    setRequestParameter 在接口中 RequestParameter
  - addQueryParameter
```
public DefaultRequest addQueryParameter(String name,
                                        Object value)
```
    从接口复制的说明: RequestParameter
    
    添加一个URL参数
    
    指定者:
    
    addQueryParameter 在接口中 RequestParameter
  - setQueryParameter
```
public DefaultRequest setQueryParameter(String name,
                                        Object value)
```
    从接口复制的说明: RequestParameter
    
    设置一个URL参数
    
    指定者:
    
    setQueryParameter 在接口中 RequestParameter
  - setQueryParameters
```
public DefaultRequest setQueryParameters(Map<String,List<Object>> queryParameters)
```
    指定者:
    
    setQueryParameters 在接口中 RequestParameter
  - removerRequestParameter
```
public DefaultRequest removerRequestParameter(String name)
```
    从接口复制的说明: RequestParameter
    
    移除一个请求参数
    
    指定者:
    
    removerRequestParameter 在接口中 RequestParameter
  - removerPathParameter
```
public DefaultRequest removerPathParameter(String name)
```
    从接口复制的说明: RequestParameter
    
    移除一个Rest参数
    
    指定者:
    
    removerPathParameter 在接口中 RequestParameter
  - removerQueryParameter
```
public DefaultRequest removerQueryParameter(String name)
```
    从接口复制的说明: RequestParameter
    
    移除一个URL参数
    
    指定者:
    
    removerQueryParameter 在接口中 RequestParameter
  - removerQueryParameter
```
public DefaultRequest removerQueryParameter(String name,
                                            int index)
```
    从接口复制的说明: RequestParameter
    
    移除指定位置处的URL参数
    
    指定者:
    
    removerQueryParameter 在接口中 RequestParameter
  - addFormParameter
```
public DefaultRequest addFormParameter(String name,
                                       Object value)
```
    从接口复制的说明: RequestParameter
    
    添加一个表单参数
    
    指定者:
    
    addFormParameter 在接口中 RequestParameter
    
    参数:
    
    name - 参数名
    
    value - 参数值
  - addHttpFiles
```
public DefaultRequest addHttpFiles(String name,
                                   HttpFile... httpFiles)
```
    从接口复制的说明: RequestParameter
    
    添加一个组Http文件参数
    
    指定者:
    
    addHttpFiles 在接口中 RequestParameter
    
    参数:
    
    name - 参数名
    
    httpFiles - Http文件列表
  - addInputStream
```
public DefaultRequest addInputStream(String name,
                                     String fileName,
                                     InputStream inputStream)
```
    从接口复制的说明: RequestParameter
    
    添加一个流式参数
    
    指定者:
    
    addInputStream 在接口中 RequestParameter
    
    参数:
    
    name - 参数名
    
    fileName - 文件名
    
    inputStream - 输入流
  - addFiles
```
public DefaultRequest addFiles(String name,
                               File... files)
```
    从接口复制的说明: RequestParameter
    
    添加一组文件参数
    
    指定者:
    
    addFiles 在接口中 RequestParameter
    
    参数:
    
    name - 参数名
    
    files - 文件列表
  - addFiles
```
public DefaultRequest addFiles(String name,
                               String... filePaths)
```
    从接口复制的说明: RequestParameter
    
    添加一组文件参数
    
    指定者:
    
    addFiles 在接口中 RequestParameter
    
    参数:
    
    name - 参数名
    
    filePaths - 文件路径列表
  - addResources
```
public DefaultRequest addResources(String name,
                                   org.springframework.core.io.Resource... resources)
```
    从接口复制的说明: RequestParameter
    
    添加一组资源参数
    
    指定者:
    
    addResources 在接口中 RequestParameter
    
    参数:
    
    name - 参数名
    
    resources - 资源列表
  - addResources
```
public DefaultRequest addResources(String name,
                                   String... resourcePaths)
```
    从接口复制的说明: RequestParameter
    
    添加一组资源参数
    
    指定者:
    
    addResources 在接口中 RequestParameter
    
    参数:
    
    name - 参数名
    
    resourcePaths - 资源路径列表
  - addMultipartFiles
```
public DefaultRequest addMultipartFiles(String name,
                                        com.luckyframework.io.MultipartFile... multipartFiles)
```
    从接口复制的说明: RequestParameter
    
    添加一组MultipartFile参数
    
    指定者:
    
    addMultipartFiles 在接口中 RequestParameter
    
    参数:
    
    name - 参数名
    
    multipartFiles - MultipartFile参数列表
  - setJsonBody
```
public DefaultRequest setJsonBody(Object jsonBody)
```
    从接口复制的说明: RequestParameter
    
    设置一个JSON类型的Body参数
    
    指定者:
    
    setJsonBody 在接口中 RequestParameter
    
    参数:
    
    jsonBody - 可序列化为JSON字符的对象
  - setJsonBody
```
public DefaultRequest setJsonBody(String jsonBodyString)
```
    从接口复制的说明: RequestParameter
    
    设置一个JSON类型的Body参数
    
    指定者:
    
    setJsonBody 在接口中 RequestParameter
    
    参数:
    
    jsonBodyString - JSON字符串
  - setXmlBody
```
public DefaultRequest setXmlBody(Object xmlBody)
```
    从接口复制的说明: RequestParameter
    
    设置一个XML类型的Body参数
    
    指定者:
    
    setXmlBody 在接口中 RequestParameter
    
    参数:
    
    xmlBody - 可序列化为XML字符的对象
  - setXmlBody
```
public DefaultRequest setXmlBody(String xmlBodyString)
```
    从接口复制的说明: RequestParameter
    
    设置一个JSON类型的Body参数
    
    指定者:
    
    setXmlBody 在接口中 RequestParameter
    
    参数:
    
    xmlBodyString - XML字符串
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 Object

类 DefaultRequest

字段概要

从接口继承的字段 com.luckyframework.httpclient.core.Request

构造器概要

方法概要

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

从接口继承的方法 com.luckyframework.httpclient.core.Request

从接口继承的方法 com.luckyframework.httpclient.core.HttpHeaderManager

构造器详细资料

DefaultRequest

DefaultRequest

方法详细资料

setCommonConnectTimeout

setCommonReadTimeout

setCommonWriterTimeout

setCommonHttpHeaderManager

setCommonRequestParameter

getCommonProxy

setCommonProxy

init

setUrlTemplate

getUrlTemplate

getUrl

getRequestMethod

getHeaderManager

getRequestParameter

getConnectTimeout

setConnectTimeout

getReadTimeout

setReadTimeout

getWriterTimeout

setWriterTimeout

setProxy

setProxy

getProxy

addCookie

removeCookie

addHeader

setHeader

putHeader

setHeaders

getHeader

removerHeader

removerFirstHeader

removerLastHeader

removerHeader

getHeaderMap

setContentType

setContentType

setAuthorization

getRequestParameters

getPathParameters

getQueryParameters

setBody

getBody

addPathParameter

setPathParameter

addRequestParameter

setRequestParameter

addQueryParameter

setQueryParameter

setQueryParameters

removerRequestParameter

removerPathParameter

removerQueryParameter

removerQueryParameter

addFormParameter

addHttpFiles

addInputStream

addFiles

addFiles

addResources

addResources

addMultipartFiles

setJsonBody

setJsonBody

setXmlBody

setXmlBody

toString