クラス OAuth2AuthorizedClient
- java.lang.Object
-
- org.springframework.security.oauth2.client.OAuth2AuthorizedClient
- 実装されているすべてのインターフェース:
java.io.Serializable
public class OAuth2AuthorizedClient extends java.lang.Object implements java.io.SerializableOAuth 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を構築します。
方法の概要
すべてのメソッド インスタンスメソッド 具象メソッド 修飾子と型 メソッド 説明 OAuth2AccessTokengetAccessToken()付与されたaccess token資格情報を返します。ClientRegistrationgetClientRegistration()認可されたクライアントのregistrationを返します。java.lang.StringgetPrincipalName()エンドユーザーのPrincipal名を返します。OAuth2RefreshTokengetRefreshToken()付与された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