クラス OAuth2AuthorizedClient
- java.lang.Object
-
- org.springframework.security.oauth2.client.OAuth2AuthorizedClient
- 実装されたすべてのインターフェース:
java.io.Serializable
public class OAuth2AuthorizedClient extends java.lang.Object implements java.io.Serializable
OAuth 2.0 の表現「承認済みクライアント」。クライアントは「認可済み」とみなされます。エンドユーザー(リソース所有者)がクライアントに保護されたリソースにアクセスする認可を与えたとき。
このクラスは、
Client
を、Resource Owner
によって認可 / 認可されたAccess Token
に関連付けます。- 導入:
- 5.0
- 関連事項:
ClientRegistration
,OAuth2AccessToken
,OAuth2RefreshToken
, 直列化された形式
コンストラクターのサマリー
コンストラクター コンストラクター 説明 OAuth2AuthorizedClient(ClientRegistration clientRegistration, java.lang.String principalName, OAuth2AccessToken accessToken)
指定されたパラメーターを使用してOAuth2AuthorizedClient
を構築します。OAuth2AuthorizedClient(ClientRegistration clientRegistration, java.lang.String principalName, OAuth2AccessToken accessToken, OAuth2RefreshToken refreshToken)
指定されたパラメーターを使用してOAuth2AuthorizedClient
を構築します。
メソッドのサマリー
すべてのメソッド インスタンスメソッド 具象メソッド 修飾子と型 メソッド 説明 OAuth2AccessToken
getAccessToken()
付与されたaccess token
資格情報を返します。ClientRegistration
getClientRegistration()
認可されたクライアントのregistration
を返します。java.lang.String
getPrincipalName()
エンドユーザーのPrincipal
名を返します。OAuth2RefreshToken
getRefreshToken()
付与されたrefresh token
資格情報を返します。
コンストラクターの詳細
OAuth2AuthorizedClient
public OAuth2AuthorizedClient(ClientRegistration clientRegistration, java.lang.String principalName, OAuth2AccessToken accessToken)
指定されたパラメーターを使用してOAuth2AuthorizedClient
を構築します。- パラメーター:
clientRegistration
- 認可されたクライアントの登録principalName
- エンドユーザーPrincipal
の名前 (リソース所有者)accessToken
- 付与されたアクセストークン資格情報
OAuth2AuthorizedClient
public OAuth2AuthorizedClient(ClientRegistration clientRegistration, java.lang.String principalName, OAuth2AccessToken accessToken, @Nullable OAuth2RefreshToken refreshToken)
指定されたパラメーターを使用してOAuth2AuthorizedClient
を構築します。- パラメーター:
clientRegistration
- 認可されたクライアントの登録principalName
- エンドユーザーPrincipal
の名前 (リソース所有者)accessToken
- 付与されたアクセストークン資格情報refreshToken
- 付与されたリフレッシュトークン資格情報
メソッドの詳細
getClientRegistration
public ClientRegistration getClientRegistration()
認可されたクライアントのregistration
を返します。
getPrincipalName
public java.lang.String getPrincipalName()
エンドユーザーのPrincipal
名を返します。- 戻り値:
- エンドユーザーの
Principal
名
getAccessToken
public OAuth2AccessToken getAccessToken()
付与されたaccess token
資格情報を返します。
getRefreshToken
@Nullable public OAuth2RefreshToken getRefreshToken()
付与されたrefresh token
資格情報を返します。- 戻り値:
OAuth2RefreshToken
- 導入:
- 5.1