Class Hierarchy        Index

Interface COM.cloudscape.authentication.Interface.AuthenticationScheme

public interface AuthenticationScheme
Copyright © 1998-1999, Cloudscape, Inc. All rights reserved.

The AuthenticationScheme interface provides operations to authenticate a user's credentials in order to successfully connect to Cloudscape. Any User authentication schemes could be implemented using this interface and registered with Cloudscape at start-up time.

If an application requires its own authentication scheme, then it can implement this interface and register as the authentication scheme that Cloudscape should call upon connection requests to the system.

A typical example would be to implement Cloudscape user authentication using LDAP, Sun NIS+, or even Windows User Domain, using this interface. Cloudscape calls this interface and leaves it up to the implementation to authenticate the passed-in user credentials.

Note: Additional connection attributes can be specified on the database connection URL and/or Properties object on jdbc connection. Values for these attributes can be retrieved at runtime by the (specialized) authentication scheme to further help user authentication, if one needs additional info other than user, password, and database name.


Method Index

 o authenticateUser(String, String, String, Properties)
Authenticate a user's credentials.
 o toString()
Return authentication scheme name.

Methods

 o authenticateUser
 public abstract void authenticateUser(String userName,
                                       String userPassword,
                                       String databaseName,
                                       Properties info) throws AuthenticationException
Authenticate a user's credentials.

Parameters:
userName - The user's name used to connect to Cloudscape
userPassword - The user's password used to connect to Cloudscape
databaseName - The database that the user wants to connect to. Optional
info - A Properties object that contains additional connection information, that can help to authenticate the user. It has properties of the 'info' object passed as part of DriverManager.getConnection(url, info) and any original Cloudscape attributes set on the URL (i.e., ;create=, databaseName=, user=, etc...).
Throws: AuthenticationException
on failure to process user authentication.
 o toString
 public abstract String toString()
Return authentication scheme name. This is typically a string that identifies the authentication scheme (name).

Returns:
authentication scheme name.
Overrides:
toString in class Object

  Class Hierarchy        Index