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 javax.persistence.DiscriminatorColumn;
  19 import javax.persistence.Entity;
  20 import javax.persistence.GeneratedValue;
  21 import javax.persistence.GenerationType;
  22 import javax.persistence.Id;
  23 import javax.persistence.Inheritance;
  24 import javax.persistence.InheritanceType;
  25 import javax.persistence.Table;
  26 import javax.persistence.Version;
  27
  28 import org.wamblee.usermgt.User;
  29
  30 /**
  31  * Represents an authorization rule to determine whether an operation is allowed
  32  * on a resource.
  33  *
  34  * @author Erik Brakkee
  35  */
  36 @Entity
  37 @Table(name = "SEC_AUTH_RULE")
  38 @Inheritance(strategy = InheritanceType.SINGLE_TABLE)
  39 @DiscriminatorColumn(name = "TYPE")
  40 public abstract class AuthorizationRule {
  41
  42     @Id
  43     @GeneratedValue(strategy = GenerationType.AUTO)
  44     private Long primaryKey;
  45
  46     @Version
  47     private int version;
  48
  49     public AuthorizationRule() {
  50         // Empty
  51     }
  52
  53     public AuthorizationRule(AuthorizationRule aRule) {
  54         primaryKey = aRule.primaryKey;
  55         version = aRule.version;
  56     }
  57
  58     /**
  59      * Returns the supported object types for which this authorization rule
  60      * applies. This can be used by the authorization service for optimization.
  61      *
  62      * @return Array of supported types.
  63      */
  64     public abstract Class[] getSupportedTypes();
  65
  66     /**
  67      * Determines whether an operation is allowed on a certain resource. The
  68      * rule implementation must be prepared to deal with resources for which it
  69      * does not apply. In those cases it should return
  70      * {@link AuthorizationResult#UNSUPPORTED_RESOURCE}.
  71      *
  72      * @param aResource
  73      *            Resource.
  74      * @param aOperation
  75      *            Operation.
  76      * @param aUser
  77      *            Current user.
  78      *
  79      * @return Authorization result.
  80      */
  81     public abstract AuthorizationResult isAllowed(Object aResource, Operation aOperation,
  82         User aUser);
  83 }