Module io.quarkus.security.api

Package io.quarkus.security

Class AuthenticationFailedException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

java.lang.SecurityException

io.quarkus.security.AuthenticationFailedException

All Implemented Interfaces:

AuthenticationException, Serializable

public final class AuthenticationFailedException
extends SecurityException
implements AuthenticationException

An exception that should be thrown (or otherwise returned to the client for async implementations) by IdentityProvider implementations if the authentication failed.

This can be used by a mechanism to determine if an authentication failure was due to bad credentials vs some other form of internal failure.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
AuthenticationFailedException()
AuthenticationFailedException(String errorMessage)
AuthenticationFailedException(String errorMessage, Throwable cause)
AuthenticationFailedException(String errorMessage, Throwable cause, Map<String,Object> attributes)
AuthenticationFailedException(String errorMessage, Map<String,Object> attributes)
AuthenticationFailedException(Throwable cause)
AuthenticationFailedException(Throwable cause, Map<String,Object> attributes)
AuthenticationFailedException(Map<String,Object> attributes)

Method Summary

Modifier and Type	Method	Description
<T> T	getAttribute(String name)	Provides an attribute that allows to better understand the cause of the authentication failure.
Map<String,Object>	getAttributes()	Provides attributes that allow to better understand the cause of the authentication failure.

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

AuthenticationFailedException

public AuthenticationFailedException()

AuthenticationFailedException

public AuthenticationFailedException(Map<String,Object> attributes)

AuthenticationFailedException

public AuthenticationFailedException(String errorMessage)

AuthenticationFailedException

public AuthenticationFailedException(String errorMessage,
 Map<String,Object> attributes)

AuthenticationFailedException

public AuthenticationFailedException(Throwable cause)

AuthenticationFailedException

public AuthenticationFailedException(Throwable cause,
 Map<String,Object> attributes)

AuthenticationFailedException

public AuthenticationFailedException(String errorMessage,
 Throwable cause)

AuthenticationFailedException

public AuthenticationFailedException(String errorMessage,
 Throwable cause,
 Map<String,Object> attributes)

Method Details

getAttribute

public <T> T getAttribute(String name)

Provides an attribute that allows to better understand the cause of the authentication failure.

Type Parameters:

T - The type of the authentication failure attribute

Parameters:

name - The authentication failure attribute name

Returns:

The authentication attribute value or null if the attribute with this name does not exist

getAttributes

public Map<String,Object> getAttributes()

Provides attributes that allow to better understand the cause of the authentication failure.

Returns:

authentication failure attributes; never null