X-Git-Url: https://juplo.de/gitweb/?p=hibernate4-maven-plugin;a=blobdiff_plain;f=src%2Fmain%2Fjava%2Fde%2Fjuplo%2Fplugins%2Fhibernate4%2FHbm2DdlMojo.java;h=f9912536b76ffb7810c841bbb1815da49d89743c;hp=7a5e0af0f1b9b9fb277ff2c077de984fc0b849d8;hb=2b1147d5e99c764c1f6816f4d4f000abe260097c;hpb=8a2e08b6409034fd692c4bea72058f785e6802ad diff --git a/src/main/java/de/juplo/plugins/hibernate4/Hbm2DdlMojo.java b/src/main/java/de/juplo/plugins/hibernate4/Hbm2DdlMojo.java index 7a5e0af0..f9912536 100644 --- a/src/main/java/de/juplo/plugins/hibernate4/Hbm2DdlMojo.java +++ b/src/main/java/de/juplo/plugins/hibernate4/Hbm2DdlMojo.java @@ -19,6 +19,7 @@ package de.juplo.plugins.hibernate4; import com.pyx4j.log4j.MavenLogAppender; import java.io.File; import java.io.FileInputStream; +import java.io.FileNotFoundException; import java.io.FileOutputStream; import java.io.IOException; import java.io.InputStream; @@ -28,6 +29,7 @@ import java.math.BigInteger; import java.net.URL; import java.net.URLClassLoader; import java.security.MessageDigest; +import java.security.NoSuchAlgorithmException; import java.sql.Connection; import java.sql.Driver; import java.sql.DriverManager; @@ -48,11 +50,14 @@ import java.util.logging.Logger; import javax.persistence.Embeddable; import javax.persistence.Entity; import javax.persistence.MappedSuperclass; +import org.apache.maven.model.Resource; import org.apache.maven.plugin.AbstractMojo; import org.apache.maven.plugin.MojoExecutionException; import org.apache.maven.plugin.MojoFailureException; import org.apache.maven.project.MavenProject; import org.hibernate.cfg.Configuration; +import org.hibernate.cfg.NamingStrategy; +import org.hibernate.envers.configuration.AuditConfiguration; import org.hibernate.tool.hbm2ddl.SchemaExport; import org.hibernate.tool.hbm2ddl.SchemaExport.Type; import org.hibernate.tool.hbm2ddl.Target; @@ -77,13 +82,17 @@ public class Hbm2DdlMojo extends AbstractMojo public final static String USERNAME = "hibernate.connection.username"; public final static String PASSWORD = "hibernate.connection.password"; public final static String DIALECT = "hibernate.dialect"; + public final static String NAMING_STRATEGY="hibernate.ejb.naming_strategy"; + public final static String ENVERS = "hibernate.export.envers"; private final static String MD5S = "schema.md5s"; /** * The maven project. + *

+ * Only needed internally. * - * @parameter expression="${project}" + * @parameter property="project" * @required * @readonly */ @@ -91,60 +100,116 @@ public class Hbm2DdlMojo extends AbstractMojo /** * Build-directory. + *

+ * Only needed internally. * - * @parameter expression="${project.build.directory}" + * @parameter property="project.build.directory" + * @required + * @readonly */ private String buildDirectory; /** - * Class-directory to scan. + * Classes-Directory to scan. + *

+ * This parameter defaults to the maven build-output-directory for classes. + * Additonally, all dependencies are scanned for annotated classes. * - * @parameter expression="${project.build.outputDirectory}" + * @parameter property="project.build.outputDirectory" */ private String outputDirectory; + /** + * Wether to scan test-classes too, or not. + *

+ * If this parameter is set to true the test-classes of the + * artifact will be scanned for hibernate-annotated classes additionally. + * + * @parameter property="hibernate.export.scan_testclasses" default-value="false" + */ + private boolean scanTestClasses; + + /** + * Test-Classes-Directory to scan. + *

+ * This parameter defaults to the maven build-output-directory for + * test-classes. + *

+ * This parameter is only used, when scanTestClasses is set + * to true! + * + * @parameter property="project.build.testOutputDirectory" + */ + private String testOutputDirectory; + /** * Skip execution + *

+ * If set to true, the execution is skipped. + *

+ * A skipped excecution is signaled via the maven-property + * ${hibernate.export.skipped}. + *

+ * The excecution is skipped automatically, if no modified or newly added + * annotated classes are found and the dialect was not changed. * - * @parameter expression="${maven.test.skip}" default-value="false" + * @parameter property="hibernate.export.skip" default-value="false" */ private boolean skip; + /** + * Force execution + *

+ * Force execution, even if no modified or newly added annotated classes + * where found and the dialect was not changed. + *

+ * skip takes precedence over force. + * + * @parameter property="hibernate.export.force" default-value="false" + */ + private boolean force; + /** * SQL-Driver name. * - * @parameter expression="${hibernate.connection.driver_class} + * @parameter property="hibernate.connection.driver_class" */ private String driverClassName; /** * Database URL. * - * @parameter expression="${hibernate.connection.url}" + * @parameter property="hibernate.connection.url" */ private String url; /** * Database username * - * @parameter expression="${hibernate.connection.username}" + * @parameter property="hibernate.connection.username" */ private String username; /** * Database password * - * @parameter expression="${hibernate.connection.password}" + * @parameter property="hibernate.connection.password" */ private String password; /** * Hibernate dialect. * - * @parameter expression="${hibernate.dialect}" + * @parameter property="hibernate.dialect" */ private String hibernateDialect; + /** + * Hibernate Naming Strategy + * @parameter property="hibernate.ejb.naming_strategy" + */ + private String hibernateNamingStrategy; + /** * Path to Hibernate configuration file. * @@ -152,51 +217,72 @@ public class Hbm2DdlMojo extends AbstractMojo */ private String hibernateProperties; + /** + * List of Hibernate-Mapping-Files (XML). + * Multiple files can be separated with white-spaces and/or commas. + * + * @parameter property="hibernate.mapping" + */ + private String hibernateMapping; + /** * Target of execution: *

- * @parameter expression="${hibernate.export.target}" default-value="EXPORT" + * + * A databaseconnection is only needed for EXPORT and BOTH, but a + * Hibernate-Dialect must always be choosen. + * + * @parameter property="hibernate.export.target" default-value="EXPORT" */ private String target; /** - * Type of export. + * Type of execution. * - * @parameter expression="${hibernate.export.type}" default-value="BOTH" + * + * If NONE is choosen, no databaseconnection is needed. + * + * @parameter property="hibernate.export.type" default-value="BOTH" */ private String type; /** * Output file. * - * @parameter expression="${hibernate.export.schema.filename}" default-value="${project.build.directory}/schema.sql" + * @parameter property="hibernate.export.schema.filename" default-value="${project.build.directory}/schema.sql" */ private String outputFile; /** * Delimiter in output-file. * - * @parameter expression="${hibernate.export.schema.delimiter}" default-value=";" + * @parameter property="hibernate.export.schema.delimiter" default-value=";" */ private String delimiter; /** * Format output-file. * - * @parameter expression="${hibernate.export.schema.format}" default-value="true" + * @parameter property="hibernate.export.schema.format" default-value="true" */ private boolean format; + /** + * Generate envers schema for auditing tables. + * + * @parameter property="hibernate.export.envers" default-value="false" + */ + private boolean envers; @Override public void execute() @@ -211,10 +297,6 @@ public class Hbm2DdlMojo extends AbstractMojo return; } - File dir = new File(outputDirectory); - if (!dir.exists()) - throw new MojoExecutionException("Cannot scan for annotated classes in " + outputDirectory + ": directory does not exist!"); - Map md5s; boolean modified = false; File saved = new File(buildDirectory + File.separator + MD5S); @@ -243,7 +325,7 @@ public class Hbm2DdlMojo extends AbstractMojo } catch (IOException e) { - getLog().warn("Cannot create saved for timestamps: " + e); + getLog().debug("Cannot create file \"" + saved.getPath() + "\" for timestamps: " + e); } } @@ -252,6 +334,8 @@ public class Hbm2DdlMojo extends AbstractMojo { getLog().debug("Creating ClassLoader for project-dependencies..."); List classpathFiles = project.getCompileClasspathElements(); + if (scanTestClasses) + classpathFiles.addAll(project.getTestClasspathElements()); URL[] urls = new URL[classpathFiles.size()]; for (int i = 0; i < classpathFiles.size(); ++i) { @@ -280,9 +364,23 @@ public class Hbm2DdlMojo extends AbstractMojo try { AnnotationDB db = new AnnotationDB(); - getLog().info("Scanning directory " + outputDirectory + " for annotated classes..."); - URL dirUrl = dir.toURI().toURL(); - db.scanArchives(dirUrl); + File dir = new File(outputDirectory); + if (dir.exists()) + { + getLog().info("Scanning directory " + outputDirectory + " for annotated classes..."); + URL dirUrl = dir.toURI().toURL(); + db.scanArchives(dirUrl); + } + if (scanTestClasses) + { + dir = new File(testOutputDirectory); + if (dir.exists()) + { + getLog().info("Scanning directory " + testOutputDirectory + " for annotated classes..."); + URL dirUrl = dir.toURI().toURL(); + db.scanArchives(dirUrl); + } + } Set classNames = new HashSet(); if (db.getAnnotationIndex().containsKey(Entity.class.getName())) @@ -297,9 +395,11 @@ public class Hbm2DdlMojo extends AbstractMojo { Class annotatedClass = classLoader.loadClass(name); classes.add(annotatedClass); + String resourceName = annotatedClass.getName(); + resourceName = resourceName.substring(resourceName.lastIndexOf(".") + 1, resourceName.length()) + ".class"; InputStream is = annotatedClass - .getResourceAsStream(annotatedClass.getSimpleName() + ".class"); + .getResourceAsStream(resourceName); byte[] buffer = new byte[1024*4]; // copy data in 4MB-chunks int i; while((i = is.read(buffer)) > -1) @@ -333,11 +433,16 @@ public class Hbm2DdlMojo extends AbstractMojo } if (classes.isEmpty()) - throw new MojoFailureException("No annotated classes found in directory " + outputDirectory); - - getLog().debug("Detected classes with mapping-annotations:"); - for (Class annotatedClass : classes) - getLog().debug(" " + annotatedClass.getName()); + { + if (hibernateMapping == null || hibernateMapping.isEmpty()) + throw new MojoFailureException("No annotated classes found in directory " + outputDirectory); + } + else + { + getLog().debug("Detected classes with mapping-annotations:"); + for (Class annotatedClass : classes) + getLog().debug(" " + annotatedClass.getName()); + } Properties properties = new Properties(); @@ -352,7 +457,7 @@ public class Hbm2DdlMojo extends AbstractMojo properties.load(new FileInputStream(file)); } else - getLog().info("No hibernate-properties-file found! Checked path: " + hibernateProperties); + getLog().info("No hibernate-properties-file found! (Checked path: " + hibernateProperties + ")"); } catch (IOException e) { @@ -367,14 +472,10 @@ public class Hbm2DdlMojo extends AbstractMojo getLog().debug( "Overwriting property " + DRIVER_CLASS + "=" + properties.getProperty(DRIVER_CLASS) + - " with the value " + driverClassName + - " from the plugin-configuration-parameter driverClassName!" + " with the value " + driverClassName ); else - getLog().debug( - "Using the value " + driverClassName + - " from the plugin-configuration-parameter driverClassName!" - ); + getLog().debug("Using the value " + driverClassName); properties.setProperty(DRIVER_CLASS, driverClassName); } if (url != null) @@ -383,14 +484,10 @@ public class Hbm2DdlMojo extends AbstractMojo getLog().debug( "Overwriting property " + URL + "=" + properties.getProperty(URL) + - " with the value " + url + - " from the plugin-configuration-parameter url!" + " with the value " + url ); else - getLog().debug( - "Using the value " + url + - " from the plugin-configuration-parameter url!" - ); + getLog().debug("Using the value " + url); properties.setProperty(URL, url); } if (username != null) @@ -399,14 +496,10 @@ public class Hbm2DdlMojo extends AbstractMojo getLog().debug( "Overwriting property " + USERNAME + "=" + properties.getProperty(USERNAME) + - " with the value " + username + - " from the plugin-configuration-parameter username!" + " with the value " + username ); else - getLog().debug( - "Using the value " + username + - " from the plugin-configuration-parameter username!" - ); + getLog().debug("Using the value " + username); properties.setProperty(USERNAME, username); } if (password != null) @@ -415,14 +508,10 @@ public class Hbm2DdlMojo extends AbstractMojo getLog().debug( "Overwriting property " + PASSWORD + "=" + properties.getProperty(PASSWORD) + - " with the value " + password + - " from the plugin-configuration-parameter password!" + " with the value " + password ); else - getLog().debug( - "Using the value " + password + - " from the plugin-configuration-parameter password!" - ); + getLog().debug("Using the value " + password); properties.setProperty(PASSWORD, password); } if (hibernateDialect != null) @@ -431,16 +520,24 @@ public class Hbm2DdlMojo extends AbstractMojo getLog().debug( "Overwriting property " + DIALECT + "=" + properties.getProperty(DIALECT) + - " with the value " + hibernateDialect + - " from the plugin-configuration-parameter hibernateDialect!" + " with the value " + hibernateDialect ); else - getLog().debug( - "Using the value " + hibernateDialect + - " from the plugin-configuration-parameter hibernateDialect!" - ); + getLog().debug("Using the value " + hibernateDialect); properties.setProperty(DIALECT, hibernateDialect); } + if ( hibernateNamingStrategy != null ) + { + if ( properties.contains(NAMING_STRATEGY)) + getLog().debug( + "Overwriting property " + + NAMING_STRATEGY + "=" + properties.getProperty(NAMING_STRATEGY) + + " with the value " + hibernateNamingStrategy + ); + else + getLog().debug("Using the value " + hibernateNamingStrategy); + properties.setProperty(NAMING_STRATEGY, hibernateNamingStrategy); + } /** The generated SQL varies with the dialect! */ if (md5s.containsKey(DIALECT)) @@ -461,6 +558,24 @@ public class Hbm2DdlMojo extends AbstractMojo md5s.put(DIALECT, properties.getProperty(DIALECT)); } + /** The generated SQL varies with the envers-configuration */ + if (md5s.get(ENVERS) != null) + { + if (md5s.get(ENVERS).equals(Boolean.toString(envers))) + getLog().debug("Envers-Configuration unchanged. Enabled: " + envers); + else + { + getLog().debug("Envers-Configuration changed. Enabled: " + envers); + modified = true; + md5s.put(ENVERS, Boolean.toString(envers)); + } + } + else + { + modified = true; + md5s.put(ENVERS, Boolean.toString(envers)); + } + if (properties.isEmpty()) { getLog().error("No properties set!"); @@ -469,6 +584,24 @@ public class Hbm2DdlMojo extends AbstractMojo Configuration config = new Configuration(); config.setProperties(properties); + + if ( properties.containsKey(NAMING_STRATEGY)) + { + String namingStrategy = properties.getProperty(NAMING_STRATEGY); + getLog().debug("Explicitly set NamingStrategy: " + namingStrategy); + try + { + @SuppressWarnings("unchecked") + Class namingStrategyClass = (Class) Class.forName(namingStrategy); + config.setNamingStrategy(namingStrategyClass.newInstance()); + } + catch (Exception e) + { + getLog().error("Error setting NamingStrategy", e); + throw new MojoExecutionException(e.getMessage()); + } + } + getLog().debug("Adding annotated classes to hibernate-mapping-configuration..."); for (Class annotatedClass : classes) { @@ -476,10 +609,72 @@ public class Hbm2DdlMojo extends AbstractMojo config.addAnnotatedClass(annotatedClass); } + if (hibernateMapping != null) + { + try + { + MessageDigest digest = java.security.MessageDigest.getInstance("MD5"); + for (String filename : hibernateMapping.split("[\\s,]+")) + { + // First try the filename as absolute/relative path + File file = new File(filename); + if (!file.exists()) + { + // If the file was not found, search for it in the resource-directories + for (Resource resource : project.getResources()) + { + file = new File(resource.getDirectory() + File.separator + filename); + if (file.exists()) + break; + } + } + if (file != null && file.exists()) + { + InputStream is = new FileInputStream(file); + byte[] buffer = new byte[1024*4]; // copy data in 4MB-chunks + int i; + while((i = is.read(buffer)) > -1) + digest.update(buffer, 0, i); + is.close(); + byte[] bytes = digest.digest(); + BigInteger bi = new BigInteger(1, bytes); + String newMd5 = String.format("%0" + (bytes.length << 1) + "x", bi); + String oldMd5 = !md5s.containsKey(filename) ? "" : md5s.get(filename); + if (!newMd5.equals(oldMd5)) + { + getLog().debug("Found new or modified mapping-file: " + filename); + modified = true; + md5s.put(filename, newMd5); + } + else + { + getLog().debug(oldMd5 + " -> mapping-file unchanged: " + filename); + } + getLog().debug("Adding mappings from XML-configurationfile: " + file); + config.addFile(file); + } + else + throw new MojoFailureException("File " + filename + " could not be found in any of the configured resource-directories!"); + } + } + catch (NoSuchAlgorithmException e) + { + throw new MojoFailureException("Cannot calculate MD5-summs!", e); + } + catch (FileNotFoundException e) + { + throw new MojoFailureException("Cannot calculate MD5-summs!", e); + } + catch (IOException e) + { + throw new MojoFailureException("Cannot calculate MD5-summs!", e); + } + } + Target target = null; try { - target = Target.valueOf(this.target); + target = Target.valueOf(this.target.toUpperCase()); } catch (IllegalArgumentException e) { @@ -490,7 +685,7 @@ public class Hbm2DdlMojo extends AbstractMojo Type type = null; try { - type = Type.valueOf(this.type); + type = Type.valueOf(this.type.toUpperCase()); } catch (IllegalArgumentException e) { @@ -507,9 +702,10 @@ public class Hbm2DdlMojo extends AbstractMojo !modified && !target.equals(Target.SCRIPT) && !target.equals(Target.NONE) + && !force ) { - getLog().info("No modified annotated classes found and dialect unchanged."); + getLog().info("No modified annotated classes or mapping-files found and dialect unchanged."); getLog().info("Skipping schema generation!"); project.getProperties().setProperty(EXPORT_SKIPPED_PROPERTY, "true"); return; @@ -527,6 +723,7 @@ public class Hbm2DdlMojo extends AbstractMojo * hibernate does not use the context-classloader of the current * thread and, hence, would not be able to resolve the driver-class! */ + getLog().debug("Target: " + target + ", Type: " + type); switch (target) { case EXPORT: @@ -536,17 +733,28 @@ public class Hbm2DdlMojo extends AbstractMojo case CREATE: case DROP: case BOTH: - Class driverClass = classLoader.loadClass(driverClassName); + Class driverClass = classLoader.loadClass(properties.getProperty(DRIVER_CLASS)); getLog().debug("Registering JDBC-driver " + driverClass.getName()); DriverManager.registerDriver(new DriverProxy((Driver)driverClass.newInstance())); - getLog().debug("Opening JDBC-connection to " + url + " as " + username + " with password " + password); - connection = DriverManager.getConnection(url, username, password); + getLog().debug( + "Opening JDBC-connection to " + + properties.getProperty(URL) + + " as " + + properties.getProperty(USERNAME) + + " with password " + + properties.getProperty(PASSWORD) + ); + connection = DriverManager.getConnection( + properties.getProperty(URL), + properties.getProperty(USERNAME), + properties.getProperty(PASSWORD) + ); } } } catch (ClassNotFoundException e) { - getLog().error("Dependency for driver-class " + driverClassName + " is missing!"); + getLog().error("Dependency for driver-class " + properties.getProperty(DRIVER_CLASS) + " is missing!"); throw new MojoExecutionException(e.getMessage()); } catch (Exception e) @@ -570,6 +778,14 @@ public class Hbm2DdlMojo extends AbstractMojo */ Thread.currentThread().setContextClassLoader(classLoader); + config.buildMappings(); + + if (envers) + { + getLog().info("Automatic auditing via hibernate-envers enabled!"); + AuditConfiguration.getFor(config); + } + SchemaExport export = new SchemaExport(config, connection); export.setOutputFile(outputFile); export.setDelimiter(delimiter); @@ -590,7 +806,8 @@ public class Hbm2DdlMojo extends AbstractMojo /** Close the connection */ try { - connection.close(); + if (connection != null) + connection.close(); } catch (SQLException e) {