wamblee.org Git - utils/blob - security/src/main/java/org/wamblee/security/authorization/AuthorizationRule.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
  17 package org.wamblee.security.authorization;
  18
  19 import org.wamblee.persistence.Persistent;
  20 import org.wamblee.usermgt.User;
  21
  22 /**
  23  * Represents an authorization rule to determine whether an operation is allowed on a resource.
  24  *
  25  * @author Erik Brakkee
  26  */
  27 public interface AuthorizationRule extends Persistent {
  28
  29     /**
  30      * Returns the supported object types for which this authorization rule applies.
  31      * This can be used by the authorization service for optimization.
  32      * @return Array of supported types.
  33      */
  34     Class[] getSupportedTypes();
  35
  36     /**
  37      * Determines whether an operation is allowed on a certain resource.
  38      * The rule implementation must be prepared to deal with resources for which it does
  39      * not apply. In those cases it should return {@link AuthorizationResult#UNSUPPORTED_RESOURCE}.
  40      * @param aResource Resource.
  41      * @param anOperation Operation.
  42      * @param aUser Current user.
  43      * @return Authorization result.
  44      */
  45     AuthorizationResult isAllowed(Object aResource, Operation anOperation, User aUser);
  46 }