git.aero2k.de Git - tmp/jakarta-migration.git/blob

   1 /**
   2  *  This document is a part of the source code and related artifacts
   3  *  for CollectionSpace, an open source collections management system
   4  *  for museums and related institutions:
   5
   6  *  http://www.collectionspace.org
   7  *  http://wiki.collectionspace.org
   8
   9  *  Copyright 2009 University of California at Berkeley
  10
  11  *  Licensed under the Educational Community License (ECL), Version 2.0.
  12  *  You may not use this file except in compliance with this License.
  13
  14  *  You may obtain a copy of the ECL 2.0 License at
  15
  16  *  https://source.collectionspace.org/collection-space/LICENSE.txt
  17
  18  *  Unless required by applicable law or agreed to in writing, software
  19  *  distributed under the License is distributed on an "AS IS" BASIS,
  20  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  21  *  See the License for the specific language governing permissions and
  22  *  limitations under the License.
  23
  24  */
  25
  26
  27 package org.collectionspace.services.authorization;
  28
  29 /**
  30  * CSpaceResource represents the resource to secure
  31  * @author
  32  */
  33 public interface CSpaceResource {
  34
  35     public enum TYPE {
  36         URI,
  37         CLASS,
  38         OBJECT,
  39         ATTRIBUTE
  40     }
  41
  42     /**
  43      * getId get tenant-qualified id of this resource
  44      * @return
  45      */
  46     public String getId();
  47
  48     /**
  49      * getType get type of the resource
  50      */
  51     public TYPE getType();
  52
  53     /**
  54      * getTenantId get the id of the tenant to which this resource is associated
  55      * @return
  56      */
  57     public String getTenantId();
  58
  59     /**
  60      * getAction is a conveneniece method to get corresponding action to be invoked
  61      * on the resource for which permission is sought
  62      * @return
  63      */
  64     public CSpaceAction getAction();
  65 }