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

[Shane Bryzak]

  User: sbryzak2
  Date: 07/11/07 03:56:24

  Modified:    doc/reference/en/modules  security.xml
  Log:
  documented security events
  
  Revision  Changes    Path
  1.80      +165 -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.79
  retrieving revision 1.80
  diff -u -b -r1.79 -r1.80
  --- security.xml	6 Nov 2007 09:15:53 -0000	1.79
  +++ security.xml	7 Nov 2007 08:56:24 -0000	1.80
  @@ -496,6 +496,17 @@
           <colspec colnum="1" colwidth="1*" />
           <colspec colnum="2" colwidth="3*" />
     
  +        <thead>
  +          <row>
  +            <entry align="center">
  +              <para>Message Key</para>
  +            </entry>
  +            <entry align="center">
  +              <para>Description</para>
  +            </entry>
  +          </row>
  +        </thead>          
  +  
           <tbody>
     
             <row>
  @@ -1315,4 +1326,158 @@
       
     </sect1>
   
  +  <sect1>
  +    <title>Security Events</title>
  +    
  +    <para>
  +      The following table describes a number of events (see <xref linkend="events"/>) raised by Seam Security.
  +    </para>
  +    
  +    <table>
  +      <title>Security Events</title>
  +  
  +      <tgroup cols="2">
  +        <colspec colnum="1" colwidth="1*" />
  +        <colspec colnum="2" colwidth="3*" />
  +        
  +        <thead>
  +          <row>
  +            <entry align="center">
  +              <para>Event Key</para>
  +            </entry>
  +            <entry align="center">
  +              <para>Description</para>
  +            </entry>
  +          </row>
  +        </thead>        
  +  
  +        <tbody>
  +  
  +          <row>
  +            <entry>
  +              <para>
  +                <literal>org.jboss.seam.security.initIdentity</literal>
  +              </para>
  +            </entry>    
  +            <entry>
  +              <para>
  +                Raised when the Identity component is created.
  +              </para>
  +            </entry>
  +          </row>
  +          <row>
  +            <entry>
  +              <para>
  +                <literal>org.jboss.seam.security.loginSuccessful</literal>
  +              </para>
  +            </entry>    
  +            <entry>
  +              <para>
  +                Raised when a login attempt is successful.
  +              </para>
  +            </entry>
  +          </row>
  +          <row>
  +            <entry>
  +              <para>
  +                <literal>org.jboss.seam.security.loginFailed</literal>
  +              </para>
  +            </entry>    
  +            <entry>
  +              <para>
  +                Raised when a login attempt fails.
  +              </para>
  +            </entry>
  +          </row>
  +          <row>
  +            <entry>
  +              <para>
  +                <literal>org.jboss.seam.security.notLoggedIn</literal>
  +              </para>
  +            </entry>    
  +            <entry>
  +              <para>
  +                Raised when a security check fails when the user is not logged in.
  +              </para>
  +            </entry>
  +          </row>     
  +          <row>
  +            <entry>
  +              <para>
  +                <literal>org.jboss.seam.security.notAuthorized</literal>
  +              </para>
  +            </entry>    
  +            <entry>
  +              <para>
  +                Raised when a security check fails when the user is logged in however doesn't have sufficient privileges.
  +              </para>
  +            </entry>
  +          </row>                
  +          <row>
  +            <entry>
  +              <para>
  +                <literal>org.jboss.seam.security.preAuthenticate</literal>
  +              </para>
  +            </entry>    
  +            <entry>
  +              <para>
  +                Raised just prior to user authentication.
  +              </para>
  +            </entry>
  +          </row>            
  +          <row>
  +            <entry>
  +              <para>
  +                <literal>org.jboss.seam.security.postAuthenticate</literal>
  +              </para>
  +            </entry>    
  +            <entry>
  +              <para>
  +                Raised just after user authentication.
  +              </para>
  +            </entry>
  +          </row>             
  +          <row>
  +            <entry>
  +              <para>
  +                <literal>org.jboss.seam.security.loggedOut</literal>
  +              </para>
  +            </entry>    
  +            <entry>
  +              <para>
  +                Raised after the user has logged out.
  +              </para>
  +            </entry>
  +          </row>            
  +          <row>
  +            <entry>
  +              <para>
  +                <literal>org.jboss.seam.security.credentialsUpdated</literal>
  +              </para>
  +            </entry>    
  +            <entry>
  +              <para>
  +                Raised when the user's credentials have been changed.
  +              </para>
  +            </entry>
  +          </row>        
  +          <row>
  +            <entry>
  +              <para>
  +                <literal>org.jboss.seam.security.rememberMe</literal>
  +              </para>
  +            </entry>    
  +            <entry>
  +              <para>
  +                Raised when the Identity's rememberMe property is changed.
  +              </para>
  +            </entry>
  +          </row>               
  +         
  +        </tbody>
  +      </tgroup>
  +    </table>    
  +    
  +  </sect1>
  +
   </chapter>