You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@beehive.apache.org by ri...@apache.org on 2005/08/26 00:42:23 UTC
svn commit: r240150 - in
/beehive/trunk/docs/forrest/release/src/documentation/content/xdocs:
pageflow/servlet_container_adapters.xml site.xml
Author: rich
Date: Thu Aug 25 15:42:17 2005
New Revision: 240150
URL: http://svn.apache.org/viewcvs?rev=240150&view=rev
Log:
- Some edits to the Servlet Container Adapters doc.
- Put Shared Flow, Inheritance, Popup Windows, Servlet Container Adapters to an "Advanced" section in the tree.
tests: build.release in docs/forrest
Modified:
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/pageflow/servlet_container_adapters.xml
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/site.xml
Modified: beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/pageflow/servlet_container_adapters.xml
URL: http://svn.apache.org/viewcvs/beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/pageflow/servlet_container_adapters.xml?rev=240150&r1=240149&r2=240150&view=diff
==============================================================================
--- beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/pageflow/servlet_container_adapters.xml (original)
+++ beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/pageflow/servlet_container_adapters.xml Thu Aug 25 15:42:17 2005
@@ -6,36 +6,47 @@
</header>
<body>
<section><title>Writing a Servlet Container Adapter</title>
-<p>Certain Page Flow features (like the default behavior for FlowController.login())
- depend on container-specific capabilities. Page Flows use "Servlet Container Adapters"
- to take advantage of container-specific functionality.</p>
-<p>To write an adapter:</p>
-
-<ol>
- <li>Write a class that implements
- <a href="../apidocs/classref_pageflows/org/apache/beehive/netui/pageflow/ServletContainerAdapter.html">org.apache.beehive.netui.pageflow.ServletContainerAdapter</a>.
- You can extend <a href="../apidocs/classref_pageflows/org/apache/beehive/netui/pageflow/DefaultServletContainerAdapter.html">org.apache.beehive.netui.pageflow.DefaultServletContainerAdapter</a>. </li>
-<li>Package the class in a JAR file which also contains a text file called
- "<code>META-INF/services/org.apache.beehive.netui.pageflow.ServletContainerAdapter</code>".
- The text file should have a single line that is your <code>ServletContainerAdapter</code> class name. </li>
-<li>Drop the JAR into the <code>WEB-INF/lib</code> directory of your web application.
- The Page Flow runtime will automatically
- pick up the first "discovered" adapter that answers true when its <code>accept</code>
- method is called. </li>
-</ol>
-
-<note>Note: the default <code>ServletContainerAdapter</code> defines "production mode"
- as the state
- where assertions are disabled. (See <a href="site:devmode">Development and Production Modes</a>
- for details.) Even if you do not want to use existing adapters for
- container-specific features, you may want to write your own adapter that defines
- production mode (<code>ServletContainerAdapter.isInProductionMode()</code>) according to your own
- requirements.</note>
- </section>
- </body>
- <footer>
- <legal>Java, J2EE, and JCP are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States and other countries.<br/>
- © 2004, Apache Software Foundation
- </legal>
- </footer>
+ <p>
+ Certain Page Flow features (like the default behavior for FlowController.login()) depend on
+ container-specific capabilities. Page Flow uses "servlet container adapters" to take advantage of
+ container-specific functionality.
+ </p>
+ <p>To write an adapter:</p>
+ <ol>
+ <li>
+ Write a class that implements
+ <a href="../apidocs/classref_pageflows/org/apache/beehive/netui/pageflow/ServletContainerAdapter.html">
+ org.apache.beehive.netui.pageflow.ServletContainerAdapter</a>.
+ You can extend <a href="../apidocs/classref_pageflows/org/apache/beehive/netui/pageflow/DefaultServletContainerAdapter.html">
+ org.apache.beehive.netui.pageflow.DefaultServletContainerAdapter</a>.
+ </li>
+ <li>
+ Package the class in a JAR file which also contains a text file in directory
+ <code>META-INF/services</code> called
+ <code>org.apache.beehive.netui.pageflow.ServletContainerAdapter</code>.
+ The text file should have a single line that is the full class name of your
+ <code>ServletContainerAdapter</code>
+ </li>
+ <li>
+ Drop the JAR into the <code>WEB-INF/lib</code> directory of your web application. The Page Flow
+ runtime will automatically pick up the first "discovered" adapter that answers <code>true</code>
+ when its <code>accept</code> method is called.
+ </li>
+ </ol>
+
+ <note>
+ Note: the default <code>ServletContainerAdapter</code> defines "production mode" as the state where
+ assertions are disabled. (See <a href="site:devmode">Development and Production Modes</a> for details.)
+ Even if you do not want to use existing adapters for container-specific features, you may want to write
+ your own adapter that defines production mode
+ (<a href="../apidocs/classref_pageflows/org/apache/beehive/netui/pageflow/ServletContainerAdapter#isInProductionMode"><code>ServletContainerAdapter.isInProductionMode()</code></a>)
+ according to your own requirements.
+ </note>
+ </section>
+ </body>
+ <footer>
+ <legal>Java, J2EE, and JCP are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States and other countries.<br/>
+ © 2004, Apache Software Foundation
+ </legal>
+ </footer>
</document>
Modified: beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/site.xml
URL: http://svn.apache.org/viewcvs/beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/site.xml?rev=240150&r1=240149&r2=240150&view=diff
==============================================================================
--- beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/site.xml (original)
+++ beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/site.xml Thu Aug 25 15:42:17 2005
@@ -23,9 +23,12 @@
</pageflow_jsp>
<pageflow_altering label="Altering a Page Flow" href="pageflow/pageflow_altering.html"/>
<databinding label="Databinding" href="pageflow/databinding.html"/>
- <pageflow_inheritance label="Inheritance" href="pageflow/pageflow_inheritance.html"/>
- <pageflow_sharedFlow label="Shared Flow" href="pageflow/sharedFlow.html"/>
- <pageflow_popups label="Popup Windows" href="pageflow/popupWindows.html"/>
+ <pageflow_advanced label="Advanced">
+ <pageflow_inheritance label="Inheritance" href="pageflow/pageflow_inheritance.html"/>
+ <pageflow_sharedFlow label="Shared Flow" href="pageflow/sharedFlow.html"/>
+ <pageflow_popups label="Popup Windows" href="pageflow/popupWindows.html"/>
+ <pageflow_servlet_adapter label="Servlet Container Adapters" href="pageflow/servlet_container_adapters.html"/>
+ </pageflow_advanced>
<pageflow_tags label="Tags">
<pageflow_tag_overview label="Overview" href="pageflow/tagsOverview.html" />
<pageflow_tag_htmlMapping label="HTML Mapping" href="pageflow/tagsHtmlMapping.html" />
@@ -44,7 +47,6 @@
</pageflow_tags>
<pageflow_valid label="Validation" href="pageflow/validation.html"/>
<pageflow_jsf label="Java Server Faces" href="pageflow/jsf.html"/>
- <pageflow_servlet_adapter label="Servlet Container Adapters" href="pageflow/servlet_container_adapters.html"/>
<devmode label="Development Mode" href="pageflow/dev_mode.html"/>
<pageflow_faq label="FAQ" href="pageflow/faq.html"/>
<!--<pageflow_programming label="Page Flow Programming" href="pageflow/guide.html"/>-->