+ * This parameter defaults to the maven build-output-directory for classes.
+ * Additonally, 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.
+ *
+ * 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 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}"
+ * @parameter property="hibernate.skip" default-value="${maven.test.skip}"
+ * @since 1.0
*/
private boolean skip;
+ /**
+ * Force execution
+ *
+ * Force execution, even if no modified or newly added annotated classes
+ * where found and the dialect was not changed.
+ *
SCRIPT export schema to SQL-script and print it to STDOUT
*
BOTH
*
- * @parameter 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"
+ * @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 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 default-value="${project.build.outputDirectory}/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 default-value=";"
+ * @parameter property="hibernate.export.schema.delimiter" default-value=";"
+ * @since 1.0
*/
private String delimiter;
/**
* Format output-file.
*
- * @parameter 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()
@@ -183,34 +334,187 @@ public class Hbm2DdlMojo extends AbstractMojo
MojoExecutionException
{
if (skip)
+ {
+ getLog().info("Exectuion 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())
+ {
+ try
+ {
+ FileInputStream fis = new FileInputStream(saved);
+ ObjectInputStream ois = new ObjectInputStream(fis);
+ md5s = (HashMap)ois.readObject();
+ ois.close();
+ }
+ catch (Exception e)
+ {
+ md5s = new HashMap();
+ getLog().warn("Cannot read timestamps from saved: " + e);
+ }
+ }
+ else
+ {
+ md5s = new HashMap();
+ try
+ {
+ saved.createNewFile();
+ }
+ catch (IOException e)
+ {
+ getLog().debug("Cannot create file \"" + saved.getPath() + "\" for timestamps: " + e);
+ }
+ }
+
+ ClassLoader classLoader = null;
+ try
+ {
+ 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)
+ {
+ getLog().debug("Dependency: " + classpathFiles.get(i));
+ urls[i] = new File(classpathFiles.get(i)).toURI().toURL();
+ }
+ classLoader = new URLClassLoader(urls, getClass().getClassLoader());
+ }
+ catch (Exception e)
+ {
+ getLog().error("Error while creating ClassLoader!", e);
+ throw new MojoExecutionException(e.getMessage());
+ }
+
+ Set> classes =
+ new TreeSet>(
+ new Comparator>() {
+ @Override
+ public int compare(Class> a, Class> b)
+ {
+ return a.getName().compareTo(b.getName());
+ }
+ }
+ );
- Set classes = new HashSet();
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()))
- classes.addAll(db.getAnnotationIndex().get(Entity.class.getName()));
+ classNames.addAll(db.getAnnotationIndex().get(Entity.class.getName()));
if (db.getAnnotationIndex().containsKey(MappedSuperclass.class.getName()))
- classes.addAll(db.getAnnotationIndex().get(MappedSuperclass.class.getName()));
+ classNames.addAll(db.getAnnotationIndex().get(MappedSuperclass.class.getName()));
if (db.getAnnotationIndex().containsKey(Embeddable.class.getName()))
- classes.addAll(db.getAnnotationIndex().get(Embeddable.class.getName()));
+ classNames.addAll(db.getAnnotationIndex().get(Embeddable.class.getName()));
+
+ MessageDigest digest = java.security.MessageDigest.getInstance("MD5");
+ for (String name : classNames)
+ {
+ 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(resourceName);
+ 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(name) ? "" : md5s.get(name);
+ if (!newMd5.equals(oldMd5))
+ {
+ getLog().debug("Found new or modified annotated class: " + name);
+ modified = true;
+ md5s.put(name, newMd5);
+ }
+ else
+ {
+ getLog().debug(oldMd5 + " -> class unchanged: " + name);
+ }
+ }
}
- catch (IOException e)
+ catch (ClassNotFoundException e)
+ {
+ getLog().error("Error while adding annotated classes!", e);
+ throw new MojoExecutionException(e.getMessage());
+ }
+ catch (Exception e)
{
getLog().error("Error while scanning!", e);
throw new MojoFailureException(e.getMessage());
}
+
if (classes.isEmpty())
- throw new MojoFailureException("No annotated classes found in directory " + outputDirectory);
+ {
+ 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();
@@ -224,7 +528,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)
{
@@ -239,14 +543,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)
@@ -255,14 +555,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)
@@ -271,14 +567,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)
@@ -287,14 +579,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 value " + password
);
else
- getLog().debug(
- "Using the value " + password +
- " from the plugin-configuration-parameter password!"
- );
+ getLog().debug("Using value " + password + " for property " + PASSWORD);
properties.setProperty(PASSWORD, password);
}
if (hibernateDialect != null)
@@ -303,66 +591,178 @@ public class Hbm2DdlMojo extends AbstractMojo
getLog().debug(
"Overwriting property " +
DIALECT + "=" + properties.getProperty(DIALECT) +
- " with the value " + hibernateDialect +
- " from the plugin-configuration-parameter hibernateDialect!"
+ " with value " + hibernateDialect
);
else
getLog().debug(
- "Using the value " + hibernateDialect +
- " from the plugin-configuration-parameter hibernateDialect!"
- );
+ "Using value " + hibernateDialect + " for property " + DIALECT
+ );
properties.setProperty(DIALECT, hibernateDialect);
}
+ 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);
+ }
- getLog().info("Gathered hibernate-configuration (turn on debugging for details):");
- if (properties.isEmpty())
+ /** The generated SQL varies with the dialect! */
+ if (md5s.containsKey(DIALECT))
{
- getLog().error("No properties set!");
- throw new MojoFailureException("Hibernate-Configuration is missing!");
+ String dialect = properties.getProperty(DIALECT);
+ if (md5s.get(DIALECT).equals(dialect))
+ getLog().debug("SQL-dialect unchanged.");
+ else
+ {
+ modified = true;
+ 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));
+ }
}
- for (Entry