クラス 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実装でのみ使用する必要があります。
メソッドのサマリー
すべてのメソッド 静的メソッド インスタンスメソッド 具象メソッド 修飾子と型 メソッド 説明 static UsernamePasswordAuthenticationTokenauthenticated(java.lang.Object principal, java.lang.Object credentials, java.util.Collection<? extends GrantedAuthority> authorities)このファクトリメソッドは、認証されたUsernamePasswordAuthenticationTokenを作成するコードで安全に使用できます。voideraseCredentials()CredentialsContainerを実装するものに対してeraseCredentialsメソッドを呼び出して、credentials、principal、detailsオブジェクトをチェックします。java.lang.ObjectgetCredentials()プリンシパルが正しいことを証明する資格情報。java.lang.ObjectgetPrincipal()認証されるプリンシパルの ID。voidsetAuthenticated(boolean isAuthenticated)詳細については、Authentication.isAuthenticated()を参照してください。static UsernamePasswordAuthenticationTokenunauthenticated(java.lang.Object principal, java.lang.Object credentials)このファクトリメソッドは、認証されていないUsernamePasswordAuthenticationTokenを作成するコードで安全に使用できます。クラス 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-
メソッドの詳細
unauthenticated
public static UsernamePasswordAuthenticationToken unauthenticated(java.lang.Object principal, java.lang.Object credentials)
このファクトリメソッドは、認証されていないUsernamePasswordAuthenticationTokenを作成するコードで安全に使用できます。- パラメーター:
principal-credentials-- 戻り値:
- isAuthenticated() の結果が誤っている UsernamePasswordAuthenticationToken
- 導入:
- 5.7
authenticated
public static UsernamePasswordAuthenticationToken authenticated(java.lang.Object principal, java.lang.Object credentials, java.util.Collection<? extends GrantedAuthority> authorities)
このファクトリメソッドは、認証されたUsernamePasswordAuthenticationTokenを作成するコードで安全に使用できます。- パラメーター:
principal-credentials-- 戻り値:
- 真の isAuthenticated() 結果を伴う UsernamePasswordAuthenticationToken
- 導入:
- 5.7
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()
クラスからコピーされた説明:AbstractAuthenticationTokenCredentialsContainerを実装するものに対してeraseCredentialsメソッドを呼び出して、credentials、principal、detailsオブジェクトをチェックします。- 次で指定:
- インターフェース
CredentialsContainerのeraseCredentials - オーバーライド:
- クラス
AbstractAuthenticationTokenのeraseCredentials