Changeset 1889 for SRUServer/trunk/src/main/java/eu/clarin/sru/server/SRUServerConfig.java

Timestamp:

04/17/12 13:06:10 (12 years ago)

Author:

oschonef

Message:

• re-name some classes to better match to SRU specification components
  • SRUService -> SRUServer
  • SRUEndpointConfig -> SRUServerConfig
• some more sanity checking in config parsing
• some updates to java docs

File:

• SRUServer/trunk/src/main/java/eu/clarin/sru/server/SRUServerConfig.java (moved) (moved from SRUServer/trunk/src/main/java/eu/clarin/sru/server/SRUEndpointConfig.java) (11 diffs)

SRUServer/trunk/src/main/java/eu/clarin/sru/server/SRUServerConfig.java

@@ -17 +17 @@
 package eu.clarin.sru.server;
 
-import java.io.InputStream;
+import java.io.IOException;
 import java.net.URL;
 import java.util.ArrayList;
@@ -30 +30 @@
 import javax.xml.parsers.DocumentBuilder;
 import javax.xml.parsers.DocumentBuilderFactory;
+import javax.xml.parsers.ParserConfigurationException;
 import javax.xml.transform.Source;
 import javax.xml.transform.dom.DOMSource;
@@ -37 +38 @@
 import javax.xml.xpath.XPath;
 import javax.xml.xpath.XPathConstants;
+import javax.xml.xpath.XPathException;
 import javax.xml.xpath.XPathExpression;
 import javax.xml.xpath.XPathExpressionException;
@@ -52 +54 @@
 
 /**
- * Endpoint configuration. Most of the endpoint configuration is created from
- * the XML file.
+ * SRU server configuration.
  * 
- * <p>Example:</p>
+ * <p>
+ * Example:
+ * </p>
  * <pre>
- * URL url = MySRUServlet.class.getClassLoader().getResource("META-INF/endpoint-config.xml");
+ * URL url = MySRUServlet.class.getClassLoader()
+ *               .getResource("META-INF/sru-server-config.xml");
  * if (url == null) {
- *     throw new ServletException("not found, url == null");
+ *     throw new ServletException(&quot;not found, url == null&quot;);
  * }
  * 
+ * // other runtime configuration, usually obtained from servlet context
  * HashMap&lt;String, String&gt; params = new HashMap&lt;String, String&gt;();
- * SRUEndpointConfig config = SRUEndpointConfig.parse(params, url.openStream());
+ * params.put(SRUServerConfig.SRU_TRANSPORT, "http");
+ * params.put(SRUServerConfig.SRU_HOST, "127.0.0.1");
+ * params.put(SRUServerConfig.SRU_PORT, "80");
+ * params.put(SRUServerConfig.SRU_DATABASE, "sru-server");
+ *
+ * SRUServerConfig config = SRUServerConfig.parse(params, url);
  * </pre>
  * 
- * <p>The XML configuration file must validate against the "endpoint-config.xsd"
- * schema bundled with the package and need to have the
+ * <p>
+ * The XML configuration file must validate against the "sru-server-config.xsd"
+ * W3C schema bundled with the package and need to have the
  * <code>http://www.clarin.eu/sru-server/1.0/</code> XML namespace.
- * </p> 
+ * </p>
  */
-public final class SRUEndpointConfig {
+public final class SRUServerConfig {
     public static final String SRU_TRANSPORT     = "sru.transport";
     public static final String SRU_HOST          = "sru.host";
@@ -79 +90 @@
     private static final String CONFIG_FILE_NAMESPACE_URI =
             "http://www.clarin.eu/sru-server/1.0/";
+    private static final String CONFIG_FILE_SCHEMA_URL =
+            "META-INF/sru-server-config.xsd";
 
     public static final class LocalizedString {
@@ -413 +426 @@
 
 
-    private SRUEndpointConfig(String transport, String host, String port,
+    private SRUServerConfig(String transport, String host, String port,
             String database, boolean echoRequests, DatabaseInfo databaseinfo,
             IndexInfo indexInfo, List<SchemaInfo> schemaInfo) {
@@ -524 +537 @@
 
     /**
-     * Parse the XML endpoint configuration.
+     * Parse a SRU server XML configuration file and create an configuration
+     * object from it.
      * 
      * @param params
      *            additional settings
-     * @param in
-     *            an {@link InputSource} to the XML configuration file
+     * @param configFile
+     *            an {@link URL} pointing to the XML configuration file
      * @return a initialized <code>SRUEndpointConfig</code> instance
      * @throws NullPointerException
-     *             if <em>params</em> or <em>in</em> is <code>null</code>
+     *             if <em>params</em> or <em>configFile</em> is
+     *             <code>null</code>
      * @throws SRUConfigException
-     *             if an error occured
+     *             if an error occurred
      */
-    public static SRUEndpointConfig parse(Map<String, String> params,
-            InputStream in) throws SRUConfigException {
+    public static SRUServerConfig parse(Map<String, String> params,
+            URL configFile) throws SRUConfigException {
         if (params == null) {
             throw new NullPointerException("params == null");
         }
-        if (in == null) {
+        if (configFile == null) {
             throw new NullPointerException("in == null");
         }
         try {
-            URL url = SRUEndpointConfig.class.getClassLoader()
-                    .getResource("META-INF/endpoint-config.xsd");
+            URL url = SRUServerConfig.class.getClassLoader()
+                    .getResource(CONFIG_FILE_SCHEMA_URL);
             if (url == null) {
-                throw new SRUConfigException("cannot open " +
-                        "\"META-INF/endpoint-config.xsd\"");
+                throw new SRUConfigException("cannot open \"" +
+                        CONFIG_FILE_SCHEMA_URL + "\"");
             }
             SchemaFactory sfactory =
@@ -564 +579 @@
             // parse input
             DocumentBuilder builder = factory.newDocumentBuilder();
-            InputSource input = new InputSource(in);
+            InputSource input = new InputSource(configFile.openStream());
             input.setPublicId(CONFIG_FILE_NAMESPACE_URI);
             input.setSystemId(CONFIG_FILE_NAMESPACE_URI);
@@ -654 +669 @@
                         "\" is mandatory");
             }
+            // sanity check
+            try {
+                int num = Integer.parseInt(port);
+                if ((num < 1) && (num > 65535)) {
+                    throw new SRUConfigException("parameter \"" + SRU_PORT +
+                            "\" must be between 1 and 65535");
+                }
+            } catch (NumberFormatException e) {
+                throw new SRUConfigException("parameter \"" + SRU_PORT +
+                        "\" must be nummerical");
+            }
 
             String database = params.get(SRU_DATABASE);
@@ -661 +687 @@
             }
 
+            // cleanup: remove leading slashed 
+            while (database.startsWith("/")) {
+                database = database.substring(1);
+            }
+
             String s;
             boolean echoRequests = false;
@@ -667 +698 @@
             }
 
-            return new SRUEndpointConfig(transport, host, port, database,
+            return new SRUServerConfig(transport, host, port, database,
                     echoRequests, databaseInfo, indexInfo,
                     schemaInfo);
+        } catch (IOException e) {
+            throw new SRUConfigException("error reading configuration file", e);
+        } catch (XPathException e) {
+            throw new SRUConfigException("error parsing configuration file", e);
+        } catch (ParserConfigurationException e) {
+            throw new SRUConfigException("error parsing configuration file", e);
+        } catch (SAXException e) {
+            throw new SRUConfigException("error parsing configuration file", e);
         } catch (SRUConfigException e) {
             throw e;
-        } catch (Exception e) {
-            throw new SRUConfigException("error parsing config", e);
         }
     }