Author: steveh
Date: Thu Mar 17 10:06:16 2005
New Revision: 157953
URL: http://svn.apache.org/viewcvs?view=rev&rev=157953
Log:
Fix for BEEHIVE-449: reference documentation netui-config.xml needs renamed and
information listed fixed
Added:
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/config/beehive-netui-config.xml
(with props)
Removed:
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/config/netui-config.xml
Modified:
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/site.xml
Added:
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/config/beehive-netui-config.xml
URL:
http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/config/beehive-netui-config.xml?view=auto&rev=157953
==============================================================================
---
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/config/beehive-netui-config.xml
(added)
+++
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/config/beehive-netui-config.xml
Thu Mar 17 10:06:16 2005
@@ -0,0 +1,786 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN"
"http://forrest.apache.org/dtd/document-v20.dtd";>
+<document>
+ <header>
+ <title>Reference Documentation: beehive-netui-config.xml File</title>
+ </header>
+ <body>
+ <section id="desc">
+ <title>Description</title>
+ <p>
+ The <code>beehive-netui-config.xml</code> file configures the
runtime behavior of your Page Flow web
+ app.
+ </p>
+ <p>Use <code>beehive-netui-config.xml</code> to declare interceptor
classes, override the default handler classes,
+ etc.</p>
+ </section>
+ <section id="structure">
+ <title>General Structure</title>
+<source><a href="#netui-config"><netui-config></a>
+ <a href="#legacy-tag-support"><legacy-tag-support></a>
+ <a href="#expression-languages"><expression-languages></a>
+ <a href="#expression-language"><expression-language></a>
+ <a href="#default-language"><default-language></a>
+ <a href="#name"><name></a>
+ <a href="#factory-class"><factory-class></a>
+ <a href="#binding-contexts"><binding-contexts></a>
+ <a href="#binding-context"><binding-context></a>
+ <a href="#name"><name></a>
+ <a href="#factory-class"><factory-class></a>
+ <a href="#pageflow-action-interceptors"><pageflow-action-interceptors></a>
+ <a href="#global"><global></a>
+ <a href="#simple-action-interceptor"><simple-action-interceptor></a>
+ <a href="#intercept-path"><intercept-path></a>
+ <a href="#after-action"><after-action></a>
+ <a href="#action-interceptor"><action-interceptor></a>
+ <a href="#interceptor-class"><interceptor-class></a>
+ <a href="#custom-property"><custom-property></a>
+ <a href="#name"><name></a>
+ <a href="#value"><value></a>
+ <a href="#per-pageflow"><per-pageflow></a>
+ <a href="#pageflow-uri"><pageflow-uri></a>
+ <a href="#simple-action-interceptor"><simple-action-interceptor></a>
+ <a href="#intercept-path"><intercept-path></a>
+ <a href="#after-action"><after-action></a>
+ <a href="#action-interceptor"><action-interceptor></a>
+ <a href="#interceptor-class"><interceptor-class></a>
+ <a href="#custom-property"><custom-property></a>
+ <a href="#per-action"><per-action></a>
+ <a href="#action-name"><action-name></a>
+ <a href="#simple-action-interceptor"><simple-action-interceptor></a>
+ <a href="#intercept-path"><intercept-path></a>
+ <a href="#after-action"><after-action></a>
+ <a href="#action-interceptor"><action-interceptor></a>
+ <a href="#interceptor-class"><interceptor-class></a>
+ <a href="#custom-property"><custom-property></a>
+ <a href="#pageflow-handlers"><pageflow-handlers></a>
+ <a href="#login-handler-class"><login-handler-class></a>
+ <a
href="#forward-redirect-handler-class"><forward-redirect-handler-class></a>
+ <a
href="#reloadable-class-handler-class"><reloadable-class-handler-class></a>
+ <a href="#exceptions-handler-class"><exceptions-handler-class></a>
+ <a href="#pageflow-config"><pageflow-config></a>
+ <a href="#enable-renesting"><enable-renesting></a>
+ <a href="#max-forwards-per-request"><max-forwards-per-request></a>
+ <a href="#max-nesting-stack-depth"><max-nesting-stack-depth></a>
+ <a href="#ensure-secure-forwards"><ensure-secure-forwards></a>
+ <a
href="#throw-session-expired-exception"><throw-session-expired-exception></a>
+ <a href="#multipart-handler"><multipart-handler></a>
+ <a href="#module-config-locators"><module-config-locators></a>
+ <a href="#description"><description></a>
+ <a href="#locator-class"><locator-class></a>
+ <a href="#type-converters"><type-converters></a>
+ <a href="#type-converter"><type-converter></a>
+ <a href="#type"><type></a>
+ <a href="#converter-class"><converter-class></a>
+ <a href="#jsp-tag-config"><jsp-tag-config></a>
+ <a href="#doctype"><doctype></a>
+ <a href="#id-javascript"><id-javascript></a>
+ <a href="#tree-image-location"><tree-image-location></a>
+ <a href="#iterator-factories"><iterator-factories></a>
+ <a href="#iterator-factory"><iterator-factory></a>
+ <a href="#name"><name></a>
+ <a href="#factory-class"><factory-class></a>
+ <a href="#request-interceptors"><request-interceptors></a>
+ <a href="#interceptor-class"><interceptor-class></a></source>
+ </section>
+ <section id="elements">
+ <title>Elements</title>
+ <section
id="action-interceptor"><title><action-interceptor></title>
+ <p><strong>Syntax</strong></p>
+ <source><action-interceptor>
+ <interceptor-class> xsd:string </interceptor-class> [occurrences: 1]
+ <custom-property>
+ <name> xsd:string </name> [occurrences: 1]
+ <value> xsd:string </value> [occurrences: 1]
+ </custom-property> [occurrences: 0-*]
+</action-interceptor></source>
+ <p><strong>Parents:</strong></p>
+ <p><a href="#global"><global></a>,
+ <a
href="#per-pageflow"><per-pageflow></a>,
+ <a
href="#per-action"><per-action></a></p>
+ <p><strong>Children:</strong></p>
+ <p>
+ <a href="#interceptor-class"><interceptor-class></a>,
+ <a href="#custom-property"><custom-property></a></p>
+ </section>
+ <section id="action-name"><title><action-name></title>
+ <p><strong>Syntax</strong></p>
+ <source><action-name> xsd:string
<action-name> [occurrences: 1]</source>
+ <p><strong>Parents:</strong></p>
+ <p><a
href="#per-action"><per-action></a></p>
+ <p><strong>Children:</strong></p>
+ <p>none</p></section>
+ <section id="after-action"><title><after-action></title>
+ <p><strong>Syntax</strong></p>
+ <source> <after-action> xsd:boolean
<after-action> [occurrences: 0-1] </source>
+ <p><strong>Parents:</strong></p>
+ <p><a
href="#intercept-path"><intercept-path></a>
+ </p>
+ <p><strong>Children:</strong></p>
+ <p>none</p></section>
+
+ <section id="binding-context"><title><binding-context></title>
+ <p><strong>Syntax</strong></p>
+ <source><binding-context> [occurrences: 0-*]
+ <name> xsd:string </name> [occurrences: 1]
+ <factory-class> xsd:string </factory-class> [occurrences: 1]
+</binding-context></source>
+ <p><strong>Parents:</strong></p>
+ <p><a
href="#binding-contexts"><binding-contexts></a></p>
+ <p><strong>Children:</strong></p>
+ <p><a href="#name"><name></a>,
+ <a
href="#factory-class"><factory-class></a></p></section>
+ <section id="binding-contexts"><title><binding-contexts></title>
+ <p><strong>Syntax</strong></p>
+ <source></binding-contexts> [occurrences:
0-1]
+ <binding-context> [occurrences: 0-*]
+ <name> xsd:string </name> [occurrences: 1]
+ <factory-class> xsd:string </factory-class> [occurrences: 1]
+ </binding-context>
+</binding-contexts></source>
+ <p><strong>Parents:</strong></p>
+ <p><a
href="#expression-language"><expression-language></a></p>
+ <p><strong>Children:</strong></p>
+ <p><a
href="#binding-context"><binding-context></a></p></section>
+ <section id="converter-class"><title><converter-class></title>
+ <p><strong>Syntax</strong></p>
+ <source><converter-class> xsd:string
</converter-class> [occurrences: 1]</source>
+ <p><strong>Parents:</strong></p>
+ <p><a
href="#type-converter"><type-converter></a></p>
+ <p><strong>Children:</strong></p>
+ <p>none</p></section>
+ <section id="custom-property"><title><custom-property></title>
+ <p><strong>Syntax</strong></p>
+ <source><custom-property>
+ <name> xsd:string </name> [occurrences: 1]
+ <value> xsd:string </value> [occurrences: 1]
+</custom-property></source>
+ <p><strong>Parents:</strong></p>
+ <p><a
href="#action-interceptor"><action-interceptor></a></p>
+ <p><strong>Children:</strong></p>
+ <p><a href="#name"><name></a>,
+ <a href="#value"><value></a></p></section>
+ <section id="default-language"><title><default-language></title>
+ <p><strong>Syntax</strong></p>
+ <source><default-language> xsd:string
</default-language> [occurrences: 1]</source>
+ <p><strong>Parents:</strong></p>
+ <p><a
href="#expression-language"><expression-language></a></p>
+ <p><strong>Children:</strong></p>
+ <p>none</p></section>
+ <section id="description"><title><description></title>
+ <p><strong>Syntax</strong></p>
+ <source><description> xsd:string
</description> [occurrences: 0-1]</source>
+ <p><strong>Parents:</strong></p>
+ <p><a
href="#module-config-locator"><module-config-locator></a></p>
+ <p><strong>Children:</strong></p>
+ <p>none</p></section>
+ <section id="doctype"><title><doctype></title>
+ <p><strong>Syntax</strong></p>
+ <source><doctype> [ html4-loose |
xhtml1-transitional ] </doctype> [occurrences: 0-1]</source>
+ <p><strong>Parents:</strong></p>
+ <p><a
href="#jsp-tag-config"><jsp-tag-config></a></p>
+ <p><strong>Children:</strong></p>
+ <p>none</p></section>
+ <section id="enable-renesting"><title><enable-renesting></title>
+ <p><strong>Syntax</strong></p>
+ <source><enable-renesting> xsd:boolean
</enable-renesting> [occurrences: 0-1]</source>
+ <p><strong>Parents:</strong></p>
+ <p><a
href="#pageflow-config"><pageflow-config></a></p>
+ <p><strong>Children:</strong></p>
+ <p>none</p></section>
+ <section
id="ensure-secure-forwards"><title><ensure-secure-forwards></title>
+ <p>For some server implementations, security checks
are executed only when an URL is called
+ directly, while security checks for
server forwards are ignored.</p>
+ <p>When this element is set to
<code>true</code>, server forwards are guaranteed to be checked.</p>
+ <p><strong>Syntax</strong></p>
+ <source><ensure-secure-forwards> xsd:boolean
</ensure-secure-forwards> [occurrences: 0-1]</source>
+ <p><strong>Parents:</strong></p>
+ <p><a
href="#pageflow-config"><pageflow-config></a></p>
+ <p><strong>Children:</strong></p>
+ <p>none</p></section>
+ <section
id="exceptions-handler-class"><title><exceptions-handler-class></title>
+ <p>Typically, exceptions thrown by the controller
class are delivered in a wrapper exception
+ class. The class named here, can be
used to unwrap these exceptions and handle
+ the underlying exception in a more
fine-grained manner.</p>
+ <p><strong>Syntax</strong></p>
+ <source><exceptions-handler-class>
xsd:string </exceptions-handler-class> [occurrences: 0-1]</source>
+ <p><strong>Parents:</strong></p>
+ <p><a
href="#pageflow-handlers"><pageflow-handlers></a></p>
+ <p><strong>Children:</strong></p>
+ <p>none</p></section>
+ <section
id="expression-language"><title><expression-language></title>
+ <p><strong>Syntax</strong></p>
+ <source> <expression-language>
[occurrences: 1-*]
+ <name> xsd:string </name> [occurrences: 1]
+ <factory-class> xsd:string </factory-class> [occurrences: 1]
+ <binding-contexts> binding-contexts </binding-contexts>
[occurrences: 0-1]
+ </expression-language></source>
+ <p><strong>Parents:</strong></p>
+ <p><a
href="#pageflow-handlers"><pageflow-handlers></a></p>
+ <p><strong>Children:</strong></p>
+ <p><a href="#name"><name></a>,
+ <a
href="#factory-class"><factory-class></a>,
+ <a
href="#binding-contexts"><binding-contexts></a></p></section>
+ <section
id="expression-languages"><title><expression-languages></title>
+ <p><strong>Syntax</strong></p>
+ <source><expression-languages> [occurrences:
1]
+ <default-language> xsd:string </default-language> [occurrences: 1]
+ <expression-language> [occurrences: 1-*]
+ <name> xsd:string </name> [occurrences: 1]
+ <factory-class> xsd:string </factory-class> [occurrences: 1]
+ <binding-contexts> binding-contexts </binding-contexts>
[occurrences: 0-1]
+ </expression-language>
+</expression-languages></source>
+ <p><strong>Parents:</strong></p>
+ <p><a
href="#netui-config"><netui-config></a></p>
+ <p><strong>Children:</strong></p>
+ <p><a
href="#default-language"><default-language></a>,
+ <a
href="#expression-language"><expression-language></a>
+ </p></section>
+ <section id="factory-class"><title><factory-class></title>
+ <p><strong>Syntax</strong></p>
+ <source><factory-class> xsd:string
</factory-class> [occurrences: 1]</source>
+ <p><strong>Parents:</strong></p>
+ <p><a
href="#binding-contexts"><binding-contexts></a></p>
+ <p><strong>Children:</strong></p>
+ <p>none</p></section>
+ <section
id="forward-redirect-handler-class"><title><forward-redirect-handler-class></title>
+ <p><strong>Syntax</strong></p>
+ <source><forward-redirect-handler-class>
xsd:string </forward-redirect-handler-class> [occurrences: 0-1]</source>
+ <p><strong>Parents:</strong></p>
+ <p><a
href="#pageflow-handlers"><pageflow-handlers></a></p>
+ <p><strong>Children:</strong></p>
+ <p>none</p></section>
+ <section id="global"><title><global></title>
+ <p><strong>Syntax</strong></p>
+ <source><global> [occurrences: 0-1]
+ <simple-action-interceptor>
+ <intercept-path> xsd:string </intercept-path> [occurrences: 1]
+ <after-action> xsd:boolean </after-action> [occurrences: 0-1]
+ </simple-action-interceptor> [occurrences: 0-*]
+ <action-interceptor>
+ <interceptor-class> xsd:string </interceptor-class> [occurrences: 1]
+ <custom-property>
+ <name> xsd:string </name> [occurrences: 1]
+ <value> xsd:string </value> [occurrences: 1]
+ </custom-property> [occurrences: 0-*]
+ </action-interceptor> [occurrences: 0-*]
+</global></source>
+ <p><strong>Parents:</strong></p>
+ <p><a
href="#pageflow-action-interceptors"><pageflow-action-interceptors></a></p>
+ <p><strong>Children:</strong></p>
+ <p><a
href="#simple-action-inteceptor"><simple-action-inteceptor></a>,
+ <a
href="#action-inteceptor"><action-inteceptor></a></p></section>
+ <section id="id-javascript"><title><id-javascript></title>
+ <p><strong>Syntax</strong></p>
+ <source><id-javascript> [ default | legacy |
legacyOnly ] </id-javascript> [occurrences: 0-1]</source>
+ <p><strong>Parents:</strong></p>
+ <p><a
href="#jsp-tag-config"><jsp-tag-config></a></p>
+ <p><strong>Children:</strong></p>
+ <p>none</p></section>
+ <section
id="interceptor-class"><title><interceptor-class></title>
+ <p><strong>Syntax</strong></p>
+ <source><interceptor-class> xsd:string
<interceptor-class> [occurrences: 1]</source>
+ <p><strong>Parents:</strong></p>
+ <p><a
href="#jsp-tag-config"><jsp-tag-config></a></p>
+ <p><strong>Children:</strong></p>
+ <p>none</p></section>
+ <section id="intercept-path"><title><intercept-path></title>
+ <p><strong>Syntax</strong></p>
+ <source><intercept-path> xsd:string
</intercept-path> [occurrences: 1]</source>
+ <p><strong>Parents:</strong></p>
+ <p><a
href="#simple-action-interceptor"><simple-action-interceptor></a></p>
+ <p><strong>Children:</strong></p>
+ <p>none</p></section>
+
+ <section
id="iterator-factories"><title><iterator-factories></title>
+ <p><strong>Syntax</strong></p>
+ <source><iterator-factories>
+ <iterator-factory> [occurrences: 0-*]
+ ...
+ </iterator-factory>
+</iterator-factories></source>
+ <p><strong>Parents:</strong></p>
+ <p><a
href="#netui-config"><netui-config></a></p>
+ <p><strong>Children:</strong></p>
+ <p><a
href="#iterator-factory"><iterator-factory></a></p></section>
+
+ <section id="iterator-factory"><title><iterator-factory></title>
+ <p><strong>Syntax</strong></p>
+ <source><iterator-factory> [occurrences: 0-*]
+ <name> xsd:string </name> [occurrences: 1]
+ <factory-class> xsd:string </factory-class> [occurrences: 1]
+</iterator-factory></source>
+ <p><strong>Parents:</strong></p>
+ <p><a
href="#iterator-factorys"><iterator-factorys></a></p>
+ <p><strong>Children:</strong></p>
+ <p><a href="#name"><name></a>,
+ <a
href="#factory-class"><factory-class></a></p></section>
+
+ <section id="jsp-tag-config"><title><jsp-tag-config></title>
+ <p><strong>Syntax</strong></p>
+ <source><jsp-tag-config>
+ <doctype> xsd:string </doctype> [occurrences: 0-1]
+ <id-javascript> [ default | legacy | legacyOnly ] </id-javascript>
[occurrences: 0-1]
+ <tree-image-location> xsd:string </tree-image-location> [occurrences:
0-1]
+</jsp-tag-config></source>
+ <p><strong>Parents:</strong></p>
+ <p><a
href="#netui-config"><netui-config></a></p>
+ <p><strong>Children:</strong></p>
+ <p><a href="#doctype"><doctype></a>,
+ <a
href="#id-javascript"><id-javascript></a>,
+ <a
href="#tree-image-location"><tree-image-location></a>,</p></section>
+
+ <section
id="legacy-tag-support"><title><legacy-tag-support></title>
+ <p><strong>Syntax</strong></p>
+ <source><legacy-tag-support> xsd:boolean
</legacy-tag-support> [occurrences: 0-1]</source>
+ <p><strong>Parents:</strong></p>
+ <p><a
href="#netui-config"><netui-config></a></p>
+ <p><strong>Children:</strong></p>
+ <p>none</p></section>
+
+ <section id="locator-class"><title><locator-class></title>
+ <p><strong>Syntax</strong></p>
+ <source><locator-class> xsd:string
</locator-class> [occurrences: 1]</source>
+ <p><strong>Parents:</strong></p>
+ <p><a
href="#module-config-locators"><module-config-locators></a></p>
+ <p><strong>Children:</strong></p>
+ <p>none</p></section>
+ <section
id="login-handler-class"><title><login-handler-class></title>
+ <p><strong>Syntax</strong></p>
+ <source><login-handler-class> xsd:string
</login-handler-class> [occurrences: 0-1]</source>
+ <p><strong>Parents:</strong></p>
+ <p><a
href="#pageflow-handlers"><pageflow-handlers></a></p>
+ <p><strong>Children:</strong></p>
+ <p>none</p></section>
+ <section
id="max-forwards-per-request"><title><max-forwards-per-request></title>
+ <p>If the number of server
+ forwards exceeds the given count, an error is written to the response
and no further
+ forwarding is excuted. This is mainly to prevent infinite loops of
server forwards.
+ To reproduce the error, invoke this action in a Page Flow:</p>
+<source>
+<![CDATA[ @Jpf.Action(
+ forwards={
+ @Jpf.Forward(name="self", path="overflow.do")
+ }
+ )
+ public Forward overflow()
+ {
+ return new Forward( "self" );
+ }]]></source>
+
+<p>If the jpf-forward-overflow-count parameter is omitted from the web.xml
file,
+the error will be written to the response after 50 server forwards within a
single request. ÃÂ
+</p>
+<p>When an application is in development, a descriptive error is sent; for
deployed applications, a 500 response is sent.</p>
+ <p><strong>Syntax</strong></p>
+ <source><max-forwards-per-request> xsd:int
</max-forwards-per-request> [occurrences: 0-1]</source>
+ <p><strong>Parents:</strong></p>
+ <p><a
href="#pageflow-config"><pageflow-config></a></p>
+ <p><strong>Children:</strong></p>
+ <p>none</p>
+</section>
+
+ <section
id="max-nesting-stack-depth"><title><max-nesting-stack-depth></title>
+ <p>
+ This parameter sets the maximum size of the Page Flow nesting stack.
+ If Page Flows are repeatedly nested until the stack exceeds the
specified value,
+ an error is written to the response object and any further nesting is
not allowed.
+ This helps prevent the nesting stack from consuming large amounts of
resources.</p>
+<p>When an application is in development, a descriptive error is sent; for
deployed applications, a 500 response is sent.</p>
+ <p><strong>Syntax</strong></p>
+ <source><max-nesting-stack-depth> xsd:int
</max-nesting-stack-depth> [occurrences: 0-1]</source>
+ <p><strong>Parents:</strong></p>
+ <p><a
href="#pageflow-config"><pageflow-config></a></p>
+ <p><strong>Children:</strong></p>
+ <p>none</p>
+ </section>
+
+ <section
id="module-config-locator"><title><module-config-locator></title>
+ <p><strong>Syntax</strong></p>
+ <source><module-config-locator>
[occurrences: 0-*]
+ <description> xsd:string </description> [occurrences: 0-1]
+ <locator-class> xsd:string </locator-class> [occurrences: 1]
+</module-config-locator></source>
+ <p><strong>Parents:</strong></p>
+ <p><a
href="#module-config-locators"><module-config-locators></a></p>
+ <p><strong>Children:</strong></p>
+ <p><a href="#description"><description></a>,
+ <a
href="#locator-class"><locator-class></a></p></section>
+
+ <section
id="module-config-locators"><title><module-config-locators></title>
+ <p>Names a class or group of classes that know the
location of the web application's
+ Struts configuration files. By default these
configuation files are saved to
+
<code>WEB-INF/.pageflow-struts-generated/</code>. But, in cases where this
default location
+ has been overridden by a custom compilation
process, use <code><module-config-locators></code> to point to a Java class
that knows the
+ new location. </p>
+ <p><strong>Syntax</strong></p>
+ <source><module-config-locators>
[occurrences: 0-1]
+ <module-config-locator> [occurrences: 0-*]
+ <description> xsd:string </description> [occurrences: 0-1]
+ <locator-class> xsd:string </locator-class> [occurrences: 1]
+ </module-config-locator>
+</module-config-locators></source>
+ <p><strong>Parents:</strong></p>
+ <p><a
href="#pageflow-config"><pageflow-config></a></p>
+ <p><strong>Children:</strong></p>
+ <p><a
href="#module-config-locator"><module-config-locator></a></p></section>
+
+ <section
id="multipart-handler"><title><multipart-handler></title>
+ <p>By default multi-part file uploading is disabled
for page flow web applications.
+ To turn it on, you must (1) explicitly
set this element to <code>memory</code>
+ or <code>disk</code>, or (2) decorate a
given controller class with
+ the @Jpf.MultipartHandler annotation.
Doing (1) will enable file uploading across
+ the entire web applcation, doing (2)
enables file uploading on a
+ controller-by-controller basis.</p>
+ <p><strong>Syntax</strong></p>
+ <source><multipart-handler> [ disabled |
memory | disk ] </multipart-handler> [occurrences: 0-1]</source>
+ <p><strong>Parents:</strong></p>
+ <p><a
href="#pageflow-config"><pageflow-config></a></p>
+ <p><strong>Children:</strong></p>
+ <p>none</p>
+ <p>
+ To disable file upload, set the value to "none".
+ [todo: other values include memory, ?, ...]</p>
+ </section>
+
+ <section id="name"><title><name></title>
+ <p><strong>Syntax</strong></p>
+ <source><name> xsd:string </name>
[occurrences: 1]</source>
+ <p><strong>Parents:</strong></p>
+ <p><a
href="#expression-language"><expression-language></a>,
+ <a
href="#iterator-factory"><iterator-factory></a>,
+ <a
href="#binding-context"><binding-context></a>,
+ <a
href="#custom-property"><custom-property></a></p>
+ <p><strong>Children:</strong></p>
+ <p>none</p></section>
+
+ <section id="netui-config">
+ <title><netui-config></title>
+ <p>
+ The top-level element in the <code>beehive-netui-config.xml</code>
file.
+ ÃÂ </p>
+ <p><strong>Syntax</strong></p>
+ <source><netui-config>
+ <legacy-tag-support> xsd:boolean </legacy-tag-support> [occurrences:
0-1]
+ <expression-languages> ... </expression-languages> [occurrences: 1]
+ <pageflow-action-interceptors> ... </pageflow-action-interceptors>
[occurrences: 0-1]
+ <pageflow-handlers> ... </pageflow-handlers> [occurrences: 0-1]
+ <pageflow-config> ... </pageflow-config> [occurrences: 0-1]
+ <type-converters> ... </type-converters> [occurrences: 0-1]
+ <jsp-tag-config> ... </jsp-tag-config> [occurrences: 0-1]
+ <iterator-factories> ... </iterator-factories> [occurrences: 0-1]
+ <request-interceptors> ... </request-interceptors> [occurrences: 0-1]
+</netui-config></source>
+ <p><strong>Parents:</strong></p>
+ <p></p>
+ <p><strong>Children:</strong></p>
+ <p> <a
href="#legacy-tag-support"><legacy-tag-support></a>,
+ <a href="#expression-languages"><expression-languages></a>,
+ <a
href="#pageflow-action-interceptors"><pageflow-action-interceptors></a>,
+ <a href="#pageflow-handlers"><pageflow-handlers></a>,
+ <a href="#pageflow-config"><pageflow-config></a>,
+ <a href="#type-converters"><type-converters></a>,
+ <a href="#jsp-tag-config"><jsp-tag-config></a>,
+ <a href="#iterator-factories"><iterator-factories></a>,
+ <a href="#request-interceptors"><request-interceptors></a></p>
+ </section>
+
+ <section id="pageflow-action-interceptors">
+ <title><pageflow-action-interceptors></title>
+ <p>If you want to be notified before (or after) every action
that's run in the webapp,
+you configure a <pageflow-action-interceptor> group.
+A simple example of this would be a monitoring infrastructure
+that keeps track of the number of actions raised. To keep track of the number
of actions raised,
+register an interceptor
+that runs the counting code before going to any action. A more complex example
+is an interceptor that *redirects* you to another page flow before allowing
you
+to go to the current one; for instance, it might take you to a nested page
flow
+that asks you to fill out a "satisfaction survey" before sending you to the
+destination page flow. </p>
+<p>The action-intercepting class is run twice: <em>both</em> before
<em>and</em> after the execution of the
+ action.</p>
+ <p><strong>Also see:</strong></p>
+ <p><a
href="../../apidocs/classref_pageflows/org/apache/beehive/netui/pageflow/interceptor/ActionInterceptor.html">Interface
org.apache.beehive.netui.pageflow.interceptor.ActionInterceptor</a></p>
+ <p><strong>Syntax</strong></p>
+ <source><pageflow-action-interceptors>
+ <global> [occurrences: 0-1]
+ <simple-action-interceptor> ...
</simple-action-interceptor> [occurrences: 0-*]
+ <action-interceptor> ... </action-interceptor>
[occurrences: 0-*]
+ </global>
+ <per-pageflow> [occurrences: 0-*]
+ <pageflow-uri> xsd:string </pageflow-uri> [occurrences: 1]
+ <simple-action-interceptor> ...
</simple-action-interceptor> [occurrences: 0-*]
+ <action-interceptor> ... </action-interceptor>
[occurrences: 0-*]
+ <per-action> [occurrences: 0-*]
+ <action-name> xsd:string </action-name>
[occurrences: 1]
+ <simple-action-interceptor> ...
</simple-action-interceptor> [occurrences: 0-*]
+ <action-interceptor> ... </action-interceptor>
[occurrences: 0-*]
+ </per-action>
+ </per-pageflow>
+</pageflow-action-interceptors></source>
+ <p><strong>Parents</strong></p>
+ <p><a
href="#netui-config"><netui-config></a></p>
+ <p><strong>Children</strong></p>
+ <p><a href="#global"><global></a>, <a
href="#per-pageflow"><per-pageflow></a> </p>
+ </section>
+
+ <section id="pageflow-config">
+ <title><pageflow-config></title>
+ <p><strong>Syntax</strong></p>
+ <source><pageflow-config>
+ <enable-renesting> xsd:boolean </enable-renesting> [occurrences:
0-1]
+ <max-forwards-per-request> xsd:int </max-forwards-per-request>
[occurrences: 0-1]
+ <max-nesting-stack-depth> xsd:int </max-nesting-stack-depth>
[occurrences: 0-1]
+ <ensure-secure-forwards> xsd:boolean </ensure-secure-forwards>
[occurrences: 0-1]
+ <throw-session-expired-exception> xsd:boolean
</throw-session-expired-exception> [occurrences: 0-1]
+ <multipart-handler> [ disabled | memory | disk ]
</multipart-handler> [occurrences: 0-1]
+ <module-config-locators> ... </module-config-locators>
[occurrences: 0-1]
+</pageflow-config></source>
+ <p><strong>Parents:</strong></p>
+ <p><a
href="#netui-config"><netui-config></a></p>
+ <p><strong>Children:</strong></p>
+ <p><a
href="#enable-renesting"><enable-renesting></a>,
+ <a
href="#max-forwards-per-request"><max-forwards-per-request></a>,
+ <a
href="#max-nesting-stack-depth"><max-nesting-stack-depth></a>,
+ <a
href="#ensure-secure-forwards"><ensure-secure-forwards></a>,
+ <a
href="#throw-session-expired-exception"><throw-session-expired-exception></a>,
+ <a
href="#multipart-handler"><multipart-handler></a>,
+ <a
href="#module-config-locators"><module-config-locators></a>,
+ </p>
+ <p>
+Configures the page flow
+runtime across the webapp. If you want to disable file-upload, for instance,
+you set the multipart-handler to "none". There will be more settings here
soon.
+ ÃÂ </p>
+ </section>
+
+ <section id="pageflow-handlers">
+ <title><pageflow-handlers></title>
+ <p>
+These settings let you override base framework behavior.
+A good example is the LoginHandler. By default, we use standard Servlet
+APIs to see if you're logged in, and we use some server-specific APIs to
+actually log you in when login() is called inside a page flow.
+If you want to replace this behavior with your own login scheme
+(which may look at a User database table for login information),
+you can provide your own LoginHandler that defines methods like login() and
isUserInRole().
+</p>
+
+ <p><strong>Syntax</strong></p>
+ <source><pageflow-handlers>
+ <login-handler-class> xsd:string </login-handler-class>
[occurrences: 0-1]
+ <forward-redirect-handler-class> xsd:string
</forward-redirect-handler-class> [occurrences: 0-1]
+ <reloadable-class-handler-class> xsd:string
</reloadable-class-handler-class> [occurrences: 0-1]
+ <exceptions-handler-class> xsd:string </exceptions-handler-class>
[occurrences: 0-1]
+</pageflow-handlers></source>
+ <p><strong>Parents:</strong></p>
+ <p><a
href="#netui-config"><netui-config></a></p>
+ <p><strong>Children:</strong></p>
+ <p><a
href="#login-handler-class"><login-handler-class></a>,
+ <a
href="#forward-redirect-handler-class"><forward-redirect-handler-class></a>,
+ <a
href="#reloadable-class-handler-class"><reloadable-class-handler-class></a>,
+ <a
href="#exceptions-handler-class"><exceptions-handler-class></a></p>
+ </section>
+
+ <section id="pageflow-uri"><title><pageflow-uri></title>
+ <p><strong>Syntax</strong></p>
+ <source><pageflow-uri> xsd:string
</pageflow-uri> [occurrences: 1]</source>
+ <p><strong>Parents:</strong></p>
+ <p><a
href="#per-pageflow"><per-pageflow></a></p>
+ <p><strong>Children:</strong></p>
+ <p>none</p></section>
+
+ <section id="per-action"><title><per-action></title>
+ <p><strong>Syntax</strong></p>
+ <source><per-action> [occurrences: 0-*]
+ <action-name> xsd:string </action-name> [occurrences: 1]
+ <simple-action-interceptor> netui:simple-action-interceptor
</simple-action-interceptor> [occurrences: 0-*]
+ <action-interceptor> netui:action-interceptor
</action-interceptor> [occurrences: 0-*]
+</per-action></source>
+ <p><strong>Parents:</strong></p>
+ <p><a
href="#global"><global></a></p>
+ <p><strong>Children:</strong></p>
+ <p><a
href="#action-name"><action-name></a>,
+ <a
href="#simple-action-interceptor"><simple-action-interceptor></a>,
+ <a
href="#action-interceptor"><action-interceptor></a></p></section>
+
+ <section id="per-pageflow"><title><per-pageflow></title>
+ <p><strong>Syntax</strong></p>
+ <source><per-pageflow> [occurrences: 0-*]
+ <pageflow-uri> xsd:string </pageflow-uri> [occurrences: 1]
+ <simple-action-interceptor> netui:simple-action-interceptor
</simple-action-interceptor> [occurrences: 0-*]
+ <action-interceptor> netui:action-interceptor
</action-interceptor> [occurrences: 0-*]
+ <per-action> [occurrences: 0-*]
+ <action-name> xsd:string </action-name> [occurrences: 1]
+ <simple-action-interceptor> netui:simple-action-interceptor
</simple-action-interceptor> [occurrences: 0-*]
+ <action-interceptor> netui:action-interceptor
</action-interceptor> [occurrences: 0-*]
+ </per-action>
+</per-pageflow></source>
+ <p><strong>Parents:</strong></p>
+ <p><a
href="#global"><global></a></p>
+ <p><strong>Children:</strong></p>
+ <p><a
href="#pageflow-uri"><pageflow-uri></a>,
+ <a
href="#simple-action-interceptor"><simple-action-interceptor></a>,
+ <a
href="#action-interceptor"><action-interceptor></a>,
+ <a
href="#per-action"><per-action></a></p></section>
+
+ <section
id="reloadable-class-handler-class"><title><reloadable-class-handler-class></title>
+ <p><strong>Syntax</strong></p>
+ <source><reloadable-class-handler-class>
xsd:string </reloadable-class-handler-class> [occurrences: 0-1]</source>
+ <p><strong>Parents:</strong></p>
+ <p><a
href="#pageflow-handlers"><pageflow-handlers></a></p>
+ <p><strong>Children:</strong></p>
+ <p>none</p></section>
+
+ <section id="request-interceptors">
+ <title><request-interceptors></title>
+ <p><strong>Syntax</strong></p>
+ <source><request-interceptors>
+ <interceptor-class> xsd:string </interceptor-class> [occurrences: 1-*]
+</request-interceptors></source>
+ <p><strong>Parents:</strong></p>
+ <p><a
href="#netui-config"><netui-config></a></p>
+ <p><strong>Children:</strong></p>
+ <p><a
href="#interceptor-class"><interceptor-class></a></p></section>
+
+ <section
id="simple-action-interceptor"><title><simple-action-interceptor></title>
+ <p><strong>Syntax</strong></p>
+ <source><simple-action-interceptor>
+ <intercept-path> xsd:string </intercept-path> [occurrences: 1]
+ <after-action> xsd:boolean </after-action> [occurrences: 0-1]
+</simple-action-interceptor></source>
+ <p><strong>Parents:</strong></p>
+ <p><a
href="#netui-config"><netui-config></a></p>
+ <p><strong>Children:</strong></p>
+ <p>none</p></section>
+
+ <section
id="throw-session-expired-exception"><title><throw-session-expired-exception></title>
+ <p><strong>Syntax</strong></p>
+ <source><throw-session-expired-exception>
xsd:boolean </throw-session-expired-exception> [occurrences: 0-1]</source>
+ <p><strong>Parents:</strong></p>
+ <p><a
href="#pageflow-config"><pageflow-config></a></p>
+ <p><strong>Children:</strong></p>
+ <p>none</p></section>
+
+ <section
id="tree-image-location"><title><tree-image-location></title>
+ <p><strong>Syntax</strong></p>
+ <source><tree-image-location> xsd:string
</tree-image-location> [occurrences: 0-1]</source>
+ <p><strong>Parents:</strong></p>
+ <p><a
href="#jsp-tag-config"><jsp-tag-config></a></p>
+ <p><strong>Children:</strong></p>
+ <p>none</p></section>
+
+ <section id="type"><title><type></title>
+ <p><strong>Syntax</strong></p>
+ <source><type> xsd:string </type>
[occurrences: 1]</source>
+ <p><strong>Parents:</strong></p>
+ <p><a
href="#type-converter"><type-converter></a></p>
+ <p><strong>Children:</strong></p>
+ <p>none</p></section>
+
+ <section id="type-converter"><title><type-converter></title>
+ <p><strong>Syntax</strong></p>
+ <source><type-converter> [occurrences: 0-*]
+ <type> xsd:string </type> [occurrences: 1]
+ <converter-class> xsd:string </converter-class> [occurrences: 1]
+</type-converter></source>
+ <p><strong>Parents:</strong></p>
+ <p><a
href="#type-converters"><type-converters></a></p>
+ <p><strong>Children:</strong></p>
+ <p>none</p></section>
+
+ <section id="type-converters"><title><type-converters></title>
+ <p><strong>Syntax</strong></p>
+ <source><type-converters>
+ <type-converter> [occurrences: 0-*]
+ <type> xsd:string </type> [occurrences: 1]
+ <converter-class> xsd:string </converter-class> [occurrences: 1]
+ </type-converter>
+</type-converters></source>
+ <p><strong>Parents:</strong></p>
+ <p><a
href="#netui-config"><netui-config></a></p>
+ <p><strong>Children:</strong></p>
+ <p><a
href="#type-converter"><type-converter></a></p></section>
+
+ <section id="value"><title><value></title>
+ <p><strong>Syntax</strong></p>
+ <source><value> xsd:string </value>
[occurrences: 1]</source>
+ <p><strong>Parents:</strong></p>
+ <p><a
href="#custom-property"><custom-property></a></p>
+ <p><strong>Children:</strong></p>
+ <p>none</p></section>
+ </section>
+ <section>
+ <title>Example</title>
+ <p>
+ Use the following example <code>netui-config.xsd</code> file as a
template.</p>
+ <source><![CDATA[<?xml version="1.0" encoding="UTF-8"?>
+
+<netui-config xmlns="http://beehive.apache.org/netui/2004/server/config";>
+
+ <legacy-tag-support>false</legacy-tag-support>
+
+ <expression-languages>
+ <default-language>netuiel</default-language>
+ <expression-language>
+ <name>netuiel</name>
+
<factory-class>org.apache.beehive.netui.script.el.ExpressionEvaluatorImpl$NetUIELEngineFactory</factory-class>
+ </expression-language>
+ </expression-languages>
+
+ <pageflow-action-interceptors>
+ <global>
+ <before-action>
+ <action-interceptor>
+
<interceptor-class>miniTests.interceptors.InterceptorsController$BeforeInterceptor</interceptor-class>
+ </action-interceptor>
+ <action-interceptor>
+
<interceptor-class>miniTests.interceptors.InterceptorsController$BeforeInterceptor2</interceptor-class>
+ </action-interceptor>
+ </before-action>
+ <after-action>
+ <action-interceptor>
+
<interceptor-class>miniTests.interceptors.InterceptorsController$AfterInterceptor</interceptor-class>
+ </action-interceptor>
+ <action-interceptor>
+
<interceptor-class>miniTests.interceptors.InterceptorsController$AfterInterceptor2</interceptor-class>
+ </action-interceptor>
+ </after-action>
+ </global>
+ </pageflow-action-interceptors>
+
+ <pageflow-handlers>
+
<forward-redirect-handler-class>pageFlowCore.forwards.Controller$Redirector</forward-redirect-handler-class>
+ </pageflow-handlers>
+
+ <pageflow-config>
+ <multipart-handler>memory</multipart-handler>
+ <module-config-locators>
+ <module-config-locator>
+ <description>For /miniTests/moduleConfigLocator.</description>
+ <locator-class>moduleConfigLocator.Locator1</locator-class>
+ </module-config-locator>
+ </module-config-locators>
+ </pageflow-config>
+
+ <jsp-tag-config>
+ <doctype>html4-loose</doctype>
+ <id-javascript>Legacy-JavaScript-Only</id-javascript>
+ </jsp-tag-config>
+
+ <iterator-factories>
+ </iterator-factories>
+
+</netui-config>
+
+ ]]></source>
+ </section>
+ <section>
+ <title>Related Topics</title>
+<p><a
href="../../apidocs/classref_pageflows/org/apache/beehive/netui/util/config/ConfigUtil.html">Class
org.apache.beehive.netui.util.config.ConfigUtil</a></p>
+<p><a
href="../../apidocs/classref_pageflows/org/apache/beehive/netui/pageflow/interceptor/ActionInterceptor.html">Interface
org.apache.beehive.netui.pageflow.interceptor.ActionInterceptor</a></p>
+ </section>
+
+ </body>
+</document>
Propchange:
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/config/beehive-netui-config.xml
------------------------------------------------------------------------------
svn:eol-style = native
Modified:
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/site.xml
URL:
http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/site.xml?view=diff&r1=157952&r2=157953
==============================================================================
---
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/site.xml
(original)
+++
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/site.xml
Thu Mar 17 10:06:16 2005
@@ -17,6 +17,7 @@
<pageflow_overview label="Overview"
href="pageflow/pageflow_overview.html"/>
<pageflow_controllers label="Controller Files"
href="pageflow/pageflow_controllers.html"/>
<pageflow_jsp label="JSP Files" href="pageflow/pageflow_jsp.html"/>
+ <pageflow_databinding label="Databinding"
href="pageflow/pageflow_databinding.html"/>
<pageflow_building label="Building a Web-App"
href="pageflow/pageflow_building.html"/>
<pageflow_altering label="Altering a Page Flow"
href="pageflow/pageflow_altering.html"/>
<pageflow_sharedFlow label="Using Data Grids"
href="pageflow/pageflow_datagrid.html"/>
@@ -39,7 +40,7 @@
<samples label="Samples">
<sam_index label="Samples" href="samples/index.html"/>
<jpetstore label="Petstore" href="jpetstore.html"/>
- <dash label="Petstore Dashboard" href="wsm/sample_Dashboard.html"/>
+ <!--<dash label="Petstore Dashboard"
href="wsm/sample_Dashboard.html"/>-->
<address label="AddressBook" href="wsm/sample_AddressBook.html"/>
<db label="Database Control"
href="controls/sample_controls-db.html"/>
<control-blank label="Page Flow Project"
href="pageflow/sample_netui-blank.html"/>
@@ -54,7 +55,7 @@
<netui label="Page Flows">
<netui_taglib label="<netui> Tags"
href="apidocs/taglib/index.html"/>
<netui_annotations label="@Jpf Annotations"
href="pageflow/jpf-annotations/pageflow_annotations.html"/>
- <netui_config label="netui-config.xml"
href="pageflow/config/netui-config.html"/>
+ <netui_config label="beehive-netui-config.xml"
href="pageflow/config/beehive-netui-config.html"/>
<netui_api label="Page Flow Javadoc"
href="apidocs/classref_pageflows/index.html"/>
</netui>
<ws label="Web Services">
