クラス OAuth2AuthorizeRequest
- java.lang.Object
-
- org.springframework.security.oauth2.client.OAuth2AuthorizeRequest
public final class OAuth2AuthorizeRequest extends java.lang.ObjectOAuth2AuthorizedClientManagerが、提供されたclientRegistrationIdによって識別されたclientをauthorize(または再認可)するために使用するリクエストを表します。- 導入:
- 5.2
- 関連事項:
OAuth2AuthorizedClientManager
ネストされたクラスの概要
ネストされたクラス 修飾子と型 クラス 説明 static classOAuth2AuthorizeRequest.BuilderOAuth2AuthorizeRequestのビルダー。
方法の概要
すべてのメソッド 静的メソッド インスタンスメソッド 具象メソッド 修飾子と型 メソッド 説明 <T> TgetAttribute(java.lang.String name)リクエストに関連付けられた属性の値を返します。使用できない場合はnullを返します。java.util.Map<java.lang.String,java.lang.Object>getAttributes()リクエストに関連付けられた属性を返します。OAuth2AuthorizedClientgetAuthorizedClient()authorized clientまたはnullが提供されなかった場合は、それを返します。java.lang.StringgetClientRegistrationId()client registrationの識別子を返します。AuthenticationgetPrincipal()認可されたクライアントに関連付けられた(ある)Principalを返します。static OAuth2AuthorizeRequest.BuilderwithAuthorizedClient(OAuth2AuthorizedClient authorizedClient)authorized clientで初期化された新しいOAuth2AuthorizeRequest.Builderを返します。static OAuth2AuthorizeRequest.BuilderwithClientRegistrationId(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