Click or drag to resize

AuthenticationException Class

Thrown when a credential validation fails during IAuthenticationProvider.Authenticate. Note that this exception is typically attached as ThrownException and available there during the ApplicationAuthenticationFailed event.
Inheritance Hierarchy

Namespace:  NetQuarry.Security
Assembly:  EAP.Core (in EAP.Core.dll) Version: 2.0.0.0 (4.6.8.0)
Syntax
public class AuthenticationException : ApplicationException, 
	IEAPExtendedException

The AuthenticationException type exposes the following members.

Constructors
  NameDescription
Public methodAuthenticationException(String)
Initializes a new instance of the AuthenticationException class.
Public methodAuthenticationException(String, Exception)
Initializes a new instance of the AuthenticationException class.
Public methodAuthenticationException(String, String)
Initializes a new instance of the AuthenticationException class.
Top
Properties
  NameDescription
Public propertyAccountDisabled
Specifies whether or not the account is disabled (either as a result of the latest login failure or previously).
Public propertyData
Gets a collection of key/value pairs that provide additional user-defined information about the exception.
(Inherited from Exception.)
Public propertyDeveloperMessage
Gets/sets any developer-specific message content.
Public propertyDoNotLogToRequestLog
Specifies that this exception does not need to be logged to xot_request_log. Note that it DOES NOT prevent the error from being logged as part of normal request logging. It DOES, however, prevent special logging of continuable errors that occur in the middle of a request. The primary example of this is a custom validation error raised during a WizardNext event. See DoNotLogToRequestLog.
Public propertyFailedLogins
Gets/sets the number of failed login attempts. If MaxFailedLogins is positive then the user account is locked once that attempt threshold has been exceeded. Normally this is the value obtained from the failed_logins column in the users table (or the override for that table as specified in the application's AuthenticationView property). A value of -1 indicates that the number of failed logins has not been determined.
Public propertyFailureType
Gets/sets the type of authentication failure.
Public propertyHelpLink
Gets or sets a link to the help file associated with this exception.
(Inherited from Exception.)
Protected propertyHResult
Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception.
(Inherited from Exception.)
Public propertyInnerException
Gets the Exception instance that caused the current exception.
(Inherited from Exception.)
Public propertyIsSensitive
Specifies whether this exception, or any of its inner exceptions, may contain sensitive information that should be suppressed when when UnhandledErrorSuppressions is enabled. See IsSensitive.
Public propertyMaxFailedLogins
Gets/sets the maximum number of failed login attempts allowed before the user account is locked. Ignored if zero or negative. Normally this value is obtained from the application's MaxFailedLogins property.
Public propertyMessage
Gets a message that describes the current exception.
(Inherited from Exception.)
Public propertySource
Gets or sets the name of the application or the object that causes the error.
(Inherited from Exception.)
Public propertyStackTrace
Gets a string representation of the immediate frames on the call stack.
(Inherited from Exception.)
Public propertySuppressInner
Specifies whether or not any inner exceptions should be suppressed when generating a non-developer user error message. See SuppressInner.
Public propertyTargetSite
Gets the method that throws the current exception.
(Inherited from Exception.)
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetBaseException
When overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions.
(Inherited from Exception.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetObjectData
When overridden in a derived class, sets the SerializationInfo with information about the exception.
(Inherited from Exception.)
Public methodGetType
Gets the runtime type of the current instance.
(Inherited from Exception.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Creates and returns a string representation of the current exception.
(Inherited from Exception.)
Top
Events
  NameDescription
Protected eventSerializeObjectState
Occurs when an exception is serialized to create an exception state object that contains serialized data about the exception.
(Inherited from Exception.)
Top
Extension Methods
  NameDescription
Public Extension MethodContainsException
Determines whether or not the exception or one of its nested internal exceptions is of the specified exception type. For example: bool isAuth = ex.ContainsException(typeof(System.Security.Authentication.AuthenticationException));
(Defined by ExceptionExtensions.)
Public Extension MethodDeveloperMessage
Gets any developer-specific message content from DeveloperMessage.
(Defined by ExceptionExtensions.)
Public Extension MethodEqualValue
Determines if the object value is equal to another object. If the two objects are null, then this returns true. There is special handling for guid comparisons (since a guid could be a string formatted in up to 3 different ways). If the special guid handling is not performed, then the object.Equals method is used.
(Defined by EAPUtil.)
Public Extension MethodIsAuthenticationException
Determines if the exception or one of its nested internal exceptions is an authentication exception. Currently only AuthenticationException is recognized.
(Defined by ExceptionExtensions.)
Public Extension MethodIsDBException
Determines if the exception is a database provider originated exception. Currently only SqlException is recognized.
(Defined by ExceptionExtensions.)
Public Extension MethodMayRequireSuppression
Determines whether this exception, (or any of its inner exceptions if considerEntireExceptionStack is specified), may contain sensitive information that should be suppressed when when UnhandledErrorSuppression is enabled. Currently exceptions where IsDBException(Exception) is true and EAPException exceptions with IsSensitive set are considered to require suppression.
(Defined by ExceptionExtensions.)
Public Extension MethodSuppressInner
Gets whether or not this exception has been marked to suppress inner exceptions when generating a non-developer user error messages. See SuppressInner.
(Defined by ExceptionExtensions.)
Public Extension MethodVerboseMessage
Gets a verbose string representation of the exception. The string is intended to look just like the standard .Net Exception.ToString() output except that it includes DeveloperMessage, if any, if the exception implements the IEAPExtendedException interface (as does the EAPException class used as the base class for most platform exceptions). As with the standard .Net Exception.ToString() method, the returned string will include the stack trace and the verbose message for any internal exceptions (recursively).
(Defined by ExceptionExtensions.)
Top
See Also