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