Changeset 28987 for main

Timestamp:

2014-04-17T13:17:33+12:00 (10 years ago)

Author:

kjdon

Message:

some tidying up. have started work on new metadata format stuff, but its not finished yet.

File:

• main/trunk/greenstone3/src/java/org/greenstone/gsdl3/core/OAIReceptionist.java (modified) (20 diffs)

main/trunk/greenstone3/src/java/org/greenstone/gsdl3/core/OAIReceptionist.java

@@ -47 +47 @@
   /** The unique  repository identifier */
   protected String repository_id = null;
-    
-  /** a converter class to parse XML and create Docs */
-  protected XMLConverter converter=null;
-  
+      
   /** the configure file of this receptionist passed from the oai servlet. */
   protected Element oai_config = null;
@@ -78 +75 @@
   /** store the super coll elements for convenience */
   HashMap<String, Element> super_coll_data = null;
+  /** store the metadata formats ??????*/
   /** The identify response */
   protected Element identify_response = null;
@@ -86 +84 @@
 
   public OAIReceptionist() {
-    this.converter = new XMLConverter();
+
   }
   
@@ -199 +197 @@
 
     // go through and store a list of collection names for convenience
-    // also create a 'to' attribute
+    // also create a 'to' attribute for the next request to the MR, which
+    // is a ListSets request to each collection
     Node child = this.collection_list.getFirstChild();
     if (child == null) {
@@ -239 +238 @@
     // send to MR
     msg_node = mr.process(message);
-    logger.error(this.converter.getPrettyString(msg_node));
+    logger.error(XMLConverter.getPrettyString(msg_node));
     NodeList response_list =  ((Element)msg_node).getElementsByTagName(GSXML.RESPONSE_ELEM);
     for (int c=0; c<response_list.getLength(); c++) {
@@ -267 +266 @@
           this.super_coll_map.put(set_spec, subcolls);
           // the first time a supercoll is mentioned, add into the set list
-          logger.error("finding the set info "+this.converter.getPrettyString(this.super_coll_data.get(set_spec)));
+          logger.error("finding the set info "+XMLConverter.getPrettyString(this.super_coll_data.get(set_spec)));
           listsets_element.appendChild(GSXML.duplicateWithNewName(listsets_doc, this.super_coll_data.get(set_spec), OAIXML.SET, true));
         }
@@ -295 +294 @@
 
     Element response = (Element) this.mr.process(mr_request_message);
-    logger.error("configure response = "+this.converter.getPrettyString(response));
+    logger.error("configure response = "+XMLConverter.getPrettyString(response));
   }
   /** process using strings - just calls process using Elements */
   public String process(String xml_in) {
     
-    Node message_node = this.converter.getDOM(xml_in);
+    Node message_node = XMLConverter.getDOM(xml_in);
     Node page = process(message_node);
-    return this.converter.getString(page);
+    return XMLConverter.getString(page);
   }
 
@@ -322 +321 @@
 
     Element message = GSXML.nodeToElement(message_node);
-    logger.error(this.converter.getString(message));
+    logger.error(XMLConverter.getString(message));
 
     // check that its a correct message tag
@@ -593 +592 @@
       Element result = (Element)mr.process(mr_msg);
       logger.error(verb+ " result for coll "+current_coll);
-      logger.error(this.converter.getPrettyString(result));
+      logger.error(XMLConverter.getPrettyString(result));
       if (result == null) {
     logger.info("message router returns null");
@@ -725 +724 @@
   }
 
-
-  // method exclusively used by doListRecords/doListIdentifiers
-  private void getRecords(Element verb_elem, NodeList list, int start_point, int end_point) {
-    for (int i=start_point; i<end_point; i++) {
-      verb_elem.appendChild(verb_elem.getOwnerDocument().importNode(list.item(i), true));
-    }
-  }
   private Element collectAll(Element result, Element msg, String verb, String elem_name) {
     if(result == null) {
@@ -763 +755 @@
     //if the verb is ListMetadataFormats, there could be only one parameter: identifier
     //, or there is no parameter; otherwise it is an error
-    //logger.info("" + this.converter.getString(msg));
+    //logger.info("" + XMLConverter.getString(msg));
     
     NodeList params = GSXML.getChildrenByTagName(req, GSXML.PARAM_ELEM);
@@ -777 +769 @@
 
       Element list_metadata_formats = lmf_doc.createElement(OAIXML.LIST_METADATA_FORMATS);
-      
-      Element format_list = (Element)GSXML.getChildByTagName(oai_config, OAIXML.LIST_METADATA_FORMATS);
-      if(format_list == null) {
-    logger.error("OAIConfig.xml must contain the supported metadata formats");
-    // TODO this is internal error, what to do???
-    return getMessage(lmf_doc, list_metadata_formats);
-      }
-      NodeList formats = format_list.getElementsByTagName(OAIXML.METADATA_FORMAT);
+      // get all the formats out of oai_config
+      NodeList formats = oai_config.getElementsByTagName(OAIXML.METADATA_FORMAT);
+      if (formats.getLength() ==0) {
+        logger.error("OAIConfig.xml must contain the supported metadata formats");
+        // TODO this is internal error, what to do???
+        return getMessage(lmf_doc, list_metadata_formats);
+      }
+    
       for(int i=0; i<formats.getLength(); i++) {
     Element meta_fmt = lmf_doc.createElement(OAIXML.METADATA_FORMAT);
@@ -794 +786 @@
     list_metadata_formats.appendChild(meta_fmt);
       }
-      return getMessage(lmf_doc, list_metadata_formats);
-      
+      this.listmetadataformats_response = getMessage(lmf_doc, list_metadata_formats);
+      return this.listmetadataformats_response;
       
     } 
@@ -820 +812 @@
     identifier = param.getAttribute(GSXML.VALUE_ATT);
     // the identifier is in the form: <coll_name>:<OID>
-    // so it must contain at least two ':' characters
-    String[] strs = identifier.split(":");
-    if(strs == null || strs.length < 2) {
-      // the OID may also contain ':'
+    // so it must contain at least one ':' characters 
+    // (the oid itself may contain : chars)
+    String[] strs = identifier.split(":", 2);
+    if(strs.length != 2) {
       logger.error("identifier is not in the form coll:id" + identifier);
       return OAIXML.createErrorMessage(OAIXML.ID_DOES_NOT_EXIST, "");
@@ -830 +822 @@
     // send request to message router
     // get the names
-    strs = splitNames(identifier);
-    if(strs == null || strs.length < 2) {
-      logger.error("identifier is not in the form coll:id" + identifier);
-      return OAIXML.createErrorMessage(OAIXML.ID_DOES_NOT_EXIST, "");
-    }
-    //String name_of_site = strs[0];
     String coll_name = strs[0];
     String oid = strs[1];
 
-    //re-organize the request element
-    // reset the 'to' attribute
+    Document msg_doc = XMLConverter.newDOM();
+    Element message = msg_doc.createElement(GSXML.MESSAGE_ELEM);
     String verb = req.getAttribute(GSXML.TO_ATT);
-    req.setAttribute(GSXML.TO_ATT, coll_name + "/" + verb);
-    // reset the identifier element
-    param.setAttribute(GSXML.NAME_ATT, OAIXML.OID);
-    param.setAttribute(GSXML.VALUE_ATT, oid);
-
-    // TODO is this the best way to do this???? should we create a new request???
-    Element message = req.getOwnerDocument().createElement(GSXML.MESSAGE_ELEM);
-    message.appendChild(req);
+    String new_to = coll_name + "/" + verb;
+    Element request = GSXML.createBasicRequest(msg_doc, "oai???", new_to, null);
+    message.appendChild(request);
+    // add the id param
+    GSXML.addParameterToList(request, OAIXML.OID, oid);
+
     //Now send the request to the message router to process
     Node result_node = mr.process(message);
@@ -861 +845 @@
     Element original_element = (Element)GSXML.getChildByTagName(oai_config, element_name);
     if(original_element != null) {
-      copyNode(to_elem, original_element);
-    }
-  }
-
-  private void copyNode(Element to_elem, Node original_element) {
-    to_elem.appendChild(to_elem.getOwnerDocument().importNode(original_element, true));
-
-  }
+      GSXML.copyNode(to_elem, original_element);
+    }
+  }
+
 
   private Element doIdentify() {
@@ -894 +874 @@
     }
     for (int i=0; i<num_admin; i++) {
-      copyNode(identify, admin_emails.item(i));
+      GSXML.copyNode(identify, admin_emails.item(i));
     }
 
@@ -927 +907 @@
     description.appendChild(gsdl);
     for (int m = 0; m<meta.getLength(); m++) {
-      copyNode(gsdl, meta.item(m));
+      GSXML.copyNode(gsdl, meta.item(m));
     }
     
@@ -934 +914 @@
     this.identify_response = identify;
     return getMessage(doc, identify);
-  }
-  //split setSpec (site_name:coll_name) into an array of strings
-  //It has already been checked that the set_spec contains at least one ':'
-  private String[] splitSetSpec(String set_spec) {
-    logger.info(set_spec);
-    String[] strs = new String[2];
-    int colon_index = set_spec.indexOf(":");
-    strs[0] = set_spec.substring(0, colon_index);
-    strs[1] = set_spec.substring(colon_index + 1);
-    return strs;
   }
   /** split the identifier into <collection + OID> as an array 
       It has already been checked that the 'identifier' contains at least one ':'
   */
-  private String[] splitNames(String identifier) {
-    logger.info(identifier);
-    String [] strs = new String[2];
-    int first_colon = identifier.indexOf(":");
-    if(first_colon == -1) {
-      return null;
-    }
-    strs[0] = identifier.substring(0, first_colon);
-    strs[1] = identifier.substring(first_colon + 1);
-    return strs;
-  }
+  // private String[] splitNames(String identifier) {
+  //   logger.info(identifier);
+  //   String [] strs = new String[2];
+  //   int first_colon = identifier.indexOf(":");
+  //   if(first_colon == -1) {
+  //     return null;
+  //   }
+  //   strs[0] = identifier.substring(0, first_colon);
+  //   strs[1] = identifier.substring(first_colon + 1);
+  //   return strs;
+  // }
   /** validate if the specified metadata prefix value is supported by the repository
    *  by checking it in the OAIConfig.xml
@@ -1007 +977 @@
 
     // get the names
-    String[] strs = splitNames(identifier);
+    String[] strs = identifier.split(":", 2);
     if(strs == null || strs.length < 2) {
       logger.error("identifier is not in the form coll:id" + identifier);