Changeset 4112

Timestamp:

Jan 31, 2008, 10:44:29 AM (15 years ago)

Author:

Nicklas Nordborg

Message:

Fixes #911: Add support for having file validators and meta data extrators in external jar files.

Location:

trunk

Files:

• doc/src/docbook/appendix/incompatible.xml (modified) (1 diff)
• doc/src/docbook/developerdoc/plugin_developer.xml (modified) (1 diff)
• doc/src/docbook/figures/uml/datalayer.platforms.png (modified) (previous)
• doc/src/uml/baseuml.mdzip (modified) (previous)
• src/core/net/sf/basedb/core/DataFileType.java (modified) (8 diffs)
• src/core/net/sf/basedb/core/Install.java (modified) (1 diff)
• src/core/net/sf/basedb/core/Update.java (modified) (2 diffs)
• src/core/net/sf/basedb/core/data/DataFileTypeData.java (modified) (2 diffs)

trunk/doc/src/docbook/appendix/incompatible.xml

@@ -82 +82 @@
     </listitem>   
     </itemizedlist>
+    
+    <bridgehead>Data file types</bridgehead>
+    <para>
+      The <methodname>DataFileType.setValidatorClass()</methodname> and
+      <methodname>DataFileType.setMetadataReaderClass()</methodname> no longer
+      verifies that the specified class names exists and implements the required interfaces.
+      This validation will instead happen at commit time. The reason for this change is
+      the added support for having the validator/meta data reader in external JAR files.
+      This means that the validation can't happen until both the class names and JAR paths
+      has been set. If a client application need validation before commit time it should use
+      <methodname>DataFileType.getValidator()</methodname> and 
+      <methodname>DataFileType.getMetadataReader()</methodname> after the class names and JAR
+      paths has been set.
+    </para>
 
   </sect1>  

trunk/doc/src/docbook/developerdoc/plugin_developer.xml

@@ -4148 +4148 @@
         (ie. they don't have to implement the <interfacename docapi="net.sf.basedb.core.plugin">Plugin</interfacename>
         interface). This means that you don't have to mess with configuration or 
-        job parameters. Another difference is that the plug-ins must be installed in
-        Tomcat's classpath (ie. in one of the 
-        <filename>WEB-INF/classes</filename> or <filename>WEB-INF/lib</filename>
-        folders).
+        job parameters.
       </para>
       

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

@@ -35 +35 @@
 import net.sf.basedb.info.ToTransferable;
 import net.sf.basedb.util.ClassUtil;
+import net.sf.basedb.util.JarClassLoader;
 
 /**
@@ -50 +51 @@
 public class DataFileType
   extends BasicItem<DataFileTypeData>
-  implements Nameable, Removable, ToTransferable<DataFileTypeInfo>
+  implements Nameable, Removable, ToTransferable<DataFileTypeInfo>, Validatable
 {
   
@@ -103 +104 @@
   public static final int MAX_CLASSNAME_LENGTH = DataFileTypeData.MAX_CLASSNAME_LENGTH;
 
+  /**
+    The maximum length of the jar paths that can be stored in the database.
+    @see #setValidatorJarPath(String)
+    @see #setMetadataReaderJarPath(String)
+  */
+  public static final int MAX_JARPATH_LENGTH = DataFileTypeData.MAX_JARPATH_LENGTH;
+  
   /**
     Create a new data file type.
@@ -363 +371 @@
   }
   
+  
+
+  /**
+    Check that the validator and meta data reader classes implement the
+    correct interfaces.
+    @since 2.6
+  */
+  @Override
+  void validate() 
+    throws InvalidDataException, BaseException
+  {
+    super.validate();
+    getValidator();
+    getMetadataReader();
+  }
+
   /**
     @since 2.5
@@ -479 +503 @@
       have write permission
     @throws StringTooLongException If the string is longer that {@link #MAX_CLASSNAME_LENGTH}.
-    @throws InvalidDataException If the named class isn't found or 
-      doesn't implement the <code>DataFileValidator</code> interface.
   */
   public void setValidatorClass(String validatorClass)
   {
     checkPermission(Permission.WRITE);
-    if (validatorClass != null)
-    {
-      try
-      {
-        ClassUtil.checkAndLoadClass(null, validatorClass, true, DataFileValidator.class);
-      }
-      catch (Throwable t)
-      {
-        throw new InvalidDataException(t);
-      }
-    }
-    getData().setValidatorClass(StringUtil.setNullableString(validatorClass, "validatorClass", MAX_EXTENSION_LENGTH));
-  }
+    getData().setValidatorClass(StringUtil.setNullableString(validatorClass, 
+        "validatorClass", MAX_CLASSNAME_LENGTH));
+  }
+  
+  /**
+    Get the path to the JAR file where the validator class is located. If the
+    path is null the validator must be in the class path.
+    @return The JAR path or null
+    @since 2.6
+  */
+  public String getValidatorJarPath()
+  {
+    return getData().getValidatorJarPath();
+  }
+  
+  /**
+    Set the path to the JAR file where the validator class is located.
+    @param validatorJarPath The path to the JAR file or null if the validator is in the class path
+    @throws PermissionDeniedException If the logged in user doesn't
+      have write permission
+    @throws StringTooLongException If the string is longer that {@link #MAX_JARPATH_LENGTH}.
+    @since 2.6
+  */
+  public void setValidatorJarPath(String validatorJarPath)
+  {
+    checkPermission(Permission.WRITE);
+    getData().setValidatorJarPath(StringUtil.setNullableString(validatorJarPath, 
+      "validatorJarPath", MAX_JARPATH_LENGTH));
+  }
+  
   
   /**
@@ -512 +551 @@
     try
     {
+      String jarPath = getValidatorJarPath();
+      ClassLoader loader = jarPath == null ? null :JarClassLoader.getInstance(jarPath);
       validator = (DataFileValidator)ClassUtil.checkAndLoadClass(
-          null, validatorClass, true, DataFileValidator.class).newInstance();
+          loader, validatorClass, true, DataFileValidator.class).newInstance();
     }
     catch (Throwable t)
@@ -539 +580 @@
       have write permission
     @throws StringTooLongException If the string is longer that {@link #MAX_CLASSNAME_LENGTH}.
-    @throws InvalidDataException If the named class isn't found or doesn't 
-      implement the <code>DataFileMetadataReader</code> interface
   */
   public void setMetadataReaderClass(String metadataReaderClass)
   {
     checkPermission(Permission.WRITE);
-    if (metadataReaderClass != null)
-    {
-      try
-      {
-        ClassUtil.checkAndLoadClass(null, metadataReaderClass, true, DataFileMetadataReader.class);
-      }
-      catch (Throwable t)
-      {
-        throw new InvalidDataException(t);
-      }
-    }
     getData().setMetadataReaderClass(StringUtil.setNullableString(metadataReaderClass, 
-      "metadataReaderClass", MAX_EXTENSION_LENGTH));
-  }
+      "metadataReaderClass", MAX_CLASSNAME_LENGTH));
+  }
+  
+  /**
+    Get the path to the JAR file where the meta data reader class is located. If the
+    path is null the reader must be in the class path.
+    @return The JAR path or null
+    @since 2.6
+  */
+  public String getMetadataReaderJarPath()
+  {
+    return getData().getMetadataReaderJarPath();
+  }
+  
+  /**
+    Set the path to the JAR file where the meta data reader class is located.
+    @param metadataReaderJarPath The path to the JAR file or null if the reader is in the class path
+    @throws PermissionDeniedException If the logged in user doesn't
+      have write permission
+    @throws StringTooLongException If the string is longer that {@link #MAX_JARPATH_LENGTH}.
+    @since 2.6
+  */
+  public void setMetadataReaderJarPath(String metadataReaderJarPath)
+  {
+    checkPermission(Permission.WRITE);
+    getData().setMetadataReaderJarPath(StringUtil.setNullableString(metadataReaderJarPath, 
+      "metadataReaderJarPath", MAX_JARPATH_LENGTH));
+  } 
   
   /**
@@ -573 +627 @@
     try
     {
+      String jarPath = getValidatorJarPath();
+      ClassLoader loader = jarPath == null ? null : JarClassLoader.getInstance(jarPath);
       reader = (DataFileMetadataReader)ClassUtil.checkAndLoadClass(
-          null, readerClass, true, DataFileMetadataReader.class).newInstance();
+          loader, readerClass, true, DataFileMetadataReader.class).newInstance();
     }
     catch (Throwable t)

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

@@ -107 +107 @@
     method.
   */
-  public static final int NEW_SCHEMA_VERSION = Integer.valueOf(49).intValue();
+  public static final int NEW_SCHEMA_VERSION = Integer.valueOf(50).intValue();
   
   public static synchronized void createTables(boolean update, final ProgressReporter progress)

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

@@ -574 +574 @@
     </td>
   </tr>
+  <tr>
+    <td>50</td>
+    <td>
+      <ul>
+      <li>Added {@link net.sf.basedb.core.data.DataFileTypeData#getValidatorJarPath()}
+      <li>Added {@link net.sf.basedb.core.data.DataFileTypeData#getMetadataReaderJarPath()}
+      </ul>
+      No special database update is needed. Only increase the schema version.
+    </td>
+  </tr>
   
   </table>
@@ -814 +824 @@
       }
       
+      if (schemaVersion < 50)
+      {
+        if (progress != null) progress.display((int)(49*progress_factor), "Updating schema version: " + schemaVersion + " -> 50...");
+        schemaVersion = setSchemaVersionInTransaction(session, 50);
+      }
       
       sc.logout();

trunk/src/core/net/sf/basedb/core/data/DataFileTypeData.java

@@ -147 +147 @@
   }
   
+  public static final int MAX_JARPATH_LENGTH = 65535;
+  private String validatorJarPath;
+  /**
+    Get the path to the JAR file where the validator class is located. If the
+    value is null the value must be in the classpath.
+    @return The path to the JAR file
+    @hibernate.property column="`validator_jarpath`" type="text" not-null="false"
+    @since 2.6
+  */
+  public String getValidatorJarPath()
+  {
+    return validatorJarPath;
+  }
+  public void setValidatorJarPath(String validatorJarPath)
+  {
+    this.validatorJarPath = validatorJarPath;
+  }
+  
+  
   private String metadataReaderClass;
   /**
@@ -161 +180 @@
   {
     this.metadataReaderClass = metadataReaderClass;
+  }
+  
+  private String metadataReaderJarPath;
+  /**
+    Get the path to the JAR file where the validator class is located. If the
+    value is null the value must be in the classpath.
+    @return The path to the JAR file
+    @hibernate.property column="`extractor_jarpath`" type="text" not-null="false"
+    @since 2.6
+  */
+  public String getMetadataReaderJarPath()
+  {
+    return metadataReaderJarPath;
+  }
+  public void setMetadataReaderJarPath(String metadataReaderJarPath)
+  {
+    this.metadataReaderJarPath = metadataReaderJarPath;
   }