X-Git-Url: http://juplo.de/gitweb/?p=hibernate4-maven-plugin;a=blobdiff_plain;f=src%2Fmain%2Fjava%2Fde%2Fjuplo%2Fplugins%2Fhibernate4%2FHbm2DdlMojo.java;h=36a5aca4b4d57058e500f3ff062556a60678bfe9;hp=bc0bc73ad91a362f8effabdfd6adb4f3c25c2225;hb=b6ac188a40136102edc51b6824875dfb07c89955;hpb=55a33e35422b904b974a19d3d6368ded60ea1811 diff --git a/src/main/java/de/juplo/plugins/hibernate4/Hbm2DdlMojo.java b/src/main/java/de/juplo/plugins/hibernate4/Hbm2DdlMojo.java index bc0bc73a..36a5aca4 100644 --- a/src/main/java/de/juplo/plugins/hibernate4/Hbm2DdlMojo.java +++ b/src/main/java/de/juplo/plugins/hibernate4/Hbm2DdlMojo.java @@ -53,6 +53,7 @@ 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.tool.hbm2ddl.SchemaExport; import org.hibernate.tool.hbm2ddl.SchemaExport.Type; import org.hibernate.tool.hbm2ddl.Target; @@ -70,18 +71,23 @@ import org.scannotation.AnnotationDB; */ public class Hbm2DdlMojo extends AbstractMojo { + public final static String EXPORT_SKIPPED_PROPERTY = "hibernate.export.skipped"; + public final static String DRIVER_CLASS = "hibernate.connection.driver_class"; public final static String URL = "hibernate.connection.url"; 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"; private final static String MD5S = "schema.md5s"; /** * The maven project. + *

+ * Only needed internally. * - * @parameter expression="${project}" + * @parameter property="project" * @required * @readonly */ @@ -89,60 +95,117 @@ 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="maven.test.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" + * @author nicus + */ + private String hibernateNamingStrategy; + /** * Path to Hibernate configuration file. * @@ -153,45 +216,47 @@ public class Hbm2DdlMojo extends AbstractMojo /** * Target of execution: *

- * @parameter expression="${hibernate.export.target}" default-value="EXPORT" + * + * @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" + * + * @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; @@ -205,6 +270,7 @@ public class Hbm2DdlMojo extends AbstractMojo if (skip) { getLog().info("Exectuion of hibernate4-maven-plugin:export was skipped!"); + project.getProperties().setProperty(EXPORT_SKIPPED_PROPERTY, "true"); return; } @@ -249,6 +315,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,6 +348,15 @@ public class Hbm2DdlMojo extends AbstractMojo 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()) + throw new MojoExecutionException("Cannot scan for annotated test-classes in " + testOutputDirectory + ": directory does not exist!"); + getLog().info("Scanning directory " + testOutputDirectory + " for annotated classes..."); + dirUrl = dir.toURI().toURL(); + db.scanArchives(dirUrl); + } Set classNames = new HashSet(); if (db.getAnnotationIndex().containsKey(Entity.class.getName())) @@ -349,7 +426,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) { @@ -364,14 +441,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) @@ -380,14 +453,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) @@ -396,14 +465,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) @@ -412,14 +477,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) @@ -428,16 +489,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)) @@ -458,25 +527,32 @@ public class Hbm2DdlMojo extends AbstractMojo md5s.put(DIALECT, properties.getProperty(DIALECT)); } - if (!modified) - { - getLog().info("No modified annotated classes found and dialect unchanged."); - getLog().info("Skipping schema generation!"); - project.getProperties().setProperty("hibernate.export.skipped", "true"); - return; - } - - getLog().info("Gathered hibernate-configuration (turn on debugging for details):"); if (properties.isEmpty()) { getLog().error("No properties set!"); throw new MojoFailureException("Hibernate-Configuration is missing!"); } - for (Entry entry : properties.entrySet()) - getLog().info(" " + entry.getKey() + " = " + entry.getValue()); 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) { @@ -487,7 +563,7 @@ public class Hbm2DdlMojo extends AbstractMojo Target target = null; try { - target = Target.valueOf(this.target); + target = Target.valueOf(this.target.toUpperCase()); } catch (IllegalArgumentException e) { @@ -498,7 +574,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,6 +583,27 @@ public class Hbm2DdlMojo extends AbstractMojo 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 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()); + Connection connection = null; try { @@ -524,17 +621,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) @@ -578,7 +686,8 @@ public class Hbm2DdlMojo extends AbstractMojo /** Close the connection */ try { - connection.close(); + if (connection != null) + connection.close(); } catch (SQLException e) {