From c43d2a3415edd6edbce737c2cd71998b353c9c7d Mon Sep 17 00:00:00 2001 From: ulrich <not disclosed> Date: Tue, 27 Dec 2016 18:58:25 +0000 Subject: [PATCH] UserMgr aufgeraeumt und mit weiteren Kommentaren versehen --- src/java/de/uhilger/um/api/UserMgr.java | 165 ++++++++++++++++++++++++++++++++++++++++++++----------- 1 files changed, 132 insertions(+), 33 deletions(-) diff --git a/src/java/de/uhilger/um/api/UserMgr.java b/src/java/de/uhilger/um/api/UserMgr.java index 399a461..cf6982a 100644 --- a/src/java/de/uhilger/um/api/UserMgr.java +++ b/src/java/de/uhilger/um/api/UserMgr.java @@ -1,73 +1,172 @@ +/* + * Nutzerverwaltung - User and role management in your browser + * Copyright (C) 2011-2016 Ulrich Hilger, http://uhilger.de + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see http://www.gnu.org/licenses/ + */ + package de.uhilger.um.api; import de.uhilger.baselink.GenericRecord; +import de.uhilger.baselink.PersistenceManager; import de.uhilger.baselink.Record; -import de.uhilger.um.App; +import de.uhilger.transit.web.WebKontext; +import de.uhilger.um.Digester; import de.uhilger.um.daten.User; +import de.uhilger.um.daten.UserRole; +import java.sql.Connection; import java.util.List; -import org.apache.catalina.realm.RealmBase; +import java.util.Properties; +import javax.servlet.ServletContext; /** - * Klasse zur Verwaltung von Benutzern in einer Datenbank + * <p>Die Methoden der Klasse UserMgr sind + * die 'Fassade', die über Transit als Programmschnittstelle + * (Application Programming Interface, API) + * nach außen bereitgestellt wird. UserMgr dient weitgehend + * als 'Durchreiche' für die Funktionalität anderer Klassen.</p> * - * @author Ulrich Hilger + * <p> + * Der UserMgr erhält die benötigten Methoden aus dem ServletContext. + * Auf diese Weise sind keine statischen Abhängigkeiten in den Code + * gewandert. Die folgenden Elemente werden vom UserMgr im ServletContext + * erwartet: + * <ul> + * <li>PersistenceManager</li> + * <li>SQL-Properties</li> + * <li>Digester</li> + * </p> + * + * @author Copyright (c) Ulrich Hilger, http://uhilger.de + * @author Published under the terms and conditions of the + * <a href="http://www.gnu.org/licenses/agpl-3.0" target="_blank">GNU Affero + * General Public License</a> + * + * @version 2, December 27, 2016 */ -public class UserMgr { +public class UserMgr implements WebKontext { - private static final String MD5 = "MD5"; + /** Zeiger zum Servlet-Kontext dieser Anwendung */ + private ServletContext ctx; - private static final Record UserMapper = new GenericRecord(User.class); + /** Name, unter dem das Properties-Objekt mit den SQL-Befehlen im ServletContext hinterlegt ist */ + public static final String UM_SQL_PROPERTIES = "umSqlProperties"; + + /** Name, unter dem das Digester-Objekt im ServletContext hinterlegt ist */ + public static final String P_DIGESTER = "digester"; + + /** Name, unter dem das Zugriffsobjekt zur Datenbank im ServletContext hinterlegt ist */ + public static final String UM_DB = "umDb"; + /** Boolean-Konstante zur Kennzeichnung von Datenbankergebnissen ohne Blobs */ + public static final boolean WITHOUT_BLOBS = false; + + /** Referenz zum SQL-Befehl zur Ermittlung der Benutzer */ public static final String SQL_GET_USER_LIST = "getUserList"; + /** Referenz zum SQL-Befehl zur Ermittlung der Benutzer-Namen */ public static final String SQL_GET_USER_NAME_LIST = "getUserNameList"; - public static final String SQL_DELETE_USER = "deleteUser"; + /** Referenz zum SQL-Befehl zur Ermittlung der Rollen */ + public static final String SQL_GET_ROLE_LIST = "getRoleList"; + /** Referenz zum SQL-Befehl zur Ermittlung der Rollen eines Benutzers */ + public static final String SQL_GET_USER_ROLES = "getUserRoles"; + /** Referenz zum SQL-Befehl zum Loeschen aller Rollen eines Nutzers */ + public static final String SQL_DELETE_USER_ROLES = "deleteUserRoles"; + + /** Mapper-Objekt fuer Benutzer */ + private static final Record UserMapper = new GenericRecord(User.class); + /** Mapper-Objekt fuer Benutzerrollen */ + private static final Record UserRoleMapper = new GenericRecord(UserRole.class); /* ----------- Benutzer -------------- */ - public User createUser(User user) { + public User createUser(User user) throws ClassNotFoundException, InstantiationException, IllegalAccessException { String kw = user.getPw(); - String digestedPw = RealmBase.Digest(kw, MD5, null); + String digesterClassName = ctx.getInitParameter(P_DIGESTER); + Digester digester = (Digester) Class.forName(digesterClassName).newInstance(); + String digestedPw = digester.digest(kw, Digester.MD5, null); user.setPw(digestedPw); - App.getDatabase().insert(user, UserMapper); + getDb().insert(user, UserMapper); return user; } public List getUserNameList() { - String sql = App.getSqlStatement(SQL_GET_USER_NAME_LIST); - List userNames = App.getDatabase().select(sql, App.WITHOUT_BLOBS); - return userNames; + return getDb().select(getSql(SQL_GET_USER_NAME_LIST), WITHOUT_BLOBS); } public User deleteUser(User user) { - return (User) App.getDatabase().delete(user, UserMapper); + PersistenceManager pm = getDb(); + Connection c = pm.getConnection(); + pm.startTransaction(c); + pm.execute(c, getSql(SQL_DELETE_USER_ROLES), user.getId()); + User deletedUser = (User) pm.delete(c, user, UserMapper); + pm.commit(c); + return deletedUser; } - - /* - public List getUserList() { - String sql = App.getSqlStatement(SQL_GET_USER_LIST); - List users = App.getDatabase().select(sql, UserMapper, App.WITHOUT_BLOBS); - return users; - } - */ - + /* ------------ Rollen ------------------ */ - public String grantRole(String userId, String roleName) { - return "not implemented"; + public UserRole grantRole(String userId, String roleName) { + UserRole ur = new UserRole(); + ur.setRole(roleName); + ur.setUser(userId); + getDb().insert(ur, UserRoleMapper); + return ur; } - public String revokeRole(String userId, String roleName) { - return "not implemented"; + public UserRole revokeRole(String userId, String roleName) { + UserRole ur = new UserRole(); + ur.setRole(roleName); + ur.setUser(userId); + getDb().delete(ur, UserRoleMapper); + return ur; } public List getRoleNamesGranted() { - return null; + return getDb().select(getSql(SQL_GET_ROLE_LIST), WITHOUT_BLOBS); } - /* ------------ sonstige Methoden -------------- */ - - public String hallo() { - return "Hallo Welt"; + public List getUserRoleNames(String userId) { + return getDb().select(getSql(SQL_GET_USER_ROLES), WITHOUT_BLOBS, userId); } + /* ----------- Helfer ---- */ + + /** + * Ein benanntes SQL-Kommando ermitteln + * @param id Name des gewuenschten SQL-Kommandos + * @return das SQL-Kommando mit der in id angegebenen Bezeichnung + */ + private String getSql(String id) { + Properties sql = (Properties) ctx.getAttribute(UserMgr.UM_SQL_PROPERTIES); + return sql.getProperty(id); + } + + private PersistenceManager getDb() { + return (PersistenceManager) ctx.getAttribute(UM_DB); + } + + /* ------------- Implementierung WebKontext ------------- */ + + @Override + public ServletContext getServletContext() { + return ctx; + } + + @Override + public void setServletContext(ServletContext servletContext) { + this.ctx = servletContext; + } + + } -- Gitblit v1.9.3