import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.project.MavenProject;
import org.hibernate.cfg.Configuration;
+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 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 ENVERS = "hibernate.export.envers";
private final static String MD5S = "schema.md5s";
/**
* The maven project.
+ * <p>
+ * Only needed internally.
*
* @parameter expression="${project}"
* @required
/**
* Build-directory.
+ * <p>
+ * Only needed internally.
*
* @parameter expression="${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}"
*/
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 expression="${hibernate.export.scann_testclasses}" default-value="false"
+ */
+ private boolean scanTestClasses;
+
+ /**
+ * 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 expression="${project.build.testOutputDirectory}"
+ */
+ 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"
*/
* Force execution
* <p>
* Force execution, even if no modified or newly added annotated classes
- * where found. <code>skip</code> takes precedence over <code>force</code>.
+ * where found and the dialect was not changed.
+ * <p>
+ * <code>skip</code> takes precedence over <code>force</code>.
*
* @parameter expression="${hibernate.export.force}" default-value="false"
*/
*/
private String hibernateDialect;
+ /**
+ * Generate envers schema for auditing tables.
+ *
+ * @parameter expression="${hibernate.export.envers}" default-value="false"
+ */
+ private Boolean envers;
+
/**
* Path to Hibernate configuration file.
*
/**
* 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>NONE</strong> do nothing - just validate the configuration (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</li>
* <li><strong>BOTH</strong></li>
* </ul>
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"
*/
{
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)
{
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<String> classNames = new HashSet<String>();
if (db.getAnnotationIndex().containsKey(Entity.class.getName()))
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 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)
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);
+ properties.setProperty(DIALECT, hibernateDialect);
+ }
+ if (envers != null)
+ {
+ if (properties.containsKey(ENVERS))
getLog().debug(
- "Using the value " + hibernateDialect +
- " from the plugin-configuration-parameter hibernateDialect!"
+ "Overwriting property " +
+ ENVERS + "=" + properties.getProperty(ENVERS) +
+ " with the value " + envers
);
- properties.setProperty(DIALECT, hibernateDialect);
+ else
+ getLog().debug("Using the value " + envers);
+ properties.setProperty(ENVERS, envers.toString());
}
+
/** The generated SQL varies with the dialect! */
if (md5s.containsKey(DIALECT))
{
md5s.put(DIALECT, properties.getProperty(DIALECT));
}
+ /** The generated SQL varies with the envers-configuration! */
+ if (md5s.containsKey(ENVERS))
+ {
+ String envers = properties.getProperty(ENVERS);
+ if (md5s.get(ENVERS).equals(envers))
+ getLog().debug("Envers-configuration unchanged.");
+ else
+ {
+ getLog().debug("Envers-configuration changed: " + envers);
+ modified = true;
+ md5s.put(ENVERS, envers.toString());
+ }
+ }
+ else
+ {
+ modified = true;
+ md5s.put(ENVERS, properties.getProperty(ENVERS));
+ }
+
if (properties.isEmpty())
{
getLog().error("No properties set!");
getLog().debug("Class " + annotatedClass);
config.addAnnotatedClass(annotatedClass);
}
+ if ("true".equals(properties.getProperty(ENVERS)))
+ {
+ config.buildMappings();
+ getLog().debug("Using envers");
+ AuditConfiguration.getFor(config);
+ }
+
Target target = null;
try
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)
/** Close the connection */
try
{
- connection.close();
+ if (connection != null)
+ connection.close();
}
catch (SQLException e)
{
projects / hibernate4-maven-plugin / blobdiff