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=9a61cd61ab7728e1e3cf7ee7d24ad7abcccd30cc;hp=96848edc3c367c792fd3ddc3bb123b60c8ff3474;hb=f2955fc974239cbb266922c04e8e11101d7e9dd9;hpb=97a45d03e1144d30b90f2f566517be22aca39358 diff --git a/src/main/java/de/juplo/plugins/hibernate4/Hbm2DdlMojo.java b/src/main/java/de/juplo/plugins/hibernate4/Hbm2DdlMojo.java index 96848edc..9a61cd61 100644 --- a/src/main/java/de/juplo/plugins/hibernate4/Hbm2DdlMojo.java +++ b/src/main/java/de/juplo/plugins/hibernate4/Hbm2DdlMojo.java @@ -47,9 +47,12 @@ import java.util.Properties; import java.util.Set; import java.util.TreeSet; import java.util.logging.Logger; +import java.util.regex.Matcher; +import java.util.regex.Pattern; import javax.persistence.Embeddable; import javax.persistence.Entity; import javax.persistence.MappedSuperclass; +import org.apache.maven.artifact.Artifact; import org.apache.maven.model.Resource; import org.apache.maven.plugin.AbstractMojo; import org.apache.maven.plugin.MojoExecutionException; @@ -57,6 +60,7 @@ 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; @@ -82,8 +86,12 @@ public class Hbm2DdlMojo extends AbstractMojo 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"; + + public final static String MD5S = "hibernate4-generatedschema.md5s"; + + private final static Pattern split = Pattern.compile("[^,\\s]+"); - private final static String MD5S = "schema.md5s"; /** * The maven project. @@ -111,22 +119,40 @@ public class Hbm2DdlMojo extends AbstractMojo * Classes-Directory to scan. *

* This parameter defaults to the maven build-output-directory for classes. - * Additonally, all dependencies are scanned for annotated classes. + * Additionally, all dependencies are scanned for annotated classes. * * @parameter property="project.build.outputDirectory" + * @since 1.0 */ private String outputDirectory; /** - * Wether to scan test-classes too, or not. + * Whether 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" + * @since 1.0.1 */ private boolean scanTestClasses; + /** + * Dependency-Scopes, that should be scanned for annotated classes. + *

+ * By default, only dependencies in the scope compile are + * scanned for annotated classes. Multiple scopes can be seperated by + * white space or commas. + *

+ * The plugin does not scan for annotated classes in transitive + * dependencies. If some of your annotated classes are hidden in a + * transitive dependency, you can simply add that dependency explicitly. + * + * @parameter property="hibernate.export.scan_dependencies" default-value="compile" + * @since 1.0.3 + */ + private String scanDependencies; + /** * Test-Classes-Directory to scan. *

@@ -137,6 +163,7 @@ public class Hbm2DdlMojo extends AbstractMojo * to true! * * @parameter property="project.build.testOutputDirectory" + * @since 1.0.2 */ private String testOutputDirectory; @@ -145,13 +172,14 @@ public class Hbm2DdlMojo extends AbstractMojo *

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

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

- * The excecution is skipped automatically, if no modified or newly added + * The execution is skipped automatically, if no modified or newly added * annotated classes are found and the dialect was not changed. * - * @parameter property="hibernate.export.skip" default-value="false" + * @parameter property="hibernate.skip" default-value="${maven.test.skip}" + * @since 1.0 */ private boolean skip; @@ -164,6 +192,7 @@ public class Hbm2DdlMojo extends AbstractMojo * skip takes precedence over force. * * @parameter property="hibernate.export.force" default-value="false" + * @since 1.0 */ private boolean force; @@ -171,6 +200,7 @@ public class Hbm2DdlMojo extends AbstractMojo * SQL-Driver name. * * @parameter property="hibernate.connection.driver_class" + * @since 1.0 */ private String driverClassName; @@ -178,6 +208,7 @@ public class Hbm2DdlMojo extends AbstractMojo * Database URL. * * @parameter property="hibernate.connection.url" + * @since 1.0 */ private String url; @@ -185,6 +216,7 @@ public class Hbm2DdlMojo extends AbstractMojo * Database username * * @parameter property="hibernate.connection.username" + * @since 1.0 */ private String username; @@ -192,6 +224,7 @@ public class Hbm2DdlMojo extends AbstractMojo * Database password * * @parameter property="hibernate.connection.password" + * @since 1.0 */ private String password; @@ -199,12 +232,15 @@ public class Hbm2DdlMojo extends AbstractMojo * Hibernate dialect. * * @parameter property="hibernate.dialect" + * @since 1.0 */ private String hibernateDialect; /** * Hibernate Naming Strategy + * * @parameter property="hibernate.ejb.naming_strategy" + * @since 1.0.2 */ private String hibernateNamingStrategy; @@ -212,6 +248,7 @@ public class Hbm2DdlMojo extends AbstractMojo * Path to Hibernate configuration file. * * @parameter default-value="${project.build.outputDirectory}/hibernate.properties" + * @since 1.0 */ private String hibernateProperties; @@ -220,22 +257,24 @@ public class Hbm2DdlMojo extends AbstractMojo * Multiple files can be separated with white-spaces and/or commas. * * @parameter property="hibernate.mapping" + * @since 1.0.2 */ private String hibernateMapping; /** * Target of execution: *

* - * A databaseconnection is only needed for EXPORT and BOTH, but a - * Hibernate-Dialect must always be choosen. + * A database connection is only needed for EXPORT and BOTH, but a + * Hibernate-Dialect must always be chosen. * * @parameter property="hibernate.export.target" default-value="EXPORT" + * @since 1.0 */ private String target; @@ -251,6 +290,7 @@ public class Hbm2DdlMojo extends AbstractMojo * If NONE is choosen, no databaseconnection is needed. * * @parameter property="hibernate.export.type" default-value="BOTH" + * @since 1.0 */ private String type; @@ -258,6 +298,7 @@ public class Hbm2DdlMojo extends AbstractMojo * Output file. * * @parameter property="hibernate.export.schema.filename" default-value="${project.build.directory}/schema.sql" + * @since 1.0 */ private String outputFile; @@ -265,6 +306,7 @@ public class Hbm2DdlMojo extends AbstractMojo * Delimiter in output-file. * * @parameter property="hibernate.export.schema.delimiter" default-value=";" + * @since 1.0 */ private String delimiter; @@ -272,9 +314,18 @@ public class Hbm2DdlMojo extends AbstractMojo * Format output-file. * * @parameter property="hibernate.export.schema.format" default-value="true" + * @since 1.0 */ private boolean format; + /** + * Generate envers schema for auditing tables. + * + * @parameter property="hibernate.export.envers" default-value="false" + * @since 1.0.3 + */ + private boolean envers; + @Override public void execute() @@ -284,7 +335,7 @@ public class Hbm2DdlMojo extends AbstractMojo { if (skip) { - getLog().info("Exectuion of hibernate4-maven-plugin:export was skipped!"); + getLog().info("Execution of hibernate4-maven-plugin:export was skipped!"); project.getProperties().setProperty(EXPORT_SKIPPED_PROPERTY, "true"); return; } @@ -293,7 +344,7 @@ public class Hbm2DdlMojo extends AbstractMojo boolean modified = false; File saved = new File(buildDirectory + File.separator + MD5S); - if (saved.exists()) + if (saved.isFile() && saved.length() > 0) { try { @@ -373,6 +424,34 @@ public class Hbm2DdlMojo extends AbstractMojo db.scanArchives(dirUrl); } } + if (scanDependencies != null) + { + Matcher matcher = split.matcher(scanDependencies); + while (matcher.find()) + { + getLog().info("Scanning dependencies for scope " + matcher.group()); + for (Artifact artifact : project.getDependencyArtifacts()) + { + if (!artifact.getScope().equalsIgnoreCase(matcher.group())) + continue; + if (artifact.getFile() == null) + { + getLog().warn( + "Cannot scan dependency " + + artifact.getId() + + ": no JAR-file available!" + ); + continue; + } + getLog().info( + "Scanning dependency " + + artifact.getId() + + " for annotated classes..." + ); + db.scanArchives(artifact.getFile().toURI().toURL()); + } + } + } Set classNames = new HashSet(); if (db.getAnnotationIndex().containsKey(Entity.class.getName())) @@ -457,7 +536,7 @@ public class Hbm2DdlMojo extends AbstractMojo throw new MojoExecutionException(e.getMessage()); } - /** Overwrite values from propertie-file or set, if given */ + /** Overwrite values from properties-file or set, if given */ if (driverClassName != null) { if (properties.containsKey(DRIVER_CLASS)) @@ -500,10 +579,10 @@ public class Hbm2DdlMojo extends AbstractMojo getLog().debug( "Overwriting property " + PASSWORD + "=" + properties.getProperty(PASSWORD) + - " with the value " + password + " with value " + password ); else - getLog().debug("Using the value " + password); + getLog().debug("Using value " + password + " for property " + PASSWORD); properties.setProperty(PASSWORD, password); } if (hibernateDialect != null) @@ -512,10 +591,12 @@ public class Hbm2DdlMojo extends AbstractMojo getLog().debug( "Overwriting property " + DIALECT + "=" + properties.getProperty(DIALECT) + - " with the value " + hibernateDialect + " with value " + hibernateDialect ); else - getLog().debug("Using the value " + hibernateDialect); + getLog().debug( + "Using value " + hibernateDialect + " for property " + DIALECT + ); properties.setProperty(DIALECT, hibernateDialect); } if ( hibernateNamingStrategy != null ) @@ -524,10 +605,13 @@ public class Hbm2DdlMojo extends AbstractMojo getLog().debug( "Overwriting property " + NAMING_STRATEGY + "=" + properties.getProperty(NAMING_STRATEGY) + - " with the value " + hibernateNamingStrategy + " with value " + hibernateNamingStrategy ); else - getLog().debug("Using the value " + hibernateNamingStrategy); + getLog().debug( + "Using value " + hibernateNamingStrategy + " for property " + + NAMING_STRATEGY + ); properties.setProperty(NAMING_STRATEGY, hibernateNamingStrategy); } @@ -539,21 +623,51 @@ public class Hbm2DdlMojo extends AbstractMojo getLog().debug("SQL-dialect unchanged."); else { - getLog().debug("SQL-dialect changed: " + dialect); modified = true; - md5s.put(DIALECT, dialect); + if (dialect == null) + { + getLog().debug("SQL-dialect was unset."); + md5s.remove(DIALECT); + } + else + { + getLog().debug("SQL-dialect changed: " + dialect); + md5s.put(DIALECT, dialect); + } + } + } + else + { + String dialect = properties.getProperty(DIALECT); + if (dialect != null) + { + modified = true; + 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(DIALECT, properties.getProperty(DIALECT)); + md5s.put(ENVERS, Boolean.toString(envers)); } if (properties.isEmpty()) { getLog().error("No properties set!"); - throw new MojoFailureException("Hibernate-Configuration is missing!"); + throw new MojoFailureException("Hibernate configuration is missing!"); } Configuration config = new Configuration(); @@ -633,15 +747,15 @@ public class Hbm2DdlMojo extends AbstractMojo } catch (NoSuchAlgorithmException e) { - throw new MojoFailureException("Cannot calculate MD5-summs!", e); + throw new MojoFailureException("Cannot calculate MD5 sums!", e); } catch (FileNotFoundException e) { - throw new MojoFailureException("Cannot calculate MD5-summs!", e); + throw new MojoFailureException("Cannot calculate MD5 sums!", e); } catch (IOException e) { - throw new MojoFailureException("Cannot calculate MD5-summs!", e); + throw new MojoFailureException("Cannot calculate MD5 sums!", e); } } @@ -752,10 +866,43 @@ 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); export.setFormat(format); + + File outF = new File(outputFile); + + if (!outF.isAbsolute()) + { + // Interpret relative file path relative to build directory + outF = new File(buildDirectory, outputFile); + getLog().info("Adjusted relative path, resulting path is " + outF.getPath()); + } + + // Ensure that directory path for specified file exists + File outFileParentDir = outF.getParentFile(); + if (null != outFileParentDir && !outFileParentDir.exists()) + { + try + { + getLog().info("Creating directory path for output file:" + outFileParentDir.getPath()); + outFileParentDir.mkdirs(); + } + catch (Exception e) + { + getLog().error("Error creating directory path for output file: " + e.getLocalizedMessage()); + } + } + + export.setOutputFile(outF.getPath()); export.execute(target, type); for (Object exception : export.getExceptions())