Changeset 2598

Timestamp:

02/20/13 11:36:52 (11 years ago)

Author:

keeloo

Message:

Changed WebAppConfig?.xml to VloConfig? to allow for the importerparameters to be included. Made the configuration sensitive to the web application context.

Location:

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

Files:

• main/java/eu/clarin/cmdi/vlo/VloApplication.java (modified) (3 diffs)
• main/java/eu/clarin/cmdi/vlo/config/VloConfig.java (modified) (10 diffs)
• main/resources/VloConfig.xml (moved) (moved from vlo/branches/vlo-2.13-param/vlo_webapp/src/main/resources/WebAppConfig.xml)
• test/java/eu/clarin/cmdi/vlo/pages/FacetBoxPanelTest.java (modified) (1 diff)

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

@@ -6 +6 @@
 import javax.servlet.ServletContext;
 import org.apache.wicket.protocol.http.WebApplication;
-import org.springframework.beans.factory.BeanFactory;
-import org.springframework.context.support.ClassPathXmlApplicationContext;
 
 /**
- * Application object for your web application. If you want to run this 
- * application without deploying, run the Start class.
+ * {@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. 
  * 
  */
@@ -18 +19 @@
     private final SearchResultsDao searchResults;
     
-    static VloConfig config;  
+    // application configuration object
     
+    static VloConfig config;
+    
+    // flag indicating whether or not the application object lives in a context
+    
+    boolean inContext;
+
     /**
-     * 
+     * Method that will be invoked when the application starts
+     */
+    @Override
+    public void init() {
+
+        if (inContext) {
+            
+            // add the context parameters to the configuration
+
+            ServletContext servletContext;
+            servletContext = this.getServletContext();
+            config = VloConfig.addServletContext(config, servletContext);
+        }
+    }
+
+    /**
+     * 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.
      */
     public VloApplication() {
 
         /**
-         * 
+         * Read the application's configuration. Because on instantiation a web
+         * application cannot said to be living in a context, context parameters
+         * can only be added to the configuration later, in this case: when the
+         * {@literal init()} method will be invoked.
          */
-        ServletContext servletContext;
-        servletContext = this.getServletContext();
-        config = VloConfig.setWebApp(servletContext);
-        
-        String test;
-        test = VloConfig.get().getSolrUrl();
-        
-        searchResults = new SearchResultsDao();        
+        config = VloConfig.webApp();
+
+        // let the {@literal init()} method know that there will be a context
+
+        inContext = true;
+
+        // start the application
+
+        searchResults = new SearchResultsDao();
     }
-    
+
     /**
-     * Invoke the application in test mode
+     * 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.
+     *
      */
     public VloApplication(VloConfig testConfig) {
+
+        // let the application use the configuration created outside of it
+
+        inContext = false;
+
         config = testConfig;
 
@@ -58 +98 @@
         return searchResults;
     }
-
 }

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

@@ -3 +3 @@
 import java.io.UnsupportedEncodingException;
 import java.net.URLEncoder;
-import javax.servlet.GenericServlet;
 import javax.servlet.ServletContext;
 import org.simpleframework.xml.Element;
@@ -89 +88 @@
     public VloConfig() {
         // let the superclass know about the logger defined here
-        // ConfigFileParam.logger = webAppConfigLogger;
 
         logger = new WebAppConfigLogger();
@@ -100 +98 @@
      */
     public static final String CONFIG_FILE =
-            VloConfig.class.getResource("/WebAppConfig.xml").getFile();
+            VloConfig.class.getResource("/VloConfig.xml").getFile();
 
     /**
@@ -131 +129 @@
     /**
      * kj: change the annotation. Instead of opening a context, it is now a 
-     * matter of initialising it. Make a new method for referencing.
+     * matter of initializing it. Make a new method for referencing.
      * 
      * Open a static context of WebAppConfig members, and assign values to
@@ -151 +149 @@
      * @return the web application configuration in a new static context
      */
-    public static VloConfig setWebApp(ServletContext context) {
+    public static VloConfig webApp() {
         if (config == null) {
             // the configuration is not there yet; create it now
@@ -157 +155 @@
         }
 
-        /**
-         * get the XML file configuration from the file by invoking the
-         * superclass method
-         */
+        // get the XML file configuration from the file by invoking the
+
         config = (VloConfig) read(config);
-
-        /* Contrary to Simple, the servlet context parameters are not retrieved
-         * by annotation. Get them by invoking a local method. 
-         * 
-         * Here also invoke a superclass method
-         */
-        config = addServletContext(config, context);
 
         return config;
@@ -177 +166 @@
      * method.
      * 
+     * In this method, exceptions to the normal web application context can 
+     * be made.
+     * 
      * @return 
      */
-    public static VloConfig WebAppTest() {
+    public static VloConfig testWebApp() {
         if (config == null) {
             // the configuration is not there yet; create it now
@@ -185 +177 @@
         }
 
-        /**
-         * get the XML file configuration from the file by invoking the
-         * superclass method
-         */
+        // get the XML file configuration from the file by invoking the
+
         config = (VloConfig) read(config);
 
@@ -607 +597 @@
             
     /**
+     *
+     * kj: repair annotation
+     * 
+     * Contrary to Simple, the web application's context parameters are not
+     * retrieved by annotation. Get them by invoking a local method.
+     *
      * Add properties of the {@literal servlet's} context<br><br>
-     * 
+     *  
      * Keep the properties in the static context of the WebAppConfig class, next
      * to the members representing the values in WebAppConfig.xml file.<br><br>
@@ -616 +612 @@
      * @return the static WebAppConfig member
      */
-    static VloConfig addServletContext(VloConfig config, ServletContext context) {
+    public static VloConfig addServletContext(VloConfig config, ServletContext context) {
 
         // retrieve parameter valies from the servlet context

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

@@ -21 +21 @@
     public void setUp() {
         WicketTester wicketTester;
-        testConfig = VloConfig.WebAppTest();
+        testConfig = VloConfig.testWebApp();
         wicketTester = new WicketTester(new VloApplication(testConfig));
     }