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 import java.util.Collection;
39
40 /**
41 * Represents a magnolia user.
42 */
43 public interface User extends Principal, Serializable {
44
45 /**
46 * Is this user in a specified role?
47 *
48 * @param roleName the name of the role
49 * @return true if in role
50 */
51 boolean hasRole(String roleName);
52
53 /**
54 * Remove a role. Implementation is optional
55 *
56 * @deprecated since 4.5 - use {@link UserManager#removeRole(User, String)} instead.
57 */
58 @Deprecated
59 default void removeRole(String roleName) throws UnsupportedOperationException {
60 throw new UnsupportedOperationException("Please, use manager to remove roles!");
61 }
62
63 /**
64 * Adds a role to this user. Implementation is optional
65 *
66 * @param roleName the name of the role
67 * @deprecated since 4.5 - use {@link UserManager#addRole(User, String)} instead.
68 */
69 @Deprecated
70 default void addRole(String roleName) throws UnsupportedOperationException {
71 throw new UnsupportedOperationException("Please, use manager to add roles!");
72 }
73
74 /**
75 * Is this user in a specified group?
76 *
77 * @return true if in group
78 */
79 boolean inGroup(String groupName);
80
81 /**
82 * Remove a group. Implementation is optional
83 *
84 * @deprecated since 4.5 - use {@link UserManager#removeGroup(User, String)} instead.
85 */
86 @Deprecated
87 default void removeGroup(String groupName) throws UnsupportedOperationException {
88 throw new UnsupportedOperationException("Please, use manager to remove groups!");
89 }
90
91 /**
92 * Adds this user to a group. Implementation is optional
93 *
94 * @deprecated since 4.5 - use {@link UserManager#addGroup(User, String)} instead.
95 */
96 @Deprecated
97 default void addGroup(String groupName) throws UnsupportedOperationException {
98 throw new UnsupportedOperationException("Please, use manager to add groups!");
99 }
100
101 /**
102 * Returns false if the user was explicitly disabled. Implementations should return
103 * true by default if the status is unknown.
104 */
105 boolean isEnabled();
106
107 /**
108 * @deprecated since 4.5, use {@link UserManager#setProperty(User, String, Value)} instead
109 */
110 @Deprecated
111 default void setEnabled(boolean enabled) {
112 throw new UnsupportedOperationException("Please, use manager to enable user!");
113 }
114
115 String getLanguage();
116
117 @Override
118 String getName();
119
120 String getPassword();
121
122 /**
123 * Gets an arbitrary property from this user.
124 */
125 String getProperty(String propertyName);
126
127 /**
128 * Sets an arbitrary property for this user.
129 * Values are currently Strings; we'd need some kind of abstract encoding mechanism to allow other types if needed.
130 *
131 * @deprecated since 4.5, use {@link UserManager#setProperty(User, String, Value)} instead
132 */
133 @Deprecated
134 void setProperty(String propertyName, String value);
135
136 /**
137 * Gets user identifier.
138 */
139 String getIdentifier();
140
141 /**
142 * Get groups that are directly assigned to the user.
143 */
144 Collection<String> getGroups();
145
146 /**
147 * Get all groups this user belongs to, collected recursively including supergroups.
148 */
149 Collection<String> getAllGroups();
150
151 /**
152 * Get roles that are directly assigned to the user.
153 */
154 Collection<String> getRoles();
155
156 /**
157 * Get all roles assigned to this user, collected recursively including groups and supergroups.
158 */
159 Collection<String> getAllRoles();
160
161 }