1 /**
2 * This file Copyright (c) 2007-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.jaas.principal;
35
36 import info.magnolia.cms.security.auth.PrincipalList;
37 import org.apache.commons.lang.StringUtils;
38 import org.apache.commons.lang.builder.ToStringBuilder;
39 import org.apache.commons.lang.builder.ToStringStyle;
40
41 import java.util.ArrayList;
42 import java.util.Collection;
43 import java.util.Iterator;
44
45 /**
46 *
47 * @author gjoseph
48 * @version $Revision: $ ($Author: $)
49 */
50 public abstract class AbstractPrincipalList implements PrincipalList {
51
52 private String name;
53
54 /**
55 * list of names
56 */
57 private Collection list;
58
59 protected AbstractPrincipalList() {
60 this.list = new ArrayList();
61 }
62
63 /**
64 * Get name given to this principal
65 * @return name
66 */
67 public String getName() {
68 if (StringUtils.isEmpty(this.name)) {
69 return getDefaultName();
70 }
71 return this.name;
72 }
73
74 abstract String getDefaultName();
75
76 /**
77 * Set principal name
78 * @param name
79 */
80 public void setName(String name) {
81 this.name = name;
82 }
83
84 /**
85 * Add a name to the list
86 * @param name
87 */
88 public void add(String name) {
89 this.list.add(name);
90 }
91
92 /**
93 * Gets list of roles as string
94 * @return roles
95 */
96 public Collection getList() {
97 return this.list;
98 }
99
100 /**
101 * Checks if the name exist in this list
102 * @param name
103 */
104 public boolean has(String name) {
105 Iterator listIterator = this.list.iterator();
106 while (listIterator.hasNext()) {
107 String roleName = (String) listIterator.next();
108 if (StringUtils.equalsIgnoreCase(name, roleName)) {
109 return true;
110 }
111 }
112 return false;
113 }
114
115 /**
116 * @see Object#toString()
117 */
118 public String toString() {
119 return new ToStringBuilder(this, ToStringStyle.SHORT_PREFIX_STYLE).append("name", getName()).append("list", this.list).toString();
120 }
121 }