LoginUser (Apache Turbine 5.1-SNAPSHOT API)

java.lang.Object
- org.apache.turbine.modules.actions.LoginUser

All Implemented Interfaces:

Action, Assembler
```
public class LoginUser
extends Object
implements Action
```
This is where we authenticate the user logging into the system against a user in the database. If the user exists in the database that users last login time will be updated.

Version:

$Id$

Author:

Dave Bryson, Henning P. Schmiedehausen, Quinton McCombs, Peter Courcoux

Field Summary

Fields
Modifier and Type Field Description

static String CGI_PASSWORD
CGI Parameter for the password

static String CGI_USERNAME
CGI Parameter for the user name
- Fields inherited from interface org.apache.turbine.modules.Action
  CACHE_SIZE_DEFAULT, CACHE_SIZE_KEY, NAME, PREFIX

Constructor Summary

Constructors
Constructor Description

LoginUser()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`doPerform(PipelineData pipelineData)`	Updates the user's LastLogin timestamp, sets their state to "logged in" and calls RunData.setUser() .

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.turbine.modules.Action
perform

- Field Detail
  - CGI_USERNAME
```
public static final String CGI_USERNAME
```
    CGI Parameter for the user name
    
    See Also:
    
    Constant Field Values
  - CGI_PASSWORD
```
public static final String CGI_PASSWORD
```
    CGI Parameter for the password
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - LoginUser
```
public LoginUser()
```
- Method Detail
  - doPerform
```
public void doPerform(PipelineData pipelineData)
               throws org.apache.fulcrum.security.util.FulcrumSecurityException
```
    Updates the user's LastLogin timestamp, sets their state to "logged in" and calls RunData.setUser() . If the user cannot be authenticated (database error?) the user is assigned anonymous status and, if tr.props contains a TEMPLATE_LOGIN, the screenTemplate is set to this, otherwise the screen is set to SCREEN_LOGIN
    
    Specified by:
    
    doPerform in interface Action
    
    Parameters:
    
    pipelineData - Turbine information.
    
    Throws:
    
    org.apache.fulcrum.security.util.FulcrumSecurityException - could not get instance of the anonymous user