Coverage Report

Coverage Report - org.apache.shiro.subject.SimplePrincipalMap

Classes in this File

Line Coverage

Branch Coverage

Complexity

SimplePrincipalMap

0/118

0/96

3.464

 /*
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
  * distributed with this work for additional information
  * regarding copyright ownership.  The ASF licenses this file
  * to you under the Apache License, Version 2.0 (the
  * "License"); you may not use this file except in compliance
  * with the License.  You may obtain a copy of the License at
  *
  * http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing,
  * software distributed under the License is distributed on an
  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  * KIND, either express or implied.  See the License for the
  * specific language governing permissions and limitations
  * under the License.
  */
 package org.apache.shiro.subject;
 
 import org.apache.shiro.util.CollectionUtils;
 
 import java.util.*;
 
 /**
  * Default implementation of the {@link PrincipalMap} interface.
  *
  * *EXPERIMENTAL for Shiro 1.2 - DO NOT USE YET*
  *
  * @author Les Hazlewood
  * @since 1.2
  */
 public class SimplePrincipalMap implements PrincipalMap {
 
     //Key: realm name, Value: map of principals specific to that realm
     //                        internal map - key: principal name, value: principal
     private Map<String, Map<String, Object>> realmPrincipals;
 
     //maintains the principals from all realms plus any that are modified via the Map modification methods
     //this ensures a fast lookup of any named principal instead of needing to iterate over
     //the realmPrincipals for each lookup.
     private Map<String, Object> combinedPrincipals;
 
     public SimplePrincipalMap() {
         this(null);
     }
 
     public SimplePrincipalMap(Map<String, Map<String, Object>> backingMap) {
         if (!CollectionUtils.isEmpty(backingMap)) {
             this.realmPrincipals = backingMap;
             for (Map<String, Object> principals : this.realmPrincipals.values()) {
                 if (!CollectionUtils.isEmpty(principals) ) {
                     ensureCombinedPrincipals().putAll(principals);
                 }
             }
         }
     }
 
     public int size() {
         return CollectionUtils.size(this.combinedPrincipals);
     }
 
     protected Map<String, Object> ensureCombinedPrincipals() {
         if (this.combinedPrincipals == null) {
             this.combinedPrincipals = new HashMap<String, Object>();
         }
         return this.combinedPrincipals;
     }
 
     public boolean containsKey(Object o) {
         return this.combinedPrincipals != null && this.combinedPrincipals.containsKey(o);
     }
 
     public boolean containsValue(Object o) {
         return this.combinedPrincipals != null && this.combinedPrincipals.containsKey(o);
     }
 
     public Object get(Object o) {
         return this.combinedPrincipals != null && this.combinedPrincipals.containsKey(o);
     }
 
     public Object put(String s, Object o) {
         return ensureCombinedPrincipals().put(s, o);
     }
 
     public Object remove(Object o) {
         return this.combinedPrincipals != null ? this.combinedPrincipals.remove(o) : null;
     }
 
     public void putAll(Map<? extends String, ?> map) {
         if (!CollectionUtils.isEmpty(map)) {
             ensureCombinedPrincipals().putAll(map);
         }
     }
 
     public Set<String> keySet() {
         return CollectionUtils.isEmpty(this.combinedPrincipals) ?
                 Collections.<String>emptySet() :
                 Collections.unmodifiableSet(this.combinedPrincipals.keySet());
     }
 
     public Collection<Object> values() {
         return CollectionUtils.isEmpty(this.combinedPrincipals) ?
                 Collections.emptySet() :
                 Collections.unmodifiableCollection(this.combinedPrincipals.values());
     }
 
     public Set<Entry<String, Object>> entrySet() {
         return CollectionUtils.isEmpty(this.combinedPrincipals) ?
                 Collections.<Entry<String,Object>>emptySet() :
                 Collections.unmodifiableSet(this.combinedPrincipals.entrySet());
     }
 
     public void clear() {
         this.realmPrincipals = null;
         this.combinedPrincipals = null;
     }
 
     public Object getPrimaryPrincipal() {
         //heuristic - just use the first one we come across:
         return !CollectionUtils.isEmpty(this.combinedPrincipals) ?
                 this.combinedPrincipals.values().iterator().next() :
                 null;
     }
 
     public <T> T oneByType(Class<T> type) {
         if (CollectionUtils.isEmpty(this.combinedPrincipals)) {
             return null;
         }
         for( Object value : this.combinedPrincipals.values()) {
             if (type.isInstance(value) ) {
                 return type.cast(value);
             }
         }
         return null;
     }
 
     public <T> Collection<T> byType(Class<T> type) {
         if (CollectionUtils.isEmpty(this.combinedPrincipals)) {
             return Collections.emptySet();
         }
         Collection<T> instances = null;
         for( Object value : this.combinedPrincipals.values()) {
             if (type.isInstance(value) ) {
                 if (instances == null) {
                     instances = new ArrayList<T>();
                 }
                 instances.add(type.cast(value));
             }
         }
         return instances != null ? instances : Collections.<T>emptyList();
     }
 
     public List asList() {
         if (CollectionUtils.isEmpty(this.combinedPrincipals)) {
             return Collections.emptyList();
         }
         List<Object> list = new ArrayList<Object>(this.combinedPrincipals.size());
         list.addAll(this.combinedPrincipals.values());
         return list;
     }
 
     public Set asSet() {
         if (CollectionUtils.isEmpty(this.combinedPrincipals)) {
             return Collections.emptySet();
         }
         Set<Object> set = new HashSet<Object>(this.combinedPrincipals.size());
         set.addAll(this.combinedPrincipals.values());
         return set;
     }
 
     public Collection fromRealm(String realmName) {
         if (CollectionUtils.isEmpty(this.realmPrincipals)) {
             return Collections.emptySet();
         }
         Map<String,Object> principals = this.realmPrincipals.get(realmName);
         if (CollectionUtils.isEmpty(principals)) {
             return Collections.emptySet();
         }
         return Collections.unmodifiableCollection(principals.values());
     }
 
     public Set<String> getRealmNames() {
         if (CollectionUtils.isEmpty(this.realmPrincipals)) {
             return Collections.emptySet();
         }
         return Collections.unmodifiableSet(this.realmPrincipals.keySet());
     }
 
     public boolean isEmpty() {
         return CollectionUtils.isEmpty(this.combinedPrincipals);
     }
 
     public Iterator iterator() {
         return asList().iterator();
     }
 
     public Map<String, Object> getRealmPrincipals(String name) {
         if (this.realmPrincipals == null) {
             return null;
         }
         Map<String,Object> principals = this.realmPrincipals.get(name);
         if (principals == null) {
             return null;
         }
         return Collections.unmodifiableMap(principals);
     }
 
     public Map<String,Object> setRealmPrincipals(String realmName, Map<String, Object> principals) {
         if (realmName == null) {
             throw new NullPointerException("realmName argument cannot be null.");
         }
         if (this.realmPrincipals == null) {
             if (!CollectionUtils.isEmpty(principals)) {
                 this.realmPrincipals = new HashMap<String,Map<String,Object>>();
                 return this.realmPrincipals.put(realmName, new HashMap<String,Object>(principals));
             } else {
                 return null;
             }
         } else {
             Map<String,Object> existingPrincipals = this.realmPrincipals.remove(realmName);
             if (!CollectionUtils.isEmpty(principals)) {
                 this.realmPrincipals.put(realmName, new HashMap<String,Object>(principals));
             }
             return existingPrincipals;
         }
     }
 
     public Object setRealmPrincipal(String realmName, String principalName, Object principal) {
         if (realmName == null) {
             throw new NullPointerException("realmName argument cannot be null.");
         }
         if (principalName == null) {
             throw new NullPointerException(("principalName argument cannot be null."));
         }
         if (principal == null) {
             return removeRealmPrincipal(realmName, principalName);
         }
         if (this.realmPrincipals == null) {
             this.realmPrincipals = new HashMap<String,Map<String,Object>>();
         }
         Map<String,Object> principals = this.realmPrincipals.get(realmName);
         if (principals == null) {
             principals = new HashMap<String,Object>();
             this.realmPrincipals.put(realmName, principals);
         }
         return principals.put(principalName, principal);
     }
 
     public Object getRealmPrincipal(String realmName, String principalName) {
         if (realmName == null) {
             throw new NullPointerException("realmName argument cannot be null.");
         }
         if (principalName == null) {
             throw new NullPointerException(("principalName argument cannot be null."));
         }
         if (this.realmPrincipals == null) {
             return null;
         }
         Map<String,Object> principals = this.realmPrincipals.get(realmName);
         if (principals != null) {
             return principals.get(principalName);
         }
         return null;
     }
 
     public Object removeRealmPrincipal(String realmName, String principalName) {
         if (realmName == null) {
             throw new NullPointerException("realmName argument cannot be null.");
         }
         if (principalName == null) {
             throw new NullPointerException(("principalName argument cannot be null."));
         }
         if (this.realmPrincipals == null) {
             return null;
         }
         Map<String,Object> principals = this.realmPrincipals.get(realmName);
         if (principals != null) {
             return principals.remove(principalName);
         }
         return null;
     }
 }

1		/*
2		* Licensed to the Apache Software Foundation (ASF) under one
3		* or more contributor license agreements. See the NOTICE file
4		* distributed with this work for additional information
5		* regarding copyright ownership. The ASF licenses this file
6		* to you under the Apache License, Version 2.0 (the
7		* "License"); you may not use this file except in compliance
8		* with the License. You may obtain a copy of the License at
9		*
10		* http://www.apache.org/licenses/LICENSE-2.0
11		*
12		* Unless required by applicable law or agreed to in writing,
13		* software distributed under the License is distributed on an
14		* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15		* KIND, either express or implied. See the License for the
16		* specific language governing permissions and limitations
17		* under the License.
18		*/
19		package org.apache.shiro.subject;
20
21		import org.apache.shiro.util.CollectionUtils;
22
23		import java.util.*;
24
25		/**
26		* Default implementation of the {@link PrincipalMap} interface.
27		*
28		* EXPERIMENTAL for Shiro 1.2 - DO NOT USE YET
29		*
30		* @author Les Hazlewood
31		* @since 1.2
32		*/
33	0	public class SimplePrincipalMap implements PrincipalMap {
34
35		//Key: realm name, Value: map of principals specific to that realm
36		// internal map - key: principal name, value: principal
37		private Map<String, Map<String, Object>> realmPrincipals;
38
39		//maintains the principals from all realms plus any that are modified via the Map modification methods
40		//this ensures a fast lookup of any named principal instead of needing to iterate over
41		//the realmPrincipals for each lookup.
42		private Map<String, Object> combinedPrincipals;
43
44		public SimplePrincipalMap() {
45	0	this(null);
46	0	}
47
48	0	public SimplePrincipalMap(Map<String, Map<String, Object>> backingMap) {
49	0	if (!CollectionUtils.isEmpty(backingMap)) {
50	0	this.realmPrincipals = backingMap;
51	0	for (Map<String, Object> principals : this.realmPrincipals.values()) {
52	0	if (!CollectionUtils.isEmpty(principals) ) {
53	0	ensureCombinedPrincipals().putAll(principals);
54		}
55	0	}
56		}
57	0	}
58
59		public int size() {
60	0	return CollectionUtils.size(this.combinedPrincipals);
61		}
62
63		protected Map<String, Object> ensureCombinedPrincipals() {
64	0	if (this.combinedPrincipals == null) {
65	0	this.combinedPrincipals = new HashMap<String, Object>();
66		}
67	0	return this.combinedPrincipals;
68		}
69
70		public boolean containsKey(Object o) {
71	0	return this.combinedPrincipals != null && this.combinedPrincipals.containsKey(o);
72		}
73
74		public boolean containsValue(Object o) {
75	0	return this.combinedPrincipals != null && this.combinedPrincipals.containsKey(o);
76		}
77
78		public Object get(Object o) {
79	0	return this.combinedPrincipals != null && this.combinedPrincipals.containsKey(o);
80		}
81
82		public Object put(String s, Object o) {
83	0	return ensureCombinedPrincipals().put(s, o);
84		}
85
86		public Object remove(Object o) {
87	0	return this.combinedPrincipals != null ? this.combinedPrincipals.remove(o) : null;
88		}
89
90		public void putAll(Map<? extends String, ?> map) {
91	0	if (!CollectionUtils.isEmpty(map)) {
92	0	ensureCombinedPrincipals().putAll(map);
93		}
94	0	}
95
96		public Set<String> keySet() {
97	0	return CollectionUtils.isEmpty(this.combinedPrincipals) ?
98		Collections.<String>emptySet() :
99		Collections.unmodifiableSet(this.combinedPrincipals.keySet());
100		}
101
102		public Collection<Object> values() {
103	0	return CollectionUtils.isEmpty(this.combinedPrincipals) ?
104		Collections.emptySet() :
105		Collections.unmodifiableCollection(this.combinedPrincipals.values());
106		}
107
108		public Set<Entry<String, Object>> entrySet() {
109	0	return CollectionUtils.isEmpty(this.combinedPrincipals) ?
110		Collections.<Entry<String,Object>>emptySet() :
111		Collections.unmodifiableSet(this.combinedPrincipals.entrySet());
112		}
113
114		public void clear() {
115	0	this.realmPrincipals = null;
116	0	this.combinedPrincipals = null;
117	0	}
118
119		public Object getPrimaryPrincipal() {
120		//heuristic - just use the first one we come across:
121	0	return !CollectionUtils.isEmpty(this.combinedPrincipals) ?
122		this.combinedPrincipals.values().iterator().next() :
123		null;
124		}
125
126		public <T> T oneByType(Class<T> type) {
127	0	if (CollectionUtils.isEmpty(this.combinedPrincipals)) {
128	0	return null;
129		}
130	0	for( Object value : this.combinedPrincipals.values()) {
131	0	if (type.isInstance(value) ) {
132	0	return type.cast(value);
133		}
134	0	}
135	0	return null;
136		}
137
138		public <T> Collection<T> byType(Class<T> type) {
139	0	if (CollectionUtils.isEmpty(this.combinedPrincipals)) {
140	0	return Collections.emptySet();
141		}
142	0	Collection<T> instances = null;
143	0	for( Object value : this.combinedPrincipals.values()) {
144	0	if (type.isInstance(value) ) {
145	0	if (instances == null) {
146	0	instances = new ArrayList<T>();
147		}
148	0	instances.add(type.cast(value));
149		}
150	0	}
151	0	return instances != null ? instances : Collections.<T>emptyList();
152		}
153
154		public List asList() {
155	0	if (CollectionUtils.isEmpty(this.combinedPrincipals)) {
156	0	return Collections.emptyList();
157		}
158	0	List<Object> list = new ArrayList<Object>(this.combinedPrincipals.size());
159	0	list.addAll(this.combinedPrincipals.values());
160	0	return list;
161		}
162
163		public Set asSet() {
164	0	if (CollectionUtils.isEmpty(this.combinedPrincipals)) {
165	0	return Collections.emptySet();
166		}
167	0	Set<Object> set = new HashSet<Object>(this.combinedPrincipals.size());
168	0	set.addAll(this.combinedPrincipals.values());
169	0	return set;
170		}
171
172		public Collection fromRealm(String realmName) {
173	0	if (CollectionUtils.isEmpty(this.realmPrincipals)) {
174	0	return Collections.emptySet();
175		}
176	0	Map<String,Object> principals = this.realmPrincipals.get(realmName);
177	0	if (CollectionUtils.isEmpty(principals)) {
178	0	return Collections.emptySet();
179		}
180	0	return Collections.unmodifiableCollection(principals.values());
181		}
182
183		public Set<String> getRealmNames() {
184	0	if (CollectionUtils.isEmpty(this.realmPrincipals)) {
185	0	return Collections.emptySet();
186		}
187	0	return Collections.unmodifiableSet(this.realmPrincipals.keySet());
188		}
189
190		public boolean isEmpty() {
191	0	return CollectionUtils.isEmpty(this.combinedPrincipals);
192		}
193
194		public Iterator iterator() {
195	0	return asList().iterator();
196		}
197
198		public Map<String, Object> getRealmPrincipals(String name) {
199	0	if (this.realmPrincipals == null) {
200	0	return null;
201		}
202	0	Map<String,Object> principals = this.realmPrincipals.get(name);
203	0	if (principals == null) {
204	0	return null;
205		}
206	0	return Collections.unmodifiableMap(principals);
207		}
208
209		public Map<String,Object> setRealmPrincipals(String realmName, Map<String, Object> principals) {
210	0	if (realmName == null) {
211	0	throw new NullPointerException("realmName argument cannot be null.");
212		}
213	0	if (this.realmPrincipals == null) {
214	0	if (!CollectionUtils.isEmpty(principals)) {
215	0	this.realmPrincipals = new HashMap<String,Map<String,Object>>();
216	0	return this.realmPrincipals.put(realmName, new HashMap<String,Object>(principals));
217		} else {
218	0	return null;
219		}
220		} else {
221	0	Map<String,Object> existingPrincipals = this.realmPrincipals.remove(realmName);
222	0	if (!CollectionUtils.isEmpty(principals)) {
223	0	this.realmPrincipals.put(realmName, new HashMap<String,Object>(principals));
224		}
225	0	return existingPrincipals;
226		}
227		}
228
229		public Object setRealmPrincipal(String realmName, String principalName, Object principal) {
230	0	if (realmName == null) {
231	0	throw new NullPointerException("realmName argument cannot be null.");
232		}
233	0	if (principalName == null) {
234	0	throw new NullPointerException(("principalName argument cannot be null."));
235		}
236	0	if (principal == null) {
237	0	return removeRealmPrincipal(realmName, principalName);
238		}
239	0	if (this.realmPrincipals == null) {
240	0	this.realmPrincipals = new HashMap<String,Map<String,Object>>();
241		}
242	0	Map<String,Object> principals = this.realmPrincipals.get(realmName);
243	0	if (principals == null) {
244	0	principals = new HashMap<String,Object>();
245	0	this.realmPrincipals.put(realmName, principals);
246		}
247	0	return principals.put(principalName, principal);
248		}
249
250		public Object getRealmPrincipal(String realmName, String principalName) {
251	0	if (realmName == null) {
252	0	throw new NullPointerException("realmName argument cannot be null.");
253		}
254	0	if (principalName == null) {
255	0	throw new NullPointerException(("principalName argument cannot be null."));
256		}
257	0	if (this.realmPrincipals == null) {
258	0	return null;
259		}
260	0	Map<String,Object> principals = this.realmPrincipals.get(realmName);
261	0	if (principals != null) {
262	0	return principals.get(principalName);
263		}
264	0	return null;
265		}
266
267		public Object removeRealmPrincipal(String realmName, String principalName) {
268	0	if (realmName == null) {
269	0	throw new NullPointerException("realmName argument cannot be null.");
270		}
271	0	if (principalName == null) {
272	0	throw new NullPointerException(("principalName argument cannot be null."));
273		}
274	0	if (this.realmPrincipals == null) {
275	0	return null;
276		}
277	0	Map<String,Object> principals = this.realmPrincipals.get(realmName);
278	0	if (principals != null) {
279	0	return principals.remove(principalName);
280		}
281	0	return null;
282		}
283		}