Changeset 6627

Timestamp:

Nov 25, 2014, 12:57:24 PM (8 years ago)

Author:

Nicklas Nordborg

Message:

Fixes #1891: Allow extensions to store settings in extension-settings.xml configuration file

Extensions should use ExtensionsControl to get/set settings. Settings that match factory configuration parameters are used ny the XmlLoader when creating factories. Eg. it will be possible to override the default settings in extensions.xml (but only if there at least is an empty placeholder to begin with).

Location:

trunk/src

Files:

• clients/web/net/sf/basedb/clients/web/extensions/ExtensionsControl.java (modified) (1 diff)
• core/net/sf/basedb/core/Presets.java (modified) (2 diffs)
• core/net/sf/basedb/util/extensions/manager/Settings.java (modified) (1 diff)
• core/net/sf/basedb/util/extensions/xml/XmlLoader.java (modified) (9 diffs)

trunk/src/clients/web/net/sf/basedb/clients/web/extensions/ExtensionsControl.java

@@ -694 +694 @@
   }
 
+  
+  /**
+    Get a configuration setting for an extension.
+    @param extensionId The ID of the extension to save a setting for
+    @param key The name of the setting
+    @return The value or null if it doesn't exists
+    @since 3.4
+  */
+  public String getSetting(String extensionId, String key)
+  {
+    return settings.getSetting(extensionId, key);
+  }
+  
+  /**
+    Set a configuration setting for an extension. Do not forget to
+    {@link #saveSettings()}.
+    @param extensionId The ID of the extension to save a setting for
+    @param key The name of the setting
+    @param value The value of the setting, use null to remove
+    @since 3.4
+  */
+  public void setSetting(String extensionId, String key, String value)
+  {
+    checkPermission(Permission.WRITE, "Extension[id=" + extensionId + "]");
+    settings.setSetting(extensionId, key, value);
+  }
+  
   /**
     Get an list returning all XML/JAR files which contains installed

trunk/src/core/net/sf/basedb/core/Presets.java

@@ -201 +201 @@
   
   /**
+    Check if a preset with the given name exists.
+    @since 3.4
+  */
+  public boolean exists(String name)
+  {
+    return presets.containsKey(name);
+  }
+  
+  /**
     Delete a named preset.
     @param name The name of the preset to delete
@@ -348 +357 @@
     
     /**
+      Get the number of settings in the preset.
+      @since 3.4
+    */
+    public int size()
+    {
+      return settings.size();
+    }
+    
+    /**
       Get all keys in this preset. The returned list is a 
       copy of the settings and are not affected by later

trunk/src/core/net/sf/basedb/util/extensions/manager/Settings.java

@@ -155 +155 @@
   
   /**
+    Get a preset containing settings for the given extesion. If no
+    settings exists, null is returned. Do not make modifications to
+    the returned preset since the result is undefined. Use
+    {@link #setSetting(String, String, String)} to set values.
+    @since 3.4
+  */
+  public Preset getSettingsForExtension(String extensionId)
+  {
+    return presets.exists(extensionId) ? presets.getPreset(extensionId) : null;
+  }
+  
+  /**
+    Set a configuration setting for an extension. Do not forget to
+    {@link #save()}.
+    @param extensionId The ID of the extension to save a setting for
+    @param key The name of the setting
+    @param value The value of the setting, use null to remove
+    @since 3.4
+  */
+  public synchronized void setSetting(String extensionId, String key, String value)
+  {
+    if (value == null && !presets.exists(extensionId)) return;
+    
+    Preset p = presets.getPreset(extensionId);
+    p.setSetting(key, value);
+    if (p.size() == 0) presets.deletePreset(extensionId);
+    hasChanged = true;
+  }
+
+  /**
+    Get a configuration setting for an extension.
+    @param extensionId The ID of the extension to save a setting for
+    @param key The name of the setting
+    @return The value or null if it doesn't exists
+    @since 3.4
+  */
+  public String getSetting(String extensionId, String key)
+  {
+    Preset p = getSettingsForExtension(extensionId);
+    return p == null ? null : p.getSetting(key);
+  }
+  
+  /**
     Check if the given file is marked as installed.
     @since 3.0

trunk/src/core/net/sf/basedb/util/extensions/xml/XmlLoader.java

@@ -43 +43 @@
 import org.jdom2.output.XMLOutputter;
 
+import net.sf.basedb.core.Application;
 import net.sf.basedb.core.BaseException;
 import net.sf.basedb.core.InvalidUseOfNullException;
+import net.sf.basedb.core.Presets.Preset;
 import net.sf.basedb.core.StringUtil;
 import net.sf.basedb.core.Version;
@@ -608 +610 @@
         if (rfTag != null)
         {
-          RendererFactory rf = createFactory(rfTag, classLoader, RendererFactory.class);
+          RendererFactory rf = createFactory(rfTag, classLoader, RendererFactory.class, null);
           extensionPoint.setRendererFactory(rf);
           extensionPoint.setAllowRendererOverrider(
@@ -617 +619 @@
         if (ehfTag != null)
         {
-          ErrorHandlerFactory ehf = createFactory(ehfTag, classLoader, ErrorHandlerFactory.class);
+          ErrorHandlerFactory ehf = createFactory(ehfTag, classLoader, ErrorHandlerFactory.class, null);
           extensionPoint.setErrorHandlerFactory(ehf);
         }
@@ -745 +747 @@
           Element afTag = epTag.getChild("action-factory", ns);
           ActionFactory af = null;
+          Preset config = Application.getExtensionsManager().getSettings().getSettingsForExtension(id);
           if (afTag != null)
           {
-            af = createFactory(afTag, classLoader, ActionFactory.class);
+            af = createFactory(afTag, classLoader, ActionFactory.class, config);
           }
         
@@ -755 +758 @@
           if (rfTag != null)
           {
-            rf = createFactory(rfTag, classLoader, RendererFactory.class);
+            rf = createFactory(rfTag, classLoader, RendererFactory.class, config);
           }
           
@@ -899 +902 @@
     @return An initialised factory
   */
-  protected <F> F createFactory(Element factoryTag, ClassLoader classLoader, Class<F> factoryType)
+  protected <F> F createFactory(Element factoryTag, ClassLoader classLoader, Class<F> factoryType, Preset config)
     throws ClassNotFoundException, NoSuchMethodException,
       IllegalAccessException, InstantiationException
@@ -908 +911 @@
       ClassUtil.checkAndLoadClass(classLoader, factoryClassName, true, factoryType);
     F factory = factoryType.cast(factoryClass.newInstance());
-    initBeanWithReflection(factory, factoryTag.getChild("parameters", ns));
+    initBeanWithReflection(factory, factoryTag.getChild("parameters", ns), config);
     return factory;
   }
@@ -927 +930 @@
     @param root The root element, if null nothing is done
   */
-  protected void initBeanWithReflection(Object bean, Element root)
+  protected void initBeanWithReflection(Object bean, Element root, Preset config)
   {
     if (root == null) return;
@@ -945 +948 @@
 
       // The value passed as an argument to the setter method
-      String value = Values.getStringOrNull(child.getText());
+      String value = config != null ? Values.getStringOrNull(config.getSetting(childName)) : null;
+      if (value == null) 
+      {
+        value = Values.getStringOrNull(child.getText());
+      }
       
       if (value == null)