Changeset 2577

Timestamp:

02/13/13 12:29:21 (11 years ago)

Author:

keeloo

Message:

Set version to 2.13, the cutting edge release for March. Also removed the WebAppParam? class; servlet parameters are retrieved from with in the WebAppConfig? class.

Location:

vlo/branches/vlo-2.13-param/vlo_webapp

Files:

• pom.xml (modified) (1 diff)
• src/main/bin/vlo_solr_importer.sh (modified) (1 diff)
• src/main/java/eu/clarin/cmdi/vlo/VloApplication.java (modified) (3 diffs)
• src/main/java/eu/clarin/cmdi/vlo/config/ConfigFileParam.java (modified) (1 diff)
• src/main/java/eu/clarin/cmdi/vlo/config/WebAppConfig.java (modified) (29 diffs)
• src/main/java/eu/clarin/cmdi/vlo/config/WebAppParam.java (deleted)
• src/main/resources/WebAppConfig.xml (modified) (1 diff)
• src/main/webapp/META-INF/context.xml (modified) (1 diff)

vlo/branches/vlo-2.13-param/vlo_webapp/pom.xml

@@ -9 +9 @@
     vlo_solr_importer.sh in src/main/bin and the version number 
     in the parent's pom.xml -->
-    <version>2.12</version>
+    <version>2.13</version>
     <name>VirtualLanguageObservatory</name>
     <description></description>

vlo/branches/vlo-2.13-param/vlo_webapp/src/main/bin/vlo_solr_importer.sh

@@ -12 +12 @@
 
 
-$JAVA -Xmx1024M -cp .:vlo-2.12-jar.jar eu.clarin.cmdi.vlo.importer.MetadataImporter
+$JAVA -Xmx1024M -cp .:vlo-2.13-jar.jar eu.clarin.cmdi.vlo.importer.MetadataImporter

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

@@ -2 +2 @@
 
 import eu.clarin.cmdi.vlo.config.WebAppConfig;
-import org.apache.wicket.protocol.http.WebApplication;
-import org.springframework.beans.factory.BeanFactory;
-import org.springframework.context.support.ClassPathXmlApplicationContext;
-
 import eu.clarin.cmdi.vlo.dao.SearchResultsDao;
 import eu.clarin.cmdi.vlo.pages.FacetedSearchPage;
+import org.apache.wicket.protocol.http.WebApplication;
 
 /**
@@ -20 +17 @@
         // BeanFactory factory = new ClassPathXmlApplicationContext(new String[] { Configuration.CONFIG_FILE });
         // factory.getBean("configuration"); //Use Configuration.getInstance to get the Configuration just loading the instance here.
+        WebAppConfig.setServletContext(this.getServletContext());
+        String test = WebAppConfig.open().getSolrUrl();
         
         searchResults = new SearchResultsDao();
@@ -27 +26 @@
      * @see org.apache.wicket.Application#getHomePage()
      */
+    @Override
     public Class<FacetedSearchPage> getHomePage() {
         return FacetedSearchPage.class;

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

@@ -64 +64 @@
             
     /**
-     * Write a assigned values to an XML file.
+     * Write annotated member values to an XML file.
      *
      * @param config the object whose annotated members and values will be

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

@@ -1 @@
-
 package eu.clarin.cmdi.vlo.config;
 
 import java.io.UnsupportedEncodingException;
 import java.net.URLEncoder;
+import javax.servlet.ServletContext;
 import org.simpleframework.xml.Element;
 import org.simpleframework.xml.ElementArray;
@@ -11 +11 @@
 /**
  * Web application configuration<br><br>
+ *
+ * A parameter that is part of the configuration of the VLO web application can
+ * be of two types: it is either a parameter that is defined from within the
+ * application, an application parameter, or it is a parameter that is defined
+ * in the context in which the application will live as a {@literal servlet}.
+ * Application parameters reside in the {@literal WebAppConfig.xml} file, while
+ * {@literal servlet} context parameters are part of the Tomcat server
+ * configuration. <br><br>
+ *
+ * An application parameter is defined an XML file in the resources directory of
+ * the application package. For every application parameter, the WebApplication
+ * class contains a member that is annotated according to the Simple framework
+ * specification. So<br><br>
+ *
+ * {@literal <parameterMember>}"the value of the
+ * parameter"{@literal </parameterMember>}<br><br>
+ *
+ * in the XML file is accompanied by<br><br>
+ *
+ * {@literal
+ *
+ * @element}<br> {@literal parameterMember}<br><br>
+ *
+ * in the WebAppConfig class. When the application invokes Simple by<br><br>
+ *
+ * WebAppConfig.open();<br><br>
+ *
+ * the parameter itself is accessed by<br><br>
+ *
+ * WebAppConfig.open().getParameterMember();<br><br>
+ *
+ * If you want to add a type of member that is not included in the class yet,
+ * refer to the Simple framework's specification.<br><br>
+ *
+ * A context parameter also resides in an XML file. For more information on the
+ * location and the format of this file, please refer to the Apache Tomcat
+ * configuration reference.<br><br>
  * 
- * The parameter members which are part of the web application configuration
- * come in two categories. One type of parameters play a role only in the
- * application, others are determined by the context of the application.<br><br>
- *
- * The first type of parameter is defined in the web application parameter file.
- * These parameters are referred to as application parameters. The second type
- * of parameter is determined by the context of the application. These
- * parameters are called context parameters.<br><br>
- *
  * Because the application is indifferent to the origin of a parameter, the
  * WebAppConfig class is the place to switch from one type of parameter to the
@@ -30 +58 @@
  * application.<br><br>
  *
- * An application parameter is defined an XML file in the resources directory of
- * the package. For every application parameter, the WebApplication class
- * contains a member that is annotated according to the Simple framework
- * specification. So<br><br>
- *
- * {@literal <parameterMember>}"the value of the
- * parameter"{@literal </parameterMember>}<br><br>
- *
- * in the XML file is accompanied by<br><br>
- *
- * {@literal
- *
- * @element}<br> {@literal parameterMember}<br><br>
- *
- * in the WebAppConfig class. When the application invokes Simple by<br><br>
- *
- * WebAppConfig.get();<br><br>
- *
- * the parameter itself is accessed by<br><br>
- *
- * WebAppConfig.get().getParameterMember();<br><br>
- * 
- * If you want to add a type of member that is not included in the class yet,
- * refer to the Simple framework's specification.<br><br>
- *
- * A context parameter also resides in an XML file. For more information on the
- * location and the format of this file, please refer to the Apache Tomcat
- * configuration reference.<br><br>
- *
- * Note on the explanation of the meaning of the parameters. Because the meaning
- * of a parameter is not local to this class, or even not local to the
+ * Please note on the explanation of the meaning of the parameters. Because the
+ * meaning of a parameter is not local to this class, or even not local to the
  * configuration package, they are described in the general VLO
  * documentation.<br><br>
@@ -72 +71 @@
     private final static org.slf4j.Logger LOG =
             LoggerFactory.getLogger(WebAppConfig.class);
-    
+
     // connect to the logging framework
     private class WebAppConfigLogger implements ConfigFilePersister.Logger {
@@ -82 +81 @@
         }
     }
-    
     private static WebAppConfigLogger logger;
 
@@ -91 +89 @@
         // let the superclass know about the logger defined here
         // ConfigFileParam.logger = webAppConfigLogger;
-        
+
         logger = new WebAppConfigLogger();
-        
+
         ConfigFilePersister.setLogger(WebAppConfig.logger);
     }
 
     /**
-     * Application parameter XML file.
-     */
-    public static final String CONFIG_FILE = WebAppConfig.class.getResource("/WebAppConfig.xml").getFile();
-
-    /**
-     * Application parameter 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.
+     * XML File in which the application configuration is stored
+     */
+    public static final String CONFIG_FILE =
+            WebAppConfig.class.getResource("/WebAppConfig.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
@@ -119 +120 @@
     
     /**
-     * Make the configuration accessible<br><br>
-     * 
+     * Make the configuration statically accessible<br><br>
+     *
      * Both the Simple framework and the methods in the web application need to
      * access the configuration. Access is granted by defining a member holding
@@ -128 +129 @@
 
     /**
-     * Make the configuration statically accessible<br><br>
-     *
-     * Access for the Simple framework is achieved by passing the member to the
-     * read method defined in the superclass.<br><br>
+     * Open a static context of WebAppConfig members, and assign values to
+     * them.<br><br>
      * 
-     * Access for the web application is achieved by invoking one of the get or
-     * read methods. Because these methods return a non-static value, while 
-     * WebAppConfig on the other hand denotes a static context,<br><br>
+     * The web application can access a parameter by invoking one of the get or
+     * set methods defined below. Because these methods return a non-static
+     * value, while WebAppConfig on the other hand denotes a static
+     * context,<br><br>
      *
      * WebAppConfig.getParameterMember()<br><br>
      *
-     * for example, would not be valid. On encountering get() however, a new
-     * context is opened, and from that, getParameterMember() can be
+     * for example, would not be valid. On encountering open() however, a new
+     * static context is opened, and from that, getParameterMember() can be
      * invoked:<br><br>
      *
-     * WebAppConfig.get().getParameterMember()<br><br>
-     *
-     * @return the web application configuration in a new context
-     */
-    public static WebAppConfig get() {
+     * WebAppConfig.open().getParameterMember()<br><br>
+     *
+     * @return the web application configuration in a new static context
+     */
+    public static WebAppConfig open() {
         if (config == null) {
             // the configuration is not there yet; create it now
@@ -153 +153 @@
         }
 
-        // get the xml file configuration by invoking the superclass method 
+        /**
+         * get the XML file configuration from the file by invoking the
+         * superclass method
+         */
         config = (WebAppConfig) read(config);
 
-        /* Contrary to Simple, the web context parameters are not retrieved
+        /* Contrary to Simple, the servlet context parameters are not retrieved
          * by annotation. Get them by invoking a local method. 
          */
-        // config = addFromContext(config);
+        config = addServletContext(config);
 
         return config;
     }
+
+    /**
+     * 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>
-     * 
+     *
      * Initialize a member corresponding to application parameters with an empty
      * string at least, for this will allow them to be linearized to
-     * corresponding elements in the XML file. Note that for the moment only
-     * de-linearization is supported by the WebAppConfig class.
-     *
-     * Refer to the general VLO documentation for a description of the member
-     * parameters.
+     * corresponding elements in the XML file.
+     * 
+     * Please refer to the general VLO documentation for a description of the
+     * member parameters.
      */
 
@@ -188 +212 @@
     @Element
     private String handleServerUrl = "";
-
-    // In the XML file, the value of the parameter is expanded by Maven.
-    @Element
-    private String solrUrl = "";
     
     @Element
@@ -197 +217 @@
     
     /**
-     * Note. The national project mapping itself is not part of the web
+     * Note: the national project mapping itself is not part of the web
      * application configuration.
      */
@@ -205 +225 @@
     /**
      * An array of facetFields<br><br>
-     * 
+     *
      * In case of an array of elements, the number of elements in the array
      * needs to be communicated to Simple. The following would be a correct
      * description of an array of three facet fields<br><br>
-     * 
-     * {@literal <facetFields length="3">}<br>
-     * {@literal    <facetField>}<br>
-     * {@literal       fieldOne}<br>
-     * {@literal    </facetField>}<br>
-     * {@literal    <facetField>}<br>
-     * {@literal       fieldTwo}<br>
-     * {@literal    </facetField>}<br>
-     * {@literal    <facetField>}<br>
-     * {@literal       fieldThree}<br>
-     * {@literal    </facetField>}<br>
+     *
+     * {@literal <facetFields length="3">}<br> {@literal    <facetField>}<br>
+     * {@literal       fieldOne}<br> {@literal    </facetField>}<br>
+     * {@literal    <facetField>}<br> {@literal       fieldTwo}<br>
+     * {@literal    </facetField>}<br> {@literal    <facetField>}<br>
+     * {@literal       fieldThree}<br> {@literal    </facetField>}<br>
      * {@literal </facetFields>}<br><br>
-     * 
+     *
      * To let Spring now it has to interpret the facetFields element as an
      * array, use the ElementArray directive. Use the directive to let Spring
-     * know that the elements inside 'facetFields' are named 'facetField'. 
-     */
-
-    @ElementArray(entry="facetField")
+     * know that the elements inside 'facetFields' are named 'facetField'.
+     */
+    @ElementArray(entry = "facetField")
     private String[] facetFields = {"", "", ""};
     
@@ -234 +248 @@
     
     @Element
-    private String language2LetterCodeComponentUrl ="";
+    private String language2LetterCodeComponentUrl = "";
     
     @Element
@@ -244 +258 @@
     @Element
     private String FederatedContentSearchUrl = " ";
-    
+
     /**
      * Get and read methods for web application parameter members<br><br>
-     * 
+     *
      * By using a get or read method, you can apply an operation to a parameter
      * here, in the WebAppConfig class, without the need to make changes in
@@ -255 +269 @@
     /**
      * Get the VloHomeLink parameter<br><br>
-     * 
+     *
      * For a description of the parameter, refer to the general VLO
      * documentation.
@@ -267 +281 @@
     /**
      * Set the VloHomeLink parameter<br><br>
-     * 
+     *
      * For a description of the parameter, refer to the general VLO
      * documentation.
@@ -273 +287 @@
      * @param vloHomeLink the parameter
      */
-    public void setVloHomeLink(String vloHomeLink) {
-        this.vloHomeLink = vloHomeLink;
+    public void setVloHomeLink(String link) {
+        this.vloHomeLink = link;
     }
 
     /**
      * Get the ProfileSchemaUrl by profileId parameter<br><br>
-     * 
+     *
      * For a description of the schema, refer to the general VLO documentation.
      * Note: the profileId needs to be expanded.
@@ -285 +299 @@
      * @return the parameter
      */
-    public String getComponentRegistryProfileSchema(String profileId) {
-        return profileSchemaUrl.replace("${PROFILE_ID}", profileId);
+    public String getComponentRegistryProfileSchema(String id) {
+        return profileSchemaUrl.replace("${PROFILE_ID}", id);
     }
 
     /**
      * Set the ProfileSchemaUrl parameter<br><br>
-     * 
+     *
      * For a description of the schema, refer to the general VLO documentation.
      * Note: the profileId needs to be expanded.
@@ -297 +311 @@
      * @param profileId the parameter
      */
-    public void setProfileSchemaUrl(String profileSchemaUrl) {
-        this.profileSchemaUrl = profileSchemaUrl;
+    public void setProfileSchemaUrl(String url) {
+        this.profileSchemaUrl = url;
     }
 
     /**
      * Get the ComponentRegisteryRESTURL parameter<br><br>
-     * 
+     *
      * For a description of the parameter, refer to the general VLO
      * documentation.
@@ -315 +329 @@
     /**
      * Set the ComponentRegisteryRESTURL parameter<br><br>
-     * 
-     * For a description of the parameter, refer to the general VLO
-     * documentation.
-     * 
+     *
+     * For a description of the parameter, refer to the general VLO
+     * documentation.
+     *
      * @param componentRegistryRESTURL the parameter
      */
-    public void setComponentRegistryRESTURL(String componentRegistryRESTURL) {
-        this.componentRegistryRESTURL = componentRegistryRESTURL;
+    public void setComponentRegistryRESTURL(String url) {
+        this.componentRegistryRESTURL = url;
     }
 
     /**
      * Get the HandleServerUrl parameter<br><br>
-     * 
+     *
      * For a description of the parameter, refer to the general VLO
      * documentation.
@@ -339 +353 @@
     /**
      * Set the HandleServerUrl parameter<br><br>
-     * 
-     * For a description of the parameter, refer to the general VLO
-     * documentation.
-     * 
+     *
+     * For a description of the parameter, refer to the general VLO
+     * documentation.
+     *
      * @param handleServerUrl the parameter
      */
-    public void setHandleServerUrl(String handleServerUrl) {
-        this.handleServerUrl = handleServerUrl;
-    }
-
-    /**
-     * Get the SolrUrl parameter<br><br>
-     * 
-     * For a description of the parameter, refer to the general VLO
-     * documentation.
-     *
-     * @return the parameter
-     */
-    public void setSolrUrl(String solrUrl) {
-        this.solrUrl = solrUrl;
-    }
-
-    /**
-     * Set the SolrUrl parameter<br><br>
-     *
-     * For a description of the parameter, refer to the general VLO
-     * documentation.
-     *
-     * @param solrUrl the parameter
-     */
-    public String getSolrUrl() {
-        return solrUrl;
+    public void setHandleServerUrl(String url) {
+        this.handleServerUrl = url;
     }
 
@@ -381 +371 @@
      * @param imdiBrowserUrl the parameter
      */
-    public void setIMDIBrowserUrl(String imdiBrowserUrl) {
-        this.imdiBrowserUrl = imdiBrowserUrl;
+    public void setIMDIBrowserUrl(String url) {
+        this.imdiBrowserUrl = url;
     }
 
@@ -401 +391 @@
         return result;
     }
-    
 
     /**
      * Get the FederatedContentSearchUrl parameter<br><br>
-     * 
-     * For a description of the parameter, refer to the general VLO
-     * documentation.
-     *
-     * @return the parameter
-     */
-    public void setFederatedContentSearchUrl(String solrUrl) {
-        this.FederatedContentSearchUrl = FederatedContentSearchUrl;
+     *
+     * For a description of the parameter, refer to the general VLO
+     * documentation.
+     *
+     * @return the parameter
+     */
+    public void setFederatedContentSearchUrl(String url) {
+        this.FederatedContentSearchUrl = url;
     }
 
@@ -435 +424 @@
      * @param nationalProjectMapping the parameter
      */
-    public void setNationalProjectMapping(String nationalProjectMapping) {
-        this.nationalProjectMapping = nationalProjectMapping;
+    public void setNationalProjectMapping(String mapping) {
+        this.nationalProjectMapping = mapping;
     }
 
@@ -471 +460 @@
      * @param facetFields the parameter, a list of facet fields
      */
-    public void setFacetFields(String[] facetFields) {
-        this.facetFields = facetFields;
+    public void setFacetFields(String[] fields) {
+        this.facetFields = fields;
     }
 
@@ -495 +484 @@
      * @param countryComponentUrl the parameter
      */
-    public void setCountryComponentUrl(String countryComponentUrl) {
-        this.countryComponentUrl = countryComponentUrl;
+    public void setCountryComponentUrl(String url) {
+        this.countryComponentUrl = url;
     }
 
@@ -519 +508 @@
      * @param language2LetterCodeComponentUrl the parameter
      */
-    public void setLanguage2LetterCodeComponentUrl(String language2LetterCodeComponentUrl) {
-        this.language2LetterCodeComponentUrl = language2LetterCodeComponentUrl;
+    public void setLanguage2LetterCodeComponentUrl(String url) {
+        this.language2LetterCodeComponentUrl = url;
     }
 
@@ -539 +528 @@
      * @param language3LetterCodeComponentUrl the parameter
      */
-    public void setLanguage3LetterCodeComponentUrl(String language3LetterCodeComponentUrl) {
-        this.language3LetterCodeComponentUrl = language3LetterCodeComponentUrl;
+    public void setLanguage3LetterCodeComponentUrl(String url) {
+        this.language3LetterCodeComponentUrl = url;
     }
 
@@ -563 +552 @@
      * @param silToISO639CodesUrl the parameter
      */
-    public void setSilToISO639CodesUrl(String silToISO639CodesUrl) {
-        this.silToISO639CodesUrl = silToISO639CodesUrl;
-    }
-    
-    /**
-     * Retrieve the context parameters<br><br>
-     *
-     * Note that in terms of the configuration, properties of the context are
-     * treated as parameters also.
-     *
-     * @param config the static WebAppConfig member
+    public void setSilToISO639CodesUrl(String url) {
+        this.silToISO639CodesUrl = url;
+    }
+    
+    // reference to the servlet context
+    private static ServletContext servletContext = null;
+        
+    /**
+     * Set the {@literal servlet} context
+     * 
+     * Note: this method needs to be invoked before open() is invoked 
+     */
+    public static void setServletContext (ServletContext context){
+        
+        servletContext = context;
+    }
+
+    /**
+     * 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>
+     *
+     * @param config static configuration 
      *
      * @return the static WebAppConfig member
      */
-    static WebAppConfig addFromContext(WebAppConfig config) {
-        
-        // retrieve parameters from the context of the web application
-        
-        docBase = WebAppParam.getContextParam ("docBase");
-        
+    static WebAppConfig addServletContext(WebAppConfig config) {
+
+        // retrieve parameter valies from the servlet context
+
+        config.solrUrl = servletContext.getInitParameter("solrUrl");
+
         return config;
     }
     
     /**
-     * Web application context members<br><br>
-     *
-     * The following defines the members corresponding to context.
-     */
-    
-    /**
-     * Context members
-     */
-    static String docBase = "";
-    
-    /**
-     * Get and read methods for the context members
-     */
-    
-    /**
-     *
-     * @return
-     */
-    public String getDocbaBase() {
-        return docBase;
-    }
-    
-    /**
-     *
-     * @return
-     */
-    public String setDocBase(String param) {
-        // potentially, modify the parameter in the configuration
-        docBase = param; 
-        return docBase;
+     * {@literal Servlet} context members<br><br>
+     *
+     * The following defines the members corresponding to {@servlet} context
+     * parameters.
+     */
+    
+    @Element
+    private String solrUrl = "";
+
+    /**
+     * Get methods for the {@literal servlet} context members
+     */
+    
+    /**
+     * Get the SolrUrl parameter<br><br>
+     *
+     * For a description of the parameter, refer to the general VLO
+     * documentation.
+     *
+     * @param solrUrl the parameter
+     */
+    public String getSolrUrl() {
+        return solrUrl;
     }
 }

vlo/branches/vlo-2.13-param/vlo_webapp/src/main/resources/WebAppConfig.xml

@@ -4 +4 @@
    <componentRegistryRESTURL>http://catalog.clarin.eu/ds/ComponentRegistry/rest/registry/profiles/</componentRegistryRESTURL>
    <handleServerUrl>http://hdl.handle.net/</handleServerUrl>
-   <solrUrl>http://localhost:8084/vlo_solr/</solrUrl>
    <imdiBrowserUrl>http://corpus1.mpi.nl/ds/imdi_browser?openpath=</imdiBrowserUrl>
    <nationalProjectMapping>nationalProjectsMapping.xml</nationalProjectMapping>

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

@@ -1 +1 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<Context antiJARLocking="true" path="/vlo"/>
+
+<!-- VLO application context file
+
+solrURL : URL through which the Solr server should be reached<br><br>
+
+Note that the VLO importer needs 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>
+
+-->
+
+<Context antiJARLocking="true" path="/vlo">
+    <Parameter name=solrURL value="http://localhost:8084/vlo_solr/"/>
+</Context>