Moved over some of the security stuff from Photos.
[utils] / security / src / main / java / org / wamblee / security / authorization / AuthorizationService.java
1 /*
2  * Copyright 2005 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
17 package org.wamblee.security.authorization;
18
19 import org.wamblee.persistence.Persistent;
20
21 /**
22  * Service to determine if access to a certain resource is allowed. 
23  */
24 public interface AuthorizationService extends Persistent {
25
26     /**
27      * Checks whether an operation is allowed on a resource. 
28      * @param aResource Resource. 
29      * @param aOperation Operation. 
30      * @return Checks whether the operation is allowed on a resource. 
31      */
32     boolean isAllowed(Object aResource, Operation aOperation);
33     
34     /**
35      * Same as {@link #isAllowed(Object, Operation)} but throws a 
36      * <code>RuntimeException</code> in case access is not allowed. 
37      * @param aResource Resource to check. 
38      * @param aOperation Operation to perform.
39      * @return Resource that was checked. 
40      */
41     <T> T check(T aResource, Operation aOperation); 
42     
43     /**
44      * Gets the authorization rules. 
45      * @return Rules. 
46      */
47     AuthorizationRule[] getRules(); 
48     
49     /**
50      * Appends a new authorization rule to the end. 
51      * @param aRule Rule to append. 
52      */
53     void appendRule(AuthorizationRule aRule); 
54     
55     /**
56      * Removes a rule. 
57      * @param aRule Index of the rule to remove.  
58      */
59     void removeRule(int aIndex); 
60         
61     /**
62      * Inserts a rule. 
63      * @param aIndex Index of the position of the rule after insertion. 
64      * @param aRule Rule to insert. 
65      */
66     void insertRuleAfter(int aIndex, AuthorizationRule aRule);
67 }