SimpleUrlAuthenticationFailureHandler (spring-security-docs-manual 5.3.2.RELEASE API)

java.lang.Object
- org.springframework.security.web.authentication.SimpleUrlAuthenticationFailureHandler

実装済みのインターフェース一覧:
AuthenticationFailureHandler
既知の直属サブクラス
ExceptionMappingAuthenticationFailureHandler
```
public class SimpleUrlAuthenticationFailureHandler
extends java.lang.Object
implements AuthenticationFailureHandler
```
AuthenticationFailureHandler は、onAuthenticationFailure メソッドが呼び出されたときに、defaultFailureUrl プロパティの値へのリダイレクトを実行します。プロパティが設定されていない場合は、失敗の原因となった AuthenticationException からのエラーメッセージとともに、401 レスポンスがクライアントに送信されます。
useForward プロパティが設定されている場合、リダイレクトではなく、宛先に対して RequestDispatcher.forward 呼び出しが行われます。
導入:
3.0

フィールド概要
フィールド
修飾子と型フィールドと説明
protected org.apache.commons.logging.Log logger

フィールド
修飾子と型	フィールドと説明
`protected org.apache.commons.logging.Log`	`logger`

コンストラクター概要
コンストラクター
コンストラクターと説明
SimpleUrlAuthenticationFailureHandler()
SimpleUrlAuthenticationFailureHandler(java.lang.String defaultFailureUrl)

コンストラクター
コンストラクターと説明
`SimpleUrlAuthenticationFailureHandler()`
`SimpleUrlAuthenticationFailureHandler(java.lang.String defaultFailureUrl)`

方法の概要

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`protected RedirectStrategy`	`getRedirectStrategy()`
`protected boolean`	`isAllowSessionCreation()`
`protected boolean`	`isUseForward()`
`void`	`onAuthenticationFailure(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, AuthenticationException exception)` 設定されている場合、`defaultFailureUrl` へのリダイレクトまたは転送を実行します。それ以外の場合は、401 エラーコードを返します。
`protected void`	`saveException(javax.servlet.http.HttpServletRequest request, AuthenticationException exception)` ビューのレンダリングで使用するために `AuthenticationException` をキャッシュします。
`void`	`setAllowSessionCreation(boolean allowSessionCreation)`
`void`	`setDefaultFailureUrl(java.lang.String defaultFailureUrl)` 失敗の宛先として使用される URL。
`void`	`setRedirectStrategy(RedirectStrategy redirectStrategy)` ターゲット URL にリダイレクトするときの動作をオーバーライドできます。
`void`	`setUseForward(boolean forwardToDestination)` `true` に設定されている場合、リダイレクトではなく、失敗した宛先 URL への転送を実行します。

クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- フィールドの詳細
  - logger
```
protected final org.apache.commons.logging.Log logger
```
- コンストラクターの詳細
  - SimpleUrlAuthenticationFailureHandler
```
public SimpleUrlAuthenticationFailureHandler()
```
  - SimpleUrlAuthenticationFailureHandler
```
public SimpleUrlAuthenticationFailureHandler(java.lang.String defaultFailureUrl)
```
- メソッドの詳細
  - onAuthenticationFailure
```
public void onAuthenticationFailure(javax.servlet.http.HttpServletRequest request,
                                    javax.servlet.http.HttpServletResponse response,
                                    AuthenticationException exception)
                             throws java.io.IOException,
                                    javax.servlet.ServletException
```
    設定されている場合、defaultFailureUrl へのリダイレクトまたは転送を実行します。それ以外の場合は、401 エラーコードを返します。
    リダイレクトまたは転送する場合、saveException が呼び出され、例外をキャッシュしてターゲットビューで使用します。
    次で指定:
    インターフェース AuthenticationFailureHandler 内の onAuthenticationFailure
    パラメーター:
    request - 認証試行が発生したリクエスト。
    response - レスポンス。
    exception - 認証リクエストを拒否するためにスローされた例外。
    例外:
    java.io.IOException
    javax.servlet.ServletException
  - saveException
```
protected final void saveException(javax.servlet.http.HttpServletRequest request,
                                   AuthenticationException exception)
```
    ビューのレンダリングで使用するために AuthenticationException をキャッシュします。
    forwardToDestination が true に設定されている場合、リクエストスコープが使用されます。それ以外の場合は、セッションに例外を格納しようとします。セッションがなく、allowSessionCreation が true の場合、セッションが作成されます。そうでない場合、例外は保存されません。
  - setDefaultFailureUrl
```
public void setDefaultFailureUrl(java.lang.String defaultFailureUrl)
```
    失敗の宛先として使用される URL。
    パラメーター:
    defaultFailureUrl - 障害 URL、たとえば "/loginFailed.jsp"。
  - isUseForward
```
protected boolean isUseForward()
```
  - setUseForward
```
public void setUseForward(boolean forwardToDestination)
```
    true に設定されている場合、リダイレクトではなく、失敗した宛先 URL への転送を実行します。デフォルトは false です。
  - setRedirectStrategy
```
public void setRedirectStrategy(RedirectStrategy redirectStrategy)
```
    ターゲット URL にリダイレクトするときの動作をオーバーライドできます。
  - getRedirectStrategy
```
protected RedirectStrategy getRedirectStrategy()
```
  - isAllowSessionCreation
```
protected boolean isAllowSessionCreation()
```
  - setAllowSessionCreation
```
public void setAllowSessionCreation(boolean allowSessionCreation)
```

クラス SimpleUrlAuthenticationFailureHandler

フィールド概要

コンストラクター概要

方法の概要

クラス java.lang.Object から継承されたメソッド

フィールドの詳細

logger

コンストラクターの詳細

SimpleUrlAuthenticationFailureHandler

SimpleUrlAuthenticationFailureHandler

メソッドの詳細

onAuthenticationFailure

saveException

setDefaultFailureUrl

isUseForward

setUseForward

setRedirectStrategy

getRedirectStrategy

isAllowSessionCreation

setAllowSessionCreation