+ * This parameter defaults to the maven build-output-directory for classes.
+ * Additionally, all dependencies are scanned for annotated classes.
*
- * @parameter expression="${project.build.outputDirectory}"
+ * @parameter property="project.build.outputDirectory"
+ * @since 1.0
*/
private String outputDirectory;
+ /**
+ * 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.
+ *
+ * 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"
+ * @since 1.0.2
+ */
+ private String testOutputDirectory;
+
/**
* Skip execution
+ *
+ * If set to true, the execution is skipped.
+ *
+ * A skipped execution is signaled via the maven-property
+ * ${hibernate.export.skipped}.
+ *
+ * The execution 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.skip" default-value="${maven.test.skip}"
+ * @since 1.0
*/
private boolean skip;
@@ -114,99 +186,145 @@ public class Hbm2DdlMojo extends AbstractMojo
* Force execution
*
* Force execution, even if no modified or newly added annotated classes
- * where found. skip takes precedence over force.
+ * where found and the dialect was not changed.
+ *
SCRIPT export schema to SQL-script and print it to STDOUT
*
BOTH
*
- * @parameter expression="${hibernate.export.target}" default-value="EXPORT"
+ *
+ * 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;
/**
- * Type of export.
+ * Type of execution.
*
*
NONE do nothing - just validate the configuration
*
CREATE create database-schema
*
DROP drop database-schema
- *
BOTH(DEFAULT!)
+ *
BOTH (DEFAULT!)
*
- * @parameter expression="${hibernate.export.type}" default-value="BOTH"
+ *
+ * If NONE is choosen, no databaseconnection is needed.
+ *
+ * @parameter property="hibernate.export.type" default-value="BOTH"
+ * @since 1.0
*/
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"
+ * @since 1.0
*/
private String outputFile;
/**
* Delimiter in output-file.
*
- * @parameter expression="${hibernate.export.schema.delimiter}" default-value=";"
+ * @parameter property="hibernate.export.schema.delimiter" default-value=";"
+ * @since 1.0
*/
private String delimiter;
/**
* Format output-file.
*
- * @parameter expression="${hibernate.export.schema.format}" default-value="true"
+ * @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()
@@ -216,20 +334,16 @@ 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;
}
- 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);
- if (saved.exists())
+ if (saved.isFile() && saved.length() > 0)
{
try
{
@@ -253,7 +367,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);
}
}
@@ -262,6 +376,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)
{
@@ -290,9 +406,51 @@ 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);
+ }
+ }
+ 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()))
@@ -307,9 +465,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)
@@ -343,11 +503,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();
@@ -370,7 +535,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))
@@ -413,10 +578,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)
@@ -425,12 +590,33 @@ 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 value " + hibernateNamingStrategy
+ );
+ else
+ getLog().debug(
+ "Using value " + hibernateNamingStrategy + " for property " +
+ NAMING_STRATEGY
+ );
+ properties.setProperty(NAMING_STRATEGY, hibernateNamingStrategy);
+ }
/** The generated SQL varies with the dialect! */
if (md5s.containsKey(DIALECT))
@@ -440,118 +626,76 @@ 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
{
- modified = true;
- md5s.put(DIALECT, properties.getProperty(DIALECT));
+ String dialect = properties.getProperty(DIALECT);
+ if (dialect != null)
+ {
+ modified = true;
+ md5s.put(DIALECT, properties.getProperty(DIALECT));
+ }
}
- if (properties.isEmpty())
+ /** The generated SQL varies with the envers-configuration */
+ if (md5s.get(ENVERS) != null)
{
- getLog().error("No properties set!");
- throw new MojoFailureException("Hibernate-Configuration is missing!");
+ 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));
+ }
}
-
- Configuration config = new Configuration();
- config.setProperties(properties);
- getLog().debug("Adding annotated classes to hibernate-mapping-configuration...");
- for (Class> annotatedClass : classes)
+ else
{
- getLog().debug("Class " + annotatedClass);
- config.addAnnotatedClass(annotatedClass);
+ modified = true;
+ md5s.put(ENVERS, Boolean.toString(envers));
}
- 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)
+ if (properties.isEmpty())
{
- 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\"");
+ getLog().error("No properties set!");
+ throw new MojoFailureException("Hibernate configuration is missing!");
}
- 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;
- }
+ final ValidationConfiguration config = new ValidationConfiguration(hibernateDialect);
- getLog().info("Gathered hibernate-configuration (turn on debugging for details):");
- for (Entry