wamblee.org Git - utils/blob - security/usermgt/src/main/java/org/wamblee/security/authorization/AuthorizationRule.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.security.authentication.UserAdministration;
  19
  20 /**
  21  * Represents an authorization rule to determine whether an operation is allowed
  22  * on a resource.
  23  *
  24  * @author Erik Brakkee
  25  */
  26 public interface AuthorizationRule {
  27
  28     /**
  29      * Sets the user admnistration to use.
  30      *
  31      * @param aAdmin
  32      *            User administration.
  33      */
  34     void setUserAdministration(UserAdministration aAdmin);
  35
  36     /**
  37      * Returns the supported object types for which this authorization rule
  38      * applies. This can be used by the authorization service for optimization.
  39      *
  40      * @return Array of supported types.
  41      */
  42     Class[] getSupportedTypes();
  43
  44     /**
  45      * Determines whether an operation is allowed on a certain resource. The
  46      * rule implementation must be prepared to deal with resources for which it
  47      * does not apply. In those cases it should return
  48      * {@link AuthorizationResult#UNSUPPORTED_RESOURCE}.
  49      *
  50      * @param aResource
  51      *            Resource.
  52      * @param aOperation
  53      *            Operation.
  54      * @param aUser
  55      *            Current user.
  56      *
  57      * @return Authorization result.
  58      */
  59     AuthorizationResult isAllowed(Object aResource, Operation aOperation,
  60         String aUser);
  61
  62 }