import com.pyx4j.log4j.MavenLogAppender;
import java.io.File;
import java.io.FileInputStream;
+import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
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.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.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;
*/
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";
+ public final static String ENVERS = "hibernate.export.envers";
+
+ public final static String MD5S = "schema.md5s";
+
+ private final static Pattern split = Pattern.compile("[^,\\s]+");
- private final static String MD5S = "schema.md5s";
/**
* The maven project.
+ * <p>
+ * Only needed internally.
*
- * @parameter expression="${project}"
+ * @parameter property="project"
* @required
* @readonly
*/
/**
* Build-directory.
+ * <p>
+ * 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.
+ * <p>
+ * 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"
+ * @since 1.0
*/
private String outputDirectory;
+ /**
+ * Wether to scan test-classes too, or not.
+ * <p>
+ * If this parameter is set to <code>true</code> 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.
+ * <p>
+ * By default, only dependencies in the scope <code>compile</code> are
+ * scanned for annotated classes. Multiple scopes can be seperated by
+ * white space or commas.
+ * <p>
+ * 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.
+ * <p>
+ * This parameter defaults to the maven build-output-directory for
+ * test-classes.
+ * <p>
+ * This parameter is only used, when <code>scanTestClasses</code> is set
+ * to <code>true</code>!
+ *
+ * @parameter property="project.build.testOutputDirectory"
+ * @since 1.0.2
+ */
+ private String testOutputDirectory;
+
/**
* Skip execution
+ * <p>
+ * If set to <code>true</code>, the execution is skipped.
+ * <p>
+ * A skipped excecution is signaled via the maven-property
+ * <code>${hibernate.export.skipped}</code>.
+ * <p>
+ * 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"
+ * @since 1.0
*/
private boolean skip;
+ /**
+ * Force execution
+ * <p>
+ * Force execution, even if no modified or newly added annotated classes
+ * where found and the dialect was not changed.
+ * <p>
+ * <code>skip</code> takes precedence over <code>force</code>.
+ *
+ * @parameter property="hibernate.export.force" default-value="false"
+ * @since 1.0
+ */
+ private boolean force;
+
/**
* SQL-Driver name.
*
- * @parameter expression="${hibernate.connection.driver_class}
+ * @parameter property="hibernate.connection.driver_class"
+ * @since 1.0
*/
private String driverClassName;
/**
* Database URL.
*
- * @parameter expression="${hibernate.connection.url}"
+ * @parameter property="hibernate.connection.url"
+ * @since 1.0
*/
private String url;
/**
* Database username
*
- * @parameter expression="${hibernate.connection.username}"
+ * @parameter property="hibernate.connection.username"
+ * @since 1.0
*/
private String username;
/**
* Database password
*
- * @parameter expression="${hibernate.connection.password}"
+ * @parameter property="hibernate.connection.password"
+ * @since 1.0
*/
private String password;
/**
* Hibernate dialect.
*
- * @parameter expression="${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;
+
/**
* Path to Hibernate configuration file.
*
* @parameter default-value="${project.build.outputDirectory}/hibernate.properties"
+ * @since 1.0
*/
private String hibernateProperties;
+ /**
+ * List of Hibernate-Mapping-Files (XML).
+ * 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:
* <ul>
- * <li><strong>NONE</strong> do nothing - just validate the configuration</li>
- * <li><strong>EXPORT</strong> create database <strong>(DEFAULT!)</strong></li>
- * <li><strong>SCRIPT</strong> export schema to SQL-script</li>
+ * <li><strong>NONE</strong> only export schema to SQL-script (forces excecution, signals skip)</li>
+ * <li><strong>EXPORT</strong> create database (<strong>DEFAULT!</strong>). forces excecution, signals skip)</li>
+ * <li><strong>SCRIPT</strong> export schema to SQL-script and print it to STDOUT</li>
* <li><strong>BOTH</strong></li>
* </ul>
- * @parameter expression="${hibernate.export.target}" 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.
* <ul>
* <li><strong>NONE</strong> do nothing - just validate the configuration</li>
* <li><strong>CREATE</strong> create database-schema</li>
* <li><strong>DROP</strong> drop database-schema</li>
- * <li><strong>BOTH</strong> <strong>(DEFAULT!)</strong></li>
+ * <li><strong>BOTH</strong> (<strong>DEFAULT!</strong>)</li>
* </ul>
- * @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()
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<String,String> md5s;
boolean modified = false;
File saved = new File(buildDirectory + File.separator + MD5S);
}
catch (IOException e)
{
- getLog().warn("Cannot create saved for timestamps: " + e);
+ getLog().debug("Cannot create file \"" + saved.getPath() + "\" for timestamps: " + e);
}
}
{
getLog().debug("Creating ClassLoader for project-dependencies...");
List<String> classpathFiles = project.getCompileClasspathElements();
+ if (scanTestClasses)
+ classpathFiles.addAll(project.getTestClasspathElements());
URL[] urls = new URL[classpathFiles.size()];
for (int i = 0; i < classpathFiles.size(); ++i)
{
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<String> classNames = new HashSet<String>();
if (db.getAnnotationIndex().containsKey(Entity.class.getName()))
{
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)
}
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();
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)
{
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)
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)
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)
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)
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);
+ }
/** The generated SQL varies with the dialect! */
if (md5s.containsKey(DIALECT))
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 (!modified)
+ /** The generated SQL varies with the envers-configuration */
+ if (md5s.get(ENVERS) != null)
{
- getLog().info("No modified annotated classes found and dialect unchanged.");
- getLog().info("Skipping schema generation!");
- project.getProperties().setProperty("hibernate.export.skipped", "true");
- return;
+ 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(ENVERS, Boolean.toString(envers));
}
- 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<Object,Object> 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<NamingStrategy> namingStrategyClass = (Class<NamingStrategy>) 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)
{
config.addAnnotatedClass(annotatedClass);
}
+ if (hibernateMapping != null)
+ {
+ try
+ {
+ MessageDigest digest = java.security.MessageDigest.getInstance("MD5");
+ for (String filename : hibernateMapping.split("[\\s,]+"))
+ {
+ // First try the filename as absolute/relative path
+ File file = new File(filename);
+ if (!file.exists())
+ {
+ // 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))
+ {
+ 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
+ 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-summs!", e);
+ }
+ catch (FileNotFoundException e)
+ {
+ throw new MojoFailureException("Cannot calculate MD5-summs!", e);
+ }
+ catch (IOException e)
+ {
+ throw new MojoFailureException("Cannot calculate MD5-summs!", e);
+ }
+ }
+
Target target = null;
try
{
- target = Target.valueOf(this.target);
+ target = Target.valueOf(this.target.toUpperCase());
}
catch (IllegalArgumentException e)
{
Type type = null;
try
{
- type = Type.valueOf(this.type);
+ type = Type.valueOf(this.type.toUpperCase());
}
catch (IllegalArgumentException e)
{
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;
+ }
+
+ getLog().info("Gathered hibernate-configuration (turn on debugging for details):");
+ for (Entry<Object,Object> entry : properties.entrySet())
+ getLog().info(" " + entry.getKey() + " = " + entry.getValue());
+
Connection connection = null;
try
{
* 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)
{
case EXPORT:
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)
*/
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);
/** Close the connection */
try
{
- connection.close();
+ if (connection != null)
+ connection.close();
}
catch (SQLException e)
{
projects / hibernate4-maven-plugin / blobdiff