Author: steveh Date: Thu Jan 27 15:43:10 2005 New Revision: 128444 URL: http://svn.apache.org/viewcvs?view=rev&rev=128444 Log: Latest content for netui-config.xml topic. Modified: incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/config/netui-config.xml
Modified: incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/config/netui-config.xml Url: http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/config/netui-config.xml?view=diff&rev=128444&p1=incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/config/netui-config.xml&r1=128443&p2=incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/config/netui-config.xml&r2=128444 ============================================================================== --- incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/config/netui-config.xml (original) +++ incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/config/netui-config.xml Thu Jan 27 15:43:10 2005 @@ -5,7 +5,7 @@ <title>Reference Documentation: netui-config.xml File</title> </header> <body> - <section> + <section id="desc"> <title>Description</title> <p> The <code>netui-config.xml</code> file configures the runtime behavior of your Page Flow web @@ -14,35 +14,328 @@ <p>Use <code>netui-config.xml</code> to declare interceptor classes, override the default handler classes, etc.</p> </section> - <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><title><action-interceptor></title><p> Â </p></section> - <section><title><after-action></title><p> Â </p></section> - <section><title><before-action></title><p> Â </p></section> - <section><title><binding-context></title><p> Â </p></section> - <section><title><binding-contexts></title><p> Â </p></section> - <section><title><converter-class></title><p> Â </p></section> - <section><title><default-language></title><p> Â </p></section> - <section><title><description></title><p> Â </p></section> - <section><title><doctype></title><p> Â </p></section> - <section><title><enable-renesting></title><p> Â </p></section> - <section><title><ensure-secure-forwards></title><p> Â </p></section> - <section><title><exceptions-handler-class></title><p> Â </p></section> - <section><title><expression-language></title><p> Â </p></section> - <section><title><expression-languages></title><p> Â </p></section> - <section><title><factory-class></title><p> Â </p></section> - <section><title><forward-redirect-handler-class></title><p> Â </p></section> - <section><title><global></title><p> Â </p></section> - <section><title><id-javascript></title><p> Â </p></section> - <section><title><interceptor-class></title><p> Â </p></section> - <section><title><iterator-factories></title><p> Â </p></section> - <section><title><iterator-factory></title><p> Â </p></section> - <section><title><jsp-tag-config></title><p> Â </p></section> - <section><title><legacy-tag-support></title><p> Â </p></section> - <section><title><locator-class></title><p> Â </p></section> - <section><title><login-handler-class></title><p> Â </p></section> - - <section><title><max-forwards-per-request></title><p>If the number of server + <section id="action-interceptor"><title><action-interceptor></title> + <p><strong>Syntax</strong></p> + <source><action-interceptor> + <interceptor-class> xsd:string </interceptor-class> [occurences: 1] + <custom-property> + <name> xsd:string </name> [occurences: 1] + <value> xsd:string </value> [occurences: 1] + </custom-property> [occurences: 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> [occurences: 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> [occurences: 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="before-action"><title><before-action></title> + <p><strong>Syntax</strong></p> + <source></source> + <p><strong>Parents:</strong></p> + <p></p> + <p><strong>Children:</strong></p> + <p></p></section> + <section id="binding-context"><title><binding-context></title> + <p><strong>Syntax</strong></p> + <source><binding-context> [occurences: 0-*] + <name> xsd:string </name> [occurences: 1] + <factory-class> xsd:string </factory-class> [occurences: 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> [occurences: 0-1] + <binding-context> [occurences: 0-*] + <name> xsd:string </name> [occurences: 1] + <factory-class> xsd:string </factory-class> [occurences: 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> [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> [1] + <value> xsd:string </value> [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> [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> [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> [ default | legacy | legacyOnly ] </doctype> [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> [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><strong>Syntax</strong></p> + <source><ensure-secure-forwards> xsd:boolean </ensure-secure-forwards> [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><strong>Syntax</strong></p> + <source><exceptions-handler-class> xsd:string </exceptions-handler-class> [0..1]</source> + <p><strong>Parents:</strong></p> + <p></p> + <p><strong>Children:</strong></p> + <p></p></section> + <section id="expression-language"><title><expression-language></title> + <p><strong>Syntax</strong></p> + <source></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-languages"><title><expression-languages></title> + <p><strong>Syntax</strong></p> + <source><expression-languages> [1] + <default-language> xsd:string </default-language> [1] + <expression-language> [1..*] + <name> xsd:string </name> [1] + <factory-class> xsd:string </factory-class> [1] + <binding-contexts> binding-contexts </binding-contexts> [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> [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> [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> [0..1] + <simple-action-interceptor> + <intercept-path> xsd:string </intercept-path> [1] + <after-action> xsd:boolean </after-action> [0..1] + </simple-action-interceptor> [0..*] + <action-interceptor> + <interceptor-class> xsd:string </interceptor-class> [1] + <custom-property> + <name> xsd:string </name> [1] + <value> xsd:string </value> [1] + </custom-property> [0..*] + </action-interceptor> [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></source> + <p><strong>Parents:</strong></p> + <p></p> + <p><strong>Children:</strong></p> + <p></p></section> + <section id="interceptor-class"><title><interceptor-class></title> + <p><strong>Syntax</strong></p> + <source><id-javascript> [ default | legacy | legacyOnly ] <id-javascript> [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="intercept-path"><title><intercept-path></title> + <p><strong>Syntax</strong></p> + <source></source> + <p><strong>Parents:</strong></p> + <p></p> + <p><strong>Children:</strong></p> + <p></p></section> + <section id="iterator-factories"><title><iterator-factories></title> + <p><strong>Syntax</strong></p> + <source></source> + <p><strong>Parents:</strong></p> + <p></p> + <p><strong>Children:</strong></p> + <p></p></section> + <section id="iterator-factory"><title><iterator-factory></title> + <p><strong>Syntax</strong></p> + <source></source> + <p><strong>Parents:</strong></p> + <p></p> + <p><strong>Children:</strong></p> + <p></p></section> + <section id="jsp-tag-config"><title><jsp-tag-config></title> + <p><strong>Syntax</strong></p> + <source></source> + <p><strong>Parents:</strong></p> + <p></p> + <p><strong>Children:</strong></p> + <p></p></section> + <section id="legacy-tag-support"><title><legacy-tag-support></title> + <p><strong>Syntax</strong></p> + <source></source> + <p><strong>Parents:</strong></p> + <p></p> + <p><strong>Children:</strong></p> + <p></p></section> + <section id="locator-class"><title><locator-class></title> + <p><strong>Syntax</strong></p> + <source></source> + <p><strong>Parents:</strong></p> + <p></p> + <p><strong>Children:</strong></p> + <p></p></section> + <section id="login-handler-class"><title><login-handler-class></title> + <p><strong>Syntax</strong></p> + <source></source> + <p><strong>Parents:</strong></p> + <p></p> + <p><strong>Children:</strong></p> + <p></p></section> + <section id="max-forwards-per-request"><title><max-forwards-per-request></title> + <p><strong>Syntax</strong></p> + <source></source> + <p><strong>Parents:</strong></p> + <p></p> + <p><strong>Children:</strong></p> + <p></p> + <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> @@ -74,8 +367,14 @@ </netui-config> ]]></source> </section> - - <section><title><max-nesting-stack-depth></title><p> + <section id="max-nesting-stack-depth"><title><max-nesting-stack-depth></title> + <p><strong>Syntax</strong></p> + <source></source> + <p><strong>Parents:</strong></p> + <p></p> + <p><strong>Children:</strong></p> + <p></p> + <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. @@ -96,10 +395,28 @@ </netui-config> ]]></source> </section> - <!-- - <section><title><module-config-locator></title><p> Â </p></section> - <section><title><module-config-locators></title><p> Â </p></section>--> - <section><title><multipart-handler></title><p> + <section id="module-config-locator"><title><module-config-locator></title> + <p><strong>Syntax</strong></p> + <source></source> + <p><strong>Parents:</strong></p> + <p></p> + <p><strong>Children:</strong></p> + <p></p></section> + <section id="module-config-locators"><title><module-config-locators></title> + <p><strong>Syntax</strong></p> + <source></source> + <p><strong>Parents:</strong></p> + <p></p> + <p><strong>Children:</strong></p> + <p></p></section> + <section id="multipart-handler"><title><multipart-handler></title> + <p><strong>Syntax</strong></p> + <source></source> + <p><strong>Parents:</strong></p> + <p></p> + <p><strong>Children:</strong></p> + <p></p> + <p> To disable file upload, set the value to "none". [todo: other values include memory, ?, ...]</p> <p><strong>Example:</strong></p> @@ -115,18 +432,37 @@ ... </netui-config> ]]></source></section> - <section><title><name></title><p> Â </p></section> - <section> + <section id="name"><title><name></title> + <p><strong>Syntax</strong></p> + <source></source> + <p><strong>Parents:</strong></p> + <p></p> + <p><strong>Children:</strong></p> + <p></p></section> + <section id="netui-config"> <title><netui-config></title> - <p> + <p><strong>Syntax</strong></p> + <source></source> + <p><strong>Parents:</strong></p> + <p></p> + <p><strong>Children:</strong></p> + <p></p> + <p> This is just the place for settings that configure 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> + <section id="pageflow-action-interceptors"> <title><pageflow-action-interceptors></title> + + <p><strong>Description</strong></p> + <p> [todo] Â </p> + <p><strong>Syntax</strong></p> + <p><code> [todo] </code></p> + <p><strong>Hierarchy</strong></p> + <p><code> [todo] </code></p> <p> If you want to be notified before (or after) every action that's run in the webapp, @@ -159,17 +495,29 @@ <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> </section> - <section> + <section id="pageflow-config"> <title><pageflow-config></title> - <p> -This is just the place for settings that configure the page flow + <p><strong>Syntax</strong></p> + <source></source> + <p><strong>Parents:</strong></p> + <p></p> + <p><strong>Children:</strong></p> + <p></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> + <section id="pageflow-handlers"> <title><pageflow-handlers></title> - <p> + <p><strong>Syntax</strong></p> + <source></source> + <p><strong>Parents:</strong></p> + <p></p> + <p><strong>Children:</strong></p> + <p></p> + <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 @@ -180,13 +528,90 @@ </p> </section> -<section><title><reloadable-class-handler-class></title><p> Â </p></section> -<section><title><throw-session-expired-exception></title><p> Â </p></section> -<section><title><tree-image-location></title><p> Â </p></section> -<section><title><type></title><p> Â </p></section> -<section><title><type-converter></title><p> Â </p></section> -<section><title><type-converters></title><p> Â </p></section> - +<section id="pageflow-uri"><title><pageflow-uri></title> + <p><strong>Syntax</strong></p> + <source></source> + <p><strong>Parents:</strong></p> + <p></p> + <p><strong>Children:</strong></p> + <p></p></section> +<section id="per-action"><title><per-action></title> + <p><strong>Syntax</strong></p> + <source></source> + <p><strong>Parents:</strong></p> + <p></p> + <p><strong>Children:</strong></p> + <p></p></section> +<section id="per-pageflow"><title><per-pageflow></title> + <p><strong>Syntax</strong></p> + <source></source> + <p><strong>Parents:</strong></p> + <p></p> + <p><strong>Children:</strong></p> + <p></p></section> +<section id="reloadable-class-handler-class"><title><reloadable-class-handler-class></title> + <p><strong>Syntax</strong></p> + <source></source> + <p><strong>Parents:</strong></p> + <p></p> + <p><strong>Children:</strong></p> + <p></p></section> +<section id="request-interceptors"><title><request-interceptors></title> + <p><strong>Syntax</strong></p> + <source></source> + <p><strong>Parents:</strong></p> + <p></p> + <p><strong>Children:</strong></p> + <p></p></section> +<section id="simple-action-interceptor"><title><simple-action-interceptor></title> + <p><strong>Syntax</strong></p> + <source></source> + <p><strong>Parents:</strong></p> + <p></p> + <p><strong>Children:</strong></p> + <p></p></section> +<section id="throw-session-expired-exception"><title><throw-session-expired-exception></title> + <p><strong>Syntax</strong></p> + <source></source> + <p><strong>Parents:</strong></p> + <p></p> + <p><strong>Children:</strong></p> + <p></p></section> +<section id="tree-image-location"><title><tree-image-location></title> + <p><strong>Syntax</strong></p> + <source></source> + <p><strong>Parents:</strong></p> + <p></p> + <p><strong>Children:</strong></p> + <p></p></section> +<section id="type"><title><type></title> + <p><strong>Syntax</strong></p> + <source></source> + <p><strong>Parents:</strong></p> + <p></p> + <p><strong>Children:</strong></p> + <p></p></section> +<section id="type-converter"><title><type-converter></title> + <p><strong>Syntax</strong></p> + <source></source> + <p><strong>Parents:</strong></p> + <p></p> + <p><strong>Children:</strong></p> + <p></p></section> +<section id="type-converters"><title><type-converters></title> + <p><strong>Syntax</strong></p> + <source></source> + <p><strong>Parents:</strong></p> + <p></p> + <p><strong>Children:</strong></p> + <p></p></section> + <section id="value"><title><value></title> + <p><strong>Syntax</strong></p> + <source></source> + <p><strong>Parents:</strong></p> + <p></p> + <p><strong>Children:</strong></p> + <p></p></section> </section> <section> <title>Example</title>
