wamblee.org Git - utils/blob - security/impl/src/main/java/org/wamblee/security/authorization/AuthorizationService.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.usermgt.UserAccessor;
  19
  20 /**
  21  * Service to determine if access to a certain resource is allowed.
  22  *
  23  * @author Erik Brakkee
  24  */
  25 public interface AuthorizationService {
  26
  27     /**
  28      * Checks whether an operation is allowed on a resource.
  29      *
  30      * @param aResource
  31      *            Resource.
  32      * @param aOperation
  33      *            Operation.
  34      *
  35      * @return Checks whether the operation is allowed on a resource.
  36      */
  37     boolean isAllowed(Object aResource, Operation aOperation);
  38
  39     /**
  40      * Checks if the given operation is allowed on the resource.
  41      *
  42      * @param <T>
  43      *            Type of resource
  44      * @param aResource
  45      *            Resource.
  46      * @param aOperation
  47      *            Operation.
  48      * @return Resource passed in in case access is allowed
  49      * @throws AuthorizationException
  50      *             In case access is denied.
  51      */
  52     <T> T check(T aResource, Operation aOperation);
  53
  54     /**
  55      * Gets the authorization rules.
  56      *
  57      * @return Rules.
  58      */
  59     AuthorizationRule[] getRules();
  60
  61     /**
  62      * Appends a new authorization rule to the end.
  63      *
  64      * @param aRule
  65      *            Rule to append.
  66      */
  67     void appendRule(AuthorizationRule aRule);
  68
  69     /**
  70      * Removes a rule.
  71      *
  72      * @param aIndex
  73      *            Index of the rule to remove.
  74      */
  75     void removeRule(int aIndex);
  76
  77     /**
  78      * Inserts a rule.
  79      *
  80      * @param aIndex
  81      *            Index of the position of the rule after insertion.
  82      * @param aRule
  83      *            Rule to insert.
  84      */
  85     void insertRuleAfter(int aIndex, AuthorizationRule aRule);
  86
  87     /**
  88      * Sets the user accessor so that the authorization service can get access
  89      * to the logged in user.
  90      *
  91      * @param aUserAccessor
  92      *            User accessor.
  93      */
  94     void setUserAccessor(UserAccessor aUserAccessor);
  95
  96 }