Package io.micronaut.security.authentication

Class AuthenticationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

io.micronaut.security.authentication.AuthenticationException

All Implemented Interfaces:

Serializable

public class AuthenticationException
extends RuntimeException

A runtime exception thrown when authentication fails.

Since:

1.0

Author:

James Kleeh

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
AuthenticationException()	No message.
AuthenticationException(AuthenticationResponse response)	Sets the message based on the response.
AuthenticationException(String message)

Method Summary

Modifier and Type	Method	Description
@Nullable AuthenticationResponse	getResponse()

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Details

AuthenticationException

public AuthenticationException(AuthenticationResponse response)

Sets the message based on the response.

Parameters:

response - The authentication response

AuthenticationException

public AuthenticationException()

No message.

AuthenticationException

public AuthenticationException(String message)

Parameters:

message - A custom message

Method Details

getResponse

@Nullable
public @Nullable AuthenticationResponse getResponse()

Returns:

The authentication response, or null if the exception is not tied to a response