Changeset 4608

Timestamp:

Oct 3, 2017, 1:15:34 PM (6 years ago)

Author:

Nicklas Nordborg

Message:

References #994: Level 3 exporter

Added a configuration file for relax. So far, the only setting is <server-mode> which can be set to RELAX or LEVEL3.

This information is used to determine default configuration settings for some plug-ins. For example, the Level3ExporterPlugin will not be able to export to the ReleaseArchive server in RELAX mode since that may cause data originating from lorry to be overwritten.

Location:

extensions/net.sf.basedb.relax/trunk

Files:

• .classpath (modified) (1 diff)
• build.xml (modified) (1 diff)
• config (added)
• config/readme.txt (added)
• config/relax-config.xml (added)
• src/net/sf/basedb/relax/Relax.java (modified) (6 diffs)
• src/net/sf/basedb/relax/plugins/Level3ExporterPlugin.java (modified) (2 diffs)
• src/net/sf/basedb/relax/plugins/ReleaseImporterPlugin.java (modified) (3 diffs)
• src/net/sf/basedb/relax/plugins/ScriptWriter.java (modified) (2 diffs)
• src/net/sf/basedb/relax/servlet/InstallServlet.java (modified) (2 diffs)

extensions/net.sf.basedb.relax/trunk/.classpath

@@ -9 +9 @@
   <classpathentry kind="lib" path="lib/base-core-3.11.0.jar"/>
   <classpathentry kind="lib" path="lib/base-webclient-3.11.0.jar"/>
+  <classpathentry kind="lib" path="lib/jdom-2.0.5.jar"/>
   <classpathentry kind="output" path=".build"/>
 </classpath>

extensions/net.sf.basedb.relax/trunk/build.xml

@@ -57 +57 @@
     >
     <copy todir="${dist}">
-      <fileset dir="." includes="README,LICENSE" />
+      <fileset dir="." includes="README,LICENSE,config/*" />
       <fileset file="${jar.name}" />
     </copy>

extensions/net.sf.basedb.relax/trunk/src/net/sf/basedb/relax/Relax.java

@@ -1 +1 @@
 package net.sf.basedb.relax;
 
+import java.io.InputStream;
+import java.net.URL;
 import java.text.SimpleDateFormat;
 import java.util.Collections;
@@ -7 +9 @@
 import javax.servlet.ServletRequest;
 
+import org.jdom2.Document;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -12 +15 @@
 import net.sf.basedb.clients.web.Base;
 import net.sf.basedb.core.Application;
+import net.sf.basedb.core.ConfigurationException;
 import net.sf.basedb.core.Include;
 import net.sf.basedb.core.ItemQuery;
@@ -17 +21 @@
 import net.sf.basedb.relax.converter.DateToStringConverter;
 import net.sf.basedb.relax.converter.StringToDateConverter;
+import net.sf.basedb.util.FileUtil;
+import net.sf.basedb.util.XmlUtil2;
 
 
@@ -83 +89 @@
 
   
+  private static volatile XmlConfig rootConfig;
+  private static volatile ServerMode serverMode;
+  
+  /**
+    Get the server mode for this server. The mode affects what items that are installed,
+    various default values, etc.
+  */
+  public static ServerMode getServerMode()
+  {
+    if (serverMode == null)
+    {
+      serverMode = ServerMode.valueOf(getConfig().getConfig("server-mode", null, ServerMode.RELAX.name()));
+    }
+    return serverMode;
+  }
+  
+  /**
+    Get the Relax configuration.
+  */
+  public static XmlConfig getConfig()
+  {
+    if (rootConfig == null) loadConfig();
+    return rootConfig;
+  }
+  
+  /**
+    Force reload the Relax configuration.
+  */
+  public static synchronized XmlConfig reloadConfig()
+  {
+    unloadConfig();
+    loadConfig();
+    return rootConfig;
+  }
+  
+  public static synchronized void unloadConfig()
+  {
+    rootConfig = null;
+    serverMode = null;
+  }
+
   /**
     Get an existing session control and check that a user is logged in.
@@ -92 +139 @@
         req.getRemoteAddr(), true);
   }
-
+  
+  private static synchronized void loadConfig()
+  {
+    URL configUrl = Relax.class.getResource("/relax-config.xml");
+    if (rootConfig != null) return;
+    InputStream is = null;
+    try
+    {
+      logger.debug("Loading configuration from; " + configUrl);
+      is = configUrl == null ? null : configUrl.openStream();
+      if (is == null)
+      {
+        throw new ConfigurationException("Can't find the configuration file. " +
+            "Make sure 'relax-config.xml' is in the CLASSPATH.");
+      }
+      
+      Document dom = XmlUtil2.getValidatedXml(configUrl, null);
+      rootConfig = new XmlConfig(dom.getRootElement(), "[relax]");
+    }
+    catch (Exception ex)
+    {
+      logger.error("Could not load configuration", ex);
+      throw new RuntimeException(ex);
+    }
+    finally
+    {
+      FileUtil.close(is);
+    }
+  }
 }

extensions/net.sf.basedb.relax/trunk/src/net/sf/basedb/relax/plugins/Level3ExporterPlugin.java

@@ -75 +75 @@
 import net.sf.basedb.opengrid.config.ConnectionInfo;
 import net.sf.basedb.relax.Relax;
+import net.sf.basedb.relax.ServerMode;
 import net.sf.basedb.relax.dao.Datafiletype;
 import net.sf.basedb.relax.dao.Fileserver;
@@ -510 +511 @@
         FileServer level3Archive = Fileserver.LEVEL3_ARCHIVE.load(dc);
         if (!fileServers.contains(level3Archive)) fileServers.add(level3Archive);
-        // We should not store level-3 data on the relax release archive
-        // IT MAY OVERWRITE DATA FILES COMING FROM REGGIE
-        fileServers.remove(Fileserver.RELEASE_ARCHIVE.load(dc)); 
+        if (Relax.getServerMode() == ServerMode.RELAX)
+        {
+          // We should not store level-3 data on the relax release archive
+          // IT MAY OVERWRITE DATA FILES COMING FROM REGGIE
+          fileServers.remove(Fileserver.RELEASE_ARCHIVE.load(dc));
+        }
         fileServers.sort(new NameableComparator<>(false));
   

extensions/net.sf.basedb.relax/trunk/src/net/sf/basedb/relax/plugins/ReleaseImporterPlugin.java

@@ -96 +96 @@
 import net.sf.basedb.opengrid.filetransfer.ByteArrayDownloadTarget;
 import net.sf.basedb.relax.Relax;
+import net.sf.basedb.relax.ServerMode;
 import net.sf.basedb.relax.converter.StringToDateConverter;
 import net.sf.basedb.relax.dao.Fileserver;
@@ -363 +364 @@
       try
       {
+        Fileserver defaultFileServer = Relax.getServerMode() == ServerMode.RELAX ? 
+          Fileserver.RELEASE_ARCHIVE : Fileserver.LEVEL3_ARCHIVE;
+        
         dc = sc.newDbControl();
         
@@ -373 +377 @@
           ));
         List<FileServer> fileServers = new ArrayList<FileServer>(query.list(dc));
-        FileServer releaseArchive = Fileserver.RELEASE_ARCHIVE.load(dc);
+        FileServer releaseArchive = defaultFileServer.load(dc);
         if (!fileServers.contains(releaseArchive)) fileServers.add(releaseArchive);
         fileServers.sort(new NameableComparator<>(false));

extensions/net.sf.basedb.relax/trunk/src/net/sf/basedb/relax/plugins/ScriptWriter.java

@@ -19 +19 @@
 import net.sf.basedb.opengrid.ScriptBuilder;
 import net.sf.basedb.relax.Relax;
+import net.sf.basedb.relax.ServerMode;
 import net.sf.basedb.relax.bash.ScriptUtil;
 import net.sf.basedb.relax.dao.Fileserver;
@@ -46 +47 @@
   public ScriptWriter(DbControl dc, ReleaseWriterOptions options) 
   {
-    this.releaseArchive = Fileserver.RELEASE_ARCHIVE.load(dc);
+    this.releaseArchive = Relax.getServerMode() == ServerMode.RELAX ? Fileserver.RELEASE_ARCHIVE.load(dc) : Fileserver.LEVEL3_ARCHIVE.load(dc);
     this.pathsToCreate = new TreeSet<>();
     this.filesToSync = new TreeMap<>();

extensions/net.sf.basedb.relax/trunk/src/net/sf/basedb/relax/servlet/InstallServlet.java

@@ -38 +38 @@
 import net.sf.basedb.relax.JsonUtil;
 import net.sf.basedb.relax.Relax;
+import net.sf.basedb.relax.ServerMode;
 import net.sf.basedb.relax.dao.Fileserver;
 import net.sf.basedb.relax.dao.Subtype;
@@ -109 +110 @@
         
         // File servers
-        jsonChecks.add(checkFileServer(dc, Fileserver.RELEASE_ARCHIVE, createIfMissing, everyoneRead));
+        if (Relax.getServerMode() == ServerMode.RELAX)
+        {
+          // The release archive is only installed on the RELAX server
+          jsonChecks.add(checkFileServer(dc, Fileserver.RELEASE_ARCHIVE, createIfMissing, everyoneRead));
+        }
         jsonChecks.add(checkFileServer(dc, Fileserver.LEVEL3_ARCHIVE, createIfMissing, everyoneRead));