[jboss-cvs] JBossAS SVN: r58755 - in projects/security/security-spi/trunk/src/main/org/jboss/security: . audit

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

Author: anil.saldhana at jboss.com
Date: 2006-11-29 17:15:40 -0500 (Wed, 29 Nov 2006)
New Revision: 58755

Modified:
   projects/security/security-spi/trunk/src/main/org/jboss/security/AuthenticationManager.java
   projects/security/security-spi/trunk/src/main/org/jboss/security/AuthorizationManager.java
   projects/security/security-spi/trunk/src/main/org/jboss/security/audit/AuditEvent.java
   projects/security/security-spi/trunk/src/main/org/jboss/security/audit/AuditProvider.java
   projects/security/security-spi/trunk/src/main/org/jboss/security/audit/SecurityAuditManager.java
Log:
update javadoc

Modified: projects/security/security-spi/trunk/src/main/org/jboss/security/AuthenticationManager.java
===================================================================
--- projects/security/security-spi/trunk/src/main/org/jboss/security/AuthenticationManager.java	2006-11-29 22:10:48 UTC (rev 58754)
+++ projects/security/security-spi/trunk/src/main/org/jboss/security/AuthenticationManager.java	2006-11-29 22:15:40 UTC (rev 58755)
@@ -30,6 +30,7 @@
  * associated with principals.
  *      
  * @author Scott.Stark at jboss.org
+ * @author Anil.Saldhana at jboss.org
  * @version $Revision$
  */
 public interface AuthenticationManager
@@ -99,7 +100,7 @@
     * @param contextMap Any context information (including information on the other domain 
     *                   that may be relevant in deriving the target principal). Any SAML 
     *                   assertions that may be relevant can be passed here.
-    * @return
+    * @return principal from a target security domain
     */
    Principal getTargetPrincipal(Principal anotherDomainPrincipal, Map contextMap);
 }

Modified: projects/security/security-spi/trunk/src/main/org/jboss/security/AuthorizationManager.java
===================================================================
--- projects/security/security-spi/trunk/src/main/org/jboss/security/AuthorizationManager.java	2006-11-29 22:10:48 UTC (rev 58754)
+++ projects/security/security-spi/trunk/src/main/org/jboss/security/AuthorizationManager.java	2006-11-29 22:15:40 UTC (rev 58755)
@@ -41,8 +41,7 @@
  *  @version $Revision$
  */
 public interface AuthorizationManager 
-{ 
-   
+{  
    /**
     * Authorize a resource
     * @param resource
@@ -78,7 +77,7 @@
     * @param targetPrincipal Principal applicable in current domain
     * @param contextMap Read-Only Contextual Information that may be useful for the
     *             implementation in determining the roles. 
-    * @return
+    * @return roles from the target domain
     */
    public Group getTargetRoles(Principal targetPrincipal, Map contextMap);
  }

Modified: projects/security/security-spi/trunk/src/main/org/jboss/security/audit/AuditEvent.java
===================================================================
--- projects/security/security-spi/trunk/src/main/org/jboss/security/audit/AuditEvent.java	2006-11-29 22:10:48 UTC (rev 58754)
+++ projects/security/security-spi/trunk/src/main/org/jboss/security/audit/AuditEvent.java	2006-11-29 22:15:40 UTC (rev 58755)
@@ -28,26 +28,46 @@
       this.auditLevel = level;
    }
    
+   /**
+    * Return the Audit Level
+    * @return
+    */
    public String getAuditLevel()
    {
       return this.auditLevel;
    }
    
+   /**
+    * Get the Contextual Map
+    * @return Map that is final 
+    */
    public Map getContextMap()
    {
       return contextMap;
    }
    
+   /**
+    * Set a non-modifiable Context Map
+    * @param cmap Map that is final
+    */
    public void setContextMap(final Map cmap)
    {
       this.contextMap = cmap;
    }
    
+   /**
+    * Get the Exception part of the audit
+    * @return
+    */
    public Exception getUnderlyingException()
    {
       return underlyingException;
    }
 
+   /**
+    * Set the exception on which an audit is happening
+    * @param underlyingException
+    */
    public void setUnderlyingException(Exception underlyingException)
    {
       this.underlyingException = underlyingException;

Modified: projects/security/security-spi/trunk/src/main/org/jboss/security/audit/AuditProvider.java
===================================================================
--- projects/security/security-spi/trunk/src/main/org/jboss/security/audit/AuditProvider.java	2006-11-29 22:10:48 UTC (rev 58754)
+++ projects/security/security-spi/trunk/src/main/org/jboss/security/audit/AuditProvider.java	2006-11-29 22:15:40 UTC (rev 58755)
@@ -19,6 +19,7 @@
     * Perform an audit of the event passed
     * A provider can log the audit as per needs.
     * @param ae audit event that holds information on the audit
+    * @see AuditEvent
     */
   public void audit(AuditEvent ae);
 }

Modified: projects/security/security-spi/trunk/src/main/org/jboss/security/audit/SecurityAuditManager.java
===================================================================
--- projects/security/security-spi/trunk/src/main/org/jboss/security/audit/SecurityAuditManager.java	2006-11-29 22:10:48 UTC (rev 58754)
+++ projects/security/security-spi/trunk/src/main/org/jboss/security/audit/SecurityAuditManager.java	2006-11-29 22:15:40 UTC (rev 58755)
@@ -32,6 +32,7 @@
    /**
     * Audit the information available in the audit event
     * @param ae the Audit Event
+    * @see AuditEvent
     */
    public void audit(AuditEvent ae);
 }