1 /**
2 * This file Copyright (c) 2003-2015 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 * @param roleName the name of the role
48 * @return true if in role
49 */
50 boolean hasRole(String roleName);
51
52 /**
53 * Remove a role. Implementation is optional
54 * @deprecated since 4.5 - use {@link UserManager#removeRole(User, String)} instead.
55 */
56 @Deprecated
57 void removeRole(String roleName) throws UnsupportedOperationException;
58
59 /**
60 * Adds a role to this user. Implementation is optional
61 * @param roleName the name of the role
62 * @deprecated since 4.5 - use {@link UserManager#addRole(User, String)} instead.
63 */
64 @Deprecated
65 void addRole(String roleName) throws UnsupportedOperationException;
66
67 /**
68 * Is this user in a specified group?
69 * @return true if in group
70 */
71 boolean inGroup(String groupName);
72
73 /**
74 * Remove a group. Implementation is optional
75 * @deprecated since 4.5 - use {@link UserManager#removeGroup(User, String)} instead.
76 */
77 @Deprecated
78 void removeGroup(String groupName) throws UnsupportedOperationException;
79
80 /**
81 * Adds this user to a group. Implementation is optional
82 * @deprecated since 4.5 - use {@link UserManager#addGroup(User, String)} instead.
83 */
84 @Deprecated
85 void addGroup(String groupName) throws UnsupportedOperationException;
86
87 /**
88 * Returns false if the user was explicitly disabled. Implementations should return
89 * true by default if the status is unknown.
90 */
91 boolean isEnabled();
92
93 /**
94 * @deprecated since 4.5, use {@link UserManager#setProperty(User, String, Value)} instead
95 */
96 @Deprecated
97 void setEnabled(boolean enabled);
98
99 String getLanguage();
100
101 @Override
102 String getName();
103
104 String getPassword();
105
106 /**
107 * Gets an arbitrary property from this user.
108 */
109 String getProperty(String propertyName);
110
111 /**
112 * Sets an arbitrary property for this user.
113 * Values are currently Strings; we'd need some kind of abstract encoding mechanism to allow other types if needed.
114 * @deprecated since 4.5, use {@link UserManager#setProperty(User, String, Value)} instead
115 */
116 @Deprecated
117 void setProperty(String propertyName, String value);
118
119 /**
120 * Gets user identifier.
121 */
122 String getIdentifier();
123
124 /**
125 * Get groups that are directly assigned to the user.
126 */
127 Collection<String> getGroups();
128
129 /**
130 * Get all groups to which this user belongs to, collected recursively including.
131 */
132 Collection<String> getAllGroups();
133
134 /**
135 * Get roles that are directly assigned to the user.
136 */
137 Collection<String> getRoles();
138
139 /**
140 * Get all roles assigned to this user, collected recursively including groups/subgroups.
141 */
142 Collection<String> getAllRoles();
143
144 }