1 /**
2 * This file Copyright (c) 2003-2018 Magnolia International
3 * Ltd. (http://www.magnolia-cms.com). All rights reserved.
4 *
5 *
6 * This file is dual-licensed under both the Magnolia
7 * Network Agreement and the GNU General Public License.
8 * You may elect to use one or the other of these licenses.
9 *
10 * This file is distributed in the hope that it will be
11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12 * implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14 * Redistribution, except as permitted by whichever of the GPL
15 * or MNA you select, is prohibited.
16 *
17 * 1. For the GPL license (GPL), you can redistribute and/or
18 * modify this file under the terms of the GNU General
19 * Public License, Version 3, as published by the Free Software
20 * Foundation. You should have received a copy of the GNU
21 * General Public License, Version 3 along with this program;
22 * if not, write to the Free Software Foundation, Inc., 51
23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24 *
25 * 2. For the Magnolia Network Agreement (MNA), this file
26 * and the accompanying materials are made available under the
27 * terms of the MNA which accompanies this distribution, and
28 * is available at http://www.magnolia-cms.com/mna.html
29 *
30 * Any modifications to this file must keep this entire header
31 * intact.
32 *
33 */
34 package info.magnolia.cms.security.auth;
35
36 import java.io.Serializable;
37 import java.security.Principal;
38 import java.util.Collection;
39 import java.util.Iterator;
40
41
42 /**
43 * A collection of {@link Principal principals}.
44 */
45 public interface PrincipalCollection extends Principal, Serializable, Iterable<Principal> {
46
47 @Override
48 public String getName();
49
50 public void setName(String name);
51
52 public void set(Collection<Principal> collection);
53
54 public void add(Principal principal);
55
56 public void addAll(Collection<Principal> principal);
57
58 public void remove(Principal principal);
59
60 public void clearAll();
61
62 public boolean contains(Principal principal);
63
64 @Override
65 public Iterator<Principal> iterator();
66
67 /**
68 * Checks if this collection contains object with the specified name.
69 */
70 public boolean contains(String name);
71
72 /**
73 * Get principal associated to the specified name from the collection.
74 */
75 public Principal get(String name);
76
77 public Collection<Principal> getCollection();
78
79 }