Class Hierarchy        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 Exception
Copyright © 1998-1999, Cloudscape, 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);
throw AuthenticationException.notAValidDatabaseUser(userName, databaseName);

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)
Construct a 'notAValidDatabaseUser' exception.

Constructors

 o AuthenticationException
 public AuthenticationException(String messageID)
Constructor

Parameters:
messageID - A message string for this exception.

Methods

 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(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(String userName,
                                                             String databaseName)
Construct a 'notAValidDatabaseUser' exception. It should typically be called when a user is not authorized access to a particular database.

Parameters:
userName - The user name not authorized in the database.
databaseName - The database name.
Returns:
an AuthenticationException object with appropriate 'notAValidDatabaseUser' error message.

  Class Hierarchy        Index