Documentation and versioning updated for v3.1.0

JeffersonLab · Sep 27, 2018 · 6b92adc · 6b92adc
1 parent d1c393a
commit 6b92adc
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 13 deletions.
diff --git a/build.xml b/build.xml
@@ -27,7 +27,7 @@
     </target>    
     <target name="doc">
         <javadoc packagenames="org.jlab.elog,org.jlab.elog.exception" sourcepath="${src.dir}" destdir="${dist.dir}/javadoc" overview="${src.dir}/overview.html">
-            <header>eLog Client API Version 3.0.0</header>
+            <header>eLog Client API Version 3.1.0</header>
             <doctitle>Electronic Logbook Client API Overview</doctitle>
             <link href="https://docs.oracle.com/javase/7/docs/api/"/>
         </javadoc>

diff --git a/doc/release-notes.html b/doc/release-notes.html
@@ -6,6 +6,8 @@
     </head>
     <body>
         <h1>Java eloglib Release Notes</h1>
+        <h2>September 27, 2018 - Version 3.1.0</h2>
+        <p>Default properties updated now that server requires SSL for schema.  Server certificate checking is now a configurable option.</p>          
         <h2>November 28, 2017 - Version 3.0.0</h2>
         <p>Upgraded to Java 7 platform (no longer support Java 6) - this fixed many issues related to Java 6 JVM.</p>        
         <h2>September 16, 2014 - Version 2.9</h2>

diff --git a/src/org/jlab/elog/Library.java b/src/org/jlab/elog/Library.java
@@ -13,7 +13,7 @@
  */
 public final class Library {
 
-    private static final String version = "2.9";
+    private static final String VERSION = "3.1.0";
     private static Properties configuration;
 
     static {
@@ -61,6 +61,6 @@ public static void setConfiguration(Properties configuration) {
      * @return The version String
      */
     public static String getVersion() {
-        return version;
+        return VERSION;
     }
 }
diff --git a/src/overview.html b/src/overview.html
@@ -12,22 +12,23 @@ <h2>Usage</h2>
             <p>
                 In order to use the library you need to include it in the 
                 classpath of your Java program.  The most recent revision of the 
-                version 2 series of the library is available from the following 
+                version 3 series of the library is available from the following 
                 paths:
             </p>
             <dl class="property-list">                
                 <dt>CUE Linux</dt>
-                <dd>/site/ace/certified/apps/eloglib/java/jlog2.jar</dd> 
+                <dd>/site/ace/certified/apps/eloglib/java/jlog3.jar</dd> 
                 <dt>ACE Linux</dt>
-                <dd>/cs/certified/apps/eloglib/java/jlog2.jar</dd>
+                <dd>/cs/certified/apps/eloglib/java/jlog3.jar</dd>
                 <dt>CUE and ACE Windows</dt>
-                <dd>K:\ace\certified\apps\eloglib\java\jlog2.jar</dd>                
+                <dd>K:\ace\certified\apps\eloglib\java\jlog3.jar</dd>                
             </dl>
             <p>
-                The versioning is organized into "major.minor" where major 
-                versions indicate API changes and minor versions are for bug 
+                Semantic versioning is used: "major.minor.patch", where major 
+                versions indicate API changes, minor versions are for new 
+                features, and patch versions are for bug 
                 fixes and implementation changes.  It is relatively safe to 
-                include the jlog2.jar in your classpath, but you may 
+                include the jlog3.jar in your classpath, but you may 
                 alternatively include a specified minor version such as 
                 jlog-2.3.jar. 
             </p>
@@ -60,8 +61,8 @@ <h2>Usage</h2>
                 on an accelerator Linux machine with the following commands:</p>
             <pre><kbd>
 cd jlog
-javac -cp /cs/certified/apps/eloglib/java/jlog2.jar  test/org/jlab/elog/example/HelloWorldDemo.java
-java -cp /cs/certified/apps/eloglib/java/jlog2.jar:test org.jlab.elog.example.HelloWorldDemo 
+javac -cp /cs/certified/apps/eloglib/java/jlog3.jar  test/org/jlab/elog/example/HelloWorldDemo.java
+java -cp /cs/certified/apps/eloglib/java/jlog3.jar:test org.jlab.elog.example.HelloWorldDemo 
             </kbd></pre>
             <p>Running the example on Windows is similar, but the classpath (-cp) 
                 delimiter is a semicolon instead of a colon.  The path to the 
@@ -161,7 +162,12 @@ <h2>Configuration</h2>
                 <dt>ATTACH_TOTAL_MAX_BYTES</dt>
                 <dd>
                     Maximum number of bytes allowed across all attachments.
-                </dd>            
+                </dd>   
+                <dt>IGNORE_SERVER_CERT_ERRORS</dt>
+                <dd>
+                    For testing it is often useful to ignore self signed 
+                    certificates such as those used on logbooktest.acc.jlab.org.
+                </dd>                 
             </dl>
             <p>
                 If building from source then you can edit the properties file