new utility for updated cached values in a multi-threaded environment.
[utils] / security / impl / src / main / java / org / wamblee / security / authorization / AuthorizationRule.java
1 /*
2  * Copyright 2005-2010 the original author or authors.
3  * 
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  * 
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  * 
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package org.wamblee.security.authorization;
17
18 import org.wamblee.security.authentication.User;
19 import org.wamblee.security.authentication.UserAdministration;
20
21 /**
22  * Represents an authorization rule to determine whether an operation is allowed
23  * on a resource.
24  * 
25  * @author Erik Brakkee
26  */
27 public interface AuthorizationRule {
28     
29     /**
30      * Sets the user admnistration to use. 
31      * @param aAdmin User administration. 
32      */
33     void setUserAdministration(UserAdministration aAdmin); 
34
35     /**
36      * Returns the supported object types for which this authorization rule
37      * applies. This can be used by the authorization service for optimization.
38      * 
39      * @return Array of supported types.
40      */
41     Class[] getSupportedTypes();
42
43     /**
44      * Determines whether an operation is allowed on a certain resource. The
45      * rule implementation must be prepared to deal with resources for which it
46      * does not apply. In those cases it should return
47      * {@link AuthorizationResult#UNSUPPORTED_RESOURCE}.
48      * 
49      * @param aResource
50      *            Resource.
51      * @param aOperation
52      *            Operation.
53      * @param aUser
54      *            Current user.
55      * 
56      * @return Authorization result.
57      */
58     AuthorizationResult isAllowed(Object aResource,
59         Operation aOperation, String aUser);
60
61 }