1 package de.juplo.plugins.hibernate4;
4 * Copyright 2001-2005 The Apache Software Foundation.
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
19 import com.pyx4j.log4j.MavenLogAppender;
21 import java.io.FileInputStream;
22 import java.io.FileOutputStream;
23 import java.io.IOException;
24 import java.io.InputStream;
25 import java.io.ObjectInputStream;
26 import java.io.ObjectOutputStream;
27 import java.math.BigInteger;
29 import java.net.URLClassLoader;
30 import java.security.MessageDigest;
31 import java.sql.Connection;
32 import java.sql.Driver;
33 import java.sql.DriverManager;
34 import java.sql.DriverPropertyInfo;
35 import java.sql.SQLException;
36 import java.sql.SQLFeatureNotSupportedException;
37 import java.util.Comparator;
38 import java.util.Enumeration;
39 import java.util.HashMap;
40 import java.util.HashSet;
41 import java.util.List;
43 import java.util.Map.Entry;
44 import java.util.Properties;
46 import java.util.TreeSet;
47 import java.util.logging.Logger;
48 import javax.persistence.Embeddable;
49 import javax.persistence.Entity;
50 import javax.persistence.MappedSuperclass;
51 import org.apache.maven.plugin.AbstractMojo;
52 import org.apache.maven.plugin.MojoExecutionException;
53 import org.apache.maven.plugin.MojoFailureException;
54 import org.apache.maven.project.MavenProject;
55 import org.hibernate.cfg.Configuration;
56 import org.hibernate.envers.configuration.AuditConfiguration;
57 import org.hibernate.tool.hbm2ddl.SchemaExport;
58 import org.hibernate.tool.hbm2ddl.SchemaExport.Type;
59 import org.hibernate.tool.hbm2ddl.Target;
60 import org.scannotation.AnnotationDB;
64 * Goal which extracts the hibernate-mapping-configuration and
65 * exports an according SQL-database-schema.
68 * @phase process-classes
70 * @requiresDependencyResolution runtime
72 public class Hbm2DdlMojo extends AbstractMojo
74 public final static String EXPORT_SKIPPED_PROPERTY = "hibernate.export.skipped";
76 public final static String DRIVER_CLASS = "hibernate.connection.driver_class";
77 public final static String URL = "hibernate.connection.url";
78 public final static String USERNAME = "hibernate.connection.username";
79 public final static String PASSWORD = "hibernate.connection.password";
80 public final static String DIALECT = "hibernate.dialect";
81 public final static String ENVERS = "hibernate.export.envers";
83 private final static String MD5S = "schema.md5s";
88 * Only needed internally.
90 * @parameter expression="${project}"
94 private MavenProject project;
99 * Only needed internally.
101 * @parameter expression="${project.build.directory}"
105 private String buildDirectory;
108 * Classes-Directory to scan.
110 * This parameter defaults to the maven build-output-directory for classes.
111 * Additonally, all dependencies are scanned for annotated classes.
113 * @parameter expression="${project.build.outputDirectory}"
115 private String outputDirectory;
118 * Wether to scan test-classes too, or not.
120 * If this parameter is set to <code>true</code> the test-classes of the
121 * artifact will be scanned for hibernate-annotated classes additionally.
123 * @parameter expression="${hibernate.export.scann_testclasses}" default-value="false"
125 private boolean scanTestClasses;
128 * Test-Classes-Directory to scan.
130 * This parameter defaults to the maven build-output-directory for
133 * This parameter is only used, when <code>scanTestClasses</code> is set
134 * to <code>true</code>!
136 * @parameter expression="${project.build.testOutputDirectory}"
138 private String testOutputDirectory;
143 * If set to <code>true</code>, the execution is skipped.
145 * A skipped excecution is signaled via the maven-property
146 * <code>${hibernate.export.skipped}</code>.
148 * The excecution is skipped automatically, if no modified or newly added
149 * annotated classes are found and the dialect was not changed.
151 * @parameter expression="${maven.test.skip}" default-value="false"
153 private boolean skip;
158 * Force execution, even if no modified or newly added annotated classes
159 * where found and the dialect was not changed.
161 * <code>skip</code> takes precedence over <code>force</code>.
163 * @parameter expression="${hibernate.export.force}" default-value="false"
165 private boolean force;
170 * @parameter expression="${hibernate.connection.driver_class}
172 private String driverClassName;
177 * @parameter expression="${hibernate.connection.url}"
184 * @parameter expression="${hibernate.connection.username}"
186 private String username;
191 * @parameter expression="${hibernate.connection.password}"
193 private String password;
198 * @parameter expression="${hibernate.dialect}"
200 private String hibernateDialect;
203 * Generate envers schema for auditing tables.
205 * @parameter expression="${hibernate.export.envers}" default-value="false"
207 private Boolean envers;
210 * Path to Hibernate configuration file.
212 * @parameter default-value="${project.build.outputDirectory}/hibernate.properties"
214 private String hibernateProperties;
217 * Target of execution:
219 * <li><strong>NONE</strong> do nothing - just validate the configuration (forces excecution, signals skip)</li>
220 * <li><strong>EXPORT</strong> create database (<strong>DEFAULT!</strong>. forces excecution, signals skip)</li>
221 * <li><strong>SCRIPT</strong> export schema to SQL-script</li>
222 * <li><strong>BOTH</strong></li>
224 * @parameter expression="${hibernate.export.target}" default-value="EXPORT"
226 private String target;
231 * <li><strong>NONE</strong> do nothing - just validate the configuration</li>
232 * <li><strong>CREATE</strong> create database-schema</li>
233 * <li><strong>DROP</strong> drop database-schema</li>
234 * <li><strong>BOTH</strong> (<strong>DEFAULT!</strong>)</li>
236 * @parameter expression="${hibernate.export.type}" default-value="BOTH"
243 * @parameter expression="${hibernate.export.schema.filename}" default-value="${project.build.directory}/schema.sql"
245 private String outputFile;
248 * Delimiter in output-file.
250 * @parameter expression="${hibernate.export.schema.delimiter}" default-value=";"
252 private String delimiter;
255 * Format output-file.
257 * @parameter expression="${hibernate.export.schema.format}" default-value="true"
259 private boolean format;
263 public void execute()
265 MojoFailureException,
266 MojoExecutionException
270 getLog().info("Exectuion of hibernate4-maven-plugin:export was skipped!");
271 project.getProperties().setProperty(EXPORT_SKIPPED_PROPERTY, "true");
275 File dir = new File(outputDirectory);
277 throw new MojoExecutionException("Cannot scan for annotated classes in " + outputDirectory + ": directory does not exist!");
279 Map<String,String> md5s;
280 boolean modified = false;
281 File saved = new File(buildDirectory + File.separator + MD5S);
287 FileInputStream fis = new FileInputStream(saved);
288 ObjectInputStream ois = new ObjectInputStream(fis);
289 md5s = (HashMap<String,String>)ois.readObject();
294 md5s = new HashMap<String,String>();
295 getLog().warn("Cannot read timestamps from saved: " + e);
300 md5s = new HashMap<String,String>();
303 saved.createNewFile();
305 catch (IOException e)
307 getLog().warn("Cannot create saved for timestamps: " + e);
311 ClassLoader classLoader = null;
314 getLog().debug("Creating ClassLoader for project-dependencies...");
315 List<String> classpathFiles = project.getCompileClasspathElements();
317 classpathFiles.addAll(project.getTestClasspathElements());
318 URL[] urls = new URL[classpathFiles.size()];
319 for (int i = 0; i < classpathFiles.size(); ++i)
321 getLog().debug("Dependency: " + classpathFiles.get(i));
322 urls[i] = new File(classpathFiles.get(i)).toURI().toURL();
324 classLoader = new URLClassLoader(urls, getClass().getClassLoader());
328 getLog().error("Error while creating ClassLoader!", e);
329 throw new MojoExecutionException(e.getMessage());
332 Set<Class<?>> classes =
333 new TreeSet<Class<?>>(
334 new Comparator<Class<?>>() {
336 public int compare(Class<?> a, Class<?> b)
338 return a.getName().compareTo(b.getName());
345 AnnotationDB db = new AnnotationDB();
346 getLog().info("Scanning directory " + outputDirectory + " for annotated classes...");
347 URL dirUrl = dir.toURI().toURL();
348 db.scanArchives(dirUrl);
351 dir = new File(testOutputDirectory);
353 throw new MojoExecutionException("Cannot scan for annotated test-classes in " + testOutputDirectory + ": directory does not exist!");
354 getLog().info("Scanning directory " + testOutputDirectory + " for annotated classes...");
355 dirUrl = dir.toURI().toURL();
356 db.scanArchives(dirUrl);
359 Set<String> classNames = new HashSet<String>();
360 if (db.getAnnotationIndex().containsKey(Entity.class.getName()))
361 classNames.addAll(db.getAnnotationIndex().get(Entity.class.getName()));
362 if (db.getAnnotationIndex().containsKey(MappedSuperclass.class.getName()))
363 classNames.addAll(db.getAnnotationIndex().get(MappedSuperclass.class.getName()));
364 if (db.getAnnotationIndex().containsKey(Embeddable.class.getName()))
365 classNames.addAll(db.getAnnotationIndex().get(Embeddable.class.getName()));
367 MessageDigest digest = java.security.MessageDigest.getInstance("MD5");
368 for (String name : classNames)
370 Class<?> annotatedClass = classLoader.loadClass(name);
371 classes.add(annotatedClass);
374 .getResourceAsStream(annotatedClass.getSimpleName() + ".class");
375 byte[] buffer = new byte[1024*4]; // copy data in 4MB-chunks
377 while((i = is.read(buffer)) > -1)
378 digest.update(buffer, 0, i);
380 byte[] bytes = digest.digest();
381 BigInteger bi = new BigInteger(1, bytes);
382 String newMd5 = String.format("%0" + (bytes.length << 1) + "x", bi);
383 String oldMd5 = !md5s.containsKey(name) ? "" : md5s.get(name);
384 if (!newMd5.equals(oldMd5))
386 getLog().debug("Found new or modified annotated class: " + name);
388 md5s.put(name, newMd5);
392 getLog().debug(oldMd5 + " -> class unchanged: " + name);
396 catch (ClassNotFoundException e)
398 getLog().error("Error while adding annotated classes!", e);
399 throw new MojoExecutionException(e.getMessage());
403 getLog().error("Error while scanning!", e);
404 throw new MojoFailureException(e.getMessage());
407 if (classes.isEmpty())
408 throw new MojoFailureException("No annotated classes found in directory " + outputDirectory);
410 getLog().debug("Detected classes with mapping-annotations:");
411 for (Class<?> annotatedClass : classes)
412 getLog().debug(" " + annotatedClass.getName());
415 Properties properties = new Properties();
417 /** Try to read configuration from properties-file */
420 File file = new File(hibernateProperties);
423 getLog().info("Reading properties from file " + hibernateProperties + "...");
424 properties.load(new FileInputStream(file));
427 getLog().info("No hibernate-properties-file found! (Checked path: " + hibernateProperties + ")");
429 catch (IOException e)
431 getLog().error("Error while reading properties!", e);
432 throw new MojoExecutionException(e.getMessage());
435 /** Overwrite values from propertie-file or set, if given */
436 if (driverClassName != null)
438 if (properties.containsKey(DRIVER_CLASS))
440 "Overwriting property " +
441 DRIVER_CLASS + "=" + properties.getProperty(DRIVER_CLASS) +
442 " with the value " + driverClassName
445 getLog().debug("Using the value " + driverClassName);
446 properties.setProperty(DRIVER_CLASS, driverClassName);
450 if (properties.containsKey(URL))
452 "Overwriting property " +
453 URL + "=" + properties.getProperty(URL) +
454 " with the value " + url
457 getLog().debug("Using the value " + url);
458 properties.setProperty(URL, url);
460 if (username != null)
462 if (properties.containsKey(USERNAME))
464 "Overwriting property " +
465 USERNAME + "=" + properties.getProperty(USERNAME) +
466 " with the value " + username
469 getLog().debug("Using the value " + username);
470 properties.setProperty(USERNAME, username);
472 if (password != null)
474 if (properties.containsKey(PASSWORD))
476 "Overwriting property " +
477 PASSWORD + "=" + properties.getProperty(PASSWORD) +
478 " with the value " + password
481 getLog().debug("Using the value " + password);
482 properties.setProperty(PASSWORD, password);
484 if (hibernateDialect != null)
486 if (properties.containsKey(DIALECT))
488 "Overwriting property " +
489 DIALECT + "=" + properties.getProperty(DIALECT) +
490 " with the value " + hibernateDialect
493 getLog().debug("Using the value " + hibernateDialect);
494 properties.setProperty(DIALECT, hibernateDialect);
498 if (properties.containsKey(ENVERS))
500 "Overwriting property " +
501 ENVERS + "=" + properties.getProperty(ENVERS) +
502 " with the value " + envers
505 getLog().debug("Using the value " + envers);
506 properties.setProperty(ENVERS, envers.toString());
510 /** The generated SQL varies with the dialect! */
511 if (md5s.containsKey(DIALECT))
513 String dialect = properties.getProperty(DIALECT);
514 if (md5s.get(DIALECT).equals(dialect))
515 getLog().debug("SQL-dialect unchanged.");
518 getLog().debug("SQL-dialect changed: " + dialect);
520 md5s.put(DIALECT, dialect);
526 md5s.put(DIALECT, properties.getProperty(DIALECT));
529 /** The generated SQL varies with the envers-configuration! */
530 if (md5s.containsKey(ENVERS))
532 String envers = properties.getProperty(ENVERS);
533 if (md5s.get(ENVERS).equals(envers))
534 getLog().debug("Envers-configuration unchanged.");
537 getLog().debug("Envers-configuration changed: " + envers);
539 md5s.put(ENVERS, envers.toString());
545 md5s.put(ENVERS, properties.getProperty(ENVERS));
548 if (properties.isEmpty())
550 getLog().error("No properties set!");
551 throw new MojoFailureException("Hibernate-Configuration is missing!");
554 Configuration config = new Configuration();
555 config.setProperties(properties);
556 getLog().debug("Adding annotated classes to hibernate-mapping-configuration...");
557 for (Class<?> annotatedClass : classes)
559 getLog().debug("Class " + annotatedClass);
560 config.addAnnotatedClass(annotatedClass);
562 if ("true".equals(properties.getProperty(ENVERS)))
564 config.buildMappings();
565 getLog().debug("Using envers");
566 AuditConfiguration.getFor(config);
570 Target target = null;
573 target = Target.valueOf(this.target.toUpperCase());
575 catch (IllegalArgumentException e)
577 getLog().error("Invalid value for configuration-option \"target\": " + this.target);
578 getLog().error("Valid values are: NONE, SCRIPT, EXPORT, BOTH");
579 throw new MojoExecutionException("Invalid value for configuration-option \"target\"");
584 type = Type.valueOf(this.type.toUpperCase());
586 catch (IllegalArgumentException e)
588 getLog().error("Invalid value for configuration-option \"type\": " + this.type);
589 getLog().error("Valid values are: NONE, CREATE, DROP, BOTH");
590 throw new MojoExecutionException("Invalid value for configuration-option \"type\"");
593 if (target.equals(Target.SCRIPT) || target.equals(Target.NONE))
595 project.getProperties().setProperty(EXPORT_SKIPPED_PROPERTY, "true");
599 && !target.equals(Target.SCRIPT)
600 && !target.equals(Target.NONE)
604 getLog().info("No modified annotated classes found and dialect unchanged.");
605 getLog().info("Skipping schema generation!");
606 project.getProperties().setProperty(EXPORT_SKIPPED_PROPERTY, "true");
610 getLog().info("Gathered hibernate-configuration (turn on debugging for details):");
611 for (Entry<Object,Object> entry : properties.entrySet())
612 getLog().info(" " + entry.getKey() + " = " + entry.getValue());
614 Connection connection = null;
618 * The connection must be established outside of hibernate, because
619 * hibernate does not use the context-classloader of the current
620 * thread and, hence, would not be able to resolve the driver-class!
631 Class driverClass = classLoader.loadClass(properties.getProperty(DRIVER_CLASS));
632 getLog().debug("Registering JDBC-driver " + driverClass.getName());
633 DriverManager.registerDriver(new DriverProxy((Driver)driverClass.newInstance()));
635 "Opening JDBC-connection to "
636 + properties.getProperty(URL)
638 + properties.getProperty(USERNAME)
640 + properties.getProperty(PASSWORD)
642 connection = DriverManager.getConnection(
643 properties.getProperty(URL),
644 properties.getProperty(USERNAME),
645 properties.getProperty(PASSWORD)
650 catch (ClassNotFoundException e)
652 getLog().error("Dependency for driver-class " + properties.getProperty(DRIVER_CLASS) + " is missing!");
653 throw new MojoExecutionException(e.getMessage());
657 getLog().error("Cannot establish connection to database!");
658 Enumeration<Driver> drivers = DriverManager.getDrivers();
659 if (!drivers.hasMoreElements())
660 getLog().error("No drivers registered!");
661 while (drivers.hasMoreElements())
662 getLog().debug("Driver: " + drivers.nextElement());
663 throw new MojoExecutionException(e.getMessage());
666 ClassLoader contextClassLoader = Thread.currentThread().getContextClassLoader();
667 MavenLogAppender.startPluginLog(this);
671 * Change class-loader of current thread, so that hibernate can
672 * see all dependencies!
674 Thread.currentThread().setContextClassLoader(classLoader);
676 SchemaExport export = new SchemaExport(config, connection);
677 export.setOutputFile(outputFile);
678 export.setDelimiter(delimiter);
679 export.setFormat(format);
680 export.execute(target, type);
682 for (Object exception : export.getExceptions())
683 getLog().debug(exception.toString());
687 /** Stop Log-Capturing */
688 MavenLogAppender.endPluginLog(this);
690 /** Restore the old class-loader (TODO: is this really necessary?) */
691 Thread.currentThread().setContextClassLoader(contextClassLoader);
693 /** Close the connection */
696 if (connection != null)
699 catch (SQLException e)
701 getLog().error("Error while closing connection: " + e.getMessage());
705 /** Write md5-sums for annotated classes to file */
708 FileOutputStream fos = new FileOutputStream(saved);
709 ObjectOutputStream oos = new ObjectOutputStream(fos);
710 oos.writeObject(md5s);
716 getLog().error("Cannot write md5-sums to file: " + e);
721 * Needed, because DriverManager won't pick up drivers, that were not
722 * loaded by the system-classloader!
724 * http://stackoverflow.com/questions/288828/how-to-use-a-jdbc-driver-fromodifiedm-an-arbitrary-location
726 static final class DriverProxy implements Driver
728 private final Driver target;
730 DriverProxy(Driver target)
733 throw new NullPointerException();
734 this.target = target;
737 public java.sql.Driver getTarget()
743 public boolean acceptsURL(String url) throws SQLException
745 return target.acceptsURL(url);
749 public java.sql.Connection connect(
751 java.util.Properties info
756 return target.connect(url, info);
760 public int getMajorVersion()
762 return target.getMajorVersion();
766 public int getMinorVersion()
768 return target.getMinorVersion();
772 public DriverPropertyInfo[] getPropertyInfo(
779 return target.getPropertyInfo(url, info);
783 public boolean jdbcCompliant()
785 return target.jdbcCompliant();
789 * This Method cannot be annotated with @Override, becaus the plugin
790 * will not compile then under Java 1.6!
792 public Logger getParentLogger() throws SQLFeatureNotSupportedException
794 throw new SQLFeatureNotSupportedException("Not supported, for backward-compatibility with Java 1.6");
798 public String toString()
800 return "Proxy: " + target;
804 public int hashCode()
806 return target.hashCode();
810 public boolean equals(Object obj)
812 if (!(obj instanceof DriverProxy))
814 DriverProxy other = (DriverProxy) obj;
815 return this.target.equals(other.target);