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