Changeset 26912 for main/trunk/greenstone3

Timestamp:

2013-02-21T14:04:36+13:00 (11 years ago)

Author:

davidb

Message:

Some adjustments to code, focusing on use of openDatabase() and closeDatabase(). Some of the changes a general spruce up, but main change triggered by needing a cleanUp function that ensures the Derby database is really shutdown when the servlet stops. Previous to this change, we could get warnings about a memory leak in catalina.out caused by threads (e.g. [derby.antiGC]) started by /greenstone3 servlet but not stopped.

File:

• main/trunk/greenstone3/src/java/org/greenstone/gsdl3/service/Authentication.java (modified) (18 diffs)

main/trunk/greenstone3/src/java/org/greenstone/gsdl3/service/Authentication.java

@@ -127 +127 @@
     protected static final String GET_USER_INFORMATION_SERVICE = "GetUserInformation";
 
-    protected DerbyWrapper _derbyWrapper = null;
+    protected static DerbyWrapper _derbyWrapper = null;
+        protected static boolean _derbyWrapperDoneForcedShutdown = false;
 
     protected String _recaptchaPrivateKey = null;
@@ -135 +136 @@
     public Authentication()
     {
+    }
+
+        public void cleanUp() {
+
+        super.cleanUp();
+
+        if (!_derbyWrapperDoneForcedShutdown) {     
+
+        // This boolean is used to ensure we always shutdown the derby server, even if it is never
+        // used by the Authentication server.  This is because the Tomcat greenstone3.xml
+        // config file also specifies a connection to the database, which can result in the
+        // server being initialized when the servlet is first accessed.  Note also, 
+        // Authentication is a ServiceRack, meaning cleanUp() is called for each service
+        // supported, however we only need to shutdown the Derby server once.  Again
+        // this boolean variable helps achieve this.
+
+        logger.info("Authentication Service performing forced shutdown of Derby Server ...");
+        
+        DerbyWrapper.shutdownDatabaseServer();
+        _derbyWrapper = null;
+        _derbyWrapperDonwForcedShutdown = true;
+
     }
 
@@ -254 +277 @@
         }
 
-        DerbyWrapper dbWrapper = new DerbyWrapper();
-
-        String usersDB_dir = this.site_home + File.separatorChar + "etc" + File.separatorChar + "usersDB";
-        dbWrapper.connectDatabase(usersDB_dir, true);
-
-        UserQueryResult userQueryResult;
+        openDatabase();
+
         try
         {
-            userQueryResult = dbWrapper.findUser(username);
+                UserQueryResult userQueryResult = _derbyWrapper.findUser(username);
+            
             Vector<UserTermInfo> terms = userQueryResult.getUserTerms();
 
@@ -268 +288 @@
             {
                 GSXML.addError(this.doc, result, _errorMessageMap.get(ERROR_REQUESTED_USER_NOT_FOUND));
+                closeDatabase();
                 return result;
             }
@@ -292 +313 @@
             ex.printStackTrace();
         }
+
+
+        closeDatabase();
 
         return result;
@@ -803 +827 @@
     private void checkAdminUserExists()
     {
-        if (_derbyWrapper == null)
-        {
-            openDatabase();
-        }
+            openDatabase();
 
         UserQueryResult userQueryResult = _derbyWrapper.findUser(null, null);
-        closeDatabase();
 
         if (userQueryResult != null)
@@ -835 +855 @@
     private boolean openDatabase()
     {
+        if (_derbyWrapper == null) {
         _derbyWrapper = new DerbyWrapper();
 
@@ -860 +881 @@
             _derbyWrapper.connectDatabase(usersDB_dir, false);
         }
-        return true;
+        }
+        return true;
     }
 
@@ -873 +895 @@
 
     private int addUserInformationToNode(String username, Element serviceNode)
-    {
-        if (_derbyWrapper == null)
-        {
-            openDatabase();
-        }
+    {       
+            openDatabase();
 
         UserQueryResult userQueryResult = _derbyWrapper.findUser(username, null);
-        closeDatabase();
 
         if (userQueryResult != null)
@@ -901 +919 @@
         }
 
-        if (_derbyWrapper == null)
-        {
-            openDatabase();
-        }
+        openDatabase();
 
         boolean success = _derbyWrapper.deleteUser(username);
+
+        if (success)
+        {
+            closeDatabase();
+            return NO_ERROR;
+        }
+
         closeDatabase();
-
-        if (success)
-        {
-            return NO_ERROR;
-        }
-
         return ERROR_REMOVING_USER;
     }
@@ -919 +935 @@
     private int addUser(String newUsername, String newPassword, String newGroups, String newStatus, String newComment, String newEmail)
     {
-        if (_derbyWrapper == null)
-        {
-            openDatabase();
-        }
+            openDatabase();
 
         newGroups = newGroups.replaceAll(" ", "");
@@ -928 +941 @@
         //Check if the user already exists
         UserQueryResult userQueryResult = _derbyWrapper.findUser(newUsername, null);
+
         if (userQueryResult != null)
         {
@@ -943 +957 @@
             }
         }
+
         closeDatabase();
         return NO_ERROR;
@@ -949 +964 @@
     private boolean checkUserExists(String username)
     {
-        if (_derbyWrapper == null)
-        {
-            openDatabase();
-        }
+            boolean check_status = false;
+
+        openDatabase();
 
         try
@@ -960 +974 @@
             if (result != null)
             {
-                return true;
-            }
-            else
-            {
-                return false;
+                check_status = true;
             }
 
@@ -970 +980 @@
         catch (Exception ex)
         {
-            return false;
-        }
-        finally
-        {
-            closeDatabase();
-        }
+            // some error occurred accessing the database
+            ex.printStackTrace();
+        }
+
+        closeDatabase();
+        return check_status;
     }
 
     private String retrieveDataForUser(String username, String dataType)
     {
-        if (_derbyWrapper == null)
-        {
-            openDatabase();
-        }
-
-        String password = null;
+            openDatabase();
+
+        String data = null;
 
         try
@@ -996 +1003 @@
                 if (dataType.equals("password"))
                 {
-                    return ((UserTermInfo) userInfo.get(i)).password;
+                    data = ((UserTermInfo) userInfo.get(i)).password;
+                    break;
                 }
                 else if (dataType.equals("groups"))
                 {
-                    return ((UserTermInfo) userInfo.get(i)).groups;
+                    data = ((UserTermInfo) userInfo.get(i)).groups;
+                    break;
                 }
                 else if (dataType.equals("status"))
                 {
-                    return ((UserTermInfo) userInfo.get(i)).accountstatus;
+                    data = ((UserTermInfo) userInfo.get(i)).accountstatus;
+                    break;
                 }
                 else if (dataType.equals("comment"))
                 {
-                    return ((UserTermInfo) userInfo.get(i)).comment;
+                    data = ((UserTermInfo) userInfo.get(i)).comment;
+                    break;
                 }
                 else if (dataType.equals("email"))
                 {
-                    return ((UserTermInfo) userInfo.get(i)).email;
+                    data = ((UserTermInfo) userInfo.get(i)).email;
+                    break;
                 }
             }
@@ -1022 +1034 @@
 
         closeDatabase();
-        return password;
+        return data;
     }