クラス OAuth2AuthenticationToken
- java.lang.Object
-
- org.springframework.security.authentication.AbstractAuthenticationToken
-
- org.springframework.security.oauth2.client.authentication.OAuth2AuthenticationToken
- 実装されているすべてのインターフェース:
java.io.Serializable、java.security.Principal、Authentication、CredentialsContainer
public class OAuth2AuthenticationToken extends AbstractAuthenticationToken
OAuth 2.0Authenticationを表すAbstractAuthenticationTokenの実装。Authenticationは、OAuth2UserPrincipalをAuthorized Clientの識別子に関連付けます。Authorized Clientは、エンドユーザー（Principal）が認可して、UserInfo エンドポイントで保護されたリソースにアクセスできるようにします。- 導入:
- 5.0
- 関連事項:
AbstractAuthenticationToken,OAuth2User,OAuth2AuthorizedClient, 連載形式
コンストラクターの概要
コンストラクター コンストラクター 説明 OAuth2AuthenticationToken(OAuth2User principal, java.util.Collection<? extends GrantedAuthority> authorities, java.lang.String authorizedClientRegistrationId)指定されたパラメーターを使用してOAuth2AuthenticationTokenを構築します。
方法の概要
すべてのメソッド インスタンスメソッド 具象メソッド 修飾子と型 メソッド 説明 java.lang.StringgetAuthorizedClientRegistrationId()Authorized Clientの登録識別子を返します。java.lang.ObjectgetCredentials()プリンシパルが正しいことを証明する資格情報。OAuth2UsergetPrincipal()認証されるプリンシパルの ID。クラス org.springframework.security.authentication.AbstractAuthenticationToken から継承されたメソッド
equals, eraseCredentials, getAuthorities, getDetails, getName, hashCode, isAuthenticated, setAuthenticated, setDetails, toString
コンストラクターの詳細
OAuth2AuthenticationToken
public OAuth2AuthenticationToken(OAuth2User principal, java.util.Collection<? extends GrantedAuthority> authorities, java.lang.String authorizedClientRegistrationId)
指定されたパラメーターを使用してOAuth2AuthenticationTokenを構築します。- パラメーター:
principal- OAuth 2.0 プロバイダーに登録されているユーザーPrincipalauthorities- ユーザーに付与された権限authorizedClientRegistrationId-Authorized Clientの登録識別子
メソッドの詳細
getPrincipal
public OAuth2User getPrincipal()
インターフェースからコピーされた説明:Authentication認証されるプリンシパルの ID。ユーザー名とパスワードを使用した認証リクエストの場合、これはユーザー名になります。呼び出し元は、認証リクエストのプリンシパルを設定することが期待されています。多くの場合、 AuthenticationManager 実装は、アプリケーションが使用するプリンシパルとして、より豊富な情報を含む Authentication を返します。認証プロバイダーの多くは、
UserDetailsオブジェクトをプリンシパルとして作成します。- 戻り値:
- 認証される
Principalまたは認証後の認証されたプリンシパル。
getCredentials
public java.lang.Object getCredentials()
インターフェースからコピーされた説明:Authenticationプリンシパルが正しいことを証明する資格情報。これは通常パスワードですが、AuthenticationManagerに関連するものであれば何でもかまいません。呼び出し元は資格情報を入力する必要があります。- 戻り値:
Principalの身元を証明する資格情報
getAuthorizedClientRegistrationId
public java.lang.String getAuthorizedClientRegistrationId()
Authorized Clientの登録識別子を返します。- 戻り値:
- 承認済みクライアントの登録識別子。