Spring Security Framework

org.springframework.security
Class AuthenticationException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by java.lang.RuntimeException
              extended by org.springframework.core.NestedRuntimeException
                  extended by org.springframework.security.SpringSecurityException
                      extended by org.springframework.security.AuthenticationException
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
AccountStatusException, AuthenticationCancelledException, AuthenticationCredentialsNotFoundException, AuthenticationServiceException, BadCredentialsException, ConcurrentLoginException, InsufficientAuthenticationException, NonceExpiredException, NtlmBaseException, OpenIDAuthenticationRequiredException, PreAuthenticatedCredentialsNotFoundException, ProviderNotFoundException, RememberMeAuthenticationException, SessionAlreadyUsedException

public abstract class AuthenticationException
extends SpringSecurityException

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

Version:
$Id$
Author:
Ben Alex
See Also:
Serialized Form

Constructor Summary
AuthenticationException(String msg)
          Constructs an AuthenticationException with the specified message and no root cause.
AuthenticationException(String msg, Object extraInformation)
           
AuthenticationException(String msg, Throwable t)
          Constructs an AuthenticationException with the specified message and root cause.
 
Method Summary
 Authentication getAuthentication()
          The authentication request which this exception corresponds to (may be null)
 Object getExtraInformation()
          Any additional information about the exception.
 
Methods inherited from class org.springframework.core.NestedRuntimeException
contains, getCause, getMessage, getMostSpecificCause, getRootCause, printStackTrace, printStackTrace
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getLocalizedMessage, getStackTrace, initCause, 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

public AuthenticationException(String msg,
                               Object extraInformation)
Method Detail

getAuthentication

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


getExtraInformation

public Object getExtraInformation()
Any additional information about the exception. Generally a UserDetails object.

Returns:
extra information or null

Spring Security Framework

Copyright © 2004-2010 SpringSource, Inc. All Rights Reserved.