jon 01/06/18 18:41:19
Modified: src/java/org/apache/turbine/modules/actions
AccessController.java LoginUser.java
LogoutUser.java
src/java/org/apache/turbine/modules/actions/sessionvalidator
DefaultSessionValidator.java
TemplateSecureSessionValidator.java
TemplateSessionValidator.java
src/java/org/apache/turbine/modules/layouts
DefaultLayout.java VelocityECSLayout.java
Log:
misc documentation patches from Gary Lawrence Murphy <[EMAIL PROTECTED]>
Revision Changes Path
1.8 +7 -2
jakarta-turbine/src/java/org/apache/turbine/modules/actions/AccessController.java
Index: AccessController.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine/src/java/org/apache/turbine/modules/actions/AccessController.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- AccessController.java 2001/05/05 16:34:20 1.7
+++ AccessController.java 2001/06/19 01:41:10 1.8
@@ -91,13 +91,18 @@
*
* @author <a href="mailto:[EMAIL PROTECTED]";>John D. McNally</a>
* @author <a href="mailto:[EMAIL PROTECTED]";>Brett McLaughlin</a>
- * @version $Id: AccessController.java,v 1.7 2001/05/05 16:34:20 mpoeschl Exp $
+ * @version $Id: AccessController.java,v 1.8 2001/06/19 01:41:10 jon Exp $
*/
public class AccessController extends Action
{
/**
- * Execute the action.
+ * If there is a user and the user is logged in, doPerform will
+ * set the RunData ACL. The list is first sought from the current
+ * session, otherwise it is loaded through
+ * <code>TurbineSecurity.getACL()</code> and added to the current
+ * session.
*
+ * @see org.apache.turbine.services.security.TurbineSecurity
* @param data Turbine information.
* @exception Exception, a generic exception.
*/
1.12 +10 -2
jakarta-turbine/src/java/org/apache/turbine/modules/actions/LoginUser.java
Index: LoginUser.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine/src/java/org/apache/turbine/modules/actions/LoginUser.java,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- LoginUser.java 2001/05/05 16:34:21 1.11
+++ LoginUser.java 2001/06/19 01:41:12 1.12
@@ -71,12 +71,20 @@
* that users last login time will be updated.
*
* @author <a href="mailto:[EMAIL PROTECTED]";>Dave Bryson</a>
- * @version $Id: LoginUser.java,v 1.11 2001/05/05 16:34:21 mpoeschl Exp $
+ * @version $Id: LoginUser.java,v 1.12 2001/06/19 01:41:12 jon Exp $
*/
public class LoginUser extends Action
{
/**
- * Execute the action.
+ * 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
+ *
+ * <p><em>Note: Turbine clears the session before calling this
+ * method</em></p>
*
* @param data Turbine information.
* @exception Exception, a generic exception.
1.10 +14 -3
jakarta-turbine/src/java/org/apache/turbine/modules/actions/LogoutUser.java
Index: LogoutUser.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine/src/java/org/apache/turbine/modules/actions/LogoutUser.java,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- LogoutUser.java 2001/05/05 16:34:22 1.9
+++ LogoutUser.java 2001/06/19 01:41:12 1.10
@@ -66,15 +66,26 @@
/**
* This action removes a user from the session. It makes sure to save
- * the User object in the sesion.
+ * the User object in the session.
*
* @author <a href="mailto:[EMAIL PROTECTED]";>Dave Bryson</a>
- * @version $Id: LogoutUser.java,v 1.9 2001/05/05 16:34:22 mpoeschl Exp $
+ * @version $Id: LogoutUser.java,v 1.10 2001/06/19 01:41:12 jon Exp $
*/
public class LogoutUser extends Action
{
/**
- * Execute the action.
+ * Clears the RunData user object back to an anonymous status not
+ * logged in, and with a null ACL. If the tr.props ACTION_LOGIN
+ * is anthing 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 behaviour
+ * - 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.
*
* @param data Turbine information.
* @exception Exception, a generic exception.
1.9 +6 -3
jakarta-turbine/src/java/org/apache/turbine/modules/actions/sessionvalidator/DefaultSessionValidator.java
Index: DefaultSessionValidator.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine/src/java/org/apache/turbine/modules/actions/sessionvalidator/DefaultSessionValidator.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- DefaultSessionValidator.java 2001/05/05 17:45:46 1.8
+++ DefaultSessionValidator.java 2001/06/19 01:41:15 1.9
@@ -83,14 +83,17 @@
* Turbine servlet.
*
* @author <a href="mailto:[EMAIL PROTECTED]";>Dave Bryson</a>
- * @version $Id: DefaultSessionValidator.java,v 1.8 2001/05/05 17:45:46 mpoeschl
Exp $
+ * @version $Id: DefaultSessionValidator.java,v 1.9 2001/06/19 01:41:15 jon Exp $
*/
public class DefaultSessionValidator extends SessionValidator
{
/**
- * Execute the action.
+ * Execute the action. The default is to populate the RunData
+ * object and, if the user is unknown, to force a login screen (as
+ * set in the tr.props).
*
- * @param data Turbine information.
+ * @see org.apache.turbine.modules.screens.error.InvalidState
+ * @param data Turbine RunData context information.
* @exception Exception, a generic exception.
*/
public void doPerform( RunData data ) throws Exception
1.9 +7 -2
jakarta-turbine/src/java/org/apache/turbine/modules/actions/sessionvalidator/TemplateSecureSessionValidator.java
Index: TemplateSecureSessionValidator.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine/src/java/org/apache/turbine/modules/actions/sessionvalidator/TemplateSecureSessionValidator.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- TemplateSecureSessionValidator.java 2001/05/23 16:35:55 1.8
+++ TemplateSecureSessionValidator.java 2001/06/19 01:41:15 1.9
@@ -79,13 +79,18 @@
*
* @author <a href="mailto:[EMAIL PROTECTED]";>John D. McNally</a>
* @author <a href="mailto:[EMAIL PROTECTED]";>Dave Bryson</a>
- * @version $Id: TemplateSecureSessionValidator.java,v 1.8 2001/05/23 16:35:55
mikeh Exp $
+ * @version $Id: TemplateSecureSessionValidator.java,v 1.9 2001/06/19 01:41:15 jon
Exp $
*/
public class TemplateSecureSessionValidator extends SessionValidator
{
/**
- * Execute the action.
+ * doPerform is virtually identical to DefaultSessionValidator
+ * except that it calls template methods instead of bare screen
+ * methods. For example, it uses <code>setScreenTemplate</code> to
+ * load the tr.props TEMPLATE_LOGIN instead of the default's
+ * setScreen to TurbineContants.SCREEN_LOGIN.
*
+ * @see DefaultSessionValidator
* @param data Turbine information.
* @exception Exception, a generic exception.
*/
1.6 +7 -5
jakarta-turbine/src/java/org/apache/turbine/modules/actions/sessionvalidator/TemplateSessionValidator.java
Index: TemplateSessionValidator.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine/src/java/org/apache/turbine/modules/actions/sessionvalidator/TemplateSessionValidator.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- TemplateSessionValidator.java 2001/05/05 17:45:46 1.5
+++ TemplateSessionValidator.java 2001/06/19 01:41:16 1.6
@@ -61,16 +61,18 @@
import org.apache.turbine.services.security.TurbineSecurity;
/**
- * SessionValidator for use with the Template Service.
+ * SessionValidator for use with the Template Service, the
+ * TemplateSessionValidator is virtually identical to the
+ * TemplateSecureValidator except that it does not tranfer to the
+ * login page when it detects a null user (or a user not logged in).
*
- * <br>
- *
- * The Template Service requires a different Session Validator
+ * <p>The Template Service requires a different Session Validator
* because of the way it handles screens.
*
+ * @see TemplateSecureValidator
* @author <a href="mailto:[EMAIL PROTECTED]";>John D. McNally</a>
* @author <a href="mailto:[EMAIL PROTECTED]";>Dave Bryson</a>
- * @version $Id: TemplateSessionValidator.java,v 1.5 2001/05/05 17:45:46 mpoeschl
Exp $
+ * @version $Id: TemplateSessionValidator.java,v 1.6 2001/06/19 01:41:16 jon Exp $
*/
public class TemplateSessionValidator extends SessionValidator
{
1.7 +4 -1
jakarta-turbine/src/java/org/apache/turbine/modules/layouts/DefaultLayout.java
Index: DefaultLayout.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine/src/java/org/apache/turbine/modules/layouts/DefaultLayout.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- DefaultLayout.java 2001/05/23 16:36:04 1.6
+++ DefaultLayout.java 2001/06/19 01:41:18 1.7
@@ -71,12 +71,15 @@
* This is an example Layout module that is executed by default.
*
* @author <a href="mailto:[EMAIL PROTECTED]";>Dave Bryson</a>
- * @version $Id: DefaultLayout.java,v 1.6 2001/05/23 16:36:04 mikeh Exp $
+ * @version $Id: DefaultLayout.java,v 1.7 2001/06/19 01:41:18 jon Exp $
*/
public class DefaultLayout extends Layout
{
/**
* Build the layout.
+ *
+ * <p><em>NOTE: Unless otherwise specified, the page background
+ * defaults to 'white'</em></p>
*
* @param data Turbine information.
* @exception Exception, a generic exception.
1.10 +3 -2
jakarta-turbine/src/java/org/apache/turbine/modules/layouts/VelocityECSLayout.java
Index: VelocityECSLayout.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine/src/java/org/apache/turbine/modules/layouts/VelocityECSLayout.java,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- VelocityECSLayout.java 2001/06/11 00:03:33 1.9
+++ VelocityECSLayout.java 2001/06/19 01:41:18 1.10
@@ -75,12 +75,13 @@
*
* @author <a href="mailto:[EMAIL PROTECTED]";>John D. McNally</a>
* @author <a href="mailto:[EMAIL PROTECTED]";>Dave Bryson</a>
- * @version $Id: VelocityECSLayout.java,v 1.9 2001/06/11 00:03:33 jon Exp $
+ * @version $Id: VelocityECSLayout.java,v 1.10 2001/06/19 01:41:18 jon Exp $
*/
public class VelocityECSLayout extends Layout
{
/**
- * Build the layout.
+ * Build the layout. Also sets the ContentType and Locale headers
+ * of the HttpServletResponse object.
*
* @param data Turbine information.
* @exception Exception, a generic exception.
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
