Added author to all java files with class comments.
[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  * @author Erik Brakkee
25  */
26 public interface AuthorizationService extends Persistent {
27
28     /**
29      * Checks whether an operation is allowed on a resource. 
30      * @param aResource Resource. 
31      * @param aOperation Operation. 
32      * @return Checks whether the operation is allowed on a resource. 
33      */
34     boolean isAllowed(Object aResource, Operation aOperation);
35     
36     /**
37      * Same as {@link #isAllowed(Object, Operation)} but throws a 
38      * <code>RuntimeException</code> in case access is not allowed. 
39      * @param aResource Resource to check. 
40      * @param aOperation Operation to perform.
41      * @return Resource that was checked. 
42      */
43     <T> T check(T aResource, Operation aOperation); 
44     
45     /**
46      * Gets the authorization rules. 
47      * @return Rules. 
48      */
49     AuthorizationRule[] getRules(); 
50     
51     /**
52      * Appends a new authorization rule to the end. 
53      * @param aRule Rule to append. 
54      */
55     void appendRule(AuthorizationRule aRule); 
56     
57     /**
58      * Removes a rule. 
59      * @param aRule Index of the rule to remove.  
60      */
61     void removeRule(int aIndex); 
62         
63     /**
64      * Inserts a rule. 
65      * @param aIndex Index of the position of the rule after insertion. 
66      * @param aRule Rule to insert. 
67      */
68     void insertRuleAfter(int aIndex, AuthorizationRule aRule);
69 }