public class

DefaultAuthenticationEventPublisher

extends Object
implements ApplicationEventPublisherAware AuthenticationEventPublisher
java.lang.Object
   ↳ org.springframework.security.authentication.DefaultAuthenticationEventPublisher

Class Overview

The default strategy for publishing authentication events.

Maps well-known AuthenticationException types to events and publishes them via the application context. If configured as a bean, it will pick up the ApplicationEventPublisher automatically. Otherwise, the constructor which takes the publisher as an argument should be used.

The exception-mapping system can be fine-tuned by setting the additionalExceptionMappings as a java.util.Properties object. In the properties object, each of the keys represent the fully qualified classname of the exception, and each of the values represent the name of an event class which subclasses AbstractAuthenticationFailureEvent and provides its constructor. The additionalExceptionMappings will be merged with the default ones.

Summary

Public Constructors
DefaultAuthenticationEventPublisher()
DefaultAuthenticationEventPublisher(ApplicationEventPublisher applicationEventPublisher)
Public Methods
void publishAuthenticationFailure(AuthenticationException exception, Authentication authentication)
void publishAuthenticationSuccess(Authentication authentication)
void setAdditionalExceptionMappings(Properties additionalExceptionMappings)
Sets additional exception to event mappings.
void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.springframework.context.ApplicationEventPublisherAware
From interface org.springframework.security.authentication.AuthenticationEventPublisher

Public Constructors

public DefaultAuthenticationEventPublisher ()

public DefaultAuthenticationEventPublisher (ApplicationEventPublisher applicationEventPublisher)

Public Methods

public void publishAuthenticationFailure (AuthenticationException exception, Authentication authentication)

public void publishAuthenticationSuccess (Authentication authentication)

public void setAdditionalExceptionMappings (Properties additionalExceptionMappings)

Sets additional exception to event mappings. These are automatically merged with the default exception to event mappings that ProviderManager defines.

Parameters
additionalExceptionMappings where keys are the fully-qualified string name of the exception class and the values are the fully-qualified string name of the event class to fire.

public void setApplicationEventPublisher (ApplicationEventPublisher applicationEventPublisher)