Source for java.security.acl.Owner

   1: /* Owner.java -- ACL owner
   2:    Copyright (C) 1998 Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: package java.security.acl;
  39: 
  40: import java.security.Principal;
  41: 
  42: /**
  43:  * This interface provides a mechanism for maintaining a list of owners
  44:  * of an access control list (ACL).  Since a <code>Principal</code> must
  45:  * be an owner in order to modify the owner list, a mechanism must be
  46:  * provided to specify the initial owner of the ACL.  The proper way to do
  47:  * this is for the implementing class to specify the initial owner in
  48:  * the contructor for that class.
  49:  *
  50:  * @version 0.0
  51:  *
  52:  * @author Aaron M. Renn (arenn@urbanophile.com)
  53:  */
  54: public interface Owner
  55: {
  56:   /**
  57:    * This method adds an owner to the access control list (ACL).  Only a
  58:    * <code>Principal</code> who is already an owner can perform this operation.
  59:    *
  60:    * @param caller The <code>Principal</code> who is requesting that an owner be added
  61:    * @param owner The <code>Principal</code> to add as a new owner
  62:    *
  63:    * @param <code>true</code> if the new owner was successfully added or <code>false</code> if the specified new owner is already an owner
  64:    *
  65:    * @exception NotOwnerException If the caller is not already an owner of this ACL
  66:    */
  67:   boolean addOwner(Principal caller, Principal owner) 
  68:     throws NotOwnerException;
  69: 
  70:   /**
  71:    * This method delets an owner from the access control list (ACL).  Only a
  72:    * <code>Principal</code> who is an owner can perform this operation.  An
  73:    * owner can delete itself from the list.  If there is only one
  74:    * owner remaining on this list, any attempt to delete it will throw an
  75:    * exception.
  76:    *
  77:    * @param caller The <code>Principal</code> who is requesting that an owner be deleted
  78:    * @param owner The <code>Principal</code> to delete as an owner
  79:    *
  80:    * @param <code>true</code> if the new owner was successfully deleted or <code>false</code> if the specified owner is not currently an owner
  81:    *
  82:    * @exception NotOwnerException If the caller is not already an owner of this ACL
  83:    * @exception LastOwnerException If completing the operation would delete the last ACL owner
  84:    */
  85:   boolean deleteOwner(Principal caller, Principal owner) 
  86:     throws NotOwnerException, LastOwnerException;
  87: 
  88:   /**
  89:    * This method tests whether or not a given <code>Principal</code> is an
  90:    * owner of this access control list (ACL).
  91:    *
  92:    * @return <code>true</code> if the <code>Principal</code> is an owner, <code>false</code> otherwise
  93:    */
  94:   boolean isOwner(Principal owner);
  95: }