io.micronaut.security.authentication

Class AuthenticationFailed

java.lang.Object

io.micronaut.security.authentication.AuthenticationFailed

All Implemented Interfaces:

AuthenticationResponse, Serializable

public class AuthenticationFailed
extends Object
implements AuthenticationResponse

Signalises an authentication failure and stores the failure reason.

Since:

1.0

Author:

Sergio del Amo

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AuthenticationFailed() Necessary for JSON Serialization.
AuthenticationFailed(AuthenticationFailureReason authenticationFailure)

Method Summary

Modifier and Type	Method and Description
protected String	createMessage(AuthenticationFailureReason authenticationFailure) Generates a Title Case string for give authentication Failure.
boolean	equals(Object o)
Optional<String>	getMessage() message getter.
AuthenticationFailureReason	getReason()
int	hashCode()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.micronaut.security.authentication.AuthenticationResponse

isAuthenticated

Constructor Detail

AuthenticationFailed

public AuthenticationFailed()

Necessary for JSON Serialization.

AuthenticationFailed

public AuthenticationFailed(AuthenticationFailureReason authenticationFailure)

Parameters:

authenticationFailure - AuthenticationFailure enum which represents the failure reason

Method Detail

createMessage

protected String createMessage(AuthenticationFailureReason authenticationFailure)

Generates a Title Case string for give authentication Failure.

Parameters:

authenticationFailure - the authentication failure

Returns:

the Title Case String

getMessage

public Optional<String> getMessage()

message getter.

Specified by:

getMessage in interface AuthenticationResponse

Returns:

Failure message

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getReason

public AuthenticationFailureReason getReason()

Returns:

The reason why authentication failed.