From 1fc020b8ce526f562badb1a18318c10e00d54cdf Mon Sep 17 00:00:00 2001
From: ulrich <not disclosed>
Date: Tue, 27 Dec 2016 17:32:39 +0000
Subject: [PATCH] Verlagerung statischer Elemente in den ServletContext (in Arbeit)

---
 src/java/de/uhilger/um/App.java            |   27 ++++-----
 src/java/de/uhilger/um/Digester.java       |   38 +++++++++++-
 src/java/de/uhilger/um/TomcatDigester.java |   27 +++++++-
 src/java/de/uhilger/um/api/UserMgr.java    |   78 +++++++++++++++++++++-----
 4 files changed, 132 insertions(+), 38 deletions(-)

diff --git a/src/java/de/uhilger/um/App.java b/src/java/de/uhilger/um/App.java
index 61c44d7..a85105e 100644
--- a/src/java/de/uhilger/um/App.java
+++ b/src/java/de/uhilger/um/App.java
@@ -2,6 +2,7 @@
 
 import de.uhilger.baselink.PersistenceManager;
 import de.uhilger.baselink.Record;
+import de.uhilger.um.api.UserMgr;
 import java.io.BufferedReader;
 import java.io.File;
 import java.io.FileInputStream;
@@ -33,8 +34,6 @@
   private static final String SCRIPT_NAME = "create_database.sql";  
   /** Name der Datei mit den SQL-Kommandos dieser Anwendung */
   public static final String SQL_PROPERTIES_NAME = "sql.properties";
-  /** Name, unter dem das Properties-Objekt mit den SQL-Befehlen im ServletContext hinterlegt ist */
-  public static final String UM_SQL_PROPERTIES = "umSqlProperties";
   /** Name des Parameters, unter dem der Name der DataSource im Deployment Descritpor zu finden ist */
   public static final String P_DSNAME = "dsname";
   
@@ -52,10 +51,19 @@
   /** Anwendungsweite Referenz zu den SQL-Befehlen */
   private static Properties sql;
   
+  /** die Klasse, die von der Nutzerverwaltung zum Verschl&uuml;sseln verwendet wird */
   private static Digester digester;
   
+  /**
+   * Diese Webanwendung initialisieren, also z.B. Elemente instantiieren, die
+   * &uuml;ber den Deployment Descritpor ver&auml;nderlich gehalten sind.
+   * 
+   * @param servletContext  der zur Laufzeit bestehende ServletContext
+   */
   private void initApp(ServletContext servletContext) {
     try {
+      initSql(servletContext);
+      initDb(servletContext);
       String digesterClassName = servletContext.getInitParameter(P_DIGESTER);
       digester = (Digester) Class.forName(digesterClassName).newInstance();
     } catch (Exception ex) {
@@ -79,7 +87,7 @@
       logger.fine("lese SQL-Eigenschaften von " + sqlFile.getAbsolutePath());
       sql = new Properties();
       sql.loadFromXML(new FileInputStream(sqlFile));
-      servletContext.setAttribute(UM_SQL_PROPERTIES, sql);
+      servletContext.setAttribute(UserMgr.UM_SQL_PROPERTIES, sql);
       logger.fine("Abfrage dbVorhanden='" + sql.getProperty(SQL_DB_VORHANDEN) + "'");
     } catch(Exception ex) {
       logger.log(Level.SEVERE, ex.getMessage(), ex);
@@ -99,15 +107,6 @@
       db = new PersistenceManager();
     }
     return db;
-  }
-  
-  /**
-   * Ein benanntes SQL-Kommando ermitteln 
-   * @param id Name des gewuenschten SQL-Kommandos
-   * @return das SQL-Kommando mit der in id angegebenen Bezeichnung 
-   */
-  public static String getSqlStatement(String id) {
-    return sql.getProperty(id);
   }
   
   public static Digester getDigester() {
@@ -140,7 +139,7 @@
     try {
       db = new PersistenceManager();
       db.setDataSourceName(servletContext.getInitParameter(P_DSNAME));
-      Properties sql = (Properties) servletContext.getAttribute(UM_SQL_PROPERTIES);
+      Properties sql = (Properties) servletContext.getAttribute(UserMgr.UM_SQL_PROPERTIES);
       if(!dbVorhanden(db, sql.getProperty(SQL_DB_VORHANDEN))) {
         logger.info("Datenbank ist nicht vorhanden");
         int[] ergebnis = db.executeScript(getSqlSkript());
@@ -183,8 +182,6 @@
   @Override
   public void contextInitialized(ServletContextEvent sce) {
     ServletContext servletContext = sce.getServletContext();
-    initSql(servletContext);
-    initDb(servletContext);
     initApp(servletContext);
   }
 
diff --git a/src/java/de/uhilger/um/Digester.java b/src/java/de/uhilger/um/Digester.java
index 8164095..0ca00c2 100644
--- a/src/java/de/uhilger/um/Digester.java
+++ b/src/java/de/uhilger/um/Digester.java
@@ -1,16 +1,46 @@
 /*
- * To change this license header, choose License Headers in Project Properties.
- * To change this template file, choose Tools | Templates
- * and open the template in the editor.
+ Nutzerverwaltung - A Generic User Manager
+ Copyright (c) 2016  Ulrich Hilger
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU Affero 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 Affero General Public License for more details.
+
+ You should have received a copy of the GNU Affero General Public License
+ along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 package de.uhilger.um;
 
 /**
+ * Klassen, die eine Verschl&uuml;sselungsfunktion f&6uml;r den 
+ * UserMgr bereitstellen wollen, m&uuml;ssen diese Schnittstelle 
+ * implementieren
  *
- * @author ulli
+ * @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 interface Digester {
+  
+  /** Name des MD5-Algorithmus zum Verschl&uuml;sseln */
   public static final String MD5 = "MD5";
 
+  /**
+   * Einen Ausdruck verschl&uuml;sseln
+   * 
+   * @param text  der Ausdruck, der verschl&uuml;sselt werden soll
+   * @param algorithm  der Name des Algorithmus, der zum Verschl&uuml;sseln verwendet werden soll
+   * @param encoding  das Encoding, in dem der Ausdruck vorliegt
+   * @return  der verschl&uuml;sselte Ausdruck
+   */
   String digest(String text, String algorithm, String encoding);
 }
diff --git a/src/java/de/uhilger/um/TomcatDigester.java b/src/java/de/uhilger/um/TomcatDigester.java
index dae60e8..3c152fd 100644
--- a/src/java/de/uhilger/um/TomcatDigester.java
+++ b/src/java/de/uhilger/um/TomcatDigester.java
@@ -1,15 +1,34 @@
 /*
- * To change this license header, choose License Headers in Project Properties.
- * To change this template file, choose Tools | Templates
- * and open the template in the editor.
+ Nutzerverwaltung - A Generic User Manager
+ Copyright (c) 2016  Ulrich Hilger
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU Affero 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 Affero General Public License for more details.
+
+ You should have received a copy of the GNU Affero General Public License
+ along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 package de.uhilger.um;
 
 import org.apache.catalina.realm.RealmBase;
 
 /**
+ * Ein Digester f&uuml;r die Nutzerverwaltung, der die Klasse 
+ * RealmBase von Tomcat zum Verschl&uuml;sseln nutzt
  *
- * @author ulli
+ * @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 TomcatDigester implements Digester {
 
diff --git a/src/java/de/uhilger/um/api/UserMgr.java b/src/java/de/uhilger/um/api/UserMgr.java
index dc2c169..6b1a321 100644
--- a/src/java/de/uhilger/um/api/UserMgr.java
+++ b/src/java/de/uhilger/um/api/UserMgr.java
@@ -20,19 +20,35 @@
 import de.uhilger.baselink.GenericRecord;
 import de.uhilger.baselink.PersistenceManager;
 import de.uhilger.baselink.Record;
+import de.uhilger.transit.web.WebKontext;
 import de.uhilger.um.App;
 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 java.util.Properties;
+import javax.servlet.ServletContext;
 
 /**
- * Klasse zur Verwaltung von Benutzern und Rollen 
- * in einer Datenbank. Die Datenbankverbindung wird 
- * vom zentralen Anwendungsobjekt bereitgestellt. 
+ * <p>Die Methoden der Klasse UserMgr sind  
+ * die 'Fassade', die &uuml;ber Transit als Programmschnittstelle 
+ * (Application Programming Interface, API) 
+ * nach au&szlig;en bereitgestellt wird. UserMgr dient weitgehend 
+ * als 'Durchreiche' f&uuml;r die Funktionalit&auml;t anderer Klassen.</p>
  * 
- * Die SQL-Befehle finden sich in WEB-INF/sql.properties
+ * <p>
+ * Der UserMgr erh&auml;lt die ben&ouml;tigten Methoden aus dem ServletContext. 
+ * Auf diese Weise sind keine statischen Abh&auml;ngigkeiten in den Code 
+ * gewandert. Die folgenden Elemente werden vom UserMgr im ServletContext 
+ * erwartet:
+ * 
+ * [noch auspraegen]
+ * 
+ * PersistenceManager
+ * SQL-Properties
+ * Digester
+ * </p> 
  * 
  * @author Copyright (c) Ulrich Hilger, http://uhilger.de
  * @author Published under the terms and conditions of the
@@ -41,10 +57,18 @@
  *
  * @version 2, December 27, 2016
  */
-public class UserMgr {
+public class UserMgr implements WebKontext {
+  
+  private ServletContext ctx;
   
   private static final Record UserMapper = new GenericRecord(User.class);
   private static final Record UserRoleMapper = new GenericRecord(UserRole.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 Zugriffsobjekt zur Datenbank im ServletContext hinterlegt ist */
+  public static final String UM_DB = "umDb";
   
   public static final String SQL_GET_USER_LIST = "getUserList";
   public static final String SQL_GET_USER_NAME_LIST = "getUserNameList";
@@ -64,16 +88,15 @@
   }
   
   public List getUserNameList() {
-    String sql = App.getSqlStatement(SQL_GET_USER_NAME_LIST);
-    List userNames = App.getDatabase().select(sql, App.WITHOUT_BLOBS);
-    return userNames;
+    String sql = getSqlStatement(SQL_GET_USER_NAME_LIST);
+    return App.getDatabase().select(sql, App.WITHOUT_BLOBS);
   }
   
   public User deleteUser(User user) {
     PersistenceManager pm = App.getDatabase();
     Connection c = pm.getConnection();
     pm.startTransaction(c);
-    String sql = App.getSqlStatement(SQL_DELETE_USER_ROLES);
+    String sql = getSqlStatement(SQL_DELETE_USER_ROLES);
     pm.execute(c, sql, user.getId());
     User deletedUser = (User) pm.delete(c, user, UserMapper);
     pm.commit(c);
@@ -99,15 +122,40 @@
   }
   
   public List getRoleNamesGranted() {
-    String sql = App.getSqlStatement(SQL_GET_ROLE_LIST);
-    List roleNames = App.getDatabase().select(sql, App.WITHOUT_BLOBS);
-    return roleNames;
+    String sql = getSqlStatement(SQL_GET_ROLE_LIST);
+    return App.getDatabase().select(sql, App.WITHOUT_BLOBS);
   }
   
   public List getUserRoleNames(String userId) {
-    String sql = App.getSqlStatement(SQL_GET_USER_ROLES);
-    List roleNames = App.getDatabase().select(sql, App.WITHOUT_BLOBS, userId);
-    return roleNames;
+    String sql = getSqlStatement(SQL_GET_USER_ROLES);
+    return App.getDatabase().select(sql, App.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 getSqlStatement(String id) {
+    Properties sql = (Properties) ctx.getAttribute(UserMgr.UM_SQL_PROPERTIES);
+    return sql.getProperty(id);
+  }
+  
+  /* ------------- Implementierung WebKontext ------------- */
+
+  @Override
+  public ServletContext getServletContext() {
+    return ctx;
+  }
+
+  @Override
+  public void setServletContext(ServletContext servletContext) {
+    this.ctx = servletContext;
+  }
+  
+  
 }

--
Gitblit v1.9.3