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

java.lang.Object
- org.hswebframework.web.authorization.oauth2.client.simple.session.DefaultOAuth2Session

所有已实现的接口:

OAuth2Session

直接已知子类:

AuthorizationCodeSession, CachedOAuth2Session, PasswordSession
```
public class DefaultOAuth2Session
extends Object
implements OAuth2Session
```
作者:

zhouhao

字段概要

字段
限定符和类型	字段和说明
`protected AccessTokenInfo`	`accessTokenInfo`
`protected OAuth2Request`	`accessTokenRequest`
`protected boolean`	`closed`
`protected OAuth2RequestBuilderFactory`	`requestBuilderFactory`
`protected String`	`scope`
`protected OAuth2ServerConfig`	`serverConfig`

构造器概要

构造器
构造器和说明

DefaultOAuth2Session()

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

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`protected void`	`applyBasicAuthParam(OAuth2Request request)`
`protected void`	`applyTokenParam(OAuth2Request request)`
`OAuth2Session`	`authorize()` 尝试进行认证
`void`	`close()` 关闭会话,将清空
`protected OAuth2Request`	`createRequest(String uriOrUrl)`
`protected String`	`encodeAuthorization(String auth)`
`AccessTokenInfo`	`getAccessToken()`
`protected String`	`getRealUrl(String url)`
`void`	`init()`
`boolean`	`isClosed()`
`void`	`onTokenChanged(java.util.function.Consumer<AccessTokenInfo> changed)`
`OAuth2Session`	`param(String name, Object value)` 设置在请求OAuth2 授权的时候的参数(除了必要之外的参数),client_id,client_secret等信息不需要调用此方法设置
`protected void`	`refreshToken()`
`OAuth2Request`	`request(String uriOrUrl)` 发起一个OAuth2请求,参数为接口地址
`AccessTokenInfo`	`requestAccessToken()`
`OAuth2Session`	`scope(String scope)`
`void`	`setRequestBuilderFactory(OAuth2RequestBuilderFactory requestBuilderFactory)`
`void`	`setServerConfig(OAuth2ServerConfig serverConfig)`

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

- 字段详细资料
  - requestBuilderFactory
```
protected OAuth2RequestBuilderFactory requestBuilderFactory
```
  - serverConfig
```
protected OAuth2ServerConfig serverConfig
```
  - closed
```
protected boolean closed
```
  - accessTokenRequest
```
protected OAuth2Request accessTokenRequest
```
  - accessTokenInfo
```
protected AccessTokenInfo accessTokenInfo
```
  - scope
```
protected String scope
```
- 构造器详细资料
  - DefaultOAuth2Session
```
public DefaultOAuth2Session()
```
- 方法详细资料
  - setRequestBuilderFactory
```
public void setRequestBuilderFactory(OAuth2RequestBuilderFactory requestBuilderFactory)
```
  - setServerConfig
```
public void setServerConfig(OAuth2ServerConfig serverConfig)
```
  - init
```
public void init()
```
  - createRequest
```
protected OAuth2Request createRequest(String uriOrUrl)
```
  - onTokenChanged
```
public void onTokenChanged(java.util.function.Consumer<AccessTokenInfo> changed)
```
  - encodeAuthorization
```
protected String encodeAuthorization(String auth)
```
  - applyBasicAuthParam
```
protected void applyBasicAuthParam(OAuth2Request request)
```
  - applyTokenParam
```
protected void applyTokenParam(OAuth2Request request)
```
  - getRealUrl
```
protected String getRealUrl(String url)
```
  - authorize
```
public OAuth2Session authorize()
```
    从接口复制的说明: OAuth2Session
    
    尝试进行认证
    
    指定者:
    
    authorize 在接口中 OAuth2Session
    
    返回:
    
    会话自身
  - request
```
public OAuth2Request request(String uriOrUrl)
```
    从接口复制的说明: OAuth2Session
    
    发起一个OAuth2请求,参数为接口地址
    
    指定者:
    
    request 在接口中 OAuth2Session
    
    参数:
    
    uriOrUrl - 请求地址,可以为URI或者URL
    
    返回:
    
    请求接口
  - param
```
public OAuth2Session param(String name,
                           Object value)
```
    从接口复制的说明: OAuth2Session
    
    设置在请求OAuth2 授权的时候的参数(除了必要之外的参数),client_id,client_secret等信息不需要调用此方法设置
    
    指定者:
    
    param 在接口中 OAuth2Session
    
    参数:
    
    name - 参数名称
    
    value - 参数值
    
    返回:
    
    会话自身
  - requestAccessToken
```
public AccessTokenInfo requestAccessToken()
```
    指定者:
    
    requestAccessToken 在接口中 OAuth2Session
  - refreshToken
```
protected void refreshToken()
```
  - scope
```
public OAuth2Session scope(String scope)
```
    指定者:
    
    scope 在接口中 OAuth2Session
  - close
```
public void close()
```
    从接口复制的说明: OAuth2Session
    
    关闭会话,将清空
    
    指定者:
    
    close 在接口中 OAuth2Session
  - isClosed
```
public boolean isClosed()
```
    指定者:
    
    isClosed 在接口中 OAuth2Session
    
    返回:
    
    是否已关闭
  - getAccessToken
```
public AccessTokenInfo getAccessToken()
```
    指定者:
    
    getAccessToken 在接口中 OAuth2Session

类 DefaultOAuth2Session

字段概要

构造器概要

方法概要

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

字段详细资料

requestBuilderFactory

serverConfig

closed

accessTokenRequest

accessTokenInfo

scope

构造器详细资料

DefaultOAuth2Session

方法详细资料

setRequestBuilderFactory

setServerConfig

init

createRequest

onTokenChanged

encodeAuthorization

applyBasicAuthParam

applyTokenParam

getRealUrl

authorize

request

param

requestAccessToken

refreshToken

scope

close

isClosed

getAccessToken