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