Changeset 4542

Timestamp:

Feb 7, 2014, 12:48:31 PM (10 years ago)

Author:

olle

Message:

Refs #823. First version of support for reading connection properties from a properties file:

1. New connection properties template file conf/connection.properties.in in client/servlet/ added. It contains settings for accessing files using SSL (Secure Sockets Layer) connection, and redirects for local cache when accessing files via URL.
2. Outermost Ant build file build.xml updated to include files connection.properties* when copying files from client/servlet/conf/ to www/WEB-INF/classes/ in distribution directory.
3. New class/file ConnectionPropertiesFile.java in api/core/ added. It loads connection.properties file and gives access to the settings in the latter.
4. Class/file core/Application.java in api/core/ updated:
   a. Private static method void createSSLFactory() updated to call new private static method String fetchProperty(Properties pf, String property, boolean replaceEmptyStringWithNull) to obtain property values.
   b, New private static method String fetchProperty(Properties pf, String property, boolean replaceEmptyStringWithNull) added. It fetches a property value from the properties file, if existing, otherwise from system properties. Optional replacement of empty string with null, when property value is returned.
   c. New private static method String fetchProperty(Properties pf, String property) added. It calls new private static method String fetchProperty(Properties pf, String property, boolean replaceEmptyStringWithNull) with argument replaceEmptyStringWithNull set to false, to obtain the vallue to return.

Location:

trunk

Files:

• api/core/src/org/proteios/ConnectionPropertiesFile.java (added)
• api/core/src/org/proteios/core/Application.java (modified) (5 diffs)
• build.xml (modified) (1 diff)
• client/servlet/conf/connection.properties.in (added)

trunk/api/core/src/org/proteios/core/Application.java

@@ -25 +25 @@
 package org.proteios.core;
 
+import org.proteios.ConnectionPropertiesFile;
 import org.proteios.core.authentication.Authenticator;
 import org.proteios.core.data.ClientData;
@@ -47 +48 @@
 import java.util.List;
 import java.util.Map;
+import java.util.Properties;
 import java.util.Random;
 import java.util.Timer;
@@ -886 +888 @@
   private static void createSSLFactory()
   {
-    String keyStoreFileName = System.getProperty("javax.net.ssl.keyStore");
-    String keyStorePassword = System
-      .getProperty("javax.net.ssl.keyStorePassword");
-    String alias = System.getProperty("cert.alias");
-    String passfile = System.getProperty("cert.passFile");
+    ConnectionPropertiesFile pf = new ConnectionPropertiesFile();
+    boolean replaceEmptyStringWithNull = true;
+    String keyStoreFileName = fetchProperty(pf, "javax.net.ssl.keyStore", replaceEmptyStringWithNull);
+    String keyStorePassword = fetchProperty(pf, "javax.net.ssl.keyStorePassword", replaceEmptyStringWithNull);
+    String alias = fetchProperty(pf, "cert.alias", replaceEmptyStringWithNull);
+    String passfile = fetchProperty(pf, "cert.passFile", replaceEmptyStringWithNull);
     if (keyStorePassword==null && passfile!=null)
     {
@@ -909 +912 @@
       }
     }
-    String trustStoreFileName = System
-      .getProperty("javax.net.ssl.trustStore");
-    String trustStorePassword = System
-      .getProperty("javax.net.ssl.trustStorePassword");
+    String trustStoreFileName = fetchProperty(pf, "javax.net.ssl.trustStore", replaceEmptyStringWithNull);
+    String trustStorePassword = fetchProperty(pf, "javax.net.ssl.trustStorePassword", replaceEmptyStringWithNull);
     if (keyStoreFileName != null && trustStoreFileName != null)
     {
@@ -951 +952 @@
       }
     }
+  }
+
+
+  /**
+   * Fetch property value from properties file, if existing,
+   * otherwise from system properties.
+   * 
+   * @param pf Properties Properties file to use.
+   * @param property String Property to get value for.
+   * @return String The found property value.
+   */
+  private static String fetchProperty(Properties pf, String property)
+  {
+    boolean replaceEmptyStringWithNull = false;
+    return fetchProperty(pf, property, replaceEmptyStringWithNull);
+  }
+
+
+  /**
+   * Fetch property value from properties file, if existing,
+   * otherwise from system properties. Optional replacement
+   * of empty string with `null`, when property value is returned.
+   * 
+   * @param pf Properties Properties file to use.
+   * @param property String Property to get value for.
+   * @param replaceEmptyStringWithNull boolean Flag indicating that `null` should be returned instead of an empty string.
+   * @return String The found property value.
+   */
+  private static String fetchProperty(Properties pf, String property, boolean replaceEmptyStringWithNull)
+  {
+    String value = null;
+    if (property != null && !property.equals(""))
+    {
+      if (pf != null)
+      {
+        // Get property value from properties file
+        value = pf.getProperty(property);
+        // Note: The output below is printed when running update.sh during installation
+        log.debug("Property " + property + " fetched from properties file.");
+      }
+      else
+      {
+        // Get property value from system properties
+        value = System.getProperty(property);
+        // Note: The output below is printed when running update.sh during installation
+        log.debug("Property " + property + " fetched from system properties.");
+      }
+      // Optional replacement of empty string with null
+      if (replaceEmptyStringWithNull)
+      {
+        if (value != null && value.equals(""))
+        {
+          value = null;
+        }
+      }
+    }
+    return value;
   }
 

trunk/build.xml

@@ -213 +213 @@
       </fileset>
       <fileset dir="client/servlet/conf">
+        <include name="connection.properties*" />
         <include name="log4j.properties*" />
         <include name="proteios.config*" />