クラス OAuth2LoginAuthenticationToken
- java.lang.Object
-
- org.springframework.security.authentication.AbstractAuthenticationToken
-
- org.springframework.security.oauth2.client.authentication.OAuth2LoginAuthenticationToken
- 実装されたすべてのインターフェース:
java.io.Serializable
、java.security.Principal
、Authentication
、CredentialsContainer
public class OAuth2LoginAuthenticationToken extends AbstractAuthenticationToken
OAuth 2.0 認証コード付与フローを活用する OAuth 2.0 ログイン用のAbstractAuthenticationToken
。
コンストラクターのサマリー
コンストラクター コンストラクター 説明 OAuth2LoginAuthenticationToken(ClientRegistration clientRegistration, OAuth2AuthorizationExchange authorizationExchange)
このコンストラクターは、認可リクエスト / レスポンスが完了したときに使用する必要があります。OAuth2LoginAuthenticationToken(ClientRegistration clientRegistration, OAuth2AuthorizationExchange authorizationExchange, OAuth2User principal, java.util.Collection<? extends GrantedAuthority> authorities, OAuth2AccessToken accessToken)
このコンストラクターは、アクセストークンのリクエスト / レスポンスが完了したときに使用する必要があります。これは、認可コード付与フローが完全に完了し、OAuth 2.0 ログインが完了したことを示します。OAuth2LoginAuthenticationToken(ClientRegistration clientRegistration, OAuth2AuthorizationExchange authorizationExchange, OAuth2User principal, java.util.Collection<? extends GrantedAuthority> authorities, OAuth2AccessToken accessToken, OAuth2RefreshToken refreshToken)
このコンストラクターは、アクセストークンのリクエスト / レスポンスが完了したときに使用する必要があります。これは、認可コード付与フローが完全に完了し、OAuth 2.0 ログインが完了したことを示します。
メソッドのサマリー
すべてのメソッド インスタンスメソッド 具象メソッド 修飾子と型 メソッド 説明 OAuth2AccessToken
getAccessToken()
access token
を返します。OAuth2AuthorizationExchange
getAuthorizationExchange()
authorization exchange
を返します。ClientRegistration
getClientRegistration()
client registration
を返します。java.lang.Object
getCredentials()
プリンシパルが正しいことを証明する資格情報。OAuth2User
getPrincipal()
認証されるプリンシパルの ID。OAuth2RefreshToken
getRefreshToken()
refresh token
を返します。クラス org.springframework.security.authentication.AbstractAuthenticationToken から継承されたメソッド
equals, eraseCredentials, getAuthorities, getDetails, getName, hashCode, isAuthenticated, setAuthenticated, setDetails, toString
コンストラクターの詳細
OAuth2LoginAuthenticationToken
public OAuth2LoginAuthenticationToken(ClientRegistration clientRegistration, OAuth2AuthorizationExchange authorizationExchange)
このコンストラクターは、認可リクエスト / レスポンスが完了したときに使用する必要があります。- パラメーター:
clientRegistration
- クライアント登録authorizationExchange
- 認可交換
OAuth2LoginAuthenticationToken
public OAuth2LoginAuthenticationToken(ClientRegistration clientRegistration, OAuth2AuthorizationExchange authorizationExchange, OAuth2User principal, java.util.Collection<? extends GrantedAuthority> authorities, OAuth2AccessToken accessToken)
このコンストラクターは、アクセストークンのリクエスト / レスポンスが完了したときに使用する必要があります。これは、認可コード付与フローが完全に完了し、OAuth 2.0 ログインが完了したことを示します。- パラメーター:
clientRegistration
- クライアント登録authorizationExchange
- 認可交換principal
- OAuth 2.0 プロバイダーに登録されているユーザーPrincipal
authorities
- ユーザーに付与された権限accessToken
- アクセストークン資格情報
OAuth2LoginAuthenticationToken
public OAuth2LoginAuthenticationToken(ClientRegistration clientRegistration, OAuth2AuthorizationExchange authorizationExchange, OAuth2User principal, java.util.Collection<? extends GrantedAuthority> authorities, OAuth2AccessToken accessToken, @Nullable OAuth2RefreshToken refreshToken)
このコンストラクターは、アクセストークンのリクエスト / レスポンスが完了したときに使用する必要があります。これは、認可コード付与フローが完全に完了し、OAuth 2.0 ログインが完了したことを示します。- パラメーター:
clientRegistration
- クライアント登録authorizationExchange
- 認可交換principal
- OAuth 2.0 プロバイダーに登録されているユーザーPrincipal
authorities
- ユーザーに付与された権限accessToken
- アクセストークン資格情報refreshToken
- リフレッシュトークンの資格情報
メソッドの詳細
getPrincipal
public OAuth2User getPrincipal()
インターフェースからコピーされた説明:Authentication
認証されるプリンシパルの ID。ユーザー名とパスワードを使用した認証リクエストの場合、これはユーザー名になります。呼び出し元は、認証リクエストのプリンシパルを設定することが期待されています。多くの場合、 AuthenticationManager 実装は、アプリケーションが使用するプリンシパルとして、より豊富な情報を含む Authentication を返します。認証プロバイダーの多くは、
UserDetails
オブジェクトをプリンシパルとして作成します。- 戻り値:
- 認証される
Principal
または認証後の認証されたプリンシパル。
getCredentials
public java.lang.Object getCredentials()
インターフェースからコピーされた説明:Authentication
プリンシパルが正しいことを証明する資格情報。これは通常パスワードですが、AuthenticationManager
に関連するものであれば何でもかまいません。発信者は資格情報を入力する必要があります。- 戻り値:
Principal
の身元を証明する資格情報
getClientRegistration
public ClientRegistration getClientRegistration()
client registration
を返します。
getAuthorizationExchange
public OAuth2AuthorizationExchange getAuthorizationExchange()
authorization exchange
を返します。
getAccessToken
public OAuth2AccessToken getAccessToken()
access token
を返します。
getRefreshToken
@Nullable public OAuth2RefreshToken getRefreshToken()
refresh token
を返します。- 戻り値:
OAuth2RefreshToken
- 導入:
- 5.1