Module bus.auth

Package org.miaixz.bus.auth

Interface Provider

All Superinterfaces:

org.miaixz.bus.core.Provider

All Known Implementing Classes:

AbstractDingtalkProvider, AbstractMicrosoftProvider, AbstractProvider, AbstractWeChatEeProvider, AbstractWeChatProvider, AfDianProvider, AlipayProvider, AliyunProvider, AmazonProvider, AppleProvider, BaiduProvider, CodingProvider, DingTalkAccountProvider, DingTalkProvider, DouyinProvider, ElemeProvider, FacebookProvider, FeishuProvider, FigmaProvider, GiteeProvider, GithubProvider, GitlabProvider, GoogleProvider, HuaweiProvider, JdProvider, KujialeProvider, LineProvider, LinkedinProvider, MeituanProvider, MicrosoftCnProvider, MicrosoftProvider, MiProvider, OktaProvider, OschinaProvider, PinterestProvider, ProginnProvider, QqMiniProvider, QqProvider, RenrenProvider, SlackProvider, StackOverflowProvider, TaobaoProvider, TeambitionProvider, ToutiaoProvider, TwitterProvider, WeChatEeQrcodeProvider, WeChatEeThirdQrcodeProvider, WeChatEeWebProvider, WeChatMiniProvider, WeChatMpProvider, WeChatOpenProvider, WeiboProvider, XimalayaProvider

public interface Provider
extends org.miaixz.bus.core.Provider

Provider公共接口，所有平台的Provider都需要实现该接口 authorize(String) login(Callback) revoke(AccToken) refresh(AccToken)

Since:

Java 17+

Author:

Kimi Liu

Method Summary

Modifier and Type	Method	Description
default String	authorize(String state)	返回带state参数的授权url，授权回调时会带上这个state
AccToken	getAccessToken(Callback callback)	获取access token
Material	getUserInfo(AccToken accToken)	使用token换取用户信息
default org.miaixz.bus.core.basic.entity.Message	login(Callback callback)	第三方登录
default org.miaixz.bus.core.basic.entity.Message	refresh(AccToken accToken)	刷新access token （续期）
default org.miaixz.bus.core.basic.entity.Message	revoke(AccToken accToken)	撤销授权
default Object	type()

Method Details

authorize

default String authorize(String state)

返回带state参数的授权url，授权回调时会带上这个state

Parameters:

state - state 验证授权流程的参数，可以防止csrf

Returns:

返回授权地址

login

default org.miaixz.bus.core.basic.entity.Message login(Callback callback)

第三方登录

Parameters:

callback - 用于接收回调参数的实体

Returns:

返回登录成功后的用户信息

revoke

default org.miaixz.bus.core.basic.entity.Message revoke(AccToken accToken)

撤销授权

Parameters:

accToken - 登录成功后返回的Token信息

Returns:

Message

refresh

default org.miaixz.bus.core.basic.entity.Message refresh(AccToken accToken)

刷新access token （续期）

Parameters:

accToken - 登录成功后返回的Token信息

Returns:

Message

getAccessToken

AccToken getAccessToken(Callback callback)

获取access token

Parameters:

callback - 授权成功后的回调参数

Returns:

token

See Also:

• AbstractProvider.authorize(String)

getUserInfo

Material getUserInfo(AccToken accToken)

使用token换取用户信息

Parameters:

accToken - token信息

Returns:

用户信息

See Also:

• getAccessToken(Callback)

type

default Object type()

Specified by:

type in interface org.miaixz.bus.core.Provider