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.tool.hbm2ddl.SchemaExport;
57 import org.hibernate.tool.hbm2ddl.SchemaExport.Type;
58 import org.hibernate.tool.hbm2ddl.Target;
59 import org.scannotation.AnnotationDB;
63 * Goal which extracts the hibernate-mapping-configuration and
64 * exports an according SQL-database-schema.
67 * @phase process-classes
69 * @requiresDependencyResolution runtime
71 public class Hbm2DdlMojo extends AbstractMojo
73 public final static String EXPORT_SKIPPED_PROPERTY = "hibernate.export.skipped";
75 public final static String DRIVER_CLASS = "hibernate.connection.driver_class";
76 public final static String URL = "hibernate.connection.url";
77 public final static String USERNAME = "hibernate.connection.username";
78 public final static String PASSWORD = "hibernate.connection.password";
79 public final static String DIALECT = "hibernate.dialect";
81 private final static String MD5S = "schema.md5s";
86 * Only needed internally.
88 * @parameter property="project"
92 private MavenProject project;
97 * Only needed internally.
99 * @parameter property="project.build.directory"
103 private String buildDirectory;
106 * Classes-Directory to scan.
108 * This parameter defaults to the maven build-output-directory for classes.
109 * Additonally, all dependencies are scanned for annotated classes.
111 * @parameter property="project.build.outputDirectory"
113 private String outputDirectory;
116 * Wether to scan test-classes too, or not.
118 * If this parameter is set to <code>true</code> the test-classes of the
119 * artifact will be scanned for hibernate-annotated classes additionally.
121 * @parameter property="hibernate.export.scan_testclasses" default-value="false"
123 private boolean scanTestClasses;
126 * Test-Classes-Directory to scan.
128 * This parameter defaults to the maven build-output-directory for
131 * This parameter is only used, when <code>scanTestClasses</code> is set
132 * to <code>true</code>!
134 * @parameter property="project.build.testOutputDirectory"
136 private String testOutputDirectory;
141 * If set to <code>true</code>, the execution is skipped.
143 * A skipped excecution is signaled via the maven-property
144 * <code>${hibernate.export.skipped}</code>.
146 * The excecution is skipped automatically, if no modified or newly added
147 * annotated classes are found and the dialect was not changed.
149 * @parameter property="maven.test.skip" default-value="false"
151 private boolean skip;
156 * Force execution, even if no modified or newly added annotated classes
157 * where found and the dialect was not changed.
159 * <code>skip</code> takes precedence over <code>force</code>.
161 * @parameter property="hibernate.export.force" default-value="false"
163 private boolean force;
168 * @parameter property="hibernate.connection.driver_class"
170 private String driverClassName;
175 * @parameter property="hibernate.connection.url"
182 * @parameter property="hibernate.connection.username"
184 private String username;
189 * @parameter property="hibernate.connection.password"
191 private String password;
196 * @parameter property="hibernate.dialect"
198 private String hibernateDialect;
201 * Path to Hibernate configuration file.
203 * @parameter default-value="${project.build.outputDirectory}/hibernate.properties"
205 private String hibernateProperties;
208 * Target of execution:
210 * <li><strong>NONE</strong> do nothing - just validate the configuration (forces excecution, signals skip)</li>
211 * <li><strong>EXPORT</strong> create database (<strong>DEFAULT!</strong>. forces excecution, signals skip)</li>
212 * <li><strong>SCRIPT</strong> export schema to SQL-script</li>
213 * <li><strong>BOTH</strong></li>
216 * @parameter property="hibernate.export.target" default-value="EXPORT"
218 private String target;
223 * <li><strong>NONE</strong> do nothing - just validate the configuration</li>
224 * <li><strong>CREATE</strong> create database-schema</li>
225 * <li><strong>DROP</strong> drop database-schema</li>
226 * <li><strong>BOTH</strong> (<strong>DEFAULT!</strong>)</li>
229 * @parameter property="hibernate.export.type" default-value="BOTH"
236 * @parameter property="hibernate.export.schema.filename" default-value="${project.build.directory}/schema.sql"
238 private String outputFile;
241 * Delimiter in output-file.
243 * @parameter property="hibernate.export.schema.delimiter" default-value=";"
245 private String delimiter;
248 * Format output-file.
250 * @parameter property="hibernate.export.schema.format" default-value="true"
252 private boolean format;
256 public void execute()
258 MojoFailureException,
259 MojoExecutionException
263 getLog().info("Exectuion of hibernate4-maven-plugin:export was skipped!");
264 project.getProperties().setProperty(EXPORT_SKIPPED_PROPERTY, "true");
268 File dir = new File(outputDirectory);
270 throw new MojoExecutionException("Cannot scan for annotated classes in " + outputDirectory + ": directory does not exist!");
272 Map<String,String> md5s;
273 boolean modified = false;
274 File saved = new File(buildDirectory + File.separator + MD5S);
280 FileInputStream fis = new FileInputStream(saved);
281 ObjectInputStream ois = new ObjectInputStream(fis);
282 md5s = (HashMap<String,String>)ois.readObject();
287 md5s = new HashMap<String,String>();
288 getLog().warn("Cannot read timestamps from saved: " + e);
293 md5s = new HashMap<String,String>();
296 saved.createNewFile();
298 catch (IOException e)
300 getLog().warn("Cannot create saved for timestamps: " + e);
304 ClassLoader classLoader = null;
307 getLog().debug("Creating ClassLoader for project-dependencies...");
308 List<String> classpathFiles = project.getCompileClasspathElements();
310 classpathFiles.addAll(project.getTestClasspathElements());
311 URL[] urls = new URL[classpathFiles.size()];
312 for (int i = 0; i < classpathFiles.size(); ++i)
314 getLog().debug("Dependency: " + classpathFiles.get(i));
315 urls[i] = new File(classpathFiles.get(i)).toURI().toURL();
317 classLoader = new URLClassLoader(urls, getClass().getClassLoader());
321 getLog().error("Error while creating ClassLoader!", e);
322 throw new MojoExecutionException(e.getMessage());
325 Set<Class<?>> classes =
326 new TreeSet<Class<?>>(
327 new Comparator<Class<?>>() {
329 public int compare(Class<?> a, Class<?> b)
331 return a.getName().compareTo(b.getName());
338 AnnotationDB db = new AnnotationDB();
339 getLog().info("Scanning directory " + outputDirectory + " for annotated classes...");
340 URL dirUrl = dir.toURI().toURL();
341 db.scanArchives(dirUrl);
344 dir = new File(testOutputDirectory);
346 throw new MojoExecutionException("Cannot scan for annotated test-classes in " + testOutputDirectory + ": directory does not exist!");
347 getLog().info("Scanning directory " + testOutputDirectory + " for annotated classes...");
348 dirUrl = dir.toURI().toURL();
349 db.scanArchives(dirUrl);
352 Set<String> classNames = new HashSet<String>();
353 if (db.getAnnotationIndex().containsKey(Entity.class.getName()))
354 classNames.addAll(db.getAnnotationIndex().get(Entity.class.getName()));
355 if (db.getAnnotationIndex().containsKey(MappedSuperclass.class.getName()))
356 classNames.addAll(db.getAnnotationIndex().get(MappedSuperclass.class.getName()));
357 if (db.getAnnotationIndex().containsKey(Embeddable.class.getName()))
358 classNames.addAll(db.getAnnotationIndex().get(Embeddable.class.getName()));
360 MessageDigest digest = java.security.MessageDigest.getInstance("MD5");
361 for (String name : classNames)
363 Class<?> annotatedClass = classLoader.loadClass(name);
364 classes.add(annotatedClass);
367 .getResourceAsStream(annotatedClass.getSimpleName() + ".class");
368 byte[] buffer = new byte[1024*4]; // copy data in 4MB-chunks
370 while((i = is.read(buffer)) > -1)
371 digest.update(buffer, 0, i);
373 byte[] bytes = digest.digest();
374 BigInteger bi = new BigInteger(1, bytes);
375 String newMd5 = String.format("%0" + (bytes.length << 1) + "x", bi);
376 String oldMd5 = !md5s.containsKey(name) ? "" : md5s.get(name);
377 if (!newMd5.equals(oldMd5))
379 getLog().debug("Found new or modified annotated class: " + name);
381 md5s.put(name, newMd5);
385 getLog().debug(oldMd5 + " -> class unchanged: " + name);
389 catch (ClassNotFoundException e)
391 getLog().error("Error while adding annotated classes!", e);
392 throw new MojoExecutionException(e.getMessage());
396 getLog().error("Error while scanning!", e);
397 throw new MojoFailureException(e.getMessage());
400 if (classes.isEmpty())
401 throw new MojoFailureException("No annotated classes found in directory " + outputDirectory);
403 getLog().debug("Detected classes with mapping-annotations:");
404 for (Class<?> annotatedClass : classes)
405 getLog().debug(" " + annotatedClass.getName());
408 Properties properties = new Properties();
410 /** Try to read configuration from properties-file */
413 File file = new File(hibernateProperties);
416 getLog().info("Reading properties from file " + hibernateProperties + "...");
417 properties.load(new FileInputStream(file));
420 getLog().info("No hibernate-properties-file found! (Checked path: " + hibernateProperties + ")");
422 catch (IOException e)
424 getLog().error("Error while reading properties!", e);
425 throw new MojoExecutionException(e.getMessage());
428 /** Overwrite values from propertie-file or set, if given */
429 if (driverClassName != null)
431 if (properties.containsKey(DRIVER_CLASS))
433 "Overwriting property " +
434 DRIVER_CLASS + "=" + properties.getProperty(DRIVER_CLASS) +
435 " with the value " + driverClassName
438 getLog().debug("Using the value " + driverClassName);
439 properties.setProperty(DRIVER_CLASS, driverClassName);
443 if (properties.containsKey(URL))
445 "Overwriting property " +
446 URL + "=" + properties.getProperty(URL) +
447 " with the value " + url
450 getLog().debug("Using the value " + url);
451 properties.setProperty(URL, url);
453 if (username != null)
455 if (properties.containsKey(USERNAME))
457 "Overwriting property " +
458 USERNAME + "=" + properties.getProperty(USERNAME) +
459 " with the value " + username
462 getLog().debug("Using the value " + username);
463 properties.setProperty(USERNAME, username);
465 if (password != null)
467 if (properties.containsKey(PASSWORD))
469 "Overwriting property " +
470 PASSWORD + "=" + properties.getProperty(PASSWORD) +
471 " with the value " + password
474 getLog().debug("Using the value " + password);
475 properties.setProperty(PASSWORD, password);
477 if (hibernateDialect != null)
479 if (properties.containsKey(DIALECT))
481 "Overwriting property " +
482 DIALECT + "=" + properties.getProperty(DIALECT) +
483 " with the value " + hibernateDialect
486 getLog().debug("Using the value " + hibernateDialect);
487 properties.setProperty(DIALECT, hibernateDialect);
490 /** The generated SQL varies with the dialect! */
491 if (md5s.containsKey(DIALECT))
493 String dialect = properties.getProperty(DIALECT);
494 if (md5s.get(DIALECT).equals(dialect))
495 getLog().debug("SQL-dialect unchanged.");
498 getLog().debug("SQL-dialect changed: " + dialect);
500 md5s.put(DIALECT, dialect);
506 md5s.put(DIALECT, properties.getProperty(DIALECT));
509 if (properties.isEmpty())
511 getLog().error("No properties set!");
512 throw new MojoFailureException("Hibernate-Configuration is missing!");
515 Configuration config = new Configuration();
516 config.setProperties(properties);
517 getLog().debug("Adding annotated classes to hibernate-mapping-configuration...");
518 for (Class<?> annotatedClass : classes)
520 getLog().debug("Class " + annotatedClass);
521 config.addAnnotatedClass(annotatedClass);
524 Target target = null;
527 target = Target.valueOf(this.target.toUpperCase());
529 catch (IllegalArgumentException e)
531 getLog().error("Invalid value for configuration-option \"target\": " + this.target);
532 getLog().error("Valid values are: NONE, SCRIPT, EXPORT, BOTH");
533 throw new MojoExecutionException("Invalid value for configuration-option \"target\"");
538 type = Type.valueOf(this.type.toUpperCase());
540 catch (IllegalArgumentException e)
542 getLog().error("Invalid value for configuration-option \"type\": " + this.type);
543 getLog().error("Valid values are: NONE, CREATE, DROP, BOTH");
544 throw new MojoExecutionException("Invalid value for configuration-option \"type\"");
547 if (target.equals(Target.SCRIPT) || target.equals(Target.NONE))
549 project.getProperties().setProperty(EXPORT_SKIPPED_PROPERTY, "true");
553 && !target.equals(Target.SCRIPT)
554 && !target.equals(Target.NONE)
558 getLog().info("No modified annotated classes found and dialect unchanged.");
559 getLog().info("Skipping schema generation!");
560 project.getProperties().setProperty(EXPORT_SKIPPED_PROPERTY, "true");
564 getLog().info("Gathered hibernate-configuration (turn on debugging for details):");
565 for (Entry<Object,Object> entry : properties.entrySet())
566 getLog().info(" " + entry.getKey() + " = " + entry.getValue());
568 Connection connection = null;
572 * The connection must be established outside of hibernate, because
573 * hibernate does not use the context-classloader of the current
574 * thread and, hence, would not be able to resolve the driver-class!
585 Class driverClass = classLoader.loadClass(properties.getProperty(DRIVER_CLASS));
586 getLog().debug("Registering JDBC-driver " + driverClass.getName());
587 DriverManager.registerDriver(new DriverProxy((Driver)driverClass.newInstance()));
589 "Opening JDBC-connection to "
590 + properties.getProperty(URL)
592 + properties.getProperty(USERNAME)
594 + properties.getProperty(PASSWORD)
596 connection = DriverManager.getConnection(
597 properties.getProperty(URL),
598 properties.getProperty(USERNAME),
599 properties.getProperty(PASSWORD)
604 catch (ClassNotFoundException e)
606 getLog().error("Dependency for driver-class " + properties.getProperty(DRIVER_CLASS) + " is missing!");
607 throw new MojoExecutionException(e.getMessage());
611 getLog().error("Cannot establish connection to database!");
612 Enumeration<Driver> drivers = DriverManager.getDrivers();
613 if (!drivers.hasMoreElements())
614 getLog().error("No drivers registered!");
615 while (drivers.hasMoreElements())
616 getLog().debug("Driver: " + drivers.nextElement());
617 throw new MojoExecutionException(e.getMessage());
620 ClassLoader contextClassLoader = Thread.currentThread().getContextClassLoader();
621 MavenLogAppender.startPluginLog(this);
625 * Change class-loader of current thread, so that hibernate can
626 * see all dependencies!
628 Thread.currentThread().setContextClassLoader(classLoader);
630 SchemaExport export = new SchemaExport(config, connection);
631 export.setOutputFile(outputFile);
632 export.setDelimiter(delimiter);
633 export.setFormat(format);
634 export.execute(target, type);
636 for (Object exception : export.getExceptions())
637 getLog().debug(exception.toString());
641 /** Stop Log-Capturing */
642 MavenLogAppender.endPluginLog(this);
644 /** Restore the old class-loader (TODO: is this really necessary?) */
645 Thread.currentThread().setContextClassLoader(contextClassLoader);
647 /** Close the connection */
650 if (connection != null)
653 catch (SQLException e)
655 getLog().error("Error while closing connection: " + e.getMessage());
659 /** Write md5-sums for annotated classes to file */
662 FileOutputStream fos = new FileOutputStream(saved);
663 ObjectOutputStream oos = new ObjectOutputStream(fos);
664 oos.writeObject(md5s);
670 getLog().error("Cannot write md5-sums to file: " + e);
675 * Needed, because DriverManager won't pick up drivers, that were not
676 * loaded by the system-classloader!
678 * http://stackoverflow.com/questions/288828/how-to-use-a-jdbc-driver-fromodifiedm-an-arbitrary-location
680 static final class DriverProxy implements Driver
682 private final Driver target;
684 DriverProxy(Driver target)
687 throw new NullPointerException();
688 this.target = target;
691 public java.sql.Driver getTarget()
697 public boolean acceptsURL(String url) throws SQLException
699 return target.acceptsURL(url);
703 public java.sql.Connection connect(
705 java.util.Properties info
710 return target.connect(url, info);
714 public int getMajorVersion()
716 return target.getMajorVersion();
720 public int getMinorVersion()
722 return target.getMinorVersion();
726 public DriverPropertyInfo[] getPropertyInfo(
733 return target.getPropertyInfo(url, info);
737 public boolean jdbcCompliant()
739 return target.jdbcCompliant();
743 * This Method cannot be annotated with @Override, becaus the plugin
744 * will not compile then under Java 1.6!
746 public Logger getParentLogger() throws SQLFeatureNotSupportedException
748 throw new SQLFeatureNotSupportedException("Not supported, for backward-compatibility with Java 1.6");
752 public String toString()
754 return "Proxy: " + target;
758 public int hashCode()
760 return target.hashCode();
764 public boolean equals(Object obj)
766 if (!(obj instanceof DriverProxy))
768 DriverProxy other = (DriverProxy) obj;
769 return this.target.equals(other.target);