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

Timestamp:

2014-04-10T14:39:33+12:00 (10 years ago)

Author:

kjdon

Message:

Lots of changes. Mainly to do with removing this.doc from everywhere. Document is not thread safe. Now we tend to create a new Document everytime we are starting a new page/message etc. in service this.desc_doc is available as teh document to create service info stuff. But it should only be used for this and not for other messages. newDOM is now static for XMLConverter. method param changes for some GSXML methods.

File:

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

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

@@ -19 +19 @@
 import org.greenstone.gsdl3.util.UserQueryResult;
 import org.greenstone.gsdl3.util.UserTermInfo;
+import org.greenstone.gsdl3.util.XMLConverter;
 import org.greenstone.util.GlobalProperties;
+
+import org.w3c.dom.Document;
 import org.w3c.dom.Element;
 import org.w3c.dom.NodeList;
@@ -168 +171 @@
 
         // set up Authentication service info - for now just has name and type
-        Element authentication_service = this.doc.createElement(GSXML.SERVICE_ELEM);
+        Element authentication_service = this.desc_doc.createElement(GSXML.SERVICE_ELEM);
         authentication_service.setAttribute(GSXML.TYPE_ATT, "authen");
         authentication_service.setAttribute(GSXML.NAME_ATT, AUTHENTICATION_SERVICE);
         this.short_service_info.appendChild(authentication_service);
 
-        Element getUserInformation_service = this.doc.createElement(GSXML.SERVICE_ELEM);
+        Element getUserInformation_service = this.desc_doc.createElement(GSXML.SERVICE_ELEM);
         getUserInformation_service.setAttribute(GSXML.TYPE_ATT, GSXML.SERVICE_TYPE_PROCESS);
         getUserInformation_service.setAttribute(GSXML.NAME_ATT, GET_USER_INFORMATION_SERVICE);
         this.short_service_info.appendChild(getUserInformation_service);
 
-        Element changeEditMode_service = this.doc.createElement(GSXML.SERVICE_ELEM);
+        Element changeEditMode_service = this.desc_doc.createElement(GSXML.SERVICE_ELEM);
         changeEditMode_service.setAttribute(GSXML.TYPE_ATT, GSXML.SERVICE_TYPE_PROCESS);
         changeEditMode_service.setAttribute(GSXML.NAME_ATT, CHANGE_USER_EDIT_MODE_SERVICE);
         this.short_service_info.appendChild(changeEditMode_service);
         
-        Element remoteAuthentication_service = this.doc.createElement(GSXML.SERVICE_ELEM);
+        Element remoteAuthentication_service = this.desc_doc.createElement(GSXML.SERVICE_ELEM);
         remoteAuthentication_service.setAttribute(GSXML.TYPE_ATT, GSXML.SERVICE_TYPE_PROCESS);
         remoteAuthentication_service.setAttribute(GSXML.NAME_ATT, REMOTE_AUTHENTICATION_SERVICE);
@@ -214 +217 @@
     }
 
-    protected Element getServiceDescription(String service_id, String lang, String subset)
-    {
-
-        Element authen_service = this.doc.createElement(GSXML.SERVICE_ELEM);
+  protected Element getServiceDescription(Document doc, String service_id, String lang, String subset)
+    {
+
+        Element authen_service = doc.createElement(GSXML.SERVICE_ELEM);
 
         if (service_id.equals(AUTHENTICATION_SERVICE))
@@ -246 +249 @@
         if (service_id.equals(AUTHENTICATION_SERVICE) && (subset == null || subset.equals(GSXML.DISPLAY_TEXT_ELEM + GSXML.LIST_MODIFIER)))
         {
-            authen_service.appendChild(GSXML.createDisplayTextElement(this.doc, GSXML.DISPLAY_TEXT_NAME, getServiceName(service_id, lang)));
-            authen_service.appendChild(GSXML.createDisplayTextElement(this.doc, GSXML.DISPLAY_TEXT_DESCRIPTION, getServiceDescription(service_id, lang)));
+            authen_service.appendChild(GSXML.createDisplayTextElement(doc, GSXML.DISPLAY_TEXT_NAME, getServiceName(service_id, lang)));
+            authen_service.appendChild(GSXML.createDisplayTextElement(doc, GSXML.DISPLAY_TEXT_DESCRIPTION, getServiceDescription(service_id, lang)));
         }
         return authen_service;
@@ -270 +273 @@
     {
         // Create a new (empty) result message
-        Element result = this.doc.createElement(GSXML.RESPONSE_ELEM);
+      Document result_doc = XMLConverter.newDOM();
+        Element result = result_doc.createElement(GSXML.RESPONSE_ELEM);
 
         result.setAttribute(GSXML.FROM_ATT, CHANGE_USER_EDIT_MODE_SERVICE);
@@ -278 +282 @@
         if (paramList == null)
         {
-            GSXML.addError(this.doc, result, _errorMessageMap.get(ERROR_REQUEST_HAS_NO_PARAM_LIST));
+            GSXML.addError(result, _errorMessageMap.get(ERROR_REQUEST_HAS_NO_PARAM_LIST));
             return result;
         }
@@ -362 +366 @@
             }
         }
-        
-        Element result = this.doc.createElement(GSXML.RESPONSE_ELEM);
+        Document result_doc = XMLConverter.newDOM();
+        Element result = result_doc.createElement(GSXML.RESPONSE_ELEM);
         result.setAttribute(GSXML.FROM_ATT, REMOTE_AUTHENTICATION_SERVICE);
         result.setAttribute(GSXML.TYPE_ATT, GSXML.REQUEST_TYPE_PROCESS);        
-        Element s = GSXML.createTextElement(this.doc, GSXML.STATUS_ELEM, message);
+        Element s = GSXML.createTextElement(result_doc, GSXML.STATUS_ELEM, message);
         result.appendChild(s);
         return result;
@@ -374 +378 @@
     {
         // Create a new (empty) result message
-        Element result = this.doc.createElement(GSXML.RESPONSE_ELEM);
+      Document result_doc = XMLConverter.newDOM();
+        Element result = result_doc.createElement(GSXML.RESPONSE_ELEM);
 
         result.setAttribute(GSXML.FROM_ATT, GET_USER_INFORMATION_SERVICE);
@@ -382 +387 @@
         if (paramList == null)
         {
-            GSXML.addError(this.doc, result, _errorMessageMap.get(ERROR_REQUEST_HAS_NO_PARAM_LIST));
+            GSXML.addError(result, _errorMessageMap.get(ERROR_REQUEST_HAS_NO_PARAM_LIST));
             return result;
         }
@@ -392 +397 @@
         if (username == null)
         {
-            GSXML.addError(this.doc, result, _errorMessageMap.get(ERROR_USERNAME_NOT_SPECIFIED));
+            GSXML.addError(result, _errorMessageMap.get(ERROR_USERNAME_NOT_SPECIFIED));
             return result;
         }
@@ -405 +410 @@
         if (terms.size() == 0)
         {
-            GSXML.addError(this.doc, result, _errorMessageMap.get(ERROR_REQUESTED_USER_NOT_FOUND));
+            GSXML.addError(result, _errorMessageMap.get(ERROR_REQUESTED_USER_NOT_FOUND));
             return result;
         }
 
         UserTermInfo userInfo = terms.get(0);
-        Element userInfoList = this.doc.createElement(GSXML.PARAM_ELEM + GSXML.LIST_MODIFIER);
+        Element userInfoList = result_doc.createElement(GSXML.PARAM_ELEM + GSXML.LIST_MODIFIER);
         result.appendChild(userInfoList);
 
-        Element usernameField = GSXML.createParameter(this.doc, "username", userInfo.username);
-        Element passwordField = GSXML.createParameter(this.doc, "password", userInfo.password);
-        Element groupsField = GSXML.createParameter(this.doc, "groups", userInfo.groups);
-        Element accountStatusField = GSXML.createParameter(this.doc, "accountstatus", userInfo.accountstatus);
-        Element commentField = GSXML.createParameter(this.doc, "comment", userInfo.comment);
+        Element usernameField = GSXML.createParameter(result_doc, "username", userInfo.username);
+        Element passwordField = GSXML.createParameter(result_doc, "password", userInfo.password);
+        Element groupsField = GSXML.createParameter(result_doc, "groups", userInfo.groups);
+        Element accountStatusField = GSXML.createParameter(result_doc, "accountstatus", userInfo.accountstatus);
+        Element commentField = GSXML.createParameter(result_doc, "comment", userInfo.comment);
 
         if (editEnabled != null)
         {
-            Element editEnabledElem = GSXML.createParameter(this.doc, "editEnabled", editEnabled);
+            Element editEnabledElem = GSXML.createParameter(result_doc, "editEnabled", editEnabled);
             userInfoList.appendChild(editEnabledElem);
         }
@@ -441 +446 @@
 
         // Create a new (empty) result message
-        Element result = this.doc.createElement(GSXML.RESPONSE_ELEM);
+        Document result_doc = XMLConverter.newDOM();
+        Element result = result_doc.createElement(GSXML.RESPONSE_ELEM);
         result.setAttribute(GSXML.FROM_ATT, AUTHENTICATION_SERVICE);
         result.setAttribute(GSXML.TYPE_ATT, GSXML.REQUEST_TYPE_PROCESS);
 
         // Create an Authentication node put into the result
-        Element authenNode = this.doc.createElement(GSXML.AUTHEN_NODE_ELEM);
+        Element authenNode = result_doc.createElement(GSXML.AUTHEN_NODE_ELEM);
         result.appendChild(authenNode);
-        result.appendChild(getCollectList(this.site_home + File.separatorChar + "collect"));
+        result.appendChild(getCollectList(result_doc, this.site_home + File.separatorChar + "collect"));
 
         // Create a service node added into the Authentication node
-        Element serviceNode = this.doc.createElement(GSXML.SERVICE_ELEM);
+        Element serviceNode = result_doc.createElement(GSXML.SERVICE_ELEM);
         authenNode.appendChild(serviceNode);
 
@@ -459 +465 @@
         {
             serviceNode.setAttribute("operation", LOGIN);
-            GSXML.addError(this.doc, result, _errorMessageMap.get(ERROR_REQUEST_HAS_NO_PARAM_LIST));
+            GSXML.addError(result, _errorMessageMap.get(ERROR_REQUEST_HAS_NO_PARAM_LIST));
             return result; // Return the empty result
         }
@@ -473 +479 @@
         {
             serviceNode.setAttribute("operation", LOGIN);
-            GSXML.addError(this.doc, result, _errorMessageMap.get(ERROR_NOT_LOGGED_IN));
+            GSXML.addError(result, _errorMessageMap.get(ERROR_NOT_LOGGED_IN));
             return result;
         }
@@ -486 +492 @@
         {
             serviceNode.setAttribute("operation", LOGIN);
-            GSXML.addError(this.doc, result, _errorMessageMap.get(ERROR_NOT_LOGGED_IN));
+            GSXML.addError(result, _errorMessageMap.get(ERROR_NOT_LOGGED_IN));
             return result;
         }
@@ -493 +499 @@
         {
             serviceNode.setAttribute("operation", LOGIN);
-            GSXML.addError(this.doc, result, _errorMessageMap.get(ERROR_ADMIN_NOT_LOGGED_IN));
+            GSXML.addError(result, _errorMessageMap.get(ERROR_ADMIN_NOT_LOGGED_IN));
             return result;
         }
@@ -502 +508 @@
             if (error != NO_ERROR)
             {
-                GSXML.addError(this.doc, result, _errorMessageMap.get(error));
+                GSXML.addError(result, _errorMessageMap.get(error));
             }
         }
@@ -518 +524 @@
             if ((error = checkUsername(newUsername)) != NO_ERROR)
             {
-                GSXML.addError(this.doc, result, _errorMessageMap.get(error));
+                GSXML.addError(result, _errorMessageMap.get(error));
                 return result;
             }
@@ -525 +531 @@
             if ((error = checkPassword(newPassword)) != NO_ERROR)
             {
-                GSXML.addError(this.doc, result, _errorMessageMap.get(error));
+                GSXML.addError(result, _errorMessageMap.get(error));
                 return result;
             }
@@ -535 +541 @@
             {
                 serviceNode.setAttribute("operation", ADD_USER);
-                GSXML.addError(this.doc, result, _errorMessageMap.get(error));
+                GSXML.addError(result, _errorMessageMap.get(error));
             }
             else
@@ -553 +559 @@
             if ((error = checkUsername(newUsername)) != NO_ERROR)
             {
-                GSXML.addError(this.doc, result, _errorMessageMap.get(error));
+                GSXML.addError(result, _errorMessageMap.get(error));
                 return result;
             }
@@ -560 +566 @@
             if ((error = checkPassword(newPassword)) != NO_ERROR)
             {
-                GSXML.addError(this.doc, result, _errorMessageMap.get(error));
+                GSXML.addError(result, _errorMessageMap.get(error));
                 return result;
             }
@@ -584 +590 @@
                     {
                         serviceNode.setAttribute("operation", REGISTER);
-                        GSXML.addError(this.doc, result, _errorMessageMap.get(ERROR_CAPTCHA_MISSING));
+                        GSXML.addError(result, _errorMessageMap.get(ERROR_CAPTCHA_MISSING));
                         return result;
                     }
@@ -593 +599 @@
                     {
                         serviceNode.setAttribute("operation", REGISTER);
-                        GSXML.addError(this.doc, result, _errorMessageMap.get(ERROR_CAPTCHA_DOES_NOT_MATCH));
+                        GSXML.addError(result, _errorMessageMap.get(ERROR_CAPTCHA_DOES_NOT_MATCH));
                         return result;
                     }
@@ -606 +612 @@
             {
                 serviceNode.setAttribute("operation", REGISTER);
-                GSXML.addError(this.doc, result, _errorMessageMap.get(error));
+                GSXML.addError(result, _errorMessageMap.get(error));
             }
         }
@@ -623 +629 @@
             if ((error = checkUsername(newUsername)) != NO_ERROR)
             {
-                GSXML.addError(this.doc, result, _errorMessageMap.get(error));
+                GSXML.addError(result, _errorMessageMap.get(error));
                 return result;
             }
@@ -636 +642 @@
                 if ((error = checkPassword(newPassword)) != NO_ERROR)
                 {
-                    GSXML.addError(this.doc, result, _errorMessageMap.get(error));
+                    GSXML.addError(result, _errorMessageMap.get(error));
                     return result;
                 }
@@ -654 +660 @@
                 {
                     serviceNode.setAttribute("operation", EDIT_USER);
-                    GSXML.addError(this.doc, result, _errorMessageMap.get(error));
+                    GSXML.addError(result, _errorMessageMap.get(error));
                 }
                 return result;
@@ -663 +669 @@
             {
                 serviceNode.setAttribute("operation", EDIT_USER);
-                GSXML.addError(this.doc, result, _errorMessageMap.get(error));
+                GSXML.addError(result, _errorMessageMap.get(error));
             }
             else
@@ -684 +690 @@
                 addUserInformationToNode(previousUsername, serviceNode);
                 serviceNode.setAttribute("operation", ACCOUNT_SETTINGS);
-                GSXML.addError(this.doc, result, _errorMessageMap.get(ERROR_USER_ALREADY_EXISTS));
+                GSXML.addError(result, _errorMessageMap.get(ERROR_USER_ALREADY_EXISTS));
                 return result;
             }
@@ -698 +704 @@
                     addUserInformationToNode(previousUsername, serviceNode);
                     serviceNode.setAttribute("operation", ACCOUNT_SETTINGS);
-                    GSXML.addError(this.doc, result, _errorMessageMap.get(ERROR_INCORRECT_PASSWORD), "Incorrect Password");
+                    GSXML.addError(result, _errorMessageMap.get(ERROR_INCORRECT_PASSWORD), "Incorrect Password");
                     return result;
                 }
@@ -706 +712 @@
                 if ((error = checkPassword(newPassword)) != NO_ERROR)
                 {
-                    GSXML.addError(this.doc, result, _errorMessageMap.get(error));
+                    GSXML.addError(result, _errorMessageMap.get(error));
                     return result;
                 }
@@ -721 +727 @@
             if ((error = checkUsername(newUsername)) != NO_ERROR)
             {
-                GSXML.addError(this.doc, result, _errorMessageMap.get(error));
+                GSXML.addError(result, _errorMessageMap.get(error));
                 return result;
             }
@@ -741 +747 @@
                     addUserInformationToNode(previousUsername, serviceNode);
                     serviceNode.setAttribute("operation", ACCOUNT_SETTINGS);
-                    GSXML.addError(this.doc, result, _errorMessageMap.get(error));
+                    GSXML.addError(result, _errorMessageMap.get(error));
                 }
                 return result;
@@ -749 +755 @@
             if (error != NO_ERROR)
             {
-                GSXML.addError(this.doc, result, _errorMessageMap.get(error));
+                GSXML.addError(result, _errorMessageMap.get(error));
             }
 
@@ -767 +773 @@
             if (user_name == null || oldPassword == null || newPassword == null)
             {
-                GSXML.addError(this.doc, result, _errorMessageMap.get("missing compulsory parameters: username, oldPassword, or newPassword"));
+                GSXML.addError(result, _errorMessageMap.get("missing compulsory parameters: username, oldPassword, or newPassword"));
                 return result;
             }
@@ -775 +781 @@
             {
                 addUserInformationToNode(user_name, serviceNode);
-                GSXML.addError(this.doc, result, _errorMessageMap.get(ERROR_INCORRECT_PASSWORD), "Incorrect Password");
+                GSXML.addError(result, _errorMessageMap.get(ERROR_INCORRECT_PASSWORD), "Incorrect Password");
                 return result;
             }
@@ -783 +789 @@
             if ((error = checkPassword(newPassword)) != NO_ERROR)
             {
-                GSXML.addError(this.doc, result, _errorMessageMap.get(error));
+                GSXML.addError(result, _errorMessageMap.get(error));
                 return result;
             }
@@ -794 +800 @@
             if (info != "succeed")
             {//see DerbyWrapper.modifyUserInfo
-                GSXML.addError(this.doc, result, _errorMessageMap.get(info));
+                GSXML.addError(result, _errorMessageMap.get(info));
                 return result;
             }
@@ -804 +810 @@
             if (error != NO_ERROR)
             {
-                GSXML.addError(this.doc, result, _errorMessageMap.get(error));
+                GSXML.addError(result, _errorMessageMap.get(error));
             }
         }
@@ -814 +820 @@
             {
                 serviceNode.setAttribute("operation", "");
-                GSXML.addError(this.doc, result, _errorMessageMap.get(ERROR_USERNAME_NOT_SPECIFIED));
+                GSXML.addError(result, _errorMessageMap.get(ERROR_USERNAME_NOT_SPECIFIED));
                 return result;
             }
@@ -821 +827 @@
             {
                 serviceNode.setAttribute("operation", LOGIN);
-                GSXML.addError(this.doc, result, _errorMessageMap.get(ERROR_NOT_AUTHORISED));
+                GSXML.addError(result, _errorMessageMap.get(ERROR_NOT_AUTHORISED));
                 return result;
             }
@@ -827 +833 @@
             if (error != NO_ERROR)
             {
-                GSXML.addError(this.doc, result, _errorMessageMap.get(error));
+                GSXML.addError(result, _errorMessageMap.get(error));
             }
         }
@@ -861 +867 @@
             if (_recaptchaPublicKey != null && _recaptchaPrivateKey != null)
             {
-                Element recaptchaElem = this.doc.createElement("recaptcha");
+                Element recaptchaElem = result_doc.createElement("recaptcha");
                 recaptchaElem.setAttribute("publicKey", _recaptchaPublicKey);
                 recaptchaElem.setAttribute("privateKey", _recaptchaPrivateKey);
@@ -873 +879 @@
             if (error != NO_ERROR)
             {
-                GSXML.addError(this.doc, result, _errorMessageMap.get(error));
+                GSXML.addError(result, _errorMessageMap.get(error));
             }
             addUserInformationToNode(null, serviceNode);
@@ -985 +991 @@
         if (userQueryResult != null)
         {
-            Element user_node = getUserNode(userQueryResult);
+          Element user_node = getUserNodeList(serviceNode.getOwnerDocument(), userQueryResult);
             serviceNode.appendChild(user_node);
             return NO_ERROR;
@@ -1114 +1120 @@
     }
 
-    private Element getUserNode(UserQueryResult userQueryResult)
-    {
-        Element user_list_node = this.doc.createElement(GSXML.USER_NODE_ELEM + "List");
+  private Element getUserNodeList(Document doc, UserQueryResult userQueryResult)
+    {
+        Element user_list_node = doc.createElement(GSXML.USER_NODE_ELEM + GSXML.LIST_MODIFIER);
 
         Vector userInfo = userQueryResult.users;
@@ -1122 +1128 @@
         for (int i = 0; i < userQueryResult.getSize(); i++)
         {
-            Element user_node = this.doc.createElement(GSXML.USER_NODE_ELEM);
+            Element user_node = doc.createElement(GSXML.USER_NODE_ELEM);
             String username = ((UserTermInfo) userInfo.get(i)).username;
             String groups = ((UserTermInfo) userInfo.get(i)).groups;
@@ -1139 +1145 @@
     }
 
-    private Element getCollectList(String collect)
-    {
-        Element collect_list_node = this.doc.createElement(GSXML.COLLECTION_ELEM + "List");
+  private Element getCollectList(Document doc, String collect)
+    {
+        Element collect_list_node = doc.createElement(GSXML.COLLECTION_ELEM + GSXML.LIST_MODIFIER);
         File[] collect_dir = (new File(collect)).listFiles();
         if (collect_dir != null && collect_dir.length > 0)
@@ -1149 +1155 @@
                 if (collect_dir[i].isDirectory() && (!collect_dir[i].getName().startsWith(".svn")))
                 {
-                    Element collect_node = this.doc.createElement(GSXML.COLLECTION_ELEM);
-                    collect_node.setAttribute("name", collect_dir[i].getName());
+                    Element collect_node = doc.createElement(GSXML.COLLECTION_ELEM);
+                    collect_node.setAttribute(GSXML.NAME_ATT, collect_dir[i].getName());
                     collect_list_node.appendChild(collect_node);
                 }