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      * @param <T> Type of resource
  42      * @param aResource Resource.
  43      * @param aOperation Operation.
  44      * @return Resource passed in in case access is allowed
  45      * @throws AuthorizationException In case access is denied.
  46      */
  47     <T> T check(T aResource, Operation aOperation);
  48
  49     /**
  50      * Gets the authorization rules.
  51      *
  52      * @return Rules.
  53      */
  54     AuthorizationRule[] getRules();
  55
  56     /**
  57      * Appends a new authorization rule to the end.
  58      *
  59      * @param aRule
  60      *            Rule to append.
  61      */
  62     void appendRule(AuthorizationRule aRule);
  63
  64     /**
  65      * Removes a rule.
  66      *
  67      * @param aIndex
  68      *            Index of the rule to remove.
  69      */
  70     void removeRule(int aIndex);
  71
  72     /**
  73      * Inserts a rule.
  74      *
  75      * @param aIndex
  76      *            Index of the position of the rule after insertion.
  77      * @param aRule
  78      *            Rule to insert.
  79      */
  80     void insertRuleAfter(int aIndex, AuthorizationRule aRule);
  81
  82     /**
  83      * Sets the user accessor so that the authorization service can get access
  84      * to the logged in user.
  85      *
  86      * @param aUserAccessor
  87      *            User accessor.
  88      */
  89     void setUserAccessor(UserAccessor aUserAccessor);
  90
  91 }