LogoutUser (Apache Turbine 5.1-SNAPSHOT API)

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

All Implemented Interfaces:

Action, Assembler
```
public class LogoutUser
extends Object
implements Action
```
This action removes a user from the session. It makes sure to save the User object in the session.

Version:

$Id$

Author:

Dave Bryson, Henning P. Schmiedehausen, Peter Courcoux

Field Summary
- Fields inherited from interface org.apache.turbine.modules.Action
  CACHE_SIZE_DEFAULT, CACHE_SIZE_KEY, NAME, PREFIX

Constructor Summary

Constructors
Constructor Description

LogoutUser()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`doPerform(PipelineData pipelineData)`	Clears the PipelineData user object back to an anonymous status not logged in, and with a null ACL.

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

- Constructor Detail
  - LogoutUser
```
public LogoutUser()
```
- Method Detail
  - doPerform
```
public void doPerform(PipelineData pipelineData)
               throws org.apache.fulcrum.security.util.FulcrumSecurityException
```
    Clears the PipelineData user object back to an anonymous status not logged in, and with a null ACL. If the tr.props ACTION_LOGIN is anything except "LogoutUser", flow is transfered to the SCREEN_HOMEPAGE If this action name is the value of action.logout then we are being run before the session validator, so we don't need to set the screen (we assume that the session validator will handle that). This is basically still here simply to preserve old behavior - it is recommended that action.logout is set to "LogoutUser" and that the session validator does handle setting the screen/template for a logged out (read not-logged-in) user.
    
    Specified by:
    
    doPerform in interface Action
    
    Parameters:
    
    pipelineData - Turbine information.
    
    Throws:
    
    org.apache.fulcrum.security.util.FulcrumSecurityException - a problem occurred in the security service.