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 /**
  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      * Checks whether an operation is allowed on a resource.
  29      *
  30      * @param aResource Resource.
  31      * @param aOperation Operation.
  32      *
  33      * @return Checks whether the operation is allowed on a resource.
  34      */
  35     boolean isAllowed(Object aResource, Operation aOperation);
  36
  37     /**
  38      * DOCUMENT ME!
  39      *
  40      * @param <T> DOCUMENT ME!
  41      * @param aResource DOCUMENT ME!
  42      * @param aOperation DOCUMENT ME!
  43      *
  44      * @return DOCUMENT ME!
  45      */
  46     <T> T check(T aResource, Operation aOperation);
  47
  48     /**
  49      * Gets the authorization rules.
  50      *
  51      * @return Rules.
  52      */
  53     AuthorizationRule[] getRules();
  54
  55     /**
  56      * Appends a new authorization rule to the end.
  57      *
  58      * @param aRule Rule to append.
  59      */
  60     void appendRule(AuthorizationRule aRule);
  61
  62     /**
  63      * Removes a rule.
  64      *
  65      * @param aIndex Index of the rule to remove.
  66      */
  67     void removeRule(int aIndex);
  68
  69     /**
  70      * Inserts a rule.
  71      *
  72      * @param aIndex Index of the position of the rule after insertion.
  73      * @param aRule Rule to insert.
  74      */
  75     void insertRuleAfter(int aIndex, AuthorizationRule aRule);
  76 }