クラス DefaultAuthenticationEventPublisher
- java.lang.Object
-
- org.springframework.security.authentication.DefaultAuthenticationEventPublisher
- 実装されたすべてのインターフェース:
org.springframework.beans.factory.Aware
、org.springframework.context.ApplicationEventPublisherAware
、AuthenticationEventPublisher
public class DefaultAuthenticationEventPublisher extends java.lang.Object implements AuthenticationEventPublisher, org.springframework.context.ApplicationEventPublisherAware
認証イベントを公開するためのデフォルトの戦略。よく知られている AuthenticationException 型をイベントにマップし、アプリケーションコンテキストを介して公開します。Bean として構成されている場合は、 ApplicationEventPublisher を自動的に取得します。それ以外の場合は、パブリッシャーを引数としてとるコンストラクターを使用する必要があります。
例外マッピングシステムは、additionalExceptionMappings を
java.util.Properties
オブジェクトとして設定することで微調整できます。プロパティオブジェクトでは、各キーは例外の完全修飾クラス名を表し、各値はAbstractAuthenticationFailureEvent
をサブクラス化してそのコンストラクターを提供するイベントクラスの名前を表します。additionalExceptionMappings はデフォルトのものとマージされます。- 導入:
- 3.0
コンストラクターのサマリー
コンストラクター コンストラクター 説明 DefaultAuthenticationEventPublisher()
DefaultAuthenticationEventPublisher(org.springframework.context.ApplicationEventPublisher applicationEventPublisher)
メソッドのサマリー
すべてのメソッド インスタンスメソッド 具象メソッド 非推奨のメソッド 修飾子と型 メソッド 説明 void
publishAuthenticationFailure(AuthenticationException exception, Authentication authentication)
void
publishAuthenticationSuccess(Authentication authentication)
void
setAdditionalExceptionMappings(java.util.Map<java.lang.Class<? extends AuthenticationException>,java.lang.Class<? extends AbstractAuthenticationFailureEvent>> mappings)
イベントマッピングに追加の例外を設定します。void
setAdditionalExceptionMappings(java.util.Properties additionalExceptionMappings)
使用すべきではありません。void
setApplicationEventPublisher(org.springframework.context.ApplicationEventPublisher applicationEventPublisher)
void
setDefaultAuthenticationFailureEvent(java.lang.Class<? extends AbstractAuthenticationFailureEvent> defaultAuthenticationFailureEventClass)
例外マッピングにマップされていない、マップされていない例外のフォールバックイベントとして、デフォルトの認証失敗イベントを設定します。
メソッドの詳細
publishAuthenticationSuccess
public void publishAuthenticationSuccess(Authentication authentication)
- 次で指定:
- インターフェース
AuthenticationEventPublisher
のpublishAuthenticationSuccess
publishAuthenticationFailure
public void publishAuthenticationFailure(AuthenticationException exception, Authentication authentication)
- 次で指定:
- インターフェース
AuthenticationEventPublisher
のpublishAuthenticationFailure
setApplicationEventPublisher
public void setApplicationEventPublisher(org.springframework.context.ApplicationEventPublisher applicationEventPublisher)
- 次で指定:
- インターフェース
org.springframework.context.ApplicationEventPublisherAware
のsetApplicationEventPublisher
setAdditionalExceptionMappings
@Deprecated public void setAdditionalExceptionMappings(java.util.Properties additionalExceptionMappings)
使用すべきではありません。イベントマッピングに追加の例外を設定します。これらは、ProviderManager
が定義するイベントマッピングのデフォルトの例外と自動的にマージされます。- パラメーター:
additionalExceptionMappings
- ここで、keys は例外クラスの完全修飾文字列名であり、values は起動するイベントクラスの完全修飾文字列名です。
setAdditionalExceptionMappings
public void setAdditionalExceptionMappings(java.util.Map<java.lang.Class<? extends AuthenticationException>,java.lang.Class<? extends AbstractAuthenticationFailureEvent>> mappings)
イベントマッピングに追加の例外を設定します。これらは、ProviderManager
が定義するイベントマッピングのデフォルトの例外と自動的にマージされます。- パラメーター:
mappings
- ここで、キーは例外クラスであり、値はイベントクラスです。- 導入:
- 5.3
setDefaultAuthenticationFailureEvent
public void setDefaultAuthenticationFailureEvent(java.lang.Class<? extends AbstractAuthenticationFailureEvent> defaultAuthenticationFailureEventClass)
例外マッピングにマップされていない、マップされていない例外のフォールバックイベントとして、デフォルトの認証失敗イベントを設定します。- パラメーター:
defaultAuthenticationFailureEventClass
- マップされていない例外に対して発生する認証失敗イベントクラスです。