wamblee.org Git - utils/blob - 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 package org.wamblee.security.authorization;
  17
  18 import org.wamblee.persistence.Persistent;
  19
  20 /**
  21  * Service to determine if access to a certain resource is allowed.
  22  *
  23  * @author Erik Brakkee
  24  */
  25 public interface AuthorizationService extends Persistent {
  26     /**
  27      * Checks whether an operation is allowed on a resource.
  28      *
  29      * @param aResource
  30      *            Resource.
  31      * @param aOperation
  32      *            Operation.
  33      *
  34      * @return Checks whether the operation is allowed on a resource.
  35      */
  36     boolean isAllowed(Object aResource, Operation aOperation);
  37
  38     <T> T check(T aResource, Operation aOperation);
  39
  40     /**
  41      * Gets the authorization rules.
  42      *
  43      * @return Rules.
  44      */
  45     AuthorizationRule[] getRules();
  46
  47     /**
  48      * Appends a new authorization rule to the end.
  49      *
  50      * @param aRule
  51      *            Rule to append.
  52      */
  53     void appendRule(AuthorizationRule aRule);
  54
  55     /**
  56      * Removes a rule.
  57      *
  58      * @param aIndex
  59      *            Index of the rule to remove.
  60      */
  61     void removeRule(int aIndex);
  62
  63     /**
  64      * Inserts a rule.
  65      *
  66      * @param aIndex
  67      *            Index of the position of the rule after insertion.
  68      * @param aRule
  69      *            Rule to insert.
  70      */
  71     void insertRuleAfter(int aIndex, AuthorizationRule aRule);
  72 }