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 info.magnolia.cms.security.auth.ACL;
37
38 import java.util.Collection;
39 import java.util.Map;
40
41 import javax.jcr.Value;
42 import javax.security.auth.Subject;
43
44
45 /**
46 * Manages users.
47 * @version $Revision: 51822 $ ($Author: ochytil $)
48 */
49 public interface UserManager {
50
51 /**
52 * Magnolia system user name.
53 */
54 public static final String SYSTEM_USER = "superuser";
55
56 /**
57 * Magnolia system default password.
58 */
59 public static final String SYSTEM_PSWD = "superuser";
60
61 /**
62 * Anonymous user name.
63 */
64 public static final String ANONYMOUS_USER = "anonymous";
65
66 /**
67 * Find a specific user. Not all implementations will support this method.
68 * @param name the name of the user
69 * @return the user object
70 */
71 public User getUser(String name) throws UnsupportedOperationException;
72
73 /**
74 * Initialize new user using JAAS authenticated/authorized subject.
75 * @throws UnsupportedOperationException if the current implementation doesn't support this operation
76 * @deprecated jaas login module should just request the user, not pass the subject around to the user manager
77 */
78 @Deprecated
79 public User getUser(Subject subject) throws UnsupportedOperationException;
80
81 /**
82 * Get system user, this user must always exist in magnolia repository.
83 * @throws UnsupportedOperationException if the current implementation doesn't support this operation
84 */
85 public User getSystemUser() throws UnsupportedOperationException;
86
87 /**
88 * Get Anonymous user, this user must always exist in magnolia repository.
89 * @throws UnsupportedOperationException if the current implementation doesn't support this operation
90 */
91 public User getAnonymousUser() throws UnsupportedOperationException;
92
93 /**
94 * Get all users.
95 * @return collection of User objects
96 * @throws UnsupportedOperationException if the current implementation doesn't support this operation
97 */
98 public Collection<User> getAllUsers() throws UnsupportedOperationException;
99
100 /**
101 * Creates a user without security restrictions.
102 * @throws UnsupportedOperationException if the current implementation doesn't support this operation
103 */
104 public User createUser(String name, String pw) throws UnsupportedOperationException;
105
106 /**
107 * Sets a new password.
108 * @return user object with updated password.
109 * @throws UnsupportedOperationException if the current implementation doesn't support this operation
110 */
111 public User changePassword(User user, String newPassword) throws UnsupportedOperationException;
112
113 /**
114 * Sets given property for the user and returns updated user object with new value of the property.
115 *
116 * @param user
117 * User to be updated. If property doesn't exist yet, it will be created. If the value is null, property will be removed if existing.
118 * @param propertyName
119 * Name of the property.
120 * @param propertyValue
121 * Value of the property. Use org.apache.jackrabbit.value.ValueFactoryImpl to convert type to Value.
122 * @return
123 */
124 public User setProperty(User user, String propertyName, Value propertyValue);
125
126 /* ---------- User Manager configuration ----------- */
127
128 /**
129 * Sets a time period for account lock.
130 * @throws UnsupportedOperationException if the current implementation doesn't support this operation
131 */
132 public void setLockTimePeriod(int lockTimePeriod) throws UnsupportedOperationException;
133
134 /**
135 * Gets a time period for account lock.
136 * @throws UnsupportedOperationException if the current implementation doesn't support this operation
137 */
138 public int getLockTimePeriod() throws UnsupportedOperationException;
139
140 /**
141 * Sets a number of failed attempts before locking account.
142 * @throws UnsupportedOperationException if the current implementation doesn't support this operation
143 */
144 public void setMaxFailedLoginAttempts(int maxFailedLoginAttempts) throws UnsupportedOperationException;
145
146 /**
147 * Gets a number of failed attempts before locking account.
148 * @throws UnsupportedOperationException if the current implementation doesn't support this operation
149 */
150 public int getMaxFailedLoginAttempts() throws UnsupportedOperationException;
151
152 /**
153 * Grants user role.
154 * @return user object with the role already granted.
155 */
156 public User addRole(User user, String roleName);
157
158 /**
159 * Adds user to a group.
160 *
161 * @return user object with the group already assigned.
162 */
163 public User addGroup(User user, String groupName);
164
165 /**
166 * Updates last access timestamp for the user.
167 *
168 * @throws UnsupportedOperationException
169 * if the current implementation doesn't support this operation
170 */
171 public void updateLastAccessTimestamp(User user) throws UnsupportedOperationException;
172
173 /**
174 * Checks whether principal belongs to the named resource.
175 * @param name principal name
176 * @param resourceName either group or role name
177 * @param resourceType either group or role see
178 * @return
179 */
180 public boolean hasAny(String principal, String resourceName, String resourceType);
181
182 /**
183 * Returns all ACLs assigned to the given user.
184 * @return
185 */
186 public Map<String, ACL> getACLs(User user);
187
188
189 }