org.davesag.generica.controller
Interface UserLoginController

All Superinterfaces:
ActionController, Controller

public interface UserLoginController
extends ActionController

An implementation of the UserLoginController interface must be able to login the user based on the form details and populate their session.

Since:
Generica 1.0
Version:
CVS Revision $Id: UserLoginController.java,v 1.3 2004/03/30 13:00:40 davesag Exp $
Author:
Dave Sag http://www.davesag.com

Method Summary
 User login()
          Logs in the user based on details in the form set above.
 void populateUserSession(User user)
          Inevitably there are things we wish to pre-populate into the user's session if they have logged in okay.
 
Methods inherited from interface org.davesag.generica.controller.ActionController
setAction
 
Methods inherited from interface org.davesag.generica.controller.Controller
setForm, setRequest, setResponse
 

Method Detail

login

public User login()
           throws Exception
Logs in the user based on details in the form set above. This method should also set the user's lastIp property and resave them if they were logged in successfully.

Returns:
The logged in user object, or null if the user could not be logged in.
Throws:
Exception - if anything went seriously wrong.

populateUserSession

public void populateUserSession(User user)
                         throws Exception
Inevitably there are things we wish to pre-populate into the user's session if they have logged in okay.

Parameters:
user - The user we just logged in.
Throws:
Exception - if anything went seriously wrong.


Dave Sag Generica API version 0.5.9 - (prerelease) Copyright 2003 - 2004 Dave Sag.