pier 2003/03/21 05:43:47
Modified: src/idl/cocoon Cocoon.idl _module.idl
Added: src/idl/cocoon Continuation.idl
Log:
Added changes proposed by Chris about returning a "Continuation" instance
and specifying a TTL in the "sendPageAndWait(...)" function.
Slight improvements on the documentation (return tyes and exception
documentation)
Revision Changes Path
1.2 +17 -2 cocoon-2.1/src/idl/cocoon/Cocoon.idl
Index: Cocoon.idl
===================================================================
RCS file: /home/cvs/cocoon-2.1/src/idl/cocoon/Cocoon.idl,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- Cocoon.idl 18 Mar 2003 00:53:37 -0000 1.1
+++ Cocoon.idl 21 Mar 2003 13:43:46 -0000 1.2
@@ -95,6 +95,8 @@
* @param uri the relative URL of the page to be sent back to the client.
* @param bean a context object which can be accessed inside this page to
* extract various values and place them in the generated page.
+ * @exception java::Exception If an error occurred attempting to send the
+ * specified page.
*/
void sendPage(in string url, in Object bean)
raises (java::Exception);
@@ -106,13 +108,26 @@
* </p>
* <p>
* The flow script is suspended after the page is generated and the
- * whole execution stack saved in a continuation.
+ * whole execution stack saved in a <code>Continuation</code>. This
+ * instance is returned to the caller once the next request triggers
+ * the continuation of the current execution stack.
+ * </p>
+ * <p>
+ * TODO: Explain in better English what exactly goes on here.
* </p>
*
* @param uri the relative URL of the page to be sent back to the client.
* @param bean a context object which can be accessed inside this page to
* extract various values and place them in the generated page.
+ * @param ttl The time to leave in milliseconds of the newly created
+ * <code>Continuation</code> instance.
+ * @exception java::Exception If an error occurred attempting to send the
+ * specified page, or creating a new
+ * <code>Continuation</code> instance.
+ * @return The <code>Continuation</code> instance associated with this
+ * current execution stack.
*/
- void sendPageAndWait(in string url, in Object bean)
+ cocoon::Continuation sendPageAndWait(in string url, in Object bean,
+ in long ttl)
raises (java::Exception);
};
1.5 +2 -0 cocoon-2.1/src/idl/cocoon/_module.idl
Index: _module.idl
===================================================================
RCS file: /home/cvs/cocoon-2.1/src/idl/cocoon/_module.idl,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- _module.idl 18 Mar 2003 00:53:37 -0000 1.4
+++ _module.idl 21 Mar 2003 13:43:46 -0000 1.5
@@ -63,6 +63,7 @@
// Interfaces definitions.
interface Cocoon;
interface Context;
+ interface Continuation;
interface Log;
interface Request;
interface Script;
@@ -70,6 +71,7 @@
// Interfaces inclusions.
#include "cocoon/Cocoon.idl"
#include "cocoon/Context.idl"
+ #include "cocoon/Continuation.idl"
#include "cocoon/Log.idl"
#include "cocoon/Request.idl"
#include "cocoon/Script.idl"
1.1 cocoon-2.1/src/idl/cocoon/Continuation.idl
Index: Continuation.idl
===================================================================
/* ========================================================================= *
* The Apache Software License, Version 1.1 *
* ========================================================================= *
* Copyright (C) 1999-2003 The Apache Software Foundation. *
* All rights reserved. *
* *
* Redistribution and use in source and binary forms, with or without *
* modification, are permitted provided that the following conditions are *
* met: *
* *
* 1. Redistributions of source code must retain the above copyright notice, *
* this list of conditions and the following disclaimer. *
* *
* 2. Redistributions in binary form must reproduce the above copyright *
* notice, this list of conditions and the following disclaimer in the *
* documentation and/or other materials provided with the distribution. *
* *
* 3. The end-user documentation included with the redistribution, if any, *
* must include the following acknowledgment: *
* *
* "This product includes software developed by the *
* Apache Software Foundation <http://www.apache.org/>." *
* *
* Alternately, this acknowledgment may appear in the software itself, if *
* and wherever such third-party acknowledgments normally appear. *
* *
* 4. The names "Apache Cocoon" and "Apache Software Foundation" must not be *
* used to endorse or promote products derived from this software without *
* prior written permission. For written permission, please contact *
* <mailto:[EMAIL PROTECTED]>. *
* *
* 5. Products derived from this software may not be called "Apache", nor *
* may "Apache" appear in their name, without prior written permission of *
* the Apache Software Foundation. *
* *
* ------------------------------------------------------------------------- *
* *
* THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED WARRANTIES *
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY *
* AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL *
* THE APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY *
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGE *
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVI- *
* CES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER *
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABI- *
* LITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT *
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH *
* DAMAGE. *
* *
* This software consists of voluntary contributions made by many individua- *
* ls on behalf of the Apache Software Foundation and was originally created *
* by Stefano Mazzocchi <mailto:[EMAIL PROTECTED]>. For more information *
* about the Apache Software Foundation please see <http://www.apache.org/>. *
* *
* ------------------------------------------------------------------------- */
/**
* <p>
* <b>(TODO)</b> The <code>Continuation</code> object.
* </p>
*/
interface Continuation {
};
