クラス AbstractAuthenticationToken
- java.lang.Object
-
- org.springframework.security.authentication.AbstractAuthenticationToken
- 実装されたすべてのインターフェース:
java.io.Serializable
、java.security.Principal
、Authentication
、CredentialsContainer
- 既知の直属サブクラス
AbstractOAuth2TokenAuthenticationToken
、AnonymousAuthenticationToken
、BearerTokenAuthenticationToken
、CasAssertionAuthenticationToken
、CasAuthenticationToken
、OAuth2AuthenticationToken
、OAuth2AuthorizationCodeAuthenticationToken
、OAuth2LoginAuthenticationToken
、OpenIDAuthenticationToken
、PreAuthenticatedAuthenticationToken
、RememberMeAuthenticationToken
、RunAsUserToken
、Saml2Authentication
、Saml2AuthenticationToken
、TestingAuthenticationToken
、UsernamePasswordAuthenticationToken
public abstract class AbstractAuthenticationToken extends java.lang.Object implements Authentication, CredentialsContainer
Authentication
オブジェクトの基本クラス。このクラスを使用する実装は不変でなければなりません。
- 関連事項:
- 直列化された形式
コンストラクターのサマリー
コンストラクター コンストラクター 説明 AbstractAuthenticationToken(java.util.Collection<? extends GrantedAuthority> authorities)
指定された権限の配列を使用してトークンを作成します。
メソッドのサマリー
すべてのメソッド インスタンスメソッド 具象メソッド 修飾子と型 メソッド 説明 boolean
equals(java.lang.Object obj)
void
eraseCredentials()
CredentialsContainer
を実装するものに対してeraseCredentials
メソッドを呼び出して、credentials
、principal
、details
オブジェクトをチェックします。java.util.Collection<GrantedAuthority>
getAuthorities()
プリンシパルが許可されたことを権限に示すために、AuthenticationManager
によって設定されます。java.lang.Object
getDetails()
認証リクエストに関する追加の詳細を保存します。java.lang.String
getName()
int
hashCode()
boolean
isAuthenticated()
認証トークンをAuthenticationManager
に提示する必要があるかどうかをAbstractSecurityInterceptor
に示すために使用されます。void
setAuthenticated(boolean authenticated)
詳細については、Authentication.isAuthenticated()
を参照してください。void
setDetails(java.lang.Object details)
java.lang.String
toString()
インターフェース org.springframework.security.core.Authentication から継承されたメソッド
getCredentials, getPrincipal
コンストラクターの詳細
AbstractAuthenticationToken
public AbstractAuthenticationToken(java.util.Collection<? extends GrantedAuthority> authorities)
指定された権限の配列を使用してトークンを作成します。- パラメーター:
authorities
- この認証オブジェクトによって表されるプリンシパルの GrantedAuthority のコレクション。
メソッドの詳細
getAuthorities
public java.util.Collection<GrantedAuthority> getAuthorities()
インターフェースからコピーされた説明:Authentication
プリンシパルが許可されたことを権限に示すために、AuthenticationManager
によって設定されます。信頼できるAuthenticationManager
によって設定されていない限り、クラスはこの値が有効であることに依存してはならないことに注意してください。実装では、返されたコレクション配列への変更が認証オブジェクトの状態に影響を与えないようにするか、変更不可能なインスタンスを使用する必要があります。
- 次で指定:
- インターフェース
Authentication
のgetAuthorities
- 戻り値:
- プリンシパルに付与された権限、またはトークンが認証されていない場合は空のコレクション。非 null。
getName
public java.lang.String getName()
- 次で指定:
- インターフェース
java.security.Principal
のgetName
isAuthenticated
public boolean isAuthenticated()
インターフェースからコピーされた説明:Authentication
認証トークンをAuthenticationManager
に提示する必要があるかどうかをAbstractSecurityInterceptor
に示すために使用されます。通常、AuthenticationManager
(または、より頻繁には、そのAuthenticationProvider
の 1 つ)は、認証が成功した後、不変の認証トークンを返します。この場合、トークンはtrue
をこのメソッドに安全に返すことができます。true
を返すとパフォーマンスが向上します。リクエストごとにAuthenticationManager
を呼び出す必要がなくなるためです。セキュリティ上の理由から、このインターフェースの実装は、不変であるか、元の作成以降プロパティが変更されていないことを保証する方法がない限り、このメソッドから
true
を返すことに十分注意する必要があります。- 次で指定:
- インターフェース
Authentication
のisAuthenticated
- 戻り値:
- トークンが認証され、
AbstractSecurityInterceptor
が再認証のために再度AuthenticationManager
にトークンを提示する必要がない場合は true。
setAuthenticated
public void setAuthenticated(boolean authenticated)
インターフェースからコピーされた説明:Authentication
詳細については、Authentication.isAuthenticated()
を参照してください。実装では、
false
パラメーターを使用してこのメソッドを呼び出すことを常に許可する必要があります。これは、さまざまなクラスで使用され、認証トークンを信頼しないことを指定するためです。実装がtrue
パラメーター(認証トークンが信頼されることを示す - 潜在的なセキュリティリスク)での呼び出しを拒否する場合、実装はIllegalArgumentException
をスローする必要があります。- 次で指定:
- インターフェース
Authentication
のsetAuthenticated
- パラメーター:
authenticated
- トークンを信頼する必要がある場合はtrue
(例外が発生する可能性があります)、トークンを信頼しない場合はfalse
getDetails
public java.lang.Object getDetails()
インターフェースからコピーされた説明:Authentication
認証リクエストに関する追加の詳細を保存します。これらは、IP アドレス、証明書のシリアル番号などです。- 次で指定:
- インターフェース
Authentication
のgetDetails
- 戻り値:
- 認証リクエストに関する追加の詳細、または使用しない場合は
null
setDetails
public void setDetails(java.lang.Object details)
eraseCredentials
public void eraseCredentials()
CredentialsContainer
を実装するものに対してeraseCredentials
メソッドを呼び出して、credentials
、principal
、details
オブジェクトをチェックします。- 次で指定:
- インターフェース
CredentialsContainer
のeraseCredentials
equals
public boolean equals(java.lang.Object obj)
- 次で指定:
- インターフェース
java.security.Principal
のequals
- オーバーライド:
- クラス
java.lang.Object
のequals
hashCode
public int hashCode()
- 次で指定:
- インターフェース
java.security.Principal
のhashCode
- オーバーライド:
- クラス
java.lang.Object
のhashCode
toString
public java.lang.String toString()
- 次で指定:
- インターフェース
java.security.Principal
のtoString
- オーバーライド:
- クラス
java.lang.Object
のtoString