From richfaces-svn-commits at lists.jboss.org Mon Apr 13 13:56:33 2009
Content-Type: multipart/mixed; boundary="===============1537625739352992978=="
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: r13542 -
 trunk/docs/userguide/en/src/main/docbook/modules.
Date: Mon, 13 Apr 2009 13:56:33 -0400
Message-ID: <E1LtQOX-00005M-MA@committer01.frg.pub.inap.atl.jboss.com>

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

Author: msorokin
Date: 2009-04-13 13:56:33 -0400 (Mon, 13 Apr 2009)
New Revision: 13542

Modified:
   trunk/docs/userguide/en/src/main/docbook/modules/RFCarchitectover.xml
Log:
https://jira.jboss.org/jira/browse/RF-6557
rich:isUserInRole(Object) function is documented

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=
009-04-13 17:29:53 UTC (rev 13541)
+++ trunk/docs/userguide/en/src/main/docbook/modules/RFCarchitectover.xml	2=
009-04-13 17:56:33 UTC (rev 13542)
@@ -3766,4 +3766,24 @@
 				url=3D"http://livedemo.exadel.com/richfaces-demo/richfaces/stateAPI.js=
f?c=3DstateAPI"
 				>here</ulink>. </para>
 	</section>
+
+	<section>
+		<title>Identifing User Roles</title>
+		=

+		<para>RichFaces provides a function to check whether the logged-in user =
belongs to a certain <property>user role</property>. The function is <code>=
rich:isUserInRole(Object)</code>, it takes  a String, a comma-separated lis=
t String, Collection etc. as arguments and returns a boolean value.
+		</para>
+		<para>For example, you need to render some controls only for administrat=
ors.
+			To do this you need to create a  role &quot;admin&quot; in web.xml and =
implement authorisation that assigns the &quot;admin&quot; role to the user=
 that loggged-in as an administrator. Afterwards, you can use the <code>ric=
h:isUserInRole(Object)</code> function with the <emphasis><property>&quot;r=
endered&quot;</property></emphasis> attribute of any component.</para>
+		=

+		<para>
+			<emphasis role=3D"bold">Example:</emphasis>
+		</para>
+		<programlisting role=3D"XML"><![CDATA[...
+<rich:editor value=3D"#{bean.text}"  rendered=3D"#{rich:isUserInRole('admi=
n')}" />
+...]]></programlisting> =

+		=

+		<para>In the example above only a logged-in user with the role &quot;adm=
in&quot; can see the text editor while  for the user with other roles the c=
omponent will not be rendered.</para>
+		=

+	</section>
+	=

 </chapter>


--===============1537625739352992978==--