1 /**
2 * This file Copyright (c) 2003-2010 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
40
41 /**
42 * @author Sameer Charles $Id: PrincipalCollection.java 32667 2010-03-13 00:37:06Z gjoseph $
43 */
44 public interface PrincipalCollection extends Principal, Serializable {
45
46 public String getName();
47
48 /**
49 * Set this principal name
50 */
51 public void setName(String name);
52
53 /**
54 * Set collection
55 * @param collection
56 */
57 public void set(Collection collection);
58
59 /**
60 * Add to collection
61 * @param principal to be added to the collection
62 */
63 public void add(Principal principal);
64
65 /**
66 * Remove from the collection
67 * @param principal to be removed from the collection
68 */
69 public void remove(Principal principal);
70
71 /**
72 * Clear collection
73 */
74 public void clearAll();
75
76 /**
77 * Check if this collection contains specified object
78 * @param principal
79 * @return true if the specified object exist in the collection
80 */
81 public boolean contains(Principal principal);
82
83 /**
84 * Checks if this collection contains object with the specified name
85 * @param name
86 * @return true if the collection contains the principal by the specified name
87 */
88 public boolean contains(String name);
89
90 /**
91 * Get principal associated to the specified name from the collection
92 * @param name
93 * @return principal object associated to the specified name
94 */
95 public Principal get(String name);
96
97 }