Changeset 2939 for SRUClient

Timestamp:

05/27/13 21:04:59 (11 years ago)

Author:

oschonef

Message:

• some more work on ZeRex? record parser

Location:

SRUClient/trunk/src/main/java/eu/clarin/sru/client

Files:

• SRUExplainRecordDataParser.java (modified) (9 diffs)
• SRUSimpleClient.java (modified) (1 diff)

SRUClient/trunk/src/main/java/eu/clarin/sru/client/SRUExplainRecordDataParser.java

@@ -34 +34 @@
  */
 public class SRUExplainRecordDataParser implements SRURecordDataParser {
-    private static final String ZEEREX_NS = SRUExplainRecordData.RECORD_SCHEMA;
+    static final String ZEEREX_NS       = SRUExplainRecordData.RECORD_SCHEMA;
+    static final String ZEEREX_NS_QUIRK = "http://explain.z3950.org/dtd/2.1/";
     private static final String VERSION_1_1     = "1.1";
     private static final String VERSION_1_2     = "1.2";
@@ -49 +50 @@
 
     @Override
-    public SRURecordData parse(XMLStreamReader reader, SRUVersion version)
+    public SRURecordData parse(final XMLStreamReader reader, SRUVersion version)
             throws XMLStreamException, SRUClientException {
         logger.debug("parsing explain record data for version {}", version);
 
         // explain
-        XmlStreamReaderUtils.readStart(reader, ZEEREX_NS, "explain", true);
+        if (XmlStreamReaderUtils.readStart(reader, ZEEREX_NS,
+                "explain", false)) {
+            return parseExplain(reader, ZEEREX_NS, version);
+        } else if (XmlStreamReaderUtils.readStart(reader,
+                ZEEREX_NS_QUIRK, "explain", false)) {
+            logger.warn("namespace '{}' is not defined by ZeeRex, enabling " +
+                    "quirk mode (consider using namespace '{}' which is defined)",
+                    ZEEREX_NS_QUIRK, ZEEREX_NS);
+            return parseExplain(reader, ZEEREX_NS_QUIRK, version);
+        } else {
+            throw new XMLStreamException("expected element '{" + ZEEREX_NS +
+                    "}explain' at this position", reader.getLocation());
+        }
+    }
+
+
+    private static SRURecordData parseExplain(XMLStreamReader reader,
+            final String namespace, final SRUVersion version)
+            throws XMLStreamException, SRUClientException {
 
         // explain/serverInfo
-        ServerInfo serverInfo = parseServerInfo(reader);
+        ServerInfo serverInfo = parseServerInfo(reader, namespace);
 
         // explain/databaseInfo
-        if (XmlStreamReaderUtils.readStart(reader, ZEEREX_NS, "databaseInfo", false)) {
+        if (XmlStreamReaderUtils.readStart(reader, namespace, "databaseInfo", false)) {
             logger.debug("databaseInfo");
-            XmlStreamReaderUtils.readEnd(reader, ZEEREX_NS, "databaseInfo", true);
+            XmlStreamReaderUtils.readEnd(reader, namespace, "databaseInfo", true);
         }
 
         // explain/metaInfo
-        if (XmlStreamReaderUtils.readStart(reader, ZEEREX_NS, "metaInfo", false)) {
+        if (XmlStreamReaderUtils.readStart(reader, namespace, "metaInfo", false)) {
             logger.debug("metaInfo");
-            XmlStreamReaderUtils.readEnd(reader, ZEEREX_NS, "metaInfo", true);
+            XmlStreamReaderUtils.readEnd(reader, namespace, "metaInfo", true);
         }
 
         // explain/indexInfo
-        while (XmlStreamReaderUtils.readStart(reader, ZEEREX_NS, "indexInfo", false)) {
+        while (XmlStreamReaderUtils.readStart(reader, namespace, "indexInfo", false)) {
             logger.debug("indexInfo");
             for (;;) {
@@ -79 +98 @@
                  * check with SRU 1.2 ...
                  */
-                if (XmlStreamReaderUtils.readStart(reader, ZEEREX_NS, "set", false, true)) {
+                if (XmlStreamReaderUtils.readStart(reader, namespace, "set", false, true)) {
                     logger.debug("set");
                     // FIXME: read attributes
                     XmlStreamReaderUtils.consumeStart(reader);
 
-                    XmlStreamReaderUtils.readEnd(reader, ZEEREX_NS, "set", true);
-                } else if (XmlStreamReaderUtils.readStart(reader, ZEEREX_NS, "index", false, true)) {
+                    XmlStreamReaderUtils.readEnd(reader, namespace, "set", true);
+                } else if (XmlStreamReaderUtils.readStart(reader, namespace, "index", false, true)) {
                     logger.debug("index");
                     // FIXME: read attributes
                     XmlStreamReaderUtils.consumeStart(reader);
-                    XmlStreamReaderUtils.readEnd(reader, ZEEREX_NS, "index", true);
+                    XmlStreamReaderUtils.readEnd(reader, namespace, "index", true);
                 } else {
                     break;
                 }
             }
-            XmlStreamReaderUtils.readEnd(reader, ZEEREX_NS, "indexInfo", true);
+            XmlStreamReaderUtils.readEnd(reader, namespace, "indexInfo", true);
         } // while
 
-        XmlStreamReaderUtils.readEnd(reader, ZEEREX_NS, "explain", true);
+        XmlStreamReaderUtils.readEnd(reader, namespace, "explain", true);
         return new SRUExplainRecordData(serverInfo);
     }
 
 
-    private static ServerInfo parseServerInfo(XMLStreamReader reader)
-            throws XMLStreamException, SRUClientException {
-        XmlStreamReaderUtils.readStart(reader, ZEEREX_NS,
+    private static ServerInfo parseServerInfo(final XMLStreamReader reader,
+            final String namespace) throws XMLStreamException,
+            SRUClientException {
+        XmlStreamReaderUtils.readStart(reader, namespace,
                 "serverInfo", true, true);
         String protocol = XmlStreamReaderUtils.readAttributeValue(reader,
@@ -118 +138 @@
                 version = SRUVersion.VERSION_1_2;
             } else {
-                throw new SRUClientException(
-                        "invalid or unsupported version: " + s);
+                throw new SRUClientException("invalid or unsupported value '" +
+                        s + "'for attribute 'version' on element '" +
+                        reader.getName() + "'");
             }
         }
@@ -127 +148 @@
                 null, "transport");
         if (s != null) {
+            s = s + " http";
             for (String i : s.split("\\s+")) {
                 String t = null;
@@ -134 +156 @@
                     t = TRANSPORT_HTTPS;
                 } else {
-                    throw new SRUClientException("invalid transport: " + i);
+                    throw new SRUClientException("invalid value '" + i +
+                            "' for attribute 'transport' on element '" +
+                            reader.getName() +
+                            " (use either 'http' of 'https' or both " +
+                            "seperated by whitespace");
                 }
                 if (t != null) {
@@ -140 +166 @@
                         transports.add(t);
                     } else {
-                        // FIXME: error message
-                        logger.warn("transport  {} was already listed", s);
+                        logger.warn("value '{}' already listed in " +
+                                "'transport' attribute of element '{}'",
+                                t, reader.getName());
                     }
                 }
@@ -151 +178 @@
         XmlStreamReaderUtils.consumeStart(reader);
 
-        String host = XmlStreamReaderUtils.readContent(reader, ZEEREX_NS,
+        String host = XmlStreamReaderUtils.readContent(reader, namespace,
                 "host", true);
-        int port = XmlStreamReaderUtils.readContent(reader, ZEEREX_NS,
+        int port = XmlStreamReaderUtils.readContent(reader, namespace,
                 "port", true, -1);
         if ((port < 0) || (port > 65535)) {
@@ -159 +186 @@
             throw new SRUClientException("invalid port number (" + port + ")");
         }
-        String database = XmlStreamReaderUtils.readContent(reader, ZEEREX_NS,
+        String database = XmlStreamReaderUtils.readContent(reader, namespace,
                 "database", true);
-        if (XmlStreamReaderUtils.readStart(reader, ZEEREX_NS,
+        if (XmlStreamReaderUtils.readStart(reader, namespace,
                 "authentication", false)) {
-            XmlStreamReaderUtils.readEnd(reader, ZEEREX_NS,
+            XmlStreamReaderUtils.readEnd(reader, namespace,
                     "authentication", true);
         }
-        XmlStreamReaderUtils.readEnd(reader, ZEEREX_NS, "serverInfo", true);
+        XmlStreamReaderUtils.readEnd(reader, namespace, "serverInfo", true);
         logger.debug("serverInfo: host={}, port={}, database={}, version={}, protocol={}, transport={}",
                 host, port, database, version, protocol, transports);

SRUClient/trunk/src/main/java/eu/clarin/sru/client/SRUSimpleClient.java

@@ -595 +595 @@
                 }
 
-                if (!SRUExplainRecordData.RECORD_SCHEMA.equals(schema)) {
-                    // FIXME: message
-                    throw new SRUClientException("bad record schema");
-                }
+                /*
+                 * Hard-coded record schema identifiers for explain
+                 */
+                if (!(SRUExplainRecordDataParser.ZEEREX_NS.equals(schema) ||
+                      SRUExplainRecordDataParser.ZEEREX_NS_QUIRK.equals(schema))) {
+                    throw new SRUClientException("record schema '" + schema +
+                            "' not supported in explain response");
+                }
+
                 try {
                     proxy.reset(recordReader);