1 /** 2 * This file Copyright (c) 2003-2010 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.util.Collection; 37 38 import javax.security.auth.Subject; 39 40 41 /** 42 * Used to get the current or other User objects. 43 * @author philipp 44 * @version $Revision: 32667 $ ($Author: gjoseph $) 45 */ 46 public interface UserManager { 47 48 /** 49 * Magnolia system user. 50 */ 51 public static final String SYSTEM_USER = "superuser"; 52 53 /** 54 * Magnolia system default password 55 */ 56 public static final String SYSTEM_PSWD = "superuser"; 57 58 /** 59 * Anonymous user 60 */ 61 public static final String ANONYMOUS_USER = "anonymous"; 62 63 /** 64 * Find a specific user. Not all implementations will support this method. 65 * @param name the name of the user 66 * @return the user object 67 */ 68 public User getUser(String name) throws UnsupportedOperationException; 69 70 /** 71 * Initialize new user using JAAS authenticated/authorized subject 72 * @param subject 73 * @throws UnsupportedOperationException 74 */ 75 public User getUser(Subject subject) throws UnsupportedOperationException; 76 77 /** 78 * Get system user, this user must always exist in magnolia repository. 79 * @return system user 80 */ 81 public User getSystemUser() throws UnsupportedOperationException; 82 83 /** 84 * Get Anonymous user, this user must always exist in magnolia repository. 85 * @return anonymous user 86 */ 87 public User getAnonymousUser() throws UnsupportedOperationException; 88 89 /** 90 * Get all users. 91 * @return collection of User objects 92 * @throws UnsupportedOperationException 93 */ 94 public Collection<User> getAllUsers() throws UnsupportedOperationException; 95 96 /** 97 * Creates a user without security restrictions 98 * @param name user name 99 * @param pw password 100 * @return the new user object 101 * @throws UnsupportedOperationException 102 */ 103 public User createUser(String name, String pw) throws UnsupportedOperationException; 104 105 public void changePassword(User user, String newPassword) throws UnsupportedOperationException; 106 107 }