cn.dev33.satoken.oauth2.logic

类 SaOAuth2Template

java.lang.Object

cn.dev33.satoken.oauth2.logic.SaOAuth2Template

public class SaOAuth2Template
extends java.lang.Object

Sa-Token-OAuth2 模块 代码实现

作者:

kong

构造器概要

构造器

构造器和说明
SaOAuth2Template()

方法概要

限定符和类型	方法和说明
java.lang.String	buildImplicitRedirectUri(java.lang.String redirectUri, java.lang.String token, java.lang.String state) 构建URL：下放Access-Token URL （implicit 隐藏式）
java.lang.String	buildRedirectUri(java.lang.String redirectUri, java.lang.String code, java.lang.String state) 构建URL：下放Code URL (Authorization Code 授权码)
AccessTokenModel	checkAccessToken(java.lang.String accessToken) 获取 Access-Token，如果AccessToken为空则抛出异常
AccessTokenModel	checkAccessTokenParam(java.lang.String clientId, java.lang.String clientSecret, java.lang.String accessToken) 校验：Access-Token、clientId、clientSecret 三者是否匹配成功
SaClientModel	checkClientModel(java.lang.String clientId) 根据id获取Client信息, 如果Client为空，则抛出异常
SaClientModel	checkClientSecret(java.lang.String clientId, java.lang.String clientSecret) 校验：clientId 与 clientSecret 是否正确
ClientTokenModel	checkClientToken(java.lang.String clientToken) 获取 Client-Token，如果ClientToken为空则抛出异常
void	checkContract(java.lang.String clientId, java.lang.String scope) 校验：该Client是否签约了指定的Scope
CodeModel	checkGainTokenParam(java.lang.String code, java.lang.String clientId, java.lang.String clientSecret, java.lang.String redirectUri) 校验：使用 code 获取 token 时提供的参数校验
RefreshTokenModel	checkRefreshTokenParam(java.lang.String clientId, java.lang.String clientSecret, java.lang.String refreshToken) 校验：使用 Refresh-Token 刷新 Access-Token 时提供的参数校验
void	checkRightUrl(java.lang.String clientId, java.lang.String url) 校验：该Client使用指定url作为回调地址，是否合法
void	checkScope(java.lang.String accessToken, java.lang.String... scopes) 校验：指定 Access-Token 是否具有指定 Scope
RefreshTokenModel	converAccessTokenToRefreshToken(AccessTokenModel at) 将 Access-Token 转换为 Refresh-Token
AccessTokenModel	converCodeToAccessToken(CodeModel cm) 将 Code 转换为 Access-Token
AccessTokenModel	converRefreshTokenToAccessToken(RefreshTokenModel rt) 将 Refresh-Token 转换为 Access-Token
RefreshTokenModel	converRefreshTokenToRefreshToken(RefreshTokenModel rt) 根据 Refresh-Token 创建一个新的 Refresh-Token
void	deleteAccessToken(java.lang.String accessToken) 删除：Access-Token
void	deleteAccessTokenIndex(java.lang.String clientId, java.lang.Object loginId) 删除：Access-Token索引
void	deleteClientToken(java.lang.String clientToken) 删除：Client-Token
void	deleteClientTokenIndex(java.lang.String clientId) 删除：Client-Token索引
void	deleteCode(java.lang.String code) 删除：Code
void	deleteCodeIndex(java.lang.String clientId, java.lang.Object loginId) 删除：Code索引
void	deleteGrantScope(java.lang.String clientId, java.lang.Object loginId) 删除：用户授权记录
void	deletePastTokenIndex(java.lang.String clientId) 删除：Past-Token索引
void	deleteRefreshToken(java.lang.String refreshToken) 删除：Refresh-Token
void	deleteRefreshTokenIndex(java.lang.String clientId, java.lang.Object loginId) 删除：Refresh-Token索引
AccessTokenModel	generateAccessToken(RequestAuthModel ra, boolean isCreateRt) 构建Model：Access-Token (根据RequestAuthModel构建，用于隐藏式 and 密码式)
AccessTokenModel	generateAccessToken(java.lang.String code) 构建Model：Access-Token
ClientTokenModel	generateClientToken(java.lang.String clientId, java.lang.String scope) 构建Model：Client-Token
CodeModel	generateCode(RequestAuthModel ra) 构建Model：Code授权码
RequestAuthModel	generateRequestAuth(SaRequest req, java.lang.Object loginId) 构建Model：请求Model
AccessTokenModel	getAccessToken(java.lang.String accessToken) 获取：Access-Token Model
java.lang.String	getAccessTokenValue(java.lang.String clientId, java.lang.Object loginId) 获取：Access-Token Value
SaClientModel	getClientModel(java.lang.String clientId) 根据id获取Client信息
ClientTokenModel	getClientToken(java.lang.String clientToken) 获取：Client-Token Model
java.lang.String	getClientTokenValue(java.lang.String clientId) 获取：Client-Token Value
CodeModel	getCode(java.lang.String code) 获取：Code Model
java.lang.String	getCodeValue(java.lang.String clientId, java.lang.Object loginId) 获取：Code Value
java.lang.String	getGrantScope(java.lang.String clientId, java.lang.Object loginId) 获取：用户授权记录
java.lang.Object	getLoginIdByAccessToken(java.lang.String accessToken) 获取 Access-Token 所代表的LoginId
java.lang.String	getOpenid(java.lang.String clientId, java.lang.Object loginId) 根据ClientId 和 LoginId 获取openid
java.lang.String	getPastTokenValue(java.lang.String clientId) 获取：Past-Token Value
RefreshTokenModel	getRefreshToken(java.lang.String refreshToken) 获取：Refresh-Token Model
java.lang.String	getRefreshTokenValue(java.lang.String clientId, java.lang.Object loginId) 获取：Refresh-Token Value
boolean	isGrant(java.lang.Object loginId, java.lang.String clientId, java.lang.String scope) 判断：指定 loginId 是否对一个 Client 授权给了指定 Scope
java.lang.String	randomAccessToken(java.lang.String clientId, java.lang.Object loginId, java.lang.String scope) 随机一个 Access-Token
java.lang.String	randomClientToken(java.lang.String clientId, java.lang.String scope) 随机一个 Client-Token
java.lang.String	randomCode(java.lang.String clientId, java.lang.Object loginId, java.lang.String scope) 随机一个 Code
java.lang.String	randomRefreshToken(java.lang.String clientId, java.lang.Object loginId, java.lang.String scope) 随机一个 Refresh-Token
AccessTokenModel	refreshAccessToken(java.lang.String refreshToken) 刷新Model：根据 Refresh-Token 生成一个新的 Access-Token
void	revokeAccessToken(java.lang.String accessToken) 回收 Access-Token
void	saveAccessToken(AccessTokenModel at) 持久化：AccessToken-Model
void	saveAccessTokenIndex(AccessTokenModel at) 持久化：AccessToken-索引
void	saveClientToken(ClientTokenModel ct) 持久化：ClientToken-Model
void	saveClientTokenIndex(ClientTokenModel ct) 持久化：ClientToken-索引
void	saveCode(CodeModel c) 持久化：Code-Model
void	saveCodeIndex(CodeModel c) 持久化：Code-索引
void	saveGrantScope(java.lang.String clientId, java.lang.Object loginId, java.lang.String scope) 持久化：用户授权记录
void	savePastTokenIndex(ClientTokenModel ct) 持久化：Past-Token-索引
void	saveRefreshToken(RefreshTokenModel rt) 持久化：RefreshToken-Model
void	saveRefreshTokenIndex(RefreshTokenModel rt) 持久化：RefreshToken-索引
java.lang.String	splicingAccessTokenIndexKey(java.lang.String clientId, java.lang.Object loginId) 拼接key：Access-Token索引
java.lang.String	splicingAccessTokenSaveKey(java.lang.String accessToken) 拼接key：Access-Token持久化
java.lang.String	splicingClientTokenIndexKey(java.lang.String clientId) 拼接key：Past-Token 索引
java.lang.String	splicingClientTokenSaveKey(java.lang.String clientToken) 拼接key：Client-Token持久化
java.lang.String	splicingCodeIndexKey(java.lang.String clientId, java.lang.Object loginId) 拼接key：Code索引
java.lang.String	splicingCodeSaveKey(java.lang.String code) 拼接key：Code持久化
java.lang.String	splicingGrantScopeKey(java.lang.String clientId, java.lang.Object loginId) 拼接key：用户授权记录
java.lang.String	splicingPastTokenIndexKey(java.lang.String clientId) 拼接key：Past-Token 索引
java.lang.String	splicingRefreshTokenIndexKey(java.lang.String clientId, java.lang.Object loginId) 拼接key：Refresh-Token索引
java.lang.String	splicingRefreshTokenSaveKey(java.lang.String refreshToken) 拼接key：Refresh-Token持久化

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

SaOAuth2Template

public SaOAuth2Template()

方法详细资料

getClientModel

public SaClientModel getClientModel(java.lang.String clientId)

根据id获取Client信息

参数:

clientId - 应用id

返回:

ClientModel

getOpenid

public java.lang.String getOpenid(java.lang.String clientId,
                                  java.lang.Object loginId)

根据ClientId 和 LoginId 获取openid

参数:

clientId - 应用id

loginId - 账号id

返回:

此账号在此Client下的openid

checkClientModel

public SaClientModel checkClientModel(java.lang.String clientId)

根据id获取Client信息, 如果Client为空，则抛出异常

参数:

clientId - 应用id

返回:

ClientModel

checkAccessToken

public AccessTokenModel checkAccessToken(java.lang.String accessToken)

获取 Access-Token，如果AccessToken为空则抛出异常

参数:

accessToken - .

返回:

.

checkClientToken

public ClientTokenModel checkClientToken(java.lang.String clientToken)

获取 Client-Token，如果ClientToken为空则抛出异常

参数:

clientToken - .

返回:

.

getLoginIdByAccessToken

public java.lang.Object getLoginIdByAccessToken(java.lang.String accessToken)

获取 Access-Token 所代表的LoginId

参数:

accessToken - Access-Token

返回:

LoginId

checkScope

public void checkScope(java.lang.String accessToken,
                       java.lang.String... scopes)

校验：指定 Access-Token 是否具有指定 Scope

参数:

accessToken - Access-Token

scopes - 需要校验的权限列表

generateRequestAuth

public RequestAuthModel generateRequestAuth(SaRequest req,
                                            java.lang.Object loginId)

构建Model：请求Model

参数:

req - SaRequest对象

loginId - 账号id

返回:

RequestAuthModel对象

generateCode

public CodeModel generateCode(RequestAuthModel ra)

构建Model：Code授权码

参数:

ra - 请求参数Model

返回:

授权码Model

generateAccessToken

public AccessTokenModel generateAccessToken(java.lang.String code)

构建Model：Access-Token

参数:

code - 授权码Model

返回:

AccessToken Model

refreshAccessToken

public AccessTokenModel refreshAccessToken(java.lang.String refreshToken)

刷新Model：根据 Refresh-Token 生成一个新的 Access-Token

参数:

refreshToken - Refresh-Token值

返回:

新的 Access-Token

generateAccessToken

public AccessTokenModel generateAccessToken(RequestAuthModel ra,
                                            boolean isCreateRt)

构建Model：Access-Token (根据RequestAuthModel构建，用于隐藏式 and 密码式)

参数:

ra - 请求参数Model

isCreateRt - 是否生成对应的Refresh-Token

返回:

Access-Token Model

generateClientToken

public ClientTokenModel generateClientToken(java.lang.String clientId,
                                            java.lang.String scope)

构建Model：Client-Token

参数:

clientId - 应用id

scope - 授权范围

返回:

Client-Token Model

buildRedirectUri

public java.lang.String buildRedirectUri(java.lang.String redirectUri,
                                         java.lang.String code,
                                         java.lang.String state)

构建URL：下放Code URL (Authorization Code 授权码)

参数:

redirectUri - 下放地址

code - code参数

state - state参数

返回:

构建完毕的URL

buildImplicitRedirectUri

public java.lang.String buildImplicitRedirectUri(java.lang.String redirectUri,
                                                 java.lang.String token,
                                                 java.lang.String state)

构建URL：下放Access-Token URL （implicit 隐藏式）

参数:

redirectUri - 下放地址

token - token

state - state参数

返回:

构建完毕的URL

revokeAccessToken

public void revokeAccessToken(java.lang.String accessToken)

回收 Access-Token

参数:

accessToken - Access-Token值

isGrant

public boolean isGrant(java.lang.Object loginId,
                       java.lang.String clientId,
                       java.lang.String scope)

判断：指定 loginId 是否对一个 Client 授权给了指定 Scope

参数:

loginId - 账号id

clientId - 应用id

scope - 权限

返回:

是否已经授权

checkContract

public void checkContract(java.lang.String clientId,
                          java.lang.String scope)

校验：该Client是否签约了指定的Scope

参数:

clientId - 应用id

scope - 权限(多个用逗号隔开)

checkRightUrl

public void checkRightUrl(java.lang.String clientId,
                          java.lang.String url)

校验：该Client使用指定url作为回调地址，是否合法

参数:

clientId - 应用id

url - 指定url

checkClientSecret

public SaClientModel checkClientSecret(java.lang.String clientId,
                                       java.lang.String clientSecret)

校验：clientId 与 clientSecret 是否正确

参数:

clientId - 应用id

clientSecret - 秘钥

返回:

SaClientModel对象

checkGainTokenParam

public CodeModel checkGainTokenParam(java.lang.String code,
                                     java.lang.String clientId,
                                     java.lang.String clientSecret,
                                     java.lang.String redirectUri)

校验：使用 code 获取 token 时提供的参数校验

参数:

code - 授权码

clientId - 应用id

clientSecret - 秘钥

redirectUri - 重定向地址

返回:

CodeModel对象

checkRefreshTokenParam

public RefreshTokenModel checkRefreshTokenParam(java.lang.String clientId,
                                                java.lang.String clientSecret,
                                                java.lang.String refreshToken)

校验：使用 Refresh-Token 刷新 Access-Token 时提供的参数校验

参数:

clientId - 应用id

clientSecret - 秘钥

refreshToken - Refresh-Token

返回:

CodeModel对象

checkAccessTokenParam

public AccessTokenModel checkAccessTokenParam(java.lang.String clientId,
                                              java.lang.String clientSecret,
                                              java.lang.String accessToken)

校验：Access-Token、clientId、clientSecret 三者是否匹配成功

参数:

clientId - 应用id

clientSecret - 秘钥

accessToken - Access-Token

返回:

SaClientModel对象

converCodeToAccessToken

public AccessTokenModel converCodeToAccessToken(CodeModel cm)

将 Code 转换为 Access-Token

参数:

cm - CodeModel对象

返回:

AccessToken对象

converAccessTokenToRefreshToken

public RefreshTokenModel converAccessTokenToRefreshToken(AccessTokenModel at)

将 Access-Token 转换为 Refresh-Token

参数:

at - .

返回:

.

converRefreshTokenToAccessToken

public AccessTokenModel converRefreshTokenToAccessToken(RefreshTokenModel rt)

将 Refresh-Token 转换为 Access-Token

参数:

rt - .

返回:

.

converRefreshTokenToRefreshToken

public RefreshTokenModel converRefreshTokenToRefreshToken(RefreshTokenModel rt)

根据 Refresh-Token 创建一个新的 Refresh-Token

参数:

rt - .

返回:

.

saveCode

public void saveCode(CodeModel c)

持久化：Code-Model

参数:

c - .

saveCodeIndex

public void saveCodeIndex(CodeModel c)

持久化：Code-索引

参数:

c - .

saveAccessToken

public void saveAccessToken(AccessTokenModel at)

持久化：AccessToken-Model

参数:

at - .

saveAccessTokenIndex

public void saveAccessTokenIndex(AccessTokenModel at)

持久化：AccessToken-索引

参数:

at - .

saveRefreshToken

public void saveRefreshToken(RefreshTokenModel rt)

持久化：RefreshToken-Model

参数:

rt - .

saveRefreshTokenIndex

public void saveRefreshTokenIndex(RefreshTokenModel rt)

持久化：RefreshToken-索引

参数:

rt - .

saveClientToken

public void saveClientToken(ClientTokenModel ct)

持久化：ClientToken-Model

参数:

ct - .

saveClientTokenIndex

public void saveClientTokenIndex(ClientTokenModel ct)

持久化：ClientToken-索引

参数:

ct - .

savePastTokenIndex

public void savePastTokenIndex(ClientTokenModel ct)

持久化：Past-Token-索引

参数:

ct - .

saveGrantScope

public void saveGrantScope(java.lang.String clientId,
                           java.lang.Object loginId,
                           java.lang.String scope)

持久化：用户授权记录

参数:

clientId - 应用id

loginId - 账号id

scope - 权限列表(多个逗号隔开)

getCode

public CodeModel getCode(java.lang.String code)

获取：Code Model

参数:

code - .

返回:

.

getCodeValue

public java.lang.String getCodeValue(java.lang.String clientId,
                                     java.lang.Object loginId)

获取：Code Value

参数:

clientId - 应用id

loginId - 账号id

返回:

.

getAccessToken

public AccessTokenModel getAccessToken(java.lang.String accessToken)

获取：Access-Token Model

参数:

accessToken - .

返回:

.

getAccessTokenValue

public java.lang.String getAccessTokenValue(java.lang.String clientId,
                                            java.lang.Object loginId)

获取：Access-Token Value

参数:

clientId - 应用id

loginId - 账号id

返回:

.

getRefreshToken

public RefreshTokenModel getRefreshToken(java.lang.String refreshToken)

获取：Refresh-Token Model

参数:

refreshToken - .

返回:

.

getRefreshTokenValue

public java.lang.String getRefreshTokenValue(java.lang.String clientId,
                                             java.lang.Object loginId)

获取：Refresh-Token Value

参数:

clientId - 应用id

loginId - 账号id

返回:

.

getClientToken

public ClientTokenModel getClientToken(java.lang.String clientToken)

获取：Client-Token Model

参数:

clientToken - .

返回:

.

getClientTokenValue

public java.lang.String getClientTokenValue(java.lang.String clientId)

获取：Client-Token Value

参数:

clientId - 应用id

返回:

.

getPastTokenValue

public java.lang.String getPastTokenValue(java.lang.String clientId)

获取：Past-Token Value

参数:

clientId - 应用id

返回:

.

getGrantScope

public java.lang.String getGrantScope(java.lang.String clientId,
                                      java.lang.Object loginId)

获取：用户授权记录

参数:

clientId - 应用id

loginId - 账号id

返回:

权限

deleteCode

public void deleteCode(java.lang.String code)

删除：Code

参数:

code - 值

deleteCodeIndex

public void deleteCodeIndex(java.lang.String clientId,
                            java.lang.Object loginId)

删除：Code索引

参数:

clientId - 应用id

loginId - 账号id

deleteAccessToken

public void deleteAccessToken(java.lang.String accessToken)

删除：Access-Token

参数:

accessToken - 值

deleteAccessTokenIndex

public void deleteAccessTokenIndex(java.lang.String clientId,
                                   java.lang.Object loginId)

删除：Access-Token索引

参数:

clientId - 应用id

loginId - 账号id

deleteRefreshToken

public void deleteRefreshToken(java.lang.String refreshToken)

删除：Refresh-Token

参数:

refreshToken - 值

deleteRefreshTokenIndex

public void deleteRefreshTokenIndex(java.lang.String clientId,
                                    java.lang.Object loginId)

删除：Refresh-Token索引

参数:

clientId - 应用id

loginId - 账号id

deleteClientToken

public void deleteClientToken(java.lang.String clientToken)

删除：Client-Token

参数:

clientToken - 值

deleteClientTokenIndex

public void deleteClientTokenIndex(java.lang.String clientId)

删除：Client-Token索引

参数:

clientId - 应用id

deletePastTokenIndex

public void deletePastTokenIndex(java.lang.String clientId)

删除：Past-Token索引

参数:

clientId - 应用id

deleteGrantScope

public void deleteGrantScope(java.lang.String clientId,
                             java.lang.Object loginId)

删除：用户授权记录

参数:

clientId - 应用id

loginId - 账号id

randomCode

public java.lang.String randomCode(java.lang.String clientId,
                                   java.lang.Object loginId,
                                   java.lang.String scope)

随机一个 Code

参数:

clientId - 应用id

loginId - 账号id

scope - 权限

返回:

Code

randomAccessToken

public java.lang.String randomAccessToken(java.lang.String clientId,
                                          java.lang.Object loginId,
                                          java.lang.String scope)

随机一个 Access-Token

参数:

clientId - 应用id

loginId - 账号id

scope - 权限

返回:

Access-Token

randomRefreshToken

public java.lang.String randomRefreshToken(java.lang.String clientId,
                                           java.lang.Object loginId,
                                           java.lang.String scope)

随机一个 Refresh-Token

参数:

clientId - 应用id

loginId - 账号id

scope - 权限

返回:

Refresh-Token

randomClientToken

public java.lang.String randomClientToken(java.lang.String clientId,
                                          java.lang.String scope)

随机一个 Client-Token

参数:

clientId - 应用id

scope - 权限

返回:

Client-Token

splicingCodeSaveKey

public java.lang.String splicingCodeSaveKey(java.lang.String code)

拼接key：Code持久化

参数:

code - 授权码

返回:

key

splicingCodeIndexKey

public java.lang.String splicingCodeIndexKey(java.lang.String clientId,
                                             java.lang.Object loginId)

拼接key：Code索引

参数:

clientId - 应用id

loginId - 账号id

返回:

key

splicingAccessTokenSaveKey

public java.lang.String splicingAccessTokenSaveKey(java.lang.String accessToken)

拼接key：Access-Token持久化

参数:

accessToken - accessToken

返回:

key

splicingAccessTokenIndexKey

public java.lang.String splicingAccessTokenIndexKey(java.lang.String clientId,
                                                    java.lang.Object loginId)

拼接key：Access-Token索引

参数:

clientId - 应用id

loginId - 账号id

返回:

key

splicingRefreshTokenSaveKey

public java.lang.String splicingRefreshTokenSaveKey(java.lang.String refreshToken)

拼接key：Refresh-Token持久化

参数:

refreshToken - refreshToken

返回:

key

splicingRefreshTokenIndexKey

public java.lang.String splicingRefreshTokenIndexKey(java.lang.String clientId,
                                                     java.lang.Object loginId)

拼接key：Refresh-Token索引

参数:

clientId - 应用id

loginId - 账号id

返回:

key

splicingClientTokenSaveKey

public java.lang.String splicingClientTokenSaveKey(java.lang.String clientToken)

拼接key：Client-Token持久化

参数:

clientToken - clientToken

返回:

key

splicingClientTokenIndexKey

public java.lang.String splicingClientTokenIndexKey(java.lang.String clientId)

拼接key：Past-Token 索引

参数:

clientId - clientId

返回:

key

splicingPastTokenIndexKey

public java.lang.String splicingPastTokenIndexKey(java.lang.String clientId)

拼接key：Past-Token 索引

参数:

clientId - clientId

返回:

key

splicingGrantScopeKey

public java.lang.String splicingGrantScopeKey(java.lang.String clientId,
                                              java.lang.Object loginId)

拼接key：用户授权记录

参数:

clientId - 应用id

loginId - 账号id

返回:

key