Package me.zhyd.oauth.request

Interface AuthRequest

All Known Implementing Classes:
AbstractAuthDingtalkRequest, AbstractAuthMicrosoftRequest, AbstractAuthWeChatEnterpriseRequest, AuthAfDianRequest, AuthAlipayCertRequest, AuthAlipayRequest, AuthAliyunRequest, AuthAmazonRequest, AuthAppleRequest, AuthBaiduRequest, AuthCodingRequest, AuthCsdnRequest, AuthDefaultRequest, AuthDingTalkAccountRequest, AuthDingTalkRequest, AuthDingTalkV2Request, AuthDouyinRequest, AuthElemeRequest, AuthFacebookRequest, AuthFeishuRequest, AuthFigmaRequest, AuthGiteeRequest, AuthGithubRequest, AuthGitlabRequest, AuthGoogleRequest, AuthHuaweiRequest, AuthHuaweiV3Request, AuthJdRequest, AuthKujialeRequest, AuthLineRequest, AuthLinkedinRequest, AuthMeituanRequest, AuthMicrosoftCnRequest, AuthMicrosoftRequest, AuthMiRequest, AuthOktaRequest, AuthOschinaRequest, AuthPinterestRequest, AuthProginnRequest, AuthQQMiniProgramRequest, AuthQqRequest, AuthRenrenRequest, AuthSlackRequest, AuthStackOverflowRequest, AuthTaobaoRequest, AuthTeambitionRequest, AuthToutiaoRequest, AuthTwitterRequest, AuthWeChatEnterpriseQrcodeRequest, AuthWeChatEnterpriseQrcodeV2Request, AuthWeChatEnterpriseThirdQrcodeRequest, AuthWeChatEnterpriseWebRequest, AuthWechatMiniProgramRequest, AuthWeChatMpRequest, AuthWeChatOpenRequest, AuthWeiboRequest, AuthXmlyRequest
public interface AuthRequest
JustAuth Request公共接口，所有平台的Request都需要实现该接口

authorize() authorize(String) login(AuthCallback) revoke(AuthToken) refresh(AuthToken)

Since:
1.8
Author:
yadong.zhang (yadong.zhang0415(a)gmail.com)

  • Method Details

    • authorize

      @Deprecated default String authorize()
      Deprecated.
      返回授权url，可自行跳转页面

      不建议使用该方式获取授权地址，不带state的授权地址，容易受到csrf攻击。 建议使用AuthDefaultRequest.authorize(String)方法生成授权地址，在回调方法中对state进行校验

      Returns:
      返回授权地址

    • authorize

      default String authorize(String state)
      返回带state参数的授权url，授权回调时会带上这个state
      Parameters:
      state - state 验证授权流程的参数，可以防止csrf
      Returns:
      返回授权地址

    • getAccessToken

      AuthToken getAccessToken(AuthCallback authCallback)
      获取access token
      Parameters:
      authCallback - 授权成功后的回调参数
      Returns:
      token
      See Also:

    • getUserInfo

      AuthUser getUserInfo(AuthToken authToken)
      使用token换取用户信息
      Parameters:
      authToken - token信息
      Returns:
      用户信息
      See Also:

    • login

      default AuthResponse<AuthUser> login(AuthCallback authCallback)
      第三方登录
      Parameters:
      authCallback - 用于接收回调参数的实体
      Returns:
      返回登录成功后的用户信息

    • revoke

      default AuthResponse revoke(AuthToken authToken)
      撤销授权
      Parameters:
      authToken - 登录成功后返回的Token信息
      Returns:
      AuthResponse

    • refresh

      default AuthResponse<AuthToken> refresh(AuthToken authToken)
      刷新access token （续期）
      Parameters:
      authToken - 登录成功后返回的Token信息
      Returns:
      AuthResponse