• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 1996, 2017, Oracle and/or its affiliates. All rights reserved.
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * This code is free software; you can redistribute it and/or modify it
6  * under the terms of the GNU General Public License version 2 only, as
7  * published by the Free Software Foundation.  Oracle designates this
8  * particular file as subject to the "Classpath" exception as provided
9  * by Oracle in the LICENSE file that accompanied this code.
10  *
11  * This code is distributed in the hope that it will be useful, but WITHOUT
12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14  * version 2 for more details (a copy is included in the LICENSE file that
15  * accompanied this code).
16  *
17  * You should have received a copy of the GNU General Public License version
18  * 2 along with this work; if not, write to the Free Software Foundation,
19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20  *
21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22  * or visit www.oracle.com if you need additional information or have any
23  * questions.
24  */
25 
26 package java.security.acl;
27 
28 import java.security.Principal;
29 
30 /**
31  * Interface for managing owners of Access Control Lists (ACLs) or ACL
32  * configurations. (Note that the Acl interface in the
33  * {@code  java.security.acl} package extends this Owner
34  * interface.) The initial owner Principal should be specified as an
35  * argument to the constructor of the class implementing this interface.
36  *
37  * @since 1.1
38  * @see java.security.acl.Acl
39  *
40  * @deprecated This class is deprecated and subject to removal in a future
41  *     version of Java SE. It has been replaced by {@code java.security.Policy}
42  *     and related classes since 1.2.
43  */
44 @Deprecated(since="9", forRemoval=true)
45 @SuppressWarnings("removal")
46 public interface Owner {
47 
48     /**
49      * Adds an owner. Only owners can modify ACL contents. The caller
50      * principal must be an owner of the ACL in order to invoke this method.
51      * That is, only an owner can add another owner. The initial owner is
52      * configured at ACL construction time.
53      *
54      * @param caller the principal invoking this method. It must be an owner
55      * of the ACL.
56      *
57      * @param owner the owner that should be added to the list of owners.
58      *
59      * @return true if successful, false if owner is already an owner.
60      * @exception NotOwnerException if the caller principal is not an owner
61      * of the ACL.
62      */
addOwner(Principal caller, Principal owner)63     public boolean addOwner(Principal caller, Principal owner)
64       throws NotOwnerException;
65 
66     /**
67      * Deletes an owner. If this is the last owner in the ACL, an exception is
68      * raised.<p>
69      *
70      * The caller principal must be an owner of the ACL in order to invoke
71      * this method.
72      *
73      * @param caller the principal invoking this method. It must be an owner
74      * of the ACL.
75      *
76      * @param owner the owner to be removed from the list of owners.
77      *
78      * @return true if the owner is removed, false if the owner is not part
79      * of the list of owners.
80      *
81      * @exception NotOwnerException if the caller principal is not an owner
82      * of the ACL.
83      *
84      * @exception LastOwnerException if there is only one owner left, so that
85      * deleteOwner would leave the ACL owner-less.
86      */
deleteOwner(Principal caller, Principal owner)87     public boolean deleteOwner(Principal caller, Principal owner)
88       throws NotOwnerException, LastOwnerException;
89 
90     /**
91      * Returns true if the given principal is an owner of the ACL.
92      *
93      * @param owner the principal to be checked to determine whether or not
94      * it is an owner.
95      *
96      * @return true if the passed principal is in the list of owners, false
97      * if not.
98      */
isOwner(Principal owner)99     public boolean isOwner(Principal owner);
100 
101 }
102