クラス 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)指定された権限の配列を使用してトークンを作成します。
メソッドのサマリー
すべてのメソッド インスタンスメソッド 具象メソッド 修飾子と型 メソッド 説明 booleanequals(java.lang.Object obj)voideraseCredentials()CredentialsContainerを実装するものに対してeraseCredentialsメソッドを呼び出して、credentials、principal、detailsオブジェクトをチェックします。java.util.Collection<GrantedAuthority>getAuthorities()プリンシパルが許可されたことを権限に示すために、AuthenticationManagerによって設定されます。java.lang.ObjectgetDetails()認証リクエストに関する追加の詳細を保存します。java.lang.StringgetName()inthashCode()booleanisAuthenticated()認証トークンをAuthenticationManagerに提示する必要があるかどうかをAbstractSecurityInterceptorに示すために使用されます。voidsetAuthenticated(boolean authenticated)詳細については、Authentication.isAuthenticated()を参照してください。voidsetDetails(java.lang.Object details)java.lang.StringtoString()インターフェース 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