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 DRIVER_CLASS = "hibernate.connection.driver_class";
74 public final static String URL = "hibernate.connection.url";
75 public final static String USERNAME = "hibernate.connection.username";
76 public final static String PASSWORD = "hibernate.connection.password";
77 public final static String DIALECT = "hibernate.dialect";
79 private final static String MD5S = "schema.md5s";
84 * @parameter expression="${project}"
88 private MavenProject project;
93 * @parameter expression="${project.build.directory}"
95 private String buildDirectory;
98 * Class-directory to scan.
100 * @parameter expression="${project.build.outputDirectory}"
102 private String outputDirectory;
107 * @parameter expression="${maven.test.skip}" default-value="false"
109 private boolean skip;
114 * @parameter expression="${hibernate.connection.driver_class}
116 private String driverClassName;
121 * @parameter expression="${hibernate.connection.url}"
128 * @parameter expression="${hibernate.connection.username}"
130 private String username;
135 * @parameter expression="${hibernate.connection.password}"
137 private String password;
142 * @parameter expression="${hibernate.dialect}"
144 private String hibernateDialect;
147 * Path to Hibernate configuration file.
149 * @parameter default-value="${project.build.outputDirectory}/hibernate.properties"
151 private String hibernateProperties;
154 * Target of execution:
156 * <li><strong>NONE</strong> do nothing - just validate the configuration</li>
157 * <li><strong>EXPORT</strong> create database <strong>(DEFAULT!)</strong></li>
158 * <li><strong>SCRIPT</strong> export schema to SQL-script</li>
159 * <li><strong>BOTH</strong></li>
161 * @parameter expression="${hibernate.export.target}" default-value="EXPORT"
163 private String target;
168 * <li><strong>NONE</strong> do nothing - just validate the configuration</li>
169 * <li><strong>CREATE</strong> create database-schema</li>
170 * <li><strong>DROP</strong> drop database-schema</li>
171 * <li><strong>BOTH</strong> <strong>(DEFAULT!)</strong></li>
173 * @parameter expression="${hibernate.export.type}" default-value="BOTH"
180 * @parameter expression="${hibernate.export.schema.filename}" default-value="${project.build.directory}/schema.sql"
182 private String outputFile;
185 * Delimiter in output-file.
187 * @parameter expression="${hibernate.export.schema.delimiter}" default-value=";"
189 private String delimiter;
192 * Format output-file.
194 * @parameter expression="${hibernate.export.schema.format}" default-value="true"
196 private boolean format;
200 public void execute()
202 MojoFailureException,
203 MojoExecutionException
207 getLog().info("Exectuion of hibernate4-maven-plugin:export was skipped!");
211 File dir = new File(outputDirectory);
213 throw new MojoExecutionException("Cannot scan for annotated classes in " + outputDirectory + ": directory does not exist!");
215 Map<String,String> md5s;
216 boolean modified = false;
217 File saved = new File(buildDirectory + File.separator + MD5S);
223 FileInputStream fis = new FileInputStream(saved);
224 ObjectInputStream ois = new ObjectInputStream(fis);
225 md5s = (HashMap<String,String>)ois.readObject();
230 md5s = new HashMap<String,String>();
231 getLog().warn("Cannot read timestamps from saved: " + e);
236 md5s = new HashMap<String,String>();
239 saved.createNewFile();
241 catch (IOException e)
243 getLog().warn("Cannot create saved for timestamps: " + e);
247 ClassLoader classLoader = null;
250 getLog().debug("Creating ClassLoader for project-dependencies...");
251 List<String> classpathFiles = project.getCompileClasspathElements();
252 URL[] urls = new URL[classpathFiles.size()];
253 for (int i = 0; i < classpathFiles.size(); ++i)
255 getLog().debug("Dependency: " + classpathFiles.get(i));
256 urls[i] = new File(classpathFiles.get(i)).toURI().toURL();
258 classLoader = new URLClassLoader(urls, getClass().getClassLoader());
262 getLog().error("Error while creating ClassLoader!", e);
263 throw new MojoExecutionException(e.getMessage());
266 Set<Class<?>> classes =
267 new TreeSet<Class<?>>(
268 new Comparator<Class<?>>() {
270 public int compare(Class<?> a, Class<?> b)
272 return a.getName().compareTo(b.getName());
279 AnnotationDB db = new AnnotationDB();
280 getLog().info("Scanning directory " + outputDirectory + " for annotated classes...");
281 URL dirUrl = dir.toURI().toURL();
282 db.scanArchives(dirUrl);
284 Set<String> classNames = new HashSet<String>();
285 if (db.getAnnotationIndex().containsKey(Entity.class.getName()))
286 classNames.addAll(db.getAnnotationIndex().get(Entity.class.getName()));
287 if (db.getAnnotationIndex().containsKey(MappedSuperclass.class.getName()))
288 classNames.addAll(db.getAnnotationIndex().get(MappedSuperclass.class.getName()));
289 if (db.getAnnotationIndex().containsKey(Embeddable.class.getName()))
290 classNames.addAll(db.getAnnotationIndex().get(Embeddable.class.getName()));
292 MessageDigest digest = java.security.MessageDigest.getInstance("MD5");
293 for (String name : classNames)
295 Class<?> annotatedClass = classLoader.loadClass(name);
296 classes.add(annotatedClass);
299 .getResourceAsStream(annotatedClass.getSimpleName() + ".class");
300 byte[] buffer = new byte[1024*4]; // copy data in 4MB-chunks
302 while((i = is.read(buffer)) > -1)
303 digest.update(buffer, 0, i);
305 byte[] bytes = digest.digest();
306 BigInteger bi = new BigInteger(1, bytes);
307 String newMd5 = String.format("%0" + (bytes.length << 1) + "x", bi);
308 String oldMd5 = !md5s.containsKey(name) ? "" : md5s.get(name);
309 if (!newMd5.equals(oldMd5))
311 getLog().debug("Found new or modified annotated class: " + name);
313 md5s.put(name, newMd5);
317 getLog().debug(oldMd5 + " -> class unchanged: " + name);
321 catch (ClassNotFoundException e)
323 getLog().error("Error while adding annotated classes!", e);
324 throw new MojoExecutionException(e.getMessage());
328 getLog().error("Error while scanning!", e);
329 throw new MojoFailureException(e.getMessage());
332 if (classes.isEmpty())
333 throw new MojoFailureException("No annotated classes found in directory " + outputDirectory);
335 getLog().debug("Detected classes with mapping-annotations:");
336 for (Class<?> annotatedClass : classes)
337 getLog().debug(" " + annotatedClass.getName());
340 Properties properties = new Properties();
342 /** Try to read configuration from properties-file */
345 File file = new File(hibernateProperties);
348 getLog().info("Reading properties from file " + hibernateProperties + "...");
349 properties.load(new FileInputStream(file));
352 getLog().info("No hibernate-properties-file found! Checked path: " + hibernateProperties);
354 catch (IOException e)
356 getLog().error("Error while reading properties!", e);
357 throw new MojoExecutionException(e.getMessage());
360 /** Overwrite values from propertie-file or set, if given */
361 if (driverClassName != null)
363 if (properties.containsKey(DRIVER_CLASS))
365 "Overwriting property " +
366 DRIVER_CLASS + "=" + properties.getProperty(DRIVER_CLASS) +
367 " with the value " + driverClassName +
368 " from the plugin-configuration-parameter driverClassName!"
372 "Using the value " + driverClassName +
373 " from the plugin-configuration-parameter driverClassName!"
375 properties.setProperty(DRIVER_CLASS, driverClassName);
379 if (properties.containsKey(URL))
381 "Overwriting property " +
382 URL + "=" + properties.getProperty(URL) +
383 " with the value " + url +
384 " from the plugin-configuration-parameter url!"
388 "Using the value " + url +
389 " from the plugin-configuration-parameter url!"
391 properties.setProperty(URL, url);
393 if (username != null)
395 if (properties.containsKey(USERNAME))
397 "Overwriting property " +
398 USERNAME + "=" + properties.getProperty(USERNAME) +
399 " with the value " + username +
400 " from the plugin-configuration-parameter username!"
404 "Using the value " + username +
405 " from the plugin-configuration-parameter username!"
407 properties.setProperty(USERNAME, username);
409 if (password != null)
411 if (properties.containsKey(PASSWORD))
413 "Overwriting property " +
414 PASSWORD + "=" + properties.getProperty(PASSWORD) +
415 " with the value " + password +
416 " from the plugin-configuration-parameter password!"
420 "Using the value " + password +
421 " from the plugin-configuration-parameter password!"
423 properties.setProperty(PASSWORD, password);
425 if (hibernateDialect != null)
427 if (properties.containsKey(DIALECT))
429 "Overwriting property " +
430 DIALECT + "=" + properties.getProperty(DIALECT) +
431 " with the value " + hibernateDialect +
432 " from the plugin-configuration-parameter hibernateDialect!"
436 "Using the value " + hibernateDialect +
437 " from the plugin-configuration-parameter hibernateDialect!"
439 properties.setProperty(DIALECT, hibernateDialect);
442 /** The generated SQL varies with the dialect! */
443 if (md5s.containsKey(DIALECT))
445 String dialect = properties.getProperty(DIALECT);
446 if (md5s.get(DIALECT).equals(dialect))
447 getLog().debug("SQL-dialect unchanged.");
450 getLog().debug("SQL-dialect changed: " + dialect);
452 md5s.put(DIALECT, dialect);
458 md5s.put(DIALECT, properties.getProperty(DIALECT));
463 getLog().info("No modified annotated classes found and dialect unchanged.");
464 getLog().info("Skipping schema generation!");
465 project.getProperties().setProperty("hibernate.export.skipped", "true");
469 getLog().info("Gathered hibernate-configuration (turn on debugging for details):");
470 if (properties.isEmpty())
472 getLog().error("No properties set!");
473 throw new MojoFailureException("Hibernate-Configuration is missing!");
475 for (Entry<Object,Object> entry : properties.entrySet())
476 getLog().info(" " + entry.getKey() + " = " + entry.getValue());
478 Configuration config = new Configuration();
479 config.setProperties(properties);
480 getLog().debug("Adding annotated classes to hibernate-mapping-configuration...");
481 for (Class<?> annotatedClass : classes)
483 getLog().debug("Class " + annotatedClass);
484 config.addAnnotatedClass(annotatedClass);
487 Target target = null;
490 target = Target.valueOf(this.target);
492 catch (IllegalArgumentException e)
494 getLog().error("Invalid value for configuration-option \"target\": " + this.target);
495 getLog().error("Valid values are: NONE, SCRIPT, EXPORT, BOTH");
496 throw new MojoExecutionException("Invalid value for configuration-option \"target\"");
501 type = Type.valueOf(this.type);
503 catch (IllegalArgumentException e)
505 getLog().error("Invalid value for configuration-option \"type\": " + this.type);
506 getLog().error("Valid values are: NONE, CREATE, DROP, BOTH");
507 throw new MojoExecutionException("Invalid value for configuration-option \"type\"");
510 Connection connection = null;
514 * The connection must be established outside of hibernate, because
515 * hibernate does not use the context-classloader of the current
516 * thread and, hence, would not be able to resolve the driver-class!
527 Class driverClass = classLoader.loadClass(driverClassName);
528 getLog().debug("Registering JDBC-driver " + driverClass.getName());
529 DriverManager.registerDriver(new DriverProxy((Driver)driverClass.newInstance()));
530 getLog().debug("Opening JDBC-connection to " + url + " as " + username + " with password " + password);
531 connection = DriverManager.getConnection(url, username, password);
535 catch (ClassNotFoundException e)
537 getLog().error("Dependency for driver-class " + driverClassName + " is missing!");
538 throw new MojoExecutionException(e.getMessage());
542 getLog().error("Cannot establish connection to database!");
543 Enumeration<Driver> drivers = DriverManager.getDrivers();
544 if (!drivers.hasMoreElements())
545 getLog().error("No drivers registered!");
546 while (drivers.hasMoreElements())
547 getLog().debug("Driver: " + drivers.nextElement());
548 throw new MojoExecutionException(e.getMessage());
551 ClassLoader contextClassLoader = Thread.currentThread().getContextClassLoader();
552 MavenLogAppender.startPluginLog(this);
556 * Change class-loader of current thread, so that hibernate can
557 * see all dependencies!
559 Thread.currentThread().setContextClassLoader(classLoader);
561 SchemaExport export = new SchemaExport(config, connection);
562 export.setOutputFile(outputFile);
563 export.setDelimiter(delimiter);
564 export.setFormat(format);
565 export.execute(target, type);
567 for (Object exception : export.getExceptions())
568 getLog().debug(exception.toString());
572 /** Stop Log-Capturing */
573 MavenLogAppender.endPluginLog(this);
575 /** Restore the old class-loader (TODO: is this really necessary?) */
576 Thread.currentThread().setContextClassLoader(contextClassLoader);
578 /** Close the connection */
583 catch (SQLException e)
585 getLog().error("Error while closing connection: " + e.getMessage());
589 /** Write md5-sums for annotated classes to file */
592 FileOutputStream fos = new FileOutputStream(saved);
593 ObjectOutputStream oos = new ObjectOutputStream(fos);
594 oos.writeObject(md5s);
600 getLog().error("Cannot write md5-sums to file: " + e);
605 * Needed, because DriverManager won't pick up drivers, that were not
606 * loaded by the system-classloader!
608 * http://stackoverflow.com/questions/288828/how-to-use-a-jdbc-driver-fromodifiedm-an-arbitrary-location
610 static final class DriverProxy implements Driver
612 private final Driver target;
614 DriverProxy(Driver target)
617 throw new NullPointerException();
618 this.target = target;
621 public java.sql.Driver getTarget()
627 public boolean acceptsURL(String url) throws SQLException
629 return target.acceptsURL(url);
633 public java.sql.Connection connect(
635 java.util.Properties info
640 return target.connect(url, info);
644 public int getMajorVersion()
646 return target.getMajorVersion();
650 public int getMinorVersion()
652 return target.getMinorVersion();
656 public DriverPropertyInfo[] getPropertyInfo(
663 return target.getPropertyInfo(url, info);
667 public boolean jdbcCompliant()
669 return target.jdbcCompliant();
673 * This Method cannot be annotated with @Override, becaus the plugin
674 * will not compile then under Java 1.6!
676 public Logger getParentLogger() throws SQLFeatureNotSupportedException
678 throw new SQLFeatureNotSupportedException("Not supported, for backward-compatibility with Java 1.6");
682 public String toString()
684 return "Proxy: " + target;
688 public int hashCode()
690 return target.hashCode();
694 public boolean equals(Object obj)
696 if (!(obj instanceof DriverProxy))
698 DriverProxy other = (DriverProxy) obj;
699 return this.target.equals(other.target);