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