Package org.springframework.security.core.userdetails

Class UsernameNotFoundException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.springframework.security.core.AuthenticationException

org.springframework.security.core.userdetails.UsernameNotFoundException

All Implemented Interfaces:

Serializable

public class UsernameNotFoundException
extends AuthenticationException

Thrown if an UserDetailsService implementation cannot locate a User by its username.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
UsernameNotFoundException(String msg)	Constructs a UsernameNotFoundException with the specified message.
UsernameNotFoundException(String msg, Throwable cause)	Constructs a UsernameNotFoundException with the specified message and root cause.

Method Summary

Modifier and Type	Method	Description
static UsernameNotFoundException	fromUsername(String username)	Construct an exception based on a specific username
static UsernameNotFoundException	fromUsername(String username, Throwable cause)	Construct an exception based on a specific username
@Nullable String	getName()	Get the username that couldn't be found

Methods inherited from class org.springframework.security.core.AuthenticationException

getAuthenticationRequest, setAuthenticationRequest

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

UsernameNotFoundException

public UsernameNotFoundException(String msg)

Constructs a UsernameNotFoundException with the specified message.

Parameters:

msg - the detail message.

UsernameNotFoundException

public UsernameNotFoundException(String msg,
 Throwable cause)

Constructs a UsernameNotFoundException with the specified message and root cause.

Parameters:

msg - the detail message.

cause - root cause

Method Details

fromUsername

public static UsernameNotFoundException fromUsername(String username)

Construct an exception based on a specific username

Parameters:

username - the invalid username

Returns:

the UsernameNotFoundException

Since:

7.0

fromUsername

public static UsernameNotFoundException fromUsername(String username,
 Throwable cause)

Construct an exception based on a specific username

Parameters:

username - the invalid username

cause - any underlying cause

Returns:

the UsernameNotFoundException

Since:

7.0

getName

public @Nullable String getName()

Get the username that couldn't be found

Returns:

the username

Since:

7.0