Changeset 2600

Timestamp:

02/21/13 07:33:35 (11 years ago)

Author:

keeloo

Message:

Instead of retrieving the SolrUrl? from the context of the application, retrieve the location of an external VloConfig? from the context, preferably the file used by the importer. By using the context in this way, the configuration for both the importer and the web application will be one and the same.

Location:

vlo/branches/vlo-2.13-param/vlo_webapp/src

Files:

• main/java/eu/clarin/cmdi/vlo/VloApplication.java (modified) (5 diffs)
• main/java/eu/clarin/cmdi/vlo/config/ConfigFromFile.java (modified) (4 diffs)
• main/java/eu/clarin/cmdi/vlo/config/ImporterConfig.java (modified) (1 diff)
• main/java/eu/clarin/cmdi/vlo/config/VloConfig.java (modified) (7 diffs)
• main/java/eu/clarin/cmdi/vlo/dao/SolrDao.java (modified) (2 diffs)
• main/webapp/META-INF/context.xml (modified) (1 diff)
• test/java/eu/clarin/cmdi/vlo/pages/FacetBoxPanelTest.java (modified) (2 diffs)

vlo/branches/vlo-2.13-param/vlo_webapp/src/main/java/eu/clarin/cmdi/vlo/VloApplication.java

@@ -9 +9 @@
 /**
  * {@literal VLO} web application.<br><br>
- * 
- * Because the class extends the WebApplication class, the VLO application 
- * will normally be deployed on a web server. However, by running the Start
- * class, the application outside of a server container. 
- * 
+ *
+ * Because the VloApplication class extends WebApplication, a class instance
+ * will normally reside inside a web server container. By running the Start
+ * class however, an instance of the application will reside outside a server
+ * container.
+ *
  */
 public class VloApplication extends WebApplication {
 
     private final SearchResultsDao searchResults;
-    
+
     // application configuration object
-    
     static VloConfig config;
     
     // flag indicating whether or not the application object lives in a context
-    
     boolean inContext;
 
@@ -35 +34 @@
         if (inContext) {
             
-            // add the context parameters to the configuration
-
+            // get the servlet's context
+            
             ServletContext servletContext;
             servletContext = this.getServletContext();
-            config = VloConfig.addServletContext(config, servletContext);
+            
+            /**
+             * Send the servlet context to the configuration object to enable it
+             * to read an externel VloConfig.xml configuration file.
+             */
+            
+            config = VloConfig.switchToExternalConfig(servletContext);
+
+            /**
+             * Instead of obtaining the SolrUrl parameter from the context, read
+             * the name of another instance - preferably the one that the
+             * importer uses for its configuration - from the context. Once this
+             * has been done, the whole web application configuration could be
+             * refreshed. Note: add a method for refreshing the current
+             * configuration to the VloConfig class.
+             */
         }
     }
@@ -46 +60 @@
      * Web application constructor<br><br>
      *
-     * Create the application by invoking this constructor, whenever you want it
-     * to be an application deployed in a web server container, that is: as an
-     * application living in a web server context.
+     * Create an application instance configured to be living inside a web
+     * server container.
      */
     public VloApplication() {
@@ -58 +71 @@
          * {@literal init()} method will be invoked.
          */
-        config = VloConfig.webApp();
+        String fileName = VloConfig.class.getResource("/VloConfig.xml").getFile();
+        
+        config = VloConfig.readConfig(fileName);
 
         // let the {@literal init()} method know that there will be a context
@@ -72 +87 @@
      * Web application constructor<br><br>
      *
-     * Introduce the idea of a channel: the environment in which a test
-     * configuration object is created is in a way connected to this method.
+     * Create an application instance configured to be living without a web
+     * server container context.<br><br>
      *
+     * @param testConfig a configuration that could be different from the
+     * packaged parameters
+     *
+     * An instance like this can for example be used for testing purposes. In
+     * the case of testing, the constructor is invoked from a class in a test
+     * package. Within such a class a configuration object can be manipulated
+     * according to specific needs. <br><br>
+     *
+     * Please note that in the case of a test configuration, while the
+     * application object could reside inside a web server container, the
+     * context associated with this container will be ignored.
      */
     public VloApplication(VloConfig testConfig) {

vlo/branches/vlo-2.13-param/vlo_webapp/src/main/java/eu/clarin/cmdi/vlo/config/ConfigFromFile.java

@@ -26 +26 @@
  * @author keeloo
  */
-public abstract class ConfigFromFile {
+public class ConfigFromFile {
 
     /**
@@ -35 +35 @@
 
     /**
-     * Constraint on a deriving class<br><br>
-     *
-     * Ask a deriving class to implement a method that returns the name of the
-     * file the persister object can read from or write to.<br><br>
-     *
-     * @return the name of an XML file
-     */
-    public abstract String getFileName();
-
-    /**
      * Configure by reading from an XML file
+     * 
+     * @param fileName
      *
      * @param config the object whose annotated members will be assigned a value
@@ -52 +44 @@
      * @return the object with values assigned to annotated members
      */
-    public static synchronized ConfigFromFile read(ConfigFromFile config) {
+    public static synchronized ConfigFromFile read(String fileName, ConfigFromFile config) {
 
         ConfigFilePersister persister;
         // config itself might not reference a file name
-        persister = new ConfigFilePersister(config, config.getFileName ());
+        persister = new ConfigFilePersister(config, fileName);
 
         // assign the members their values
@@ -68 +60 @@
      * @param config the object whose annotated members and values will be
      * written to a file in the form of an XML definition.
+     * 
+     * @param 
      */
-     public static void write(ConfigFromFile config) {
+     public static void write(ConfigFromFile config, String fileName) {
         
         ConfigFilePersister persister;
         // config itself might not reference a file name
-        persister = new ConfigFilePersister(config, config.getFileName ());
+        persister = new ConfigFilePersister(config, fileName);
 
         // create the definition

vlo/branches/vlo-2.13-param/vlo_webapp/src/main/java/eu/clarin/cmdi/vlo/config/ImporterConfig.java

@@ -20 +20 @@
 public class ImporterConfig extends ConfigFromFile {
     
-    /**
-     * Definition of the name of the configuration file.
-     *
-     * @return
-     */
-    @Override
-    public String getFileName() {
-        return "ImporterConfig.xml";
-    }
-    
-    // 'override' the base class method
+
     public static synchronized ImporterConfig get() {
         return (ImporterConfig)ImporterConfig.get();

vlo/branches/vlo-2.13-param/vlo_webapp/src/main/java/eu/clarin/cmdi/vlo/config/VloConfig.java

@@ -95 +95 @@
     
     /**
-     * XML File in which the application configuration is stored
-     */
-    public static final String CONFIG_FILE =
-            VloConfig.class.getResource("/VloConfig.xml").getFile();
-
-    /**
-     * Get the name of the XML file.
-     *
-     * Represent the filename by a method primarily for making it available to
-     * the superclass. In other words: this method overrides a method in the
-     * superclass.
-     *
-     * @return the name of the application parameter XML file
-     */
-    @Override
-    public String getFileName() {
-        /**
-         * Check the name of the web application parameter file. May be turn it
-         * into a {@literal maven} parameter.
-         */
-        return CONFIG_FILE;
-    }
-    
-    /**
      * Make the configuration statically accessible<br><br>
      *
@@ -146 +122 @@
      *
      * WebAppConfig.open().getParameterMember()<br><br>
+     * 
+     * @param fileName
      *
      * @return the web application configuration in a new static context
      */
-    public static VloConfig webApp() {
+    public static VloConfig readConfig(String fileName) {
         if (config == null) {
             // the configuration is not there yet; create it now
@@ -157 +135 @@
         // get the XML file configuration from the file by invoking the
 
-        config = (VloConfig) read(config);
+        config = (VloConfig) read(fileName, config);
 
         return config;
@@ -169 +147 @@
      * be made.
      * 
+     * @param fileName
+     * 
      * @return 
      */
-    public static VloConfig testWebApp() {
+    public static VloConfig readTestConfig(String fileName) {
         if (config == null) {
             // the configuration is not there yet; create it now
@@ -179 +159 @@
         // get the XML file configuration from the file by invoking the
 
-        config = (VloConfig) read(config);
+        config = (VloConfig) read(fileName, config);
 
         return config;
@@ -193 +173 @@
     }
 
-    /**
-     * Close the static context of WebAppConfig members<br><cr>
-     * 
-     * As a counterpart to open() the close() method just writes the value of
-     * the parameters in the XML file back to this file.
-     */
-    public void close() {
-        if (config == null) {
-            // no configuration is not there yet; no need to do anything
-        } else {
-            // put it away by invoking the superclass write method
-
-            write (config);
-
-            /**
-             * Contrary to web the application parameters, servlet context
-             * parameters can not be written back to where they reside, so there
-             * is nothing left to do here.
-             */
-        }
-    }
-    
     /**
      * Web application parameter members<br><br>
@@ -612 +570 @@
      * @return the static WebAppConfig member
      */
-    public static VloConfig addServletContext(VloConfig config, ServletContext context) {
+    public static VloConfig switchToExternalConfig(ServletContext context) {
 
         // retrieve parameter valies from the servlet context
 
-        config.solrUrl = context.getInitParameter("solrUrl");
+        String fileName;
+        fileName = context.getInitParameter("externalConfig");
+        
+        if (fileName == null) {
+            // no external config
+        } else {
+            config = (VloConfig) read(fileName, config);
+        }
 
         return config;

vlo/branches/vlo-2.13-param/vlo_webapp/src/main/java/eu/clarin/cmdi/vlo/dao/SolrDao.java

@@ -13 +13 @@
 import org.slf4j.LoggerFactory;
 
-import eu.clarin.cmdi.vlo.Configuration;
 import eu.clarin.cmdi.vlo.config.VloConfig;
 
@@ -22 +21 @@
 
     public SolrDao() {
-        String solrUrl = VloConfig.get().getSolrUrl();
+        String solrUrl;
+        solrUrl = VloConfig.get().getSolrUrl();
         try {
             solrServer = new CommonsHttpSolrServer(solrUrl);

vlo/branches/vlo-2.13-param/vlo_webapp/src/main/webapp/META-INF/context.xml

@@ -2 +2 @@
 <!-- VLO application context file
 
-solrURL : URL through which the Solr server should be reached<br><br>
-
-Note that the VLO importer needs to know about this URL to. Because the
-importer is not a web application, the value of the parameter should
-be defined in the ImporterConfig.xml<br><br>
-
-as<br><br>
-
-<solrUrl>http://localhost:8084/vlo_solr/</solrUrl><br><br>
+explain about how the configurtion works
 
 -->
 <Context antiJARLocking="true" path="/vlo">
-  <Parameter name="solrUrl" value="http://localhost:8084/vlo_solr/"/>
+  <Parameter name="externalConfig" value="/Users/keeloo/VloConfig.xml"/>
 </Context>

vlo/branches/vlo-2.13-param/vlo_webapp/src/test/java/eu/clarin/cmdi/vlo/pages/FacetBoxPanelTest.java

@@ -1 +1 @@
 package eu.clarin.cmdi.vlo.pages;
 
-import static org.junit.Assert.assertEquals;
-
+import eu.clarin.cmdi.vlo.VloApplication;
+import eu.clarin.cmdi.vlo.config.VloConfig;
 import java.util.List;
-
 import org.apache.solr.client.solrj.response.FacetField;
 import org.apache.solr.client.solrj.response.FacetField.Count;
 import org.apache.wicket.util.tester.WicketTester;
+import static org.junit.Assert.assertEquals;
 import org.junit.Before;
 import org.junit.Test;
-
-import eu.clarin.cmdi.vlo.VloApplication;
-import eu.clarin.cmdi.vlo.config.VloConfig;
 
 public class FacetBoxPanelTest {
@@ -21 +18 @@
     public void setUp() {
         WicketTester wicketTester;
-        testConfig = VloConfig.testWebApp();
+        String fileName = VloConfig.class.getResource("/VloConfig.xml").getFile();
+        
+        testConfig = VloConfig.readTestConfig(fileName);
+        
+        // optionally, modify the test configuration here
+        
         wicketTester = new WicketTester(new VloApplication(testConfig));
     }