Package com.samskivert.servlet.user

Provides services for managing a database of users in a web application or suite of web applications.

See:
          Description

Interface Summary
Authenticator Provides a means for applications to use their own application-specific authentication schemes for validating a user by constructing their own authenticator and passing it to UserManager.login(java.lang.String, com.samskivert.servlet.user.Password, boolean, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.samskivert.servlet.user.Authenticator).
 

Class Summary
Password Represents an encrypted password.
User A user object contains information about a registered user in our web application environment.
UserManager The user manager provides easy access to user objects for servlets.
UserManager.InsecureAuthenticator A totally insecure authenticator that authenticates any user.
UserManager.PasswordAuthenticator An authenticator that requires that the user-supplied password match the actual user password.
Username Allows us to require a valid username as a parameter without having to do the checking ourselves.
UserRepository Interfaces with the RDBMS in which the user information is stored.
UserUtil User related utility functions.
 

Exception Summary
AuthenticationFailedException Thrown when a user authentication attempt failed.
InvalidPasswordException Thrown during authentication when an invalid password is supplied.
InvalidUsernameException Thrown during user account creation if an invalid username is supplied.
NoSuchUserException Thrown when a user cannot be located in the user database.
UserExistsException Thrown during user account creation when a user with the requested username already exists.
 

Package com.samskivert.servlet.user Description

Provides services for managing a database of users in a web application or suite of web applications.

This is accomplished through the UserManager which can be used to load user objects, create new users, update existing users and generally all of the user-related things that you'd like to do. The user manager manages cookies for persistent or session-only authentication and provides support for requiring that a user be authenticated in order to access a page.

The user manager stores user information in an SQL database which is accomplished by the UserRepository class. Presently, it assumes that it is making use of a MySQL database, but the dependencies are minimal. Eventually I'll modify the repository abstraction so that the database-specific support code can be chosen at runtime rather than compile time. Why I designed it the way it is in the first place, I can't imagine. I'm a bad monkey.

The user table (and associated User object) are inentionally minimal. The expectation is that application specific data will be stored and accessed via some other table that is keyed on the userid provided by these services.



Copyright © 2000-2008 Michael Bayne. All Rights Reserved.