[jboss-cvs] JBossAS SVN: r100370 - projects/security/picketbox/trunk/picketbox/src/main/java/org/picketbox/plugins/authorization.

[jboss-cvs-commits at lists.jboss.org]

Author: anil.saldhana at jboss.com
Date: 2010-02-03 13:34:39 -0500 (Wed, 03 Feb 2010)
New Revision: 100370

Modified:
   projects/security/picketbox/trunk/picketbox/src/main/java/org/picketbox/plugins/authorization/PicketBoxAuthorizationModule.java
Log:
update javadoc

Modified: projects/security/picketbox/trunk/picketbox/src/main/java/org/picketbox/plugins/authorization/PicketBoxAuthorizationModule.java
===================================================================
--- projects/security/picketbox/trunk/picketbox/src/main/java/org/picketbox/plugins/authorization/PicketBoxAuthorizationModule.java	2010-02-03 18:32:52 UTC (rev 100369)
+++ projects/security/picketbox/trunk/picketbox/src/main/java/org/picketbox/plugins/authorization/PicketBoxAuthorizationModule.java	2010-02-03 18:34:39 UTC (rev 100370)
@@ -39,8 +39,37 @@
 import org.jboss.security.identity.RoleGroup;
 
 /**
+ * <p>
  * Simple Authorization Module that authorizes users with
  * the configured roles
+ * <b>Note:</b>The roles need to be placed as a comma separated list of values.
+ * </p>
+ * <p>
+ * Example:
+ * </p>
+ * <p>
+ * &lt;policy xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
+         xsi:schemaLocation="urn:jboss:security-config:5.0"
+         xmlns="urn:jboss:security-config:5.0"
+         xmlns:jbxb="urn:jboss:security-config:5.0"&gt;<br/>
+     &lt;application-policy name = "test"&gt; <br/>
+         &lt;authentication&gt;<br/>
+            &lt;login-module code = "org.jboss.security.auth.spi.UsersRolesLoginModule"
+               flag = "required"&gt;<br/> 
+               &lt;module-option name = "name"&gt;1.1&lt;/module-option&gt;<br/>
+               &lt;module-option name = "succeed"&gt;true&lt;/module-option&gt;<br/>
+               &lt;module-option name = "throwEx"&gt;false&lt;/module-option&gt; <br/>
+            &lt;/login-module&gt; <br/>
+         &lt;/authentication&gt; <br/>
+         &lt;authorization&gt;<br/>
+           &lt;policy-module <br/>
+              code="org.picketbox.plugins.authorization.PicketBoxAuthorizationModule"&gt;<br/>
+              &lt;module-option name="roles"&gt;validuser&lt;/module-option&gt;<br/>
+            &lt;/policy-module&gt;<br/>
+         &lt;/authorization&gt;<br/>
+      &lt;/application-policy&gt;  <br/>
+   &lt;/policy&gt; <br/>
+</p>
  * <a href="mailto:anil.saldhana at redhat.com>Anil Saldhana</a>
  */
 public class PicketBoxAuthorizationModule implements AuthorizationModule