X-Git-Url: http://wamblee.org/gitweb/?a=blobdiff_plain;f=security%2Fsrc%2Fmain%2Fjava%2Forg%2Fwamblee%2Fsecurity%2Fauthorization%2FAuthorizationRule.java;h=8aab974ada61eae9acae7869091c6b554c4c9ed4;hb=17775e14ecfb286e59f67117e5cee7e21e95ab1f;hp=8c17b7f347dd0b5e53e5e8a00049f25c11ffd207;hpb=162af365e45e54e5e8d656be276914df2005eaec;p=utils

diff --git a/security/src/main/java/org/wamblee/security/authorization/AuthorizationRule.java b/security/src/main/java/org/wamblee/security/authorization/AuthorizationRule.java
index 8c17b7f3..8aab974a 100644
--- a/security/src/main/java/org/wamblee/security/authorization/AuthorizationRule.java
+++ b/security/src/main/java/org/wamblee/security/authorization/AuthorizationRule.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2005 the original author or authors.
+ * Copyright 2005-2010 the original author or authors.
  * 
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -13,32 +13,42 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */ 
-
 package org.wamblee.security.authorization;
 
 import org.wamblee.persistence.Persistent;
+
 import org.wamblee.usermgt.User;
 
 /**
- * Represents an authorization rule to determine whether an operation is allowed on a resource. 
+ * Represents an authorization rule to determine whether an operation is allowed
+ * on a resource.
+ * 
+ * @author Erik Brakkee
  */
 public interface AuthorizationRule extends Persistent {
-    
     /**
-     * Returns the supported object types for which this authorization rule applies.
-     * This can be used by the authorization service for optimization.  
-     * @return Array of supported types. 
+     * Returns the supported object types for which this authorization rule
+     * applies. This can be used by the authorization service for optimization.
+     * 
+     * @return Array of supported types.
      */
     Class[] getSupportedTypes();
 
     /**
-     * Determines whether an operation is allowed on a certain resource. 
-     * The rule implementation must be prepared to deal with resources for which it does
-     * not apply. In those cases it should return {@link AuthorizationResult#UNSUPPORTED_RESOURCE}. 
-     * @param aResource Resource. 
-     * @param anOperation Operation. 
-     * @param aUser Current user.  
-     * @return Authorization result. 
+     * Determines whether an operation is allowed on a certain resource. The
+     * rule implementation must be prepared to deal with resources for which it
+     * does not apply. In those cases it should return
+     * {@link AuthorizationResult#UNSUPPORTED_RESOURCE}.
+     * 
+     * @param aResource
+     *            Resource.
+     * @param anOperation
+     *            Operation.
+     * @param aUser
+     *            Current user.
+     * 
+     * @return Authorization result.
      */
-    AuthorizationResult isAllowed(Object aResource, Operation anOperation, User aUser);
+    AuthorizationResult isAllowed(Object aResource, Operation anOperation,
+        User aUser);
 }