クラス OAuth2AuthorizeRequest
- java.lang.Object
-
- org.springframework.security.oauth2.client.OAuth2AuthorizeRequest
public final class OAuth2AuthorizeRequest extends java.lang.Object
OAuth2AuthorizedClientManager
が、提供されたclientRegistrationId
によって識別されたclient
をauthorize
(または再認可)するために使用するリクエストを表します。- 導入:
- 5.2
- 関連事項:
OAuth2AuthorizedClientManager
ネストされたクラスのサマリー
ネストされたクラス 修飾子と型 クラス 説明 static class
OAuth2AuthorizeRequest.Builder
OAuth2AuthorizeRequest
のビルダー。
メソッドのサマリー
すべてのメソッド 静的メソッド インスタンスメソッド 具象メソッド 修飾子と型 メソッド 説明 <T> T
getAttribute(java.lang.String name)
リクエストに関連付けられた属性の値を返します。使用できない場合はnull
を返します。java.util.Map<java.lang.String,java.lang.Object>
getAttributes()
リクエストに関連付けられた属性を返します。OAuth2AuthorizedClient
getAuthorizedClient()
authorized client
またはnull
が提供されなかった場合は、それを返します。java.lang.String
getClientRegistrationId()
client registration
の識別子を返します。Authentication
getPrincipal()
認可されたクライアントに関連付けられた(ある)Principal
を返します。static OAuth2AuthorizeRequest.Builder
withAuthorizedClient(OAuth2AuthorizedClient authorizedClient)
authorized client
で初期化された新しいOAuth2AuthorizeRequest.Builder
を返します。static OAuth2AuthorizeRequest.Builder
withClientRegistrationId(java.lang.String clientRegistrationId)
client registration
の識別子で初期化された新しいOAuth2AuthorizeRequest.Builder
を返します。
メソッドの詳細
getClientRegistrationId
public java.lang.String getClientRegistrationId()
client registration
の識別子を返します。- 戻り値:
- クライアント登録の識別子
getAuthorizedClient
@Nullable public OAuth2AuthorizedClient getAuthorizedClient()
authorized client
またはnull
が提供されなかった場合は、それを返します。- 戻り値:
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
- 属性の名前- 戻り値:
- リクエストに関連付けられた属性の値
withClientRegistrationId
public static OAuth2AuthorizeRequest.Builder withClientRegistrationId(java.lang.String clientRegistrationId)
client registration
の識別子で初期化された新しいOAuth2AuthorizeRequest.Builder
を返します。- パラメーター:
clientRegistrationId
-client registration
の識別子- 戻り値:
OAuth2AuthorizeRequest.Builder
withAuthorizedClient
public static OAuth2AuthorizeRequest.Builder withAuthorizedClient(OAuth2AuthorizedClient authorizedClient)
authorized client
で初期化された新しいOAuth2AuthorizeRequest.Builder
を返します。- パラメーター:
authorizedClient
-authorized client
- 戻り値:
OAuth2AuthorizeRequest.Builder