Package io.micronaut.security.event

Class LoginFailedEvent

java.lang.Object

java.util.EventObject

io.micronaut.context.event.ApplicationEvent

io.micronaut.security.event.SecurityEvent

io.micronaut.security.event.LoginFailedEvent

All Implemented Interfaces:

Serializable

public class LoginFailedEvent
extends SecurityEvent

Event triggered when an unsuccessful login takes place.

Since:

1.0

Author:

Sergio del Amo

See Also:

• Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor	Description
LoginFailedEvent(Object source)	Deprecated, for removal: This API element is subject to removal in a future version. use LoginFailedEvent(java.lang.Object,io.micronaut.security.authentication.AuthenticationRequest).
LoginFailedEvent(Object source, AuthenticationRequest authenticationRequest)	Deprecated, for removal: This API element is subject to removal in a future version. use LoginFailedEvent(java.lang.Object,io.micronaut.security.authentication.AuthenticationRequest,@io.micronaut.core.annotation.Nullable java.lang.String,java.util.Locale).
LoginFailedEvent(Object source, AuthenticationRequest authenticationRequest, @Nullable String host, Locale locale)	Event triggered when an unsuccessful login takes place.

Method Summary

Modifier and Type	Method	Description
@Nullable AuthenticationRequest	getAuthenticationRequest()

Methods inherited from class io.micronaut.security.event.SecurityEvent

getHost, getLocale

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

LoginFailedEvent

public LoginFailedEvent(Object source,
 AuthenticationRequest authenticationRequest,
 @Nullable
 @Nullable String host,
 Locale locale)

Event triggered when an unsuccessful login takes place.

Parameters:

source - The AuthenticationResponse object signaling the authentication failure and reason.

authenticationRequest - A request to authenticate.

host - The hostname from the request if available

locale - The locale of the request

Throws:

IllegalArgumentException - if source is null.

Since:

4.7.0

LoginFailedEvent

@Deprecated(forRemoval=true,
            since="4.7.0")
public LoginFailedEvent(Object source,
 AuthenticationRequest authenticationRequest)

Deprecated, for removal: This API element is subject to removal in a future version.

use LoginFailedEvent(java.lang.Object,io.micronaut.security.authentication.AuthenticationRequest,@io.micronaut.core.annotation.Nullable java.lang.String,java.util.Locale).

Event triggered when an unsuccessful login takes place.

Parameters:

source - The AuthenticationResponse object signaling the authentication failure and reason.

authenticationRequest - A request to authenticate.

Throws:

IllegalArgumentException - if source is null.

Since:

4.1.0

LoginFailedEvent

@Deprecated(forRemoval=true,
            since="4.1.0")
public LoginFailedEvent(Object source)

Deprecated, for removal: This API element is subject to removal in a future version.

use LoginFailedEvent(java.lang.Object,io.micronaut.security.authentication.AuthenticationRequest).

Event triggered when an unsuccessful login takes place.

Parameters:

source - The AuthenticationResponse object signaling the authentication failure and reason.

Throws:

IllegalArgumentException - if source is null.

Method Details

getAuthenticationRequest

@Nullable
public @Nullable AuthenticationRequest getAuthenticationRequest()

Returns:

A request to authenticate.

Since:

4.1.0