SimpleOAuth2Request (hsweb-authorization-oauth2-client 3.0.3 API)

java.lang.Object
- org.hswebframework.web.authorization.oauth2.client.simple.request.SimpleOAuth2Request

所有已实现的接口:: OAuth2Request

public class SimpleOAuth2Request
extends Object
implements OAuth2Request

作者:: zhouhao

构造器概要

构造器
构造器和说明

SimpleOAuth2Request(org.hswebframework.expands.request.http.HttpRequest request)

构造器
构造器和说明
`SimpleOAuth2Request(org.hswebframework.expands.request.http.HttpRequest request)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`OAuth2Request`	`accept(String accept)` 设置接受响应的格式,相当与请求头:Accept
`OAuth2Request`	`contentType(String contentType)` 设置请求的contentType
`OAuth2Request`	`cookie(String cookie)` 设置cookie
`protected SimpleOAuth2Response`	`createNativeResponse(java.util.function.Supplier<org.hswebframework.expands.request.http.Response> responseSupplier)`
`protected OAuth2Response`	`createResponse(java.util.function.Supplier<org.hswebframework.expands.request.http.Response> responseSupplier)`
`protected OAuth2Response`	`createUnCheckResponse(org.hswebframework.web.authorization.oauth2.client.simple.request.UnCheck<org.hswebframework.expands.request.http.Response> unCheck)`
`OAuth2Response`	`delete()` 以DELETE方式请求,并返回请求结果
`OAuth2Response`	`get()` 以GET方式请求,并返回请求结果
`OAuth2Request`	`header(String name, String value)` 设置请求头
`OAuth2Request`	`onRefreshTokenExpired(TokenExpiredCallBack refreshTokenExpiredCallBack)`
`OAuth2Request`	`onTokenExpired(TokenExpiredCallBack callback)`
`OAuth2Request`	`param(String name, Object value)` 设置请求参数,相当于/url?
`OAuth2Request`	`params(Map<String,String> params)`
`OAuth2Response`	`patch()` 以PATCH方式请求,并返回请求结果
`OAuth2Response`	`post()` 以POST方式请求,并返回请求结果
`OAuth2Response`	`put()` 以PUT方式请求,并返回请求结果
`OAuth2Request`	`requestBody(String value)` 设置请求体,将内容根据contentType(默认application/json)序列化为对应的请求数据
`void`	`setConvertHandler(ResponseConvertHandler convertHandler)`
`void`	`setResponseJudge(ResponseJudge responseJudge)`
`OAuth2Request`	`timeout(long millisecond, java.util.function.Consumer<OAuth2Request> timeoutCallBack)` 设置请求超时时间,超时后回调 timeoutConsumer
`OAuth2Response`	`upload(String name, InputStream inputStream)`
`OAuth2Response`	`upload(String name, InputStream inputStream, String fileName)`

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

- 构造器详细资料
  - SimpleOAuth2Request
```
public SimpleOAuth2Request(org.hswebframework.expands.request.http.HttpRequest request)
```
- 方法详细资料
  - setConvertHandler
```
public void setConvertHandler(ResponseConvertHandler convertHandler)
```
  - setResponseJudge
```
public void setResponseJudge(ResponseJudge responseJudge)
```
  - onRefreshTokenExpired
```
public OAuth2Request onRefreshTokenExpired(TokenExpiredCallBack refreshTokenExpiredCallBack)
```
    指定者:
    
    onRefreshTokenExpired 在接口中 OAuth2Request
  - onTokenExpired
```
public OAuth2Request onTokenExpired(TokenExpiredCallBack callback)
```
    指定者:
    
    onTokenExpired 在接口中 OAuth2Request
  - upload
```
public OAuth2Response upload(String name,
                             InputStream inputStream)
```
    指定者:
    
    upload 在接口中 OAuth2Request
  - upload
```
public OAuth2Response upload(String name,
                             InputStream inputStream,
                             String fileName)
```
    指定者:
    
    upload 在接口中 OAuth2Request
  - params
```
public OAuth2Request params(Map<String,String> params)
```
    指定者:
    
    params 在接口中 OAuth2Request
  - param
```
public OAuth2Request param(String name,
                           Object value)
```
    从接口复制的说明: OAuth2Request
    
    设置请求参数,相当于/url?name=value
    
    指定者:
    
    param 在接口中 OAuth2Request
    
    参数:
    
    name - 参数名称
    
    value - 参数值
    
    返回:
    
    request自身
  - requestBody
```
public OAuth2Request requestBody(String value)
```
    从接口复制的说明: OAuth2Request
    
    设置请求体,将内容根据contentType(默认application/json)序列化为对应的请求数据
    
    指定者:
    
    requestBody 在接口中 OAuth2Request
    
    参数:
    
    value - 请求内容
    
    返回:
    
    request自身
  - header
```
public OAuth2Request header(String name,
                            String value)
```
    从接口复制的说明: OAuth2Request
    
    设置请求头
    
    指定者:
    
    header 在接口中 OAuth2Request
    
    参数:
    
    name - 名称
    
    value - 值
    
    返回:
    
    request自身
  - cookie
```
public OAuth2Request cookie(String cookie)
```
    从接口复制的说明: OAuth2Request
    
    设置cookie
    
    指定者:
    
    cookie 在接口中 OAuth2Request
    
    参数:
    
    cookie - 值
    
    返回:
    
    request自身
  - contentType
```
public OAuth2Request contentType(String contentType)
```
    从接口复制的说明: OAuth2Request
    
    设置请求的contentType
    
    指定者:
    
    contentType 在接口中 OAuth2Request
    
    返回:
    
    request自身
    
    另请参阅:
    
    "application/json"
  - accept
```
public OAuth2Request accept(String accept)
```
    从接口复制的说明: OAuth2Request
    
    设置接受响应的格式,相当与请求头:Accept
    
    指定者:
    
    accept 在接口中 OAuth2Request
    
    返回:
    
    request自身
    
    另请参阅:
    
    "application/json"
  - timeout
```
public OAuth2Request timeout(long millisecond,
                             java.util.function.Consumer<OAuth2Request> timeoutCallBack)
```
    从接口复制的说明: OAuth2Request
    
    设置请求超时时间,超时后回调 timeoutConsumer
    
    指定者:
    
    timeout 在接口中 OAuth2Request
    
    参数:
    
    millisecond - 超时时间（毫秒）,小于0则不设置超时
    
    timeoutCallBack - 超时后的处理回调
    
    返回:
    
    request自身
    
    另请参阅:
    
    Consumer
  - createNativeResponse
```
protected SimpleOAuth2Response createNativeResponse(java.util.function.Supplier<org.hswebframework.expands.request.http.Response> responseSupplier)
```
  - createResponse
```
protected OAuth2Response createResponse(java.util.function.Supplier<org.hswebframework.expands.request.http.Response> responseSupplier)
```
  - createUnCheckResponse
```
protected OAuth2Response createUnCheckResponse(org.hswebframework.web.authorization.oauth2.client.simple.request.UnCheck<org.hswebframework.expands.request.http.Response> unCheck)
```
  - get
```
public OAuth2Response get()
```
    从接口复制的说明: OAuth2Request
    
    以GET方式请求,并返回请求结果
    
    指定者:
    
    get 在接口中 OAuth2Request
    
    返回:
    
    请求结果
  - put
```
public OAuth2Response put()
```
    从接口复制的说明: OAuth2Request
    
    以PUT方式请求,并返回请求结果
    
    指定者:
    
    put 在接口中 OAuth2Request
    
    返回:
    
    请求结果
  - post
```
public OAuth2Response post()
```
    从接口复制的说明: OAuth2Request
    
    以POST方式请求,并返回请求结果
    
    指定者:
    
    post 在接口中 OAuth2Request
    
    返回:
    
    请求结果
  - delete
```
public OAuth2Response delete()
```
    从接口复制的说明: OAuth2Request
    
    以DELETE方式请求,并返回请求结果
    
    指定者:
    
    delete 在接口中 OAuth2Request
    
    返回:
    
    请求结果
  - patch
```
public OAuth2Response patch()
```
    从接口复制的说明: OAuth2Request
    
    以PATCH方式请求,并返回请求结果
    
    指定者:
    
    patch 在接口中 OAuth2Request
    
    返回:
    
    请求结果

类 SimpleOAuth2Request

构造器概要

方法概要

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

构造器详细资料

SimpleOAuth2Request

方法详细资料

setConvertHandler

setResponseJudge

onRefreshTokenExpired

onTokenExpired

upload

upload

params

param

requestBody

header

cookie

contentType

accept

timeout

createNativeResponse

createResponse

createUnCheckResponse

get

put

post

delete

patch