Changeset 3732

Timestamp:

Sep 14, 2007, 2:03:09 PM (15 years ago)

Author:

Martin Svensson

Message:

References #733 The PluginConfigurationImporter? class can be used outside the plugin system to
import selected configurations in an XML-file

File:

• trunk/src/plugins/core/net/sf/basedb/plugins/PluginConfigurationImporter.java (modified) (9 diffs)

trunk/src/plugins/core/net/sf/basedb/plugins/PluginConfigurationImporter.java

@@ -74 +74 @@
 import java.util.Map;
 import java.util.Set;
+import java.util.jar.JarEntry;
+import java.util.jar.JarFile;
 
 import org.jdom.Document;
 import org.jdom.Element;
+import org.jdom.JDOMException;
 
 /**
@@ -143 +146 @@
   private boolean setPermissions;
   private boolean importAll;
+  private HashMap<Integer, Boolean> configurationMap;
 
   /*
@@ -347 +351 @@
     throws BaseException
   {           
-    DbControl dc = null;
-    
+    DbControl dc = null;    
     try
     {
@@ -358 +361 @@
         filePath = f.getPath().toString();
       }
-      
       //Get the root element of the XML file
       URL dtdURL = PluginConfigurationImporter.class.getResource("/net/sf/basedb/core/dtd/"+dtdFileName);
-      Document doc = XMLUtil.getValidatedXML(in, dtdURL, filePath);     
+      Document doc = XMLUtil.getValidatedXML(in, dtdURL, filePath);   
       Element rootElement = doc.getRootElement();   
       
       int parameternumber = 0;
-      List configurations = rootElement.getChildren();      
+      List configurations = rootElement.getChildren();
       for (Object obj : configurations)
       {
@@ -373 +375 @@
         String pluginClassName = configuration.getAttributeValue("pluginClassName");
         
-        boolean importConfiguration = !importAll && 
-          job.getValue("configuration"+parameternumber) != null ? Boolean.TRUE.equals(job.getValue("configuration"+parameternumber)) : false;
+        boolean importConfiguration = !importAll && getConfigurationInstallOption(parameternumber);
         if (importConfiguration || importAll)
         {
@@ -410 +411 @@
   /*
       -----------------------------------------------------
-  */  
+  */
+  
+  /**
+    Imports plugin configurations direct from an xml file, located in a jar.
+    @since 2.5
+    @param jarPath Path to the jar-file
+    @param xmlPath Where in the jar-file the XML-file is located
+    @param configurations A hasmap with a boolean value for each configuration in the xml-file. 
+      The value should be TRUE if the configuration should be imported, FALSE otherwise.
+    @param importAll If all configurations in the xml-file should be imported or not.
+      @param setPermissions If the configurations should be shared to the same users as the plugins they belong to. 
+      @throws IOException When something goes wrong accessing a file
+      @throws JDOMException When failed to read the XML-file
+      @throws BaseException When the hashmap with import options has different 
+        size compared to number of configurations in XML-file
+    
+   */
+  public void importPluginConfigurationsFromJar(String jarPath, String xmlPath, 
+        HashMap<Integer, Boolean> configurations,  boolean importAll, boolean setPermissions) 
+    throws IOException, JDOMException, BaseException
+  {
+    this.importAll = importAll;
+    this.setPermissions = setPermissions;
+    this.configurationMap = configurations;
+    
+    URL dtdURL = PluginConfigurationImporter.class.getResource("/net/sf/basedb/core/dtd/"+dtdFileName);
+    
+    JarFile jar = new JarFile(jarPath);
+    InputStream is = jar.getInputStream(new JarEntry(xmlPath));
+    Document doc = XMLUtil.getValidatedXML(is, dtdURL, null);
+    is.close();
+    Element rootElement = doc.getRootElement();
+    List children = rootElement.getChildren();    
+    
+    if (children.size() != configurations.size())
+    {
+      throw new BaseException("The list of configuration to import or not does'n " +
+          "have the same size as the list of available plugins");
+    }
+    
+    is = jar.getInputStream(new JarEntry(xmlPath));
+    doImport(is, null);
+    is.close();
+  }
+  
   
   private RequestInformation getConfiguredJobParameters()
@@ -433 +478 @@
   }
   
+  /**
+    Gets request information to set which configuration to import
+      @return request information with parameter to use.
+  */
   private RequestInformation getConfiguredSelectionParameters()
   {
@@ -519 +568 @@
         }
       }
-      
     }
     return configureSelection;
@@ -613 +661 @@
     }
   }
+  
+  /**
+    Returns if a configuration in a certain place/order in the XML-file should be imported
+      @param orderNumber The number of order the configuration has in the XML-file
+      @return TRUE if the configuration should be imported, FALSE otherwise.
+   */
+  private boolean getConfigurationInstallOption(int orderNumber)
+  {
+    boolean importIt = false;
+    if (configurationMap != null)
+    {
+      Boolean value = configurationMap.get(orderNumber);
+      importIt = value != null ? value : false;
+    }
+    else if (job != null)
+    {
+      importIt = job.getValue("configuration"+orderNumber) != null ? 
+          Boolean.TRUE.equals(job.getValue("configuration" + orderNumber)) : false;
+    }
+    
+    return importIt;
+  }
 }