1 /**
2 * This file Copyright (c) 2003-2013 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;
65
66 private String name;
67
68 public PrincipalCollectionImpl(){
69 this.collection = new ArrayList<Principal>();
70 }
71
72 public PrincipalCollectionImpl(Collection<Principal> principals){
73 this.collection = principals;
74 }
75
76 /**
77 * Gets name given to this principal.
78 * @return name
79 */
80 @Override
81 public String getName() {
82 if (StringUtils.isEmpty(this.name)) {
83 return NAME;
84 }
85 return this.name;
86 }
87
88 /**
89 * Sets this principal name.
90 */
91 @Override
92 public void setName(String name) {
93 this.name = name;
94 }
95
96 /**
97 * Sets internal collection of principals.
98 * @deprecated since 4.5
99 */
100 @Override
101 @Deprecated
102 public void set(Collection<Principal> collection) {
103 throw new UnsupportedOperationException("use addAll() instead");
104 }
105
106 /**
107 * Adds principal to the internal collection of principals.
108 * @param principal to be added to the collection
109 */
110 @Override
111 public void add(Principal principal) {
112 this.collection.add(principal);
113 }
114
115 /**
116 * Adds principals to the internal collection of principals.
117 * @param principal to be added to the collection
118 */
119 @Override
120 public void addAll(Collection<Principal> principal) {
121 this.collection.addAll(principal);
122 }
123
124 /**
125 * Removes principal from the collection if present or does nothing in case principal was not present in the collection.
126 * @param principal to be removed from the collection
127 */
128 @Override
129 public void remove(Principal principal) {
130 this.collection.remove(principal);
131 }
132
133 /**
134 * removes all principals from the collection.
135 */
136 @Override
137 public void clearAll() {
138 this.collection.clear();
139 }
140
141 /**
142 * Checks if this collection contains specified principal.
143 * @return true if the specified object exist in the collection, false otherwise.
144 */
145 @Override
146 public boolean contains(Principal principal) {
147 return this.collection.contains(principal);
148 }
149
150 /**
151 * Checks if this collection contains principal with the specified name.
152 * @param name
153 * @return true if the collection contains the principal by the specified name, false otherwise.
154 */
155 @Override
156 public boolean contains(String name) {
157 return this.get(name) != null;
158 }
159
160 /**
161 * Gets principal associated to the specified name from the collection.
162 * @param name
163 * @return principal object associated to the specified name.
164 */
165 @Override
166 public Principal get(String name) {
167 //TODO: change internal collection to a map and store names as keys to avoid loops !!!!
168 Iterator<Principal> principalIterator = this.collection.iterator();
169 while (principalIterator.hasNext()) {
170 Principal principal = principalIterator.next();
171 if (StringUtils.equalsIgnoreCase(name, principal.getName())) {
172 return principal;
173 }
174 }
175 return null;
176 }
177
178 /**
179 * @return collection of principals
180 */
181 @Override
182 public Collection<Principal> getCollection() {
183 return collection;
184 }
185
186 /**
187 * Returns an iterator over the collection of principals.
188 * @return iterator for Principal objects
189 */
190 @Override
191 public Iterator<Principal> iterator() {
192 return collection.iterator();
193 }
194
195 /**
196 * @see java.lang.Object#toString()
197 */
198 @Override
199 public String toString() {
200 return new ToStringBuilder(this, ToStringStyle.SHORT_PREFIX_STYLE).append("name", getName()).toString();
201 }
202 }