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;
35
36 import java.security.Principal;
37
38 /**
39 * Provides the name for the default realm. A realm is a independent set of users.
40 * @author philipp
41 * @version $Id$
42 */
43 public interface Realm extends Principal {
44
45 /**
46 * The realm for the admin interface.
47 */
48 public static final Realm REALM_ADMIN = new RealmImpl("admin");
49
50 /**
51 * No realm --> all users.
52 */
53 public static final Realm REALM_ALL = new RealmImpl("all");
54
55 /**
56 * Contains not removable system users: anonymous, superuser.
57 */
58 public static final Realm REALM_SYSTEM = new RealmImpl("system");
59
60 /**
61 * The default realm is {@link Realm#REALM_ALL}.
62 */
63 public static final Realm DEFAULT_REALM = REALM_ALL;
64
65 /**
66 * Implementation of the realm. Enum would be easier to read, but would not be backward compatible.
67 * @author had
68 * @version $Id$
69 */
70 class RealmImpl implements Realm {
71 private final String name;
72 public RealmImpl(String name) {
73 if (name == null) {
74 throw new NullPointerException("Realm name can't be null!");
75 }
76 this.name = name;
77 }
78 @Override
79 public String getName() {
80 return name;
81 }
82
83 @Override
84 public int hashCode() {
85 return this.name.hashCode();
86 }
87
88 @Override
89 public boolean equals(Object o) {
90 if (o == null || !(o instanceof Realm) ) {
91 return false;
92 }
93 return this.name.equals(((Realm) o).getName());
94 }
95 }
96
97 /**
98 * Factory for providing realms.
99 */
100 public class Factory {
101 public static Realm newRealm(String realmName) {
102 if (REALM_ADMIN.getName().equals(realmName)) return REALM_ADMIN;
103 if (REALM_ALL.getName().equals(realmName)) return REALM_ALL;
104 if (REALM_SYSTEM.getName().equals(realmName)) return REALM_SYSTEM;
105 return new RealmImpl(realmName);
106 }
107 }
108 }