1 /**
2 * This file Copyright (c) 2003-2011 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
37 import java.security.Principal;
38 import java.util.ArrayList;
39 import java.util.Collection;
40 import java.util.Iterator;
41
42 import org.apache.commons.lang.StringUtils;
43 import org.apache.commons.lang.builder.ToStringBuilder;
44 import org.apache.commons.lang.builder.ToStringStyle;
45
46
47 /**
48 * Principal collection implementation based on simple list. Collection is managed externally.
49 * Date: Jun 29, 2005
50 * @author Sameer Charles $Id$
51 */
52 public class PrincipalCollectionImpl implements PrincipalCollection {
53
54 /**
55 * Stable serialVersionUID.
56 */
57 private static final long serialVersionUID = 222L;
58
59 private static final String NAME = "PrincipalCollection";
60
61 /**
62 * Collection of principal objects.
63 */
64 private final Collection<Principal> collection = new ArrayList<Principal>();
65
66 private String name;
67
68 /**
69 * Gets name given to this principal.
70 * @return name
71 */
72 @Override
73 public String getName() {
74 if (StringUtils.isEmpty(this.name)) {
75 return NAME;
76 }
77 return this.name;
78 }
79
80 /**
81 * Sets this principal name.
82 */
83 @Override
84 public void setName(String name) {
85 this.name = name;
86 }
87
88 /**
89 * Sets internal collection of principals.
90 * @deprecated since 4.5
91 */
92 @Override
93 @Deprecated
94 public void set(Collection<Principal> collection) {
95 throw new UnsupportedOperationException("use addAll() instead");
96 }
97
98 /**
99 * Adds principal to the internal collection of principals.
100 * @param principal to be added to the collection
101 */
102 @Override
103 public void add(Principal principal) {
104 this.collection.add(principal);
105 }
106
107 /**
108 * Adds principals to the internal collection of principals.
109 * @param principal to be added to the collection
110 */
111 @Override
112 public void addAll(Collection<Principal> principal) {
113 this.collection.addAll(principal);
114 }
115
116 /**
117 * Removes principal from the collection if present or does nothing in case principal was not present in the collection.
118 * @param principal to be removed from the collection
119 */
120 @Override
121 public void remove(Principal principal) {
122 this.collection.remove(principal);
123 }
124
125 /**
126 * removes all principals from the collection.
127 */
128 @Override
129 public void clearAll() {
130 this.collection.clear();
131 }
132
133 /**
134 * Checks if this collection contains specified principal.
135 * @return true if the specified object exist in the collection, false otherwise.
136 */
137 @Override
138 public boolean contains(Principal principal) {
139 return this.collection.contains(principal);
140 }
141
142 /**
143 * Checks if this collection contains principal with the specified name.
144 * @param name
145 * @return true if the collection contains the principal by the specified name, false otherwise.
146 */
147 @Override
148 public boolean contains(String name) {
149 return this.get(name) != null;
150 }
151
152 /**
153 * Gets principal associated to the specified name from the collection.
154 * @param name
155 * @return principal object associated to the specified name.
156 */
157 @Override
158 public Principal get(String name) {
159 //TODO: change internal collection to a map and store names as keys to avoid loops !!!!
160 Iterator<Principal> principalIterator = this.collection.iterator();
161 while (principalIterator.hasNext()) {
162 Principal principal = principalIterator.next();
163 if (StringUtils.equalsIgnoreCase(name, principal.getName())) {
164 return principal;
165 }
166 }
167 return null;
168 }
169
170 /**
171 * Returns an iterator over the collection of principals.
172 * @return iterator for Principal objects
173 */
174 @Override
175 public Iterator<Principal> iterator() {
176 return collection.iterator();
177 }
178
179 /**
180 * @see java.lang.Object#toString()
181 */
182 @Override
183 public String toString() {
184 return new ToStringBuilder(this, ToStringStyle.SHORT_PREFIX_STYLE).append("name", getName()).toString();
185 }
186 }