svn commit: r604891 - in /lenya/branches/branch_1_2_x_shibboleth/src/java/org/apache/lenya/ac: AttributeOwner.java AttributeRuleEvaluator.java

Author: andreas
Date: Mon Dec 17 07:16:39 2007
New Revision: 604891

URL: http://svn.apache.org/viewvc?rev=604891&view=rev
Log:
Added some javadoc comments.

Modified:
    lenya/branches/branch_1_2_x_shibboleth/src/java/org/apache/lenya/ac/AttributeOwner.java
    lenya/branches/branch_1_2_x_shibboleth/src/java/org/apache/lenya/ac/AttributeRuleEvaluator.java

Modified: lenya/branches/branch_1_2_x_shibboleth/src/java/org/apache/lenya/ac/AttributeOwner.java
URL: http://svn.apache.org/viewvc/lenya/branches/branch_1_2_x_shibboleth/src/java/org/apache/lenya/ac/AttributeOwner.java?rev=604891&r1=604890&r2=604891&view=diff
==============================================================================
--- lenya/branches/branch_1_2_x_shibboleth/src/java/org/apache/lenya/ac/AttributeOwner.java (original)
+++ lenya/branches/branch_1_2_x_shibboleth/src/java/org/apache/lenya/ac/AttributeOwner.java Mon Dec 17 07:16:39 2007
@@ -18,7 +18,11 @@
 package org.apache.lenya.ac;
 
 /**
- * Attribute owner.
+ * An attribute owner provides a map of key-value pairs which are used for authorization decisions.
+ * The values are string arrays, i.e. the AttributeOwner can provide multiple values for each key.
+ * 
+ * @see Group#matches(AttributeOwner)
+ * @see AttributeRuleEvaluator
  */
 public interface AttributeOwner {
 
@@ -29,8 +33,8 @@
 
     /**
      * @param name The attribute name.
-     * @return The attribute values or <code>null</code> if no value is
-     *         available for the attribute.
+     * @return The attribute values or <code>null</code> if no value is available for the
+     *         attribute.
      * @throws AccessControlException if the attribute is not supported.
      */
     String[] getAttributeValues(String name) throws AccessControlException;

Modified: lenya/branches/branch_1_2_x_shibboleth/src/java/org/apache/lenya/ac/AttributeRuleEvaluator.java
URL: http://svn.apache.org/viewvc/lenya/branches/branch_1_2_x_shibboleth/src/java/org/apache/lenya/ac/AttributeRuleEvaluator.java?rev=604891&r1=604890&r2=604891&view=diff
==============================================================================
--- lenya/branches/branch_1_2_x_shibboleth/src/java/org/apache/lenya/ac/AttributeRuleEvaluator.java (original)
+++ lenya/branches/branch_1_2_x_shibboleth/src/java/org/apache/lenya/ac/AttributeRuleEvaluator.java Mon Dec 17 07:16:39 2007
@@ -27,13 +27,15 @@
     /**
      * @param user The user.
      * @param rule The rule.
-     * @return if the rule is complied.
+     * @return if the rule is complied by the user's attributes.
      */
     public boolean isComplied(AttributeOwner user, String rule);
 
     /**
      * @param rule The rule to validate.
-     * @return If the rule is valid.
+     * @return If the rule is valid, i.e. if it is syntactically correct and doesn't reference any
+     *         attributes which are not supported by the {@link AttributeDefinition} that is
+     *         provided by the {@link AttributeDefinitionRegistry}.
      */
     public ValidationResult validate(String rule);