org.springframework.security.core

Class AuthenticationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.springframework.security.core.AuthenticationException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AccountStatusException, AuthenticationCredentialsNotFoundException, AuthenticationServiceException, BadCredentialsException, InsufficientAuthenticationException, ProviderNotFoundException, UsernameNotFoundException

public abstract class AuthenticationException
extends RuntimeException

Abstract superclass for all exceptions related to an Authentication object being invalid for whatever reason.

Author:

Ben Alex

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AuthenticationException(String msg) Constructs an AuthenticationException with the specified message and no root cause.
AuthenticationException(String msg, Object extraInformation) Deprecated. Use the exception message or use a custom exception if you really need additional information.
AuthenticationException(String msg, Throwable t) Constructs an AuthenticationException with the specified message and root cause.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearExtraInformation() Deprecated.
Authentication	getAuthentication() Deprecated. to avoid potential leaking of sensitive information (e.g. through serialization/remoting).
Object	getExtraInformation() Deprecated. Use the exception message or use a custom exception if you really need additional information.
void	setAuthentication(Authentication authentication) Deprecated.

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 Detail

AuthenticationException

public AuthenticationException(String msg,
                       Throwable t)

Constructs an AuthenticationException with the specified message and root cause.

Parameters:

msg - the detail message

t - the root cause

AuthenticationException

public AuthenticationException(String msg)

Constructs an AuthenticationException with the specified message and no root cause.

Parameters:

msg - the detail message

AuthenticationException

@Deprecated
public AuthenticationException(String msg,
                                  Object extraInformation)

Deprecated. Use the exception message or use a custom exception if you really need additional information.

Method Detail

getAuthentication

@Deprecated
public Authentication getAuthentication()

Deprecated. to avoid potential leaking of sensitive information (e.g. through serialization/remoting).

The authentication request which this exception corresponds to (may be null)

setAuthentication

@Deprecated
public void setAuthentication(Authentication authentication)

Deprecated.

getExtraInformation

@Deprecated
public Object getExtraInformation()

Deprecated. Use the exception message or use a custom exception if you really need additional information.

Any additional information about the exception. Generally a UserDetails object.

Returns:

extra information or null

clearExtraInformation

@Deprecated
public void clearExtraInformation()

Deprecated.