[jboss-cvs] jboss-seam/doc/reference/en/modules ...

[Shane Bryzak]

  User: sbryzak2
  Date: 07/07/09 20:49:43

  Modified:    doc/reference/en/modules  security.xml
  Log:
  JBSEAM-1618 document Identity.addRole()
  
  Revision  Changes    Path
  1.69      +25 -0     jboss-seam/doc/reference/en/modules/security.xml
  
  (In the diff below, changes in quantity of whitespace are not shown.)
  
  Index: security.xml
  ===================================================================
  RCS file: /cvsroot/jboss/jboss-seam/doc/reference/en/modules/security.xml,v
  retrieving revision 1.68
  retrieving revision 1.69
  diff -u -b -r1.68 -r1.69
  --- security.xml	26 Jun 2007 23:10:44 -0000	1.68
  +++ security.xml	10 Jul 2007 00:49:43 -0000	1.69
  @@ -204,6 +204,31 @@
           authentication method returns <literal>false</literal> to indicate the authentication failed.
         </para>
   
  +      <sect3>
  +        <title>Identity.addRole()</title>
  +        
  +        <para>
  +          The <literal>Identity.addRole()</literal> method behaves differently depending on whether the current
  +          session is authenticated or not.  If the session is not authenticated, then <literal>addRole()</literal> 
  +          should <emphasis>only</emphasis> be called during the authentication process.  When called here, the
  +          role name is placed into a temporary list of pre-authenticated roles.  Once authentication is successful,
  +          the pre-authenticated roles then become "real" roles, and calling <literal>Identity.hasRole()</literal>
  +          for those roles will then return true.  The following sequence diagram represents the list of pre-authenticated
  +          roles as a first class object to show more clearly how it fits in to the authentication process.
  +        
  +        </para>
  +        
  +        <mediaobject>
  +          <imageobject role="fo">
  +            <imagedata fileref="images/security-addrole.png" align="center"/>
  +          </imageobject>
  +          <imageobject role="html">
  +            <imagedata fileref="../shared/images/security-addrole.png" align="center"/>
  +          </imageobject>
  +        </mediaobject>        
  +        
  +      </sect3>
  +
       </sect2>
   
       <sect2>