Class Hierarchy    Previous  Next  Index

Class COM.cloudscape.authentication.Interface.AuthenticationException

java.lang.Object
    |
    +----java.lang.Throwable
            |
            +----java.lang.Exception
                    |
                    +----COM.cloudscape.authentication.Interface.AuthenticationException

public class AuthenticationException
extends java.lang.Exception
Copyright © 1998-2000, Informix Software, Inc. All rights reserved.

This is the Cloudscape Authentication exception class.
Failure to authenticate a user raises this exception. Appropriate static methods should be called to cause an appropriate exception to be constructed for Cloudscape.

A specialized authentication scheme class should raise this exception if the class failed to authenticate successfully the passed-in user's credentials.

Something of the form:
----------------------
throw AuthenticationException.loginFailed();
throw AuthenticationException.loginFailed(specificLoginFailureMsg);

Authentication exceptions are errors that are severe enough to terminate the session (connection).


Constructor Index

 o AuthenticationException(String)
Constructor

Method Index

 o loginFailed()
Construct a 'Login Failed' exception with a default error message.
 o loginFailed(String)
Construct a 'Login Failed' exception with an error message other than the default one.
 o notAValidDatabaseUser(String, String)
Deprecated method for invalid user in a database. Deprecated

Constructor Detail

 o AuthenticationException
public AuthenticationException(java.lang.String messageID)
          Constructor
Parameters:
messageID - A message string for this exception.

Method Detail

 o loginFailed
public static AuthenticationException loginFailed()
          Construct a 'Login Failed' exception with a default error message.
Returns:
an AuthenticationException object with default 'Login Failed' error message.
 o loginFailed
public static AuthenticationException loginFailed(java.lang.String exceptionMsg)
          Construct a 'Login Failed' exception with an error message other than the default one.
Returns:
an AuthenticationException object with a specific/overriden 'Login Failed' error message.
 o notAValidDatabaseUser
public static AuthenticationException notAValidDatabaseUser(java.lang.String userName,
                                                            java.lang.String databaseName)
Note: notAValidDatabaseUser() is deprecated.Use loginFailed method.

          Deprecated method for invalid user in a database. This method now simply calls the no argument loginFailed method. In some situations it is a security violation to reveal the name of a database on a remote machine and the fact the user is not valid within that database.
This method will be removed in a future version of Cloudscape.

Parameters:
userName - Ignored
databaseName - Ignored.
Returns:
See loginFailed().
See Also:
loginFailed

  Class Hierarchy    Previous  Next  Index