(no commit message)

[utils] / security / usermgt / src / main / java / org / wamblee / security / authorization / AuthorizationRule.java

diff --git a/security/usermgt/src/main/java/org/wamblee/security/authorization/AuthorizationRule.java b/security/usermgt/src/main/java/org/wamblee/security/authorization/AuthorizationRule.java
new file mode 100644 (file)
index 0000000..37ce1c8
--- /dev/null
+++ b/security/usermgt/src/main/java/org/wamblee/security/authorization/AuthorizationRule.java
@@ -0,0 +1,60 @@
+/*
+ * 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.
+ * You may obtain a copy of the License at
+ * 
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.wamblee.security.authorization;
+
+import org.wamblee.security.authentication.UserAdministration;
+
+/**
+ * Represents an authorization rule to determine whether an operation is allowed
+ * on a resource.
+ * 
+ * @author Erik Brakkee
+ */
+public interface AuthorizationRule {
+    
+    /**
+     * Sets the user admnistration to use. 
+     * @param aAdmin User administration. 
+     */
+    void setUserAdministration(UserAdministration aAdmin); 
+
+    /**
+     * 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 aOperation
+     *            Operation.
+     * @param aUser
+     *            Current user.
+     * 
+     * @return Authorization result.
+     */
+    AuthorizationResult isAllowed(Object aResource,
+        Operation aOperation, String aUser);
+
+}
\ No newline at end of file