From richfaces-svn-commits at lists.jboss.org Mon Sep 29 06:49:27 2008
Content-Type: multipart/mixed; boundary="===============3474815665194439686=="
MIME-Version: 1.0
From: richfaces-svn-commits at lists.jboss.org
To: richfaces-svn-commits at lists.jboss.org
Subject: [richfaces-svn-commits] JBoss Rich Faces SVN: r10593 - in trunk/docs:
 userguide/en/src/main/docbook/modules and 1 other directory.
Date: Mon, 29 Sep 2008 06:49:27 -0400
Message-ID: <E1KkGJj-0003l0-Kz@committer01.frg.pub.inap.atl.jboss.com>

--===============3474815665194439686==
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable

Author: artdaw
Date: 2008-09-29 06:49:27 -0400 (Mon, 29 Sep 2008)
New Revision: 10593

Modified:
   trunk/docs/faq/en/src/main/docbook/module/RFCfaq.xml
   trunk/docs/userguide/en/src/main/docbook/modules/RFCarchitectover.xml
Log:
https://jira.jboss.org/jira/browse/RF-3117 - info about Request Errors and =
Session Expiration Handling was added to the Dev.Guide and FAQ =


Modified: trunk/docs/faq/en/src/main/docbook/module/RFCfaq.xml
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- trunk/docs/faq/en/src/main/docbook/module/RFCfaq.xml	2008-09-29 09:18:4=
2 UTC (rev 10592)
+++ trunk/docs/faq/en/src/main/docbook/module/RFCfaq.xml	2008-09-29 10:49:2=
7 UTC (rev 10593)
@@ -2608,6 +2608,62 @@
 </context-param>
 ...]]></programlisting>
           </section>
+          <section id=3D"sessionExpiredHandling">
+                    <?dbhtml filename=3D"sessionExpiredHandling.html"?>
+                    <title>How to handle Request Errors and Session Expira=
tion?</title>
+                    <para> =

+                   	In order to redefine standard handlers responsible for=
 processing of different exceptional situations =

+                    you should take the following steps:
+                    </para>
+                    <itemizedlist>
+                    	<listitem>
+                    		<para>
+                    			add to your <property>web.xml</property> the follow=
ing code:		=

+                    		</para>
+                 	        <programlisting role=3D"XML"><![CDATA[...
+<context-param>
+	<param-name>org.ajax4jsf.handleViewExpiredOnClient</param-name>
+	<param-value>true</param-value>
+</context-param> =

+...]]></programlisting>
+                    	</listitem>
+                    	<listitem>
+                    		<para>
+                    			add custom <emphasis><property>&quot;onError&quot;<=
/property></emphasis>, <emphasis><property>&quot;onExpire&quot;</property><=
/emphasis> handlers: =

+                    		</para>
+                   	        <programlisting role=3D"Java"><![CDATA[...
+A4J.AJAX.onError =3D function(req,status,message){
+	window.alert("Custom onError handler "+message);
+}
+A4J.AJAX.onExpired =3D function(loc,expiredMsg){
+	if(window.confirm("Custom onExpired handler "+expiredMsg+" for a location=
: "+loc)){
+		return loc;
+	} else {
+		return false;
+	}
+} =

+...]]></programlisting>
+							<para>
+								For the detailed description see =

+								the <ulink url=3D"http://www.jboss.org/file-access/default/members=
/jbossrichfaces/freezone/docs/devguide/en/html_single/index.html#RequestErr=
orsAndSessionExpirationHandling">Request Errors and Session Expiration Hand=
ling</ulink> section of the Developer Guide.
+							</para>
+                    	</listitem>
+                    </itemizedlist> =

+                <note>
+				<title>Note:</title>
+				<para>
+				Note that custom <emphasis><property>&quot;onError&quot;</property></e=
mphasis>, <emphasis><property>&quot;onExpire&quot;</property></emphasis> ha=
ndlers =

+				do not work under MyFaces. MyFaces handles exception by its internals =
generating debug page. =

+				You could use the following code to prevent such behavior:
+				</para>
+				<programlisting role=3D"XML"><![CDATA[...
+<context-param>
+	<param-name>org.apache.myfaces.ERROR_HANDLING</param-name>
+	<param-value>false</param-value>
+</context-param> =

+...]]></programlisting>
+			</note>
+          </section>
 	  <section id=3D"ajaxCookie">
                     <?dbhtml filename=3D"ajaxCookie.html"?>
                     <title>How to add cookie in an AJAX Respond?</title>

Modified: trunk/docs/userguide/en/src/main/docbook/modules/RFCarchitectover=
.xml
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- trunk/docs/userguide/en/src/main/docbook/modules/RFCarchitectover.xml	2=
008-09-29 09:18:42 UTC (rev 10592)
+++ trunk/docs/userguide/en/src/main/docbook/modules/RFCarchitectover.xml	2=
008-09-29 10:49:27 UTC (rev 10593)
@@ -1210,7 +1210,7 @@
 			<para> To execute your own code on the client in case of an error durin=
g Ajax request,
 				it&apos;s necessary to redefine the standard
 					<code>&quot;A4J.AJAX.onError&quot;</code> method: </para>
-			<programlisting role=3D"JAVA"><![CDATA[ A4J.AJAX.onError =3D function(r=
eq,status,message){
+			<programlisting role=3D"JAVA"><![CDATA[ A4J.AJAX.onError =3D function(r=
eq, status, message){
     window.alert("Custom onError handler "+message);
 }]]></programlisting>
 			<para> The function defined this way accepts as parameters: </para>
@@ -1245,7 +1245,7 @@
 			</para>
 =

 			<programlisting role=3D"JAVA">
-<![CDATA[A4J.AJAX.onExpired =3D function(loc,expiredMsg){
+<![CDATA[A4J.AJAX.onExpired =3D function(loc, expiredMsg){
     if(window.confirm("Custom onExpired handler "+expiredMsg+" for a locat=
ion: "+loc)){
       return loc;
     } else {
@@ -1267,6 +1267,20 @@
 						</emphasis> event. </para>
 				</listitem>
 			</itemizedlist>
+			<note>
+				<title>Note:</title>
+				<para>
+				Note that custom <emphasis><property>&quot;onError&quot;</property></e=
mphasis>, <emphasis><property>&quot;onExpire&quot;</property></emphasis> ha=
ndlers =

+				do not work under MyFaces. MyFaces handles exception by its internals =
generating debug page. =

+				You could use the following code to prevent such behavior:
+				</para>
+				<programlisting role=3D"XML"><![CDATA[...
+<context-param>
+	<param-name>org.apache.myfaces.ERROR_HANDLING</param-name>
+	<param-value>false</param-value>
+</context-param> =

+...]]></programlisting>
+			</note>
 			<!--note>
 				<title>Note:</title>
 				Until the version 1.0.5 the method can&apos;t be redefined on <emphasi=
s >


--===============3474815665194439686==--