From 6b92adc36f7a5068012f543f496a69f037bd6562 Mon Sep 17 00:00:00 2001 From: ryans Date: Thu, 27 Sep 2018 13:41:05 -0400 Subject: [PATCH] Documentation and versioning updated for v3.1.0 --- build.xml | 2 +- doc/release-notes.html | 2 ++ src/org/jlab/elog/Library.java | 4 ++-- src/overview.html | 26 ++++++++++++++++---------- 4 files changed, 21 insertions(+), 13 deletions(-) diff --git a/build.xml b/build.xml index 44ac4d4..b6f1f14 100644 --- a/build.xml +++ b/build.xml @@ -27,7 +27,7 @@ -
eLog Client API Version 3.0.0
+
eLog Client API Version 3.1.0
Electronic Logbook Client API Overview diff --git a/doc/release-notes.html b/doc/release-notes.html index 5f13ef2..4a446d9 100644 --- a/doc/release-notes.html +++ b/doc/release-notes.html @@ -6,6 +6,8 @@

Java eloglib Release Notes

+

September 27, 2018 - Version 3.1.0

+

Default properties updated now that server requires SSL for schema. Server certificate checking is now a configurable option.

November 28, 2017 - Version 3.0.0

Upgraded to Java 7 platform (no longer support Java 6) - this fixed many issues related to Java 6 JVM.

September 16, 2014 - Version 2.9

diff --git a/src/org/jlab/elog/Library.java b/src/org/jlab/elog/Library.java index 16b75fc..16f5400 100644 --- 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 index d3cf599..748c6de 100644 --- a/src/overview.html +++ b/src/overview.html @@ -12,22 +12,23 @@

Usage

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:

CUE Linux
-
/site/ace/certified/apps/eloglib/java/jlog2.jar
+
/site/ace/certified/apps/eloglib/java/jlog3.jar
ACE Linux
-
/cs/certified/apps/eloglib/java/jlog2.jar
+
/cs/certified/apps/eloglib/java/jlog3.jar
CUE and ACE Windows
-
K:\ace\certified\apps\eloglib\java\jlog2.jar
+
K:\ace\certified\apps\eloglib\java\jlog3.jar

- 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.

@@ -60,8 +61,8 @@

Usage

on an accelerator Linux machine with the following commands:


 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

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 @@

Configuration

ATTACH_TOTAL_MAX_BYTES
Maximum number of bytes allowed across all attachments. -
+ +
IGNORE_SERVER_CERT_ERRORS
+
+ For testing it is often useful to ignore self signed + certificates such as those used on logbooktest.acc.jlab.org. +

If building from source then you can edit the properties file