Changeset 32874 for gs3-extensions/iiif-servlet/trunk/src/gsdl-src/java/org/greenstone/gsdl3/util/IIIFXML.java

Timestamp:

2019-03-07T22:47:07+13:00 (5 years ago)

Author:

davidb

Message:

Next round of changes, migrating from OAI imprint to what is needed for IIIF

File:

• gs3-extensions/iiif-servlet/trunk/src/gsdl-src/java/org/greenstone/gsdl3/util/IIIFXML.java (modified) (11 diffs)

gs3-extensions/iiif-servlet/trunk/src/gsdl-src/java/org/greenstone/gsdl3/util/IIIFXML.java

@@ -37 +37 @@
   static Logger logger = Logger.getLogger(org.greenstone.gsdl3.util.IIIFXML.class.getName());
 
-  // the leading keyword of oai protocol
+  // the leading keyword of IIIF protocol // ****
   public static final String VERB = "verb";
 
@@ -67 +67 @@
     
   // record response data
-  // SET_SPEC
   public static final String RECORD = "record";
-
-    public static final String OAIPMH = "OAIPMH"; // ****
+  public static final String HEADER = "header";
+  public static final String METADATA = "metadata";
+
+    //public static final String OAIPMH = "OAIPMH"; // ****
     
     //public static final String OAI_SET_LIST = "oaiSetList"; // ****
@@ -80 +81 @@
   //public static final String FILE_SEPARATOR = File.separator;
     //public static final String OAI_VERSION1 = "1.0";
-    public static final String IIIF_VERSION2 = "2.1"; // ****
+    //public static final String IIIF_VERSION2 = "2.1"; // ****
   /*************************above are final values****************************/
     
@@ -143 +144 @@
 
     
-  /** TODO: returns a basic response for appropriate oai version
+  /** TODO: returns a basic response (loosely based on OAI XML message)
    *  
    */
@@ -161 +162 @@
     String[] strs = pairs[i].split("=");
     if(strs != null && strs.length == 2) {
-      request_elem.setAttribute(strs[0], oaiDecode(strs[1]));
+      request_elem.setAttribute(strs[0], iiifDecode(strs[1]));
     }
       }
@@ -168 +169 @@
     GSXML.setNodeText(request_elem, baseURL);
       
-    Node resp_date = GSXML.getChildByTagName(response, RESPONSE_DATE); // ****
+    //Node resp_date = GSXML.getChildByTagName(response, RESPONSE_DATE); // ****
     
     return response;
@@ -265 +266 @@
    *  original form (eg, ':'). 
    */
-  public static String oaiDecode(String escaped_str) {
-    logger.info("oaiDecode() " +escaped_str);
+  public static String iiifDecode(String escaped_str) {
+    logger.info("iiifDecode() " +escaped_str);
     for (int i=0; i<special_char.length; i++) {
       if (escaped_str.indexOf(escape_sequence[i]) != -1) {
@@ -277 +278 @@
    *  escaped sequences (eg, '%3A'). 
    */
-    public static String oaiEncode(String original_str) { // ****
-    logger.info("oaiEncode() " + original_str);      
+    public static String iiifEncode(String original_str) { // ****
+    logger.info("iiifEncode() " + original_str);      
     for (int i=0; i<special_char.length; i++) {
       if (original_str.indexOf(special_char[i]) != -1) {
@@ -288 +289 @@
 
   public static Element createResponseHeader(Document response_doc, String verb) {
-      String tag_name = (iiif_version.equals(IIIF_VERSION2))? IIIF_PMH : verb; // ****
-    Element oai = response_doc.createElement(tag_name);
-    Element resp_date = response_doc.createElement(RESPONSE_DATE); // ****
+      //String tag_name = (iiif_version.equals(IIIF_VERSION2))? IIIF_PMH : verb; // ****
+      String tag_name = IIIF_PMH;
+    Element iiif = response_doc.createElement(tag_name);
+    //Element resp_date = response_doc.createElement(RESPONSE_DATE); // ****
     Element req = response_doc.createElement(REQUEST);
-    oai.appendChild(resp_date);
-    oai.appendChild(req);
-
-    if(iiif_version.equals(IIIF_VERSION2)) { // ****
-      oai.setAttribute("xmlns", "http://www.openarchives.org/OAI/2.0/");
-      oai.setAttribute("xmlns:xsi", "http://www.w3.org/2001/XMLSchema-instance");
-      oai.setAttribute("xsi:schemaLocation", "http://www.openarchives.org/OAI/2.0/ \n http://www.openarchives.org/OAI/2.0/OAI-PMH.xsd");
-    } else {
-      oai.setAttribute("xmlns", "http://www.openarchives.com/OAI/1.1/OAI_" + verb);
-      oai.setAttribute("xmlns:xsi", "http://www.w3.org/2001/XMLSchema-instance");
-      oai.setAttribute("xsi:schemaLocation", "http://www.openarchives.org/OAI/1.1/OAI_" + verb + "\n http://www.openarchives.org/OAI/1.1/OAI_" + verb + ".xsd");
-    }
-    return oai;
-  }
-
-    
+    //oai.appendChild(resp_date);
+    iiif.appendChild(req);
+
+    return iiif;
+  }
+
+    /*
   public static Element createOAIIdentifierXML(Document doc, String repository_id, String sample_collection, String sample_doc_id) {
     String xml = "<oai-identifier xmlns=\"http://www.openarchives.org/OAI/2.0/oai-identifier\"\n xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"\n xsi:schemaLocation=\"http://www.openarchives.org/OAI/2.0/oai-identifier\n http://www.openarchives.org/OAI/2.0/oai-identifier.xsd\">\n <scheme>oai</scheme>\n<repositoryIdentifier>" + repository_id + "</repositoryIdentifier>\n<delimiter>:</delimiter>\n<sampleIdentifier>oai:"+repository_id+":"+sample_collection+":"+sample_doc_id+"</sampleIdentifier>\n</oai-identifier>";
@@ -316 +309 @@
 
   }
-
+    */
+
+    /*
   public static Element createGSDLElement(Document doc) {
     String xml = "<gsdl xmlns=\"http://www.greenstone.org/namespace/gsdl_oaiinfo/1.0/gsdl_oaiinfo\"\n xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"\n xsi:schemaLocation=\"http://www.greenstone.org/namespace/gsdl_oaiinfo/1.0/gsdl_oaiinfo\n   http://www.greenstone.org/namespace/gsdl_oaiinfo/1.0/gsdl_oaiinfo.xsd\"></gsdl>";
@@ -322 +317 @@
     return (Element)doc.importNode(xml_doc.getDocumentElement(), true);    
   }
+    */
+    
 }