クラス UsernamePasswordAuthenticationToken
- java.lang.Object
-
- org.springframework.security.authentication.AbstractAuthenticationToken
-
- org.springframework.security.authentication.UsernamePasswordAuthenticationToken
- 実装されたすべてのインターフェース:
java.io.Serializable
、java.security.Principal
、Authentication
、CredentialsContainer
- 既知の直属サブクラス
JaasAuthenticationToken
public class UsernamePasswordAuthenticationToken extends AbstractAuthenticationToken
ユーザー名とパスワードを簡単に提示するために設計されたAuthentication
実装。principal
およびcredentials
は、Object.toString()
メソッドを介してそれぞれのプロパティを提供するObject
で設定する必要があります。このようなObject
を使用するのに最も簡単なのはString
です。- 関連事項:
- 直列化された形式
コンストラクターのサマリー
コンストラクター コンストラクター 説明 UsernamePasswordAuthenticationToken(java.lang.Object principal, java.lang.Object credentials)
AbstractAuthenticationToken.isAuthenticated()
はfalse
を返すため、このコンストラクターは、UsernamePasswordAuthenticationToken
を作成するすべてのコードで安全に使用できます。UsernamePasswordAuthenticationToken(java.lang.Object principal, java.lang.Object credentials, java.util.Collection<? extends GrantedAuthority> authorities)
このコンストラクターは、信頼できる(つまり、信頼できる)の作成に満足しているAuthenticationManager
またはAuthenticationProvider
実装でのみ使用する必要があります。
メソッドのサマリー
すべてのメソッド インスタンスメソッド 具象メソッド 修飾子と型 メソッド 説明 void
eraseCredentials()
CredentialsContainer
を実装するものに対してeraseCredentials
メソッドを呼び出して、credentials
、principal
、details
オブジェクトをチェックします。java.lang.Object
getCredentials()
プリンシパルが正しいことを証明する資格情報。java.lang.Object
getPrincipal()
認証されるプリンシパルの ID。void
setAuthenticated(boolean isAuthenticated)
詳細については、Authentication.isAuthenticated()
を参照してください。クラス org.springframework.security.authentication.AbstractAuthenticationToken から継承されたメソッド
equals, getAuthorities, getDetails, getName, hashCode, isAuthenticated, setDetails, toString
コンストラクターの詳細
UsernamePasswordAuthenticationToken
public UsernamePasswordAuthenticationToken(java.lang.Object principal, java.lang.Object credentials)
AbstractAuthenticationToken.isAuthenticated()
はfalse
を返すため、このコンストラクターは、UsernamePasswordAuthenticationToken
を作成するすべてのコードで安全に使用できます。
UsernamePasswordAuthenticationToken
public UsernamePasswordAuthenticationToken(java.lang.Object principal, java.lang.Object credentials, java.util.Collection<? extends GrantedAuthority> authorities)
このコンストラクターは、信頼された(つまり、AbstractAuthenticationToken.isAuthenticated()
=true
)認証トークンの作成に満足しているAuthenticationManager
またはAuthenticationProvider
実装でのみ使用する必要があります。- パラメーター:
principal
-credentials
-authorities
-
メソッドの詳細
getCredentials
public java.lang.Object getCredentials()
インターフェースからコピーされた説明:Authentication
プリンシパルが正しいことを証明する資格情報。これは通常パスワードですが、AuthenticationManager
に関連するものであれば何でもかまいません。発信者は資格情報を入力する必要があります。- 戻り値:
Principal
の身元を証明する資格情報
getPrincipal
public java.lang.Object getPrincipal()
インターフェースからコピーされた説明:Authentication
認証されるプリンシパルの ID。ユーザー名とパスワードを使用した認証リクエストの場合、これはユーザー名になります。呼び出し元は、認証リクエストのプリンシパルを設定することが期待されています。多くの場合、 AuthenticationManager 実装は、アプリケーションが使用するプリンシパルとして、より豊富な情報を含む Authentication を返します。認証プロバイダーの多くは、
UserDetails
オブジェクトをプリンシパルとして作成します。- 戻り値:
- 認証される
Principal
または認証後の認証されたプリンシパル。
setAuthenticated
public void setAuthenticated(boolean isAuthenticated) throws java.lang.IllegalArgumentException
インターフェースからコピーされた説明:Authentication
詳細については、Authentication.isAuthenticated()
を参照してください。実装では、
false
パラメーターを使用してこのメソッドを呼び出すことを常に許可する必要があります。これは、さまざまなクラスで使用され、認証トークンを信頼しないことを指定するためです。実装がtrue
パラメーター(認証トークンが信頼されることを示す - 潜在的なセキュリティリスク)での呼び出しを拒否する場合、実装はIllegalArgumentException
をスローする必要があります。- 次で指定:
- インターフェース
Authentication
のsetAuthenticated
- オーバーライド:
- クラス
AbstractAuthenticationToken
のsetAuthenticated
- パラメーター:
isAuthenticated
- トークンを信頼する必要がある場合はtrue
(例外が発生する可能性があります)、トークンを信頼しない場合はfalse
- 例外:
java.lang.IllegalArgumentException
- 実装が不変であるか、Authentication.isAuthenticated()
への独自の代替アプローチを実装しているため、認証トークンを(引数としてtrue
を渡すことにより)信頼しようとする試みが拒否された場合
eraseCredentials
public void eraseCredentials()
クラスからコピーされた説明:AbstractAuthenticationToken
CredentialsContainer
を実装するものに対してeraseCredentials
メソッドを呼び出して、credentials
、principal
、details
オブジェクトをチェックします。- 次で指定:
- インターフェース
CredentialsContainer
のeraseCredentials
- オーバーライド:
- クラス
AbstractAuthenticationToken
のeraseCredentials