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=a37176cc78771eaf3fbbde6ca0f3c4eeef4fb254;hp=96848edc3c367c792fd3ddc3bb123b60c8ff3474;hb=5da1114d419ae10f94a83ad56cea9856a39f00b6;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..a37176cc 100644 --- a/src/main/java/de/juplo/plugins/hibernate4/Hbm2DdlMojo.java +++ b/src/main/java/de/juplo/plugins/hibernate4/Hbm2DdlMojo.java @@ -30,14 +30,11 @@ 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; import java.sql.DriverPropertyInfo; import java.sql.SQLException; import java.sql.SQLFeatureNotSupportedException; import java.util.Comparator; -import java.util.Enumeration; import java.util.HashMap; import java.util.HashSet; import java.util.List; @@ -47,16 +44,23 @@ 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; import org.apache.maven.plugin.MojoFailureException; import org.apache.maven.project.MavenProject; -import org.hibernate.cfg.Configuration; +import org.hibernate.boot.registry.StandardServiceRegistryBuilder; +import org.hibernate.boot.registry.internal.StandardServiceRegistryImpl; +import org.hibernate.cfg.Environment; import org.hibernate.cfg.NamingStrategy; +import org.hibernate.envers.configuration.spi.AuditConfiguration; +import org.hibernate.internal.util.config.ConfigurationHelper; 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,43 @@ 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. + *

+ * If you do not want any dependencies to be scanned for annotated + * classes, set this parameter to none. + *

+ * 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 +166,7 @@ public class Hbm2DdlMojo extends AbstractMojo * to true! * * @parameter property="project.build.testOutputDirectory" + * @since 1.0.2 */ private String testOutputDirectory; @@ -145,13 +175,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 +195,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 +203,7 @@ public class Hbm2DdlMojo extends AbstractMojo * SQL-Driver name. * * @parameter property="hibernate.connection.driver_class" + * @since 1.0 */ private String driverClassName; @@ -178,6 +211,7 @@ public class Hbm2DdlMojo extends AbstractMojo * Database URL. * * @parameter property="hibernate.connection.url" + * @since 1.0 */ private String url; @@ -185,6 +219,7 @@ public class Hbm2DdlMojo extends AbstractMojo * Database username * * @parameter property="hibernate.connection.username" + * @since 1.0 */ private String username; @@ -192,6 +227,7 @@ public class Hbm2DdlMojo extends AbstractMojo * Database password * * @parameter property="hibernate.connection.password" + * @since 1.0 */ private String password; @@ -199,12 +235,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 +251,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 +260,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 +293,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 +301,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 +309,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 +317,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 +338,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 +347,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 +427,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 +539,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 +582,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,22 +594,31 @@ 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); } + else + { + hibernateDialect = properties.getProperty(DIALECT); + } if ( hibernateNamingStrategy != null ) { if ( properties.contains(NAMING_STRATEGY)) 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,24 +630,55 @@ 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(); + final ValidationConfiguration config = new ValidationConfiguration(hibernateDialect); + config.setProperties(properties); if ( properties.containsKey(NAMING_STRATEGY)) @@ -576,186 +698,182 @@ public class Hbm2DdlMojo extends AbstractMojo } } - getLog().debug("Adding annotated classes to hibernate-mapping-configuration..."); - for (Class annotatedClass : classes) + ClassLoader contextClassLoader = Thread.currentThread().getContextClassLoader(); + MavenLogAppender.startPluginLog(this); + try { - getLog().debug("Class " + annotatedClass); - config.addAnnotatedClass(annotatedClass); - } + /** + * Change class-loader of current thread, so that hibernate can + * see all dependencies! + */ + Thread.currentThread().setContextClassLoader(classLoader); - if (hibernateMapping != null) - { - try + getLog().debug("Adding annotated classes to hibernate-mapping-configuration..."); + // build annotated packages + Set packages = new HashSet(); + for (Class annotatedClass : classes) + { + String packageName = annotatedClass.getPackage().getName(); + if (!packages.contains(packageName)) + { + getLog().debug("Add package " + packageName); + packages.add(packageName); + config.addPackage(packageName); + getLog().debug("type definintions" + config.getTypeDefs()); + } + getLog().debug("Class " + annotatedClass); + config.addAnnotatedClass(annotatedClass); + } + + if (hibernateMapping != null) { - MessageDigest digest = java.security.MessageDigest.getInstance("MD5"); - for (String filename : hibernateMapping.split("[\\s,]+")) + try { - // First try the filename as absolute/relative path - File file = new File(filename); - if (!file.exists()) + MessageDigest digest = java.security.MessageDigest.getInstance("MD5"); + for (String filename : hibernateMapping.split("[\\s,]+")) { - // If the file was not found, search for it in the resource-directories - for (Resource resource : project.getResources()) + // First try the filename as absolute/relative path + File file = new File(filename); + if (!file.exists()) { - file = new File(resource.getDirectory() + File.separator + filename); - if (file.exists()) - break; + // 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)) + if (file != null && file.exists()) { - getLog().debug("Found new or modified mapping-file: " + filename); - modified = true; - md5s.put(filename, newMd5); + 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 - { - getLog().debug(oldMd5 + " -> mapping-file unchanged: " + filename); - } - getLog().debug("Adding mappings from XML-configurationfile: " + file); - config.addFile(file); + throw new MojoFailureException("File " + filename + " could not be found in any of the configured resource-directories!"); } - 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 sums!", e); + } + catch (FileNotFoundException e) + { + throw new MojoFailureException("Cannot calculate MD5 sums!", e); + } + catch (IOException e) + { + throw new MojoFailureException("Cannot calculate MD5 sums!", e); + } + } + + Target target = null; + try + { + target = Target.valueOf(this.target.toUpperCase()); } - catch (NoSuchAlgorithmException e) + catch (IllegalArgumentException e) { - throw new MojoFailureException("Cannot calculate MD5-summs!", e); + getLog().error("Invalid value for configuration-option \"target\": " + this.target); + getLog().error("Valid values are: NONE, SCRIPT, EXPORT, BOTH"); + throw new MojoExecutionException("Invalid value for configuration-option \"target\""); } - catch (FileNotFoundException e) + Type type = null; + try { - throw new MojoFailureException("Cannot calculate MD5-summs!", e); + type = Type.valueOf(this.type.toUpperCase()); } - catch (IOException e) + catch (IllegalArgumentException e) { - throw new MojoFailureException("Cannot calculate MD5-summs!", e); + getLog().error("Invalid value for configuration-option \"type\": " + this.type); + getLog().error("Valid values are: NONE, CREATE, DROP, BOTH"); + throw new MojoExecutionException("Invalid value for configuration-option \"type\""); } - } - Target target = null; - try - { - target = Target.valueOf(this.target.toUpperCase()); - } - catch (IllegalArgumentException e) - { - getLog().error("Invalid value for configuration-option \"target\": " + this.target); - getLog().error("Valid values are: NONE, SCRIPT, EXPORT, BOTH"); - throw new MojoExecutionException("Invalid value for configuration-option \"target\""); - } - Type type = null; - try - { - type = Type.valueOf(this.type.toUpperCase()); - } - catch (IllegalArgumentException e) - { - getLog().error("Invalid value for configuration-option \"type\": " + this.type); - getLog().error("Valid values are: NONE, CREATE, DROP, BOTH"); - throw new MojoExecutionException("Invalid value for configuration-option \"type\""); - } + if (target.equals(Target.SCRIPT) || target.equals(Target.NONE)) + { + project.getProperties().setProperty(EXPORT_SKIPPED_PROPERTY, "true"); + } + if ( + !modified + && !target.equals(Target.SCRIPT) + && !target.equals(Target.NONE) + && !force + ) + { + 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; + } - if (target.equals(Target.SCRIPT) || target.equals(Target.NONE)) - { - project.getProperties().setProperty(EXPORT_SKIPPED_PROPERTY, "true"); - } - if ( - !modified - && !target.equals(Target.SCRIPT) - && !target.equals(Target.NONE) - && !force - ) - { - 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; - } + getLog().info("Gathered hibernate-configuration (turn on debugging for details):"); + for (Entry entry : properties.entrySet()) + getLog().info(" " + entry.getKey() + " = " + entry.getValue()); - getLog().info("Gathered hibernate-configuration (turn on debugging for details):"); - for (Entry entry : properties.entrySet()) - getLog().info(" " + entry.getKey() + " = " + entry.getValue()); + Environment.verifyProperties( properties ); + ConfigurationHelper.resolvePlaceHolders( properties ); + StandardServiceRegistryImpl registry = + (StandardServiceRegistryImpl) + new StandardServiceRegistryBuilder().applySettings(properties).build(); - Connection connection = null; - try - { - /** - * The connection must be established outside of hibernate, because - * 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) + config.buildMappings(); + + if (envers) { - case EXPORT: - case BOTH: - switch (type) - { - case CREATE: - case DROP: - case BOTH: - 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 " - + properties.getProperty(URL) - + " as " - + properties.getProperty(USERNAME) - + " with password " - + properties.getProperty(PASSWORD) - ); - connection = DriverManager.getConnection( - properties.getProperty(URL), - properties.getProperty(USERNAME), - properties.getProperty(PASSWORD) - ); - } + getLog().info("Automatic auditing via hibernate-envers enabled!"); + AuditConfiguration.getFor(config); } - } - catch (ClassNotFoundException e) - { - getLog().error("Dependency for driver-class " + properties.getProperty(DRIVER_CLASS) + " is missing!"); - throw new MojoExecutionException(e.getMessage()); - } - catch (Exception e) - { - getLog().error("Cannot establish connection to database!"); - Enumeration drivers = DriverManager.getDrivers(); - if (!drivers.hasMoreElements()) - getLog().error("No drivers registered!"); - while (drivers.hasMoreElements()) - getLog().debug("Driver: " + drivers.nextElement()); - throw new MojoExecutionException(e.getMessage()); - } - ClassLoader contextClassLoader = Thread.currentThread().getContextClassLoader(); - MavenLogAppender.startPluginLog(this); - try - { - /** - * Change class-loader of current thread, so that hibernate can - * see all dependencies! - */ - Thread.currentThread().setContextClassLoader(classLoader); - - SchemaExport export = new SchemaExport(config, connection); - export.setOutputFile(outputFile); + SchemaExport export = new SchemaExport(registry, config); 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()) @@ -768,17 +886,6 @@ public class Hbm2DdlMojo extends AbstractMojo /** Restore the old class-loader (TODO: is this really necessary?) */ Thread.currentThread().setContextClassLoader(contextClassLoader); - - /** Close the connection */ - try - { - if (connection != null) - connection.close(); - } - catch (SQLException e) - { - getLog().error("Error while closing connection: " + e.getMessage()); - } } /** Write md5-sums for annotated classes to file */