quintonm 2003/03/21 14:41:27
Modified: src/java/org/apache/turbine/services/pull
RunDataApplicationTool.java ApplicationTool.java
Log:
updated javadocs.
- Infomation about the persistent scope tools has been removed.
- Warning about session tools being initialized with a null object and how to work
around
was added.
Revision Changes Path
1.3 +15 -5
jakarta-turbine-2/src/java/org/apache/turbine/services/pull/RunDataApplicationTool.java
Index: RunDataApplicationTool.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine-2/src/java/org/apache/turbine/services/pull/RunDataApplicationTool.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- RunDataApplicationTool.java 12 Mar 2003 23:18:45 -0000 1.2
+++ RunDataApplicationTool.java 21 Mar 2003 22:41:27 -0000 1.3
@@ -69,14 +69,24 @@
* Initialize the application tool. The data parameter holds a different
* type depending on how the tool is being instantiated:
* <ul>
- * <li>For global tools data will be null
- * <li>For request tools data will be of type RunData
- * <li>For session and persistent tools data will be of type User
+ * <li>For global tools data will be null</li>
+ * <li>For request tools data will be of type RunData</li>
+ * <li>For session and authorized tools data will be of type User</li>
+ * </ul>
+ * <p>
+ * It is possible that session scope tools will be initialized with a null
+ * <code>User</code> object. This happens when the first request on a
+ * session happens to the be login action. The next request on the session
+ * will cause the session tool to be refreshed if
+ * <code>tools.per.request.refresh</code> is set to <code>true</code>
+ * in <code>TurbineResources.properties</code>. You will then be able to
+ * get a <code>User</code> object from the instance of
+ * <code>RunData</object>.
*
* @param data initialization data
*/
public void init(Object data);
-
+
/**
* Refresh the application tool. This is
* necessary for development work where you
1.5 +13 -4
jakarta-turbine-2/src/java/org/apache/turbine/services/pull/ApplicationTool.java
Index: ApplicationTool.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine-2/src/java/org/apache/turbine/services/pull/ApplicationTool.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- ApplicationTool.java 9 Mar 2003 03:06:30 -0000 1.4
+++ ApplicationTool.java 21 Mar 2003 22:41:27 -0000 1.5
@@ -66,9 +66,18 @@
* Initialize the application tool. The data parameter holds a different
* type depending on how the tool is being instantiated:
* <ul>
- * <li>For global tools data will be null
- * <li>For request tools data will be of type RunData
- * <li>For session and persistent tools data will be of type User
+ * <li>For global tools data will be null</li>
+ * <li>For request tools data will be of type RunData</li>
+ * <li>For session and authorized tools data will be of type User</li>
+ * </ul>
+ * <p>
+ * It is possible that session scope tools will be initialized with a null
+ * <code>User</code> object. This happens when the first request on a
+ * session happens to the be login action.
+ * <p>
+ * If your session tool depends on having a <code>User</code> object, you
+ * should look at implementing the [EMAIL PROTECTED] RunDataApplicationTool}
interface
+ * instead.
*
* @param data initialization data
*/
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
