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
26package java.security.acl;
27
28import 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 package has been replaced by {@code java.security.Policy}
41 *      and related classes since 1.2.
42 */
43@Deprecated(since="9")
44public interface Owner {
45
46    /**
47     * Adds an owner. Only owners can modify ACL contents. The caller
48     * principal must be an owner of the ACL in order to invoke this method.
49     * That is, only an owner can add another owner. The initial owner is
50     * configured at ACL construction time.
51     *
52     * @param caller the principal invoking this method. It must be an owner
53     * of the ACL.
54     *
55     * @param owner the owner that should be added to the list of owners.
56     *
57     * @return true if successful, false if owner is already an owner.
58     * @exception NotOwnerException if the caller principal is not an owner
59     * of the ACL.
60     */
61    public boolean addOwner(Principal caller, Principal owner)
62      throws NotOwnerException;
63
64    /**
65     * Deletes an owner. If this is the last owner in the ACL, an exception is
66     * raised.<p>
67     *
68     * The caller principal must be an owner of the ACL in order to invoke
69     * this method.
70     *
71     * @param caller the principal invoking this method. It must be an owner
72     * of the ACL.
73     *
74     * @param owner the owner to be removed from the list of owners.
75     *
76     * @return true if the owner is removed, false if the owner is not part
77     * of the list of owners.
78     *
79     * @exception NotOwnerException if the caller principal is not an owner
80     * of the ACL.
81     *
82     * @exception LastOwnerException if there is only one owner left, so that
83     * deleteOwner would leave the ACL owner-less.
84     */
85    public boolean deleteOwner(Principal caller, Principal owner)
86      throws NotOwnerException, LastOwnerException;
87
88    /**
89     * Returns true if the given principal is an owner of the ACL.
90     *
91     * @param owner the principal to be checked to determine whether or not
92     * it is an owner.
93     *
94     * @return true if the passed principal is in the list of owners, false
95     * if not.
96     */
97    public boolean isOwner(Principal owner);
98
99}
100