Request (lucky-httpclient 2.0.0 API)

所有超级接口:

HttpHeaderManager, RequestParameter

所有已知实现类:

DefaultRequest
```
public interface Request
extends RequestParameter, HttpHeaderManager
```
请求接口

版本:

1.0.0

作者:

fk7075

字段概要

字段
限定符和类型	字段和说明
`static Integer`	`DEF_CONNECTION_TIME_OUT` 默认的连接超时时间
`static Integer`	`DEF_READ_TIME_OUT` 默认的读超时时间
`static Integer`	`DEF_WRITER_TIME_OUT` 默认的写超时时间

方法概要

所有方法静态方法实例方法抽象方法默认方法
限定符和类型	方法和说明
`default Request`	`addCookie(String name, String value)`
`static DefaultRequest`	`builder(String url, RequestMethod requestMethod, Object... pathParams)` 快速构建一个Http请求
`static DefaultRequest`	`connect(String url, Object... pathParams)` 构建一个Http[CONNECT]请求
`static DefaultRequest`	`delete(String url, Object... pathParams)` 构建一个Http[DELETE]请求
`static DefaultRequest`	`get(String url, Object... pathParams)` 构建一个Http[GET]请求
`Integer`	`getConnectTimeout()` 获取连接超时时间
`default String`	`getCookie(String name)`
`default List<Header>`	`getCookies()`
`HttpHeaderManager`	`getHeaderManager()` 请求头管理器
`Proxy`	`getProxy()` 获取代理对象
`Integer`	`getReadTimeout()` 获取数据读取的超时时间
`RequestMethod`	`getRequestMethod()` 请求方式(GET、POST、DELETE、PUT...)
`RequestParameter`	`getRequestParameter()` 请求参数
`String`	`getUrl()` 目标资源的完整URL地址
`Integer`	`getWriterTimeout()` 获取数据写入的超时时间
`static DefaultRequest`	`head(String url, Object... pathParams)` 构建一个Http[HEAD]请求
`static DefaultRequest`	`options(String url, Object... pathParams)` 构建一个Http[OPTIONS]请求
`static DefaultRequest`	`patch(String url, Object... pathParams)` 构建一个Http[PATCH]请求
`static DefaultRequest`	`post(String url, Object... pathParams)` 构建一个Http[POST]请求
`static DefaultRequest`	`put(String url, Object... pathParams)` 构建一个Http[PUT]请求
`default Request`	`removeCookie(String name)`
`Request`	`setConnectTimeout(Integer connectionTime)` 设置连接超时时间(单位：ms；默认值: 2000ms)
`Request`	`setProxy(Proxy proxy)` 设置代理
`default Request`	`setProxy(String ip, int port)` 设置代理
`Request`	`setReadTimeout(Integer readTimeout)` 设置数据读取的超时时间(单位：ms；默认值: 2000ms)
`Request`	`setWriterTimeout(Integer writerTimeout)` 设置数据写入的超时时间(单位：ms；默认值: 2000ms)
`static DefaultRequest`	`trace(String url, Object... pathParams)` 构建一个Http[TRACE]请求

从接口继承的方法 com.luckyframework.httpclient.core.RequestParameter
addFiles, addFiles, addFormParameter, addHttpFiles, addInputStream, addMultipartFiles, addPathParameter, addQueryParameter, addRequestParameter, addResources, addResources, getBody, getPathParameters, getQueryParameters, getRequestParameters, removerPathParameter, removerQueryParameter, removerQueryParameter, removerRequestParameter, setBody, setJsonBody, setJsonBody, setPathParameter, setQueryParameter, setQueryParameters, setRequestParameter, setXmlBody, setXmlBody

从接口继承的方法 com.luckyframework.httpclient.core.HttpHeaderManager
addHeader, check, checkHeaderName, checkHeaderValue, getContentType, getFirstHeader, getHeader, getHeaderMap, getHeaders, getLastHeader, putHeader, removerFirstHeader, removerHeader, removerHeader, removerLastHeader, setAuthorization, setContentType, setContentType, setHeader, setHeaders

- 字段详细资料
  - DEF_CONNECTION_TIME_OUT
```
static final Integer DEF_CONNECTION_TIME_OUT
```
    默认的连接超时时间
  - DEF_READ_TIME_OUT
```
static final Integer DEF_READ_TIME_OUT
```
    默认的读超时时间
  - DEF_WRITER_TIME_OUT
```
static final Integer DEF_WRITER_TIME_OUT
```
    默认的写超时时间
- 方法详细资料
  - getUrl
```
String getUrl()
```
    目标资源的完整URL地址
  - getRequestMethod
```
RequestMethod getRequestMethod()
```
    请求方式(GET、POST、DELETE、PUT...)
  - getHeaderManager
```
HttpHeaderManager getHeaderManager()
```
    请求头管理器
  - getRequestParameter
```
RequestParameter getRequestParameter()
```
    请求参数
  - getConnectTimeout
```
Integer getConnectTimeout()
```
    获取连接超时时间
    
    返回:
    
    连接超时时间 (单位：ms；默认值: 6000ms)
  - setConnectTimeout
```
Request setConnectTimeout(Integer connectionTime)
```
    设置连接超时时间(单位：ms；默认值: 2000ms)
    
    参数:
    
    connectionTime - 连接超时时间 ,单位：ms
  - getReadTimeout
```
Integer getReadTimeout()
```
    获取数据读取的超时时间
    
    返回:
    
    数据读取的超时时间 (单位：ms；默认值: 2000ms)
  - setReadTimeout
```
Request setReadTimeout(Integer readTimeout)
```
    设置数据读取的超时时间(单位：ms；默认值: 2000ms)
    
    参数:
    
    readTimeout - 响应数据的超时时间,单位：ms
  - getWriterTimeout
```
Integer getWriterTimeout()
```
    获取数据写入的超时时间
    
    返回:
    
    据写入的超时时间 (单位：ms；默认值: 2000ms)
  - setWriterTimeout
```
Request setWriterTimeout(Integer writerTimeout)
```
    设置数据写入的超时时间(单位：ms；默认值: 2000ms)
    
    参数:
    
    writerTimeout - 响应数据的超时时间,单位：ms
  - setProxy
```
Request setProxy(Proxy proxy)
```
    设置代理
    
    参数:
    
    proxy - 代理
  - getProxy
```
Proxy getProxy()
```
    获取代理对象
    
    返回:
    
    代理对象
  - setProxy
```
default Request setProxy(String ip,
                         int port)
```
    设置代理
    
    参数:
    
    ip - 代理IP
    
    port - 代理端口
  - addCookie
```
default Request addCookie(String name,
                          String value)
```
  - getCookie
```
default String getCookie(String name)
```
  - getCookies
```
default List<Header> getCookies()
```
  - removeCookie
```
default Request removeCookie(String name)
```
  - builder
```
static DefaultRequest builder(String url,
                              RequestMethod requestMethod,
                              Object... pathParams)
```
    快速构建一个Http请求
    
    参数:
    
    url - 请求地址,支持Rest参数占位符
    
    requestMethod - 请求方式[GET、POST、DELETE、PUT...]
    
    pathParams - Rest参数占位符的填充值
    
    返回:
    
    DefaultRequest
  - get
```
static DefaultRequest get(String url,
                          Object... pathParams)
```
    构建一个Http[GET]请求
    
    参数:
    
    url - 请求地址,支持Rest参数占位符
    
    pathParams - Rest参数占位符的填充值
    
    返回:
    
    DefaultRequest
  - post
```
static DefaultRequest post(String url,
                           Object... pathParams)
```
    构建一个Http[POST]请求
    
    参数:
    
    url - 请求地址,支持Rest参数占位符
    
    pathParams - Rest参数占位符的填充值
    
    返回:
    
    DefaultRequest
  - delete
```
static DefaultRequest delete(String url,
                             Object... pathParams)
```
    构建一个Http[DELETE]请求
    
    参数:
    
    url - 请求地址,支持Rest参数占位符
    
    pathParams - Rest参数占位符的填充值
    
    返回:
    
    DefaultRequest
  - put
```
static DefaultRequest put(String url,
                          Object... pathParams)
```
    构建一个Http[PUT]请求
    
    参数:
    
    url - 请求地址,支持Rest参数占位符
    
    pathParams - Rest参数占位符的填充值
    
    返回:
    
    DefaultRequest
  - head
```
static DefaultRequest head(String url,
                           Object... pathParams)
```
    构建一个Http[HEAD]请求
    
    参数:
    
    url - 请求地址,支持Rest参数占位符
    
    pathParams - Rest参数占位符的填充值
    
    返回:
    
    DefaultRequest
  - patch
```
static DefaultRequest patch(String url,
                            Object... pathParams)
```
    构建一个Http[PATCH]请求
    
    参数:
    
    url - 请求地址,支持Rest参数占位符
    
    pathParams - Rest参数占位符的填充值
    
    返回:
    
    DefaultRequest
  - connect
```
static DefaultRequest connect(String url,
                              Object... pathParams)
```
    构建一个Http[CONNECT]请求
    
    参数:
    
    url - 请求地址,支持Rest参数占位符
    
    pathParams - Rest参数占位符的填充值
    
    返回:
    
    DefaultRequest
  - options
```
static DefaultRequest options(String url,
                              Object... pathParams)
```
    构建一个Http[OPTIONS]请求
    
    参数:
    
    url - 请求地址,支持Rest参数占位符
    
    pathParams - Rest参数占位符的填充值
    
    返回:
    
    DefaultRequest
  - trace
```
static DefaultRequest trace(String url,
                            Object... pathParams)
```
    构建一个Http[TRACE]请求
    
    参数:
    
    url - 请求地址,支持Rest参数占位符
    
    pathParams - Rest参数占位符的填充值
    
    返回:
    
    DefaultRequest

接口 Request

字段概要

方法概要

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

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

字段详细资料

DEF_CONNECTION_TIME_OUT

DEF_READ_TIME_OUT

DEF_WRITER_TIME_OUT

方法详细资料

getUrl

getRequestMethod

getHeaderManager

getRequestParameter

getConnectTimeout

setConnectTimeout

getReadTimeout

setReadTimeout

getWriterTimeout

setWriterTimeout

setProxy

getProxy

setProxy

addCookie

getCookie

getCookies

removeCookie

builder

get

post

delete

put

head

patch

connect

options

trace