クラス OAuth2AuthorizationContext
- java.lang.Object
-
- org.springframework.security.oauth2.client.OAuth2AuthorizationContext
public final class OAuth2AuthorizationContext extends java.lang.Object
認可固有の状態を保持し、OAuth 2.0 クライアントを認可(または再認可)しようとするときにOAuth2AuthorizedClientProvider
によって使用されるコンテキスト。- 導入:
- 5.2
- 関連事項:
OAuth2AuthorizedClientProvider
ネストされたクラスのサマリー
ネストされたクラス 修飾子と型 クラス 説明 static class
OAuth2AuthorizationContext.Builder
OAuth2AuthorizationContext
のビルダー。
フィールドサマリー
フィールド 修飾子と型 フィールド 説明 static java.lang.String
PASSWORD_ATTRIBUTE_NAME
リソース所有者のパスワードの値に関連付けられたコンテキストでのattribute
の名前。static java.lang.String
REQUEST_SCOPE_ATTRIBUTE_NAME
「リクエストスコープ」の値に関連付けられたコンテキストでのattribute
の名前。static java.lang.String
USERNAME_ATTRIBUTE_NAME
リソース所有者のユーザー名の値に関連付けられたコンテキストでのattribute
の名前。
メソッドのサマリー
すべてのメソッド 静的メソッド インスタンスメソッド 具象メソッド 修飾子と型 メソッド 説明 <T> T
getAttribute(java.lang.String name)
コンテキストに関連付けられている属性の値を返します。使用できない場合はnull
を返します。java.util.Map<java.lang.String,java.lang.Object>
getAttributes()
コンテキストに関連付けられた属性を返します。OAuth2AuthorizedClient
getAuthorizedClient()
ClientRegistration
getClientRegistration()
client registration
を返します。Authentication
getPrincipal()
認可されたクライアントに関連付けられた(ある)Principal
を返します。static OAuth2AuthorizationContext.Builder
withAuthorizedClient(OAuth2AuthorizedClient authorizedClient)
OAuth2AuthorizedClient
で初期化された新しいOAuth2AuthorizationContext.Builder
を返します。static OAuth2AuthorizationContext.Builder
withClientRegistration(ClientRegistration clientRegistration)
ClientRegistration
で初期化された新しいOAuth2AuthorizationContext.Builder
を返します。
フィールドの詳細
REQUEST_SCOPE_ATTRIBUTE_NAME
public static final java.lang.String REQUEST_SCOPE_ATTRIBUTE_NAME
USERNAME_ATTRIBUTE_NAME
public static final java.lang.String USERNAME_ATTRIBUTE_NAME
リソース所有者のユーザー名の値に関連付けられたコンテキストでのattribute
の名前。
PASSWORD_ATTRIBUTE_NAME
public static final java.lang.String PASSWORD_ATTRIBUTE_NAME
リソース所有者のパスワードの値に関連付けられたコンテキストでのattribute
の名前。
メソッドの詳細
getClientRegistration
public ClientRegistration getClientRegistration()
client registration
を返します。
getAuthorizedClient
@Nullable public OAuth2AuthorizedClient getAuthorizedClient()
- 戻り値:
- クライアント登録が提供された場合は
OAuth2AuthorizedClient
またはnull
getPrincipal
public Authentication getPrincipal()
認可されたクライアントに関連付けられた(ある)Principal
を返します。- 戻り値:
- 認可されたクライアントに関連付けられている(される)
Principal
getAttributes
public java.util.Map<java.lang.String,java.lang.Object> getAttributes()
コンテキストに関連付けられた属性を返します。- 戻り値:
- コンテキストに関連付けられた属性の
Map
getAttribute
@Nullable public <T> T getAttribute(java.lang.String name)
コンテキストに関連付けられている属性の値を返します。使用できない場合はnull
を返します。- 型パラメーター:
T
- 属性の型- パラメーター:
name
- 属性の名前- 戻り値:
- コンテキストに関連付けられた属性の値
withClientRegistration
public static OAuth2AuthorizationContext.Builder withClientRegistration(ClientRegistration clientRegistration)
ClientRegistration
で初期化された新しいOAuth2AuthorizationContext.Builder
を返します。- パラメーター:
clientRegistration
-client registration
- 戻り値:
OAuth2AuthorizationContext.Builder
withAuthorizedClient
public static OAuth2AuthorizationContext.Builder withAuthorizedClient(OAuth2AuthorizedClient authorizedClient)
OAuth2AuthorizedClient
で初期化された新しいOAuth2AuthorizationContext.Builder
を返します。- パラメーター:
authorizedClient
-authorized client
- 戻り値:
OAuth2AuthorizationContext.Builder