Changeset 26096 for main/trunk

Timestamp:

2012-08-10T20:31:34+12:00 (12 years ago)

Author:

ak19

Message:

Now the dc:identifier is set for OAI to either gs.OAIResourceURL if this was set by the user, else to srclinkFile if this exists, else a url to the Greenstone version of a document. This is the logic that GS2 used (in the output_custom_metadata function of dublincore.cpp of runtime-src's oaiservr). Having made this change, doing get-document over OAI works, as is required for the Downloading Over OAI tutorial. Get-document was previously not implemented during the updates to get GS3's OAI server to validate, since the OAI validator never checked for this. This is an optional operation that Greenstone 2 provided, and which GS3 now also allows.

Location:

main/trunk/greenstone3/src/java/org/greenstone/gsdl3

Files:

• service/OAIPMH.java (modified) (2 diffs)
• util/OAIXML.java (modified) (6 diffs)

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

@@ -483 +483 @@
         String[] metadata_names = getMetadataNameMapping(metadata_format);
         HashMap meta_map = getInfoByNames(info, metadata_names);
+        
+        // if there's no dc:identifier already after the mapping, we'll add it in
+        if(!meta_map.containsKey(OAIXML.DC+":identifier")) { // dc:identifier OAIXML.IDENTIFIER
+            outputCustomMetadata(meta_map, info, OAIXML.DC+":identifier");
+        }
+    
+        
     if (meta_map == null) {
       return metadata;
@@ -701 +708 @@
     return (empty_map == true) ? null : map;
   }
+  
+  // GS3 version of GS2's runtime-src/src/oaiservr/dublincore.cpp function output_custom_metadata
+  protected void outputCustomMetadata(HashMap meta_map, DBInfo info, String dc_identifier) {
+        
+    // try gs.OAIResourceURL, else srclinkFile, else the GS version of the document
+    String identifier_value = info.getInfo(OAIXML.GS_OAI_RESOURCE_URL);
+    
+    if(identifier_value.equals("")) {
+        String url = OAIXML.getBaseURL(); // e.g. e.g. http://host:port/greenstone3/library/oaiserver
+    
+        identifier_value = info.getInfo("srclinkFile");
+        if(identifier_value.equals("")) 
+        {
+            // no source file to link to, so link to the GS version of the document (need to use URL-style slashes)
+            // e.g. http://host:port/greenstone3/library/collection/lucene-jdbm-demo/document/HASH014602ec89e16b7d431c7627
+            
+            identifier_value = url.replace("oaiserver", "library") + "collection/" + this.coll_name + "/document/" + info.getInfo("identifier"); // OID
+        } 
+        else // use srclinkFile
+        {       
+            // e.g. http://host:port/greenstone3/sites/localsite/collect/backdrop/index/assoc/D0.dir/Cat.jpg
+            identifier_value = url.replace("oaiserver", "") + "sites/" + this.site_name 
+                + "/collect/" + this.coll_name + "/index/assoc/" 
+                + info.getInfo("assocfilepath") + "/" + identifier_value; // srclinkFile
+        }
+    } // else use gs.OAIResourceURL as-is
+    
+    //logger.info("**** dc:identifier: " + identifier_value);
+    
+    meta_map.put(dc_identifier, identifier_value);
+  }
 }
 

main/trunk/greenstone3/src/java/org/greenstone/gsdl3/util/OAIXML.java

@@ -99 +99 @@
     public static final String GRANULARITY = "granularity";
     public static final String GS3OAI = "GS3OAI";
+    public static final String GS_OAI_RESOURCE_URL = "gs.OAIResourceURL";
     public static final String HAS_OAI = "hasOAI";
     public static final String HEADER = "header";
@@ -177 +178 @@
      */
     public static String oai_version = "2.0";
+    public static String baseURL = "";
     
     /**response owner document */
@@ -194 +196 @@
       return oai_version;
     }
+    
+    public static String getBaseURL() {
+        return baseURL;
+    }
+    
     public static Element createElement(String tag_name) {
       return response_doc.createElement(tag_name);
@@ -286 +293 @@
     }
     /** Read in OAIConfig.xml (residing web/WEB-INF/classes/) and use it to configure the receptionist etc.
-     *  the oai_version variable is also set in here. 
+     *  the oai_version and baseURL variables are also set in here. 
      *  The init() method is also called in here. */ 
     public static Element getOAIConfigXML() {
@@ -310 +317 @@
       oai_version = GSXML.getNodeText(protocol_version).trim();
 
+      // initialize baseURL
+      Element base_url_elem = (Element)GSXML.getChildByTagName(oai_config_elem, BASE_URL);
+      baseURL = GSXML.getNodeText(base_url_elem);
+      
       //initialize token_expiration
       Element expiration = (Element)GSXML.getChildByTagName(oai_config_elem, RESUMPTION_TOKEN_EXPIRATION);
@@ -387 +398 @@
         }
       }//end of for()
-      Element base_url_elem = (Element)GSXML.getChildByTagName(oai_config_elem, BASE_URL);
-      String base_url = GSXML.getNodeText(base_url_elem);
-      GSXML.setNodeText(request_elem, base_url);
+      
+      GSXML.setNodeText(request_elem, baseURL);
       
       Node resp_date = GSXML.getChildByTagName(response, RESPONSE_DATE);