1 package de.juplo.plugins.hibernate;
4 import com.pyx4j.log4j.MavenLogAppender;
6 import java.io.FileInputStream;
7 import java.io.FileOutputStream;
8 import java.io.IOException;
9 import java.io.InputStream;
10 import java.net.MalformedURLException;
12 import java.security.NoSuchAlgorithmException;
13 import java.time.ZonedDateTime;
14 import java.util.Collections;
15 import java.util.EnumSet;
16 import java.util.HashMap;
17 import java.util.HashSet;
18 import java.util.Iterator;
19 import java.util.LinkedHashSet;
20 import java.util.List;
22 import java.util.Map.Entry;
23 import java.util.Properties;
25 import java.util.regex.Matcher;
26 import java.util.regex.Pattern;
27 import javax.persistence.Embeddable;
28 import javax.persistence.Entity;
29 import javax.persistence.MappedSuperclass;
30 import javax.persistence.spi.PersistenceUnitTransactionType;
31 import org.apache.maven.artifact.Artifact;
32 import org.apache.maven.model.Resource;
33 import org.apache.maven.plugin.AbstractMojo;
34 import org.apache.maven.plugin.MojoExecutionException;
35 import org.apache.maven.plugin.MojoFailureException;
36 import org.apache.maven.project.MavenProject;
37 import org.hibernate.boot.MetadataBuilder;
38 import org.hibernate.boot.MetadataSources;
39 import org.hibernate.boot.cfgxml.internal.ConfigLoader;
40 import org.hibernate.boot.cfgxml.spi.LoadedConfig;
41 import org.hibernate.boot.cfgxml.spi.MappingReference;
42 import org.hibernate.boot.model.naming.ImplicitNamingStrategy;
43 import org.hibernate.boot.model.naming.PhysicalNamingStrategy;
44 import org.hibernate.boot.registry.BootstrapServiceRegistry;
45 import org.hibernate.boot.registry.BootstrapServiceRegistryBuilder;
46 import org.hibernate.boot.registry.StandardServiceRegistry;
47 import org.hibernate.boot.registry.StandardServiceRegistryBuilder;
48 import org.hibernate.boot.registry.classloading.spi.ClassLoaderService;
49 import org.hibernate.boot.registry.classloading.spi.ClassLoadingException;
50 import org.hibernate.boot.registry.selector.spi.StrategySelector;
51 import org.hibernate.boot.spi.MetadataImplementor;
52 import org.hibernate.cfg.AvailableSettings;
53 import static org.hibernate.cfg.AvailableSettings.DIALECT;
54 import static org.hibernate.cfg.AvailableSettings.DRIVER;
55 import static org.hibernate.cfg.AvailableSettings.FORMAT_SQL;
56 import static org.hibernate.cfg.AvailableSettings.HBM2DDL_DELIMITER;
57 import static org.hibernate.cfg.AvailableSettings.HBM2DLL_CREATE_NAMESPACES;
58 import static org.hibernate.cfg.AvailableSettings.IMPLICIT_NAMING_STRATEGY;
59 import static org.hibernate.cfg.AvailableSettings.JPA_JDBC_DRIVER;
60 import static org.hibernate.cfg.AvailableSettings.JPA_JDBC_PASSWORD;
61 import static org.hibernate.cfg.AvailableSettings.JPA_JDBC_URL;
62 import static org.hibernate.cfg.AvailableSettings.JPA_JDBC_USER;
63 import static org.hibernate.cfg.AvailableSettings.PASS;
64 import static org.hibernate.cfg.AvailableSettings.PHYSICAL_NAMING_STRATEGY;
65 import static org.hibernate.cfg.AvailableSettings.SHOW_SQL;
66 import static org.hibernate.cfg.AvailableSettings.USER;
67 import static org.hibernate.cfg.AvailableSettings.URL;
68 import org.hibernate.engine.config.spi.ConfigurationService;
69 import org.hibernate.engine.jdbc.connections.spi.ConnectionProvider;
70 import org.hibernate.internal.util.config.ConfigurationException;
71 import org.hibernate.jpa.boot.internal.ParsedPersistenceXmlDescriptor;
72 import org.hibernate.jpa.boot.internal.PersistenceXmlParser;
73 import org.hibernate.tool.schema.TargetType;
74 import org.hibernate.tool.schema.internal.ExceptionHandlerCollectingImpl;
75 import org.hibernate.tool.schema.internal.exec.ScriptTargetOutputToFile;
76 import org.hibernate.tool.schema.spi.ExecutionOptions;
77 import org.hibernate.tool.schema.spi.SchemaManagementToolCoordinator;
78 import org.hibernate.tool.schema.spi.ScriptTargetOutput;
79 import org.hibernate.tool.schema.spi.TargetDescriptor;
80 import org.scannotation.AnnotationDB;
84 * Baseclass with common attributes and methods.
86 * @phase process-classes
88 * @requiresDependencyResolution runtime
90 public abstract class AbstractSchemaMojo extends AbstractMojo
92 public final static String EXECUTE = "hibernate.schema.execute";
93 public final static String OUTPUTDIRECTORY = "project.build.outputDirectory";
94 public final static String SCAN_CLASSES = "hibernate.schema.scan.classes";
95 public final static String SCAN_DEPENDENCIES = "hibernate.schema.scan.dependencies";
96 public final static String SCAN_TESTCLASSES = "hibernate.schema.scan.test_classes";
97 public final static String TEST_OUTPUTDIRECTORY = "project.build.testOutputDirectory";
98 public final static String SKIPPED = "hibernate.schema.skipped";
99 public final static String SCRIPT = "hibernate.schema.script";
101 private final static Pattern SPLIT = Pattern.compile("[^,\\s]+");
103 private final Set<String> packages = new HashSet<String>();
109 * Only needed internally.
111 * @parameter property="project"
115 private MavenProject project;
120 * Only needed internally.
122 * @parameter property="project.build.directory"
126 private String buildDirectory;
129 /** Parameters to configure the genaration of the SQL *********************/
132 * Excecute the generated SQL.
133 * If set to <code>false</code>, only the SQL-script is created and the
134 * database is not touched.
136 * <strong>Important:</strong>
137 * This configuration value can only be configured through the
138 * <code>pom.xml</code>, or by the definition of a system-property, because
139 * it is not known by Hibernate nor JPA and, hence, not picked up from
140 * their configuration!
142 * @parameter property="hibernate.schema.execute" default-value="true"
145 private Boolean execute;
150 * If set to <code>true</code>, the execution is skipped.
152 * A skipped execution is signaled via the maven-property
153 * <code>${hibernate.schema.skipped}</code>.
155 * The execution is skipped automatically, if no modified or newly added
156 * annotated classes are found and the dialect was not changed.
158 * <strong>Important:</strong>
159 * This configuration value can only be configured through the
160 * <code>pom.xml</code>, or by the definition of a system-property, because
161 * it is not known by Hibernate nor JPA and, hence, not picked up from
162 * their configuration!
164 * @parameter property="hibernate.schema.skip" default-value="${maven.test.skip}"
167 private boolean skip;
170 * Force generation/execution
172 * Force the generation and (if configured) the execution of the SQL, even if
173 * no modified or newly added annotated classes where found and the
174 * configuration was not changed.
176 * <code>skip</code> takes precedence over <code>force</code>.
178 * <strong>Important:</strong>
179 * This configuration value can only be configured through the
180 * <code>pom.xml</code>, or by the definition of a system-property, because
181 * it is not known by Hibernate nor JPA and, hence, not picked up from
182 * their configuration!
184 * @parameter property="hibernate.schema.force" default-value="false"
187 private boolean force;
192 * @parameter property="hibernate.dialect"
195 private String dialect;
198 * Delimiter in output-file.
200 * <strong>Important:</strong>
201 * This configuration value can only be configured through the
202 * <code>pom.xml</code>, or by the definition of a system-property, because
203 * it is not known by Hibernate nor JPA and, hence, not picked up from
204 * their configuration!
206 * @parameter property="hibernate.hbm2ddl.delimiter" default-value=";"
209 private String delimiter;
212 * Show the generated SQL in the command-line output.
214 * @parameter property="hibernate.show_sql"
217 private Boolean show;
220 * Format output-file.
222 * @parameter property="hibernate.format_sql"
225 private Boolean format;
228 * Specifies whether to automatically create also the database schema/catalog.
230 * @parameter property="hibernate.hbm2dll.create_namespaces" default-value="false"
233 private Boolean createNamespaces;
236 * Implicit naming strategy
238 * @parameter property="hibernate.implicit_naming_strategy"
241 private String implicitNamingStrategy;
244 * Physical naming strategy
246 * @parameter property="hibernate.physical_naming_strategy"
249 private String physicalNamingStrategy;
252 * Wether the project should be scanned for annotated-classes, or not
254 * This parameter is intended to allow overwriting of the parameter
255 * <code>exclude-unlisted-classes</code> of a <code>persistence-unit</code>.
256 * If not specified, it defaults to <code>true</code>
258 * @parameter property="hibernate.schema.scan.classes"
261 private Boolean scanClasses;
264 * Classes-Directory to scan.
266 * This parameter defaults to the maven build-output-directory for classes.
267 * Additionally, all dependencies are scanned for annotated classes.
269 * <strong>Important:</strong>
270 * This configuration value can only be configured through the
271 * <code>pom.xml</code>, or by the definition of a system-property, because
272 * it is not known by Hibernate nor JPA and, hence, not picked up from
273 * their configuration!
275 * @parameter property="project.build.outputDirectory"
278 private String outputDirectory;
281 * Dependency-Scopes, that should be scanned for annotated classes.
283 * By default, only dependencies in the scope <code>compile</code> are
284 * scanned for annotated classes. Multiple scopes can be seperated by
285 * white space or commas.
287 * If you do not want any dependencies to be scanned for annotated
288 * classes, set this parameter to <code>none</code>.
290 * The plugin does not scan for annotated classes in transitive
291 * dependencies. If some of your annotated classes are hidden in a
292 * transitive dependency, you can simply add that dependency explicitly.
294 * @parameter property="hibernate.schema.scan.dependencies" default-value="compile"
297 private String scanDependencies;
300 * Whether to scan the test-branch of the project for annotated classes, or
303 * If this parameter is set to <code>true</code> the test-classes of the
304 * artifact will be scanned for hibernate-annotated classes additionally.
306 * <strong>Important:</strong>
307 * This configuration value can only be configured through the
308 * <code>pom.xml</code>, or by the definition of a system-property, because
309 * it is not known by Hibernate nor JPA and, hence, not picked up from
310 * their configuration!
312 * @parameter property="hibernate.schema.scan.test_classes" default-value="false"
315 private Boolean scanTestClasses;
318 * Test-Classes-Directory to scan.
320 * This parameter defaults to the maven build-output-directory for
323 * This parameter is only used, when <code>scanTestClasses</code> is set
324 * to <code>true</code>!
326 * <strong>Important:</strong>
327 * This configuration value can only be configured through the
328 * <code>pom.xml</code>, or by the definition of a system-property, because
329 * it is not known by Hibernate nor JPA and, hence, not picked up from
330 * their configuration!
332 * @parameter property="project.build.testOutputDirectory"
335 private String testOutputDirectory;
338 /** Conection parameters *************************************************/
343 * @parameter property="hibernate.connection.driver_class"
346 private String driver;
351 * @parameter property="hibernate.connection.url"
359 * @parameter property="hibernate.connection.username"
362 private String username;
367 * @parameter property="hibernate.connection.password"
370 private String password;
373 /** Parameters to locate configuration sources ****************************/
376 * Path to a file or name of a ressource with hibernate properties.
377 * If this parameter is specified, the plugin will try to load configuration
378 * values from a file with the given path or a ressource on the classpath with
379 * the given name. If both fails, the execution of the plugin will fail.
381 * If this parameter is not set the plugin will load configuration values
382 * from a ressource named <code>hibernate.properties</code> on the classpath,
383 * if it is present, but will not fail if there is no such ressource.
385 * During ressource-lookup, the test-classpath takes precedence.
390 private String hibernateProperties;
393 * Path to Hibernate configuration file (.cfg.xml).
394 * If this parameter is specified, the plugin will try to load configuration
395 * values from a file with the given path or a ressource on the classpath with
396 * the given name. If both fails, the execution of the plugin will fail.
398 * If this parameter is not set the plugin will load configuration values
399 * from a ressource named <code>hibernate.cfg.xml</code> on the classpath,
400 * if it is present, but will not fail if there is no such ressource.
402 * During ressource-lookup, the test-classpath takes precedence.
404 * Settings in this file will overwrite settings in the properties file.
409 private String hibernateConfig;
412 * Name of the persistence-unit.
413 * If this parameter is specified, the plugin will try to load configuration
414 * values from a persistence-unit with the specified name. If no such
415 * persistence-unit can be found, the plugin will throw an exception.
417 * If this parameter is not set and there is only one persistence-unit
418 * available, that unit will be used automatically. But if this parameter is
419 * not set and there are multiple persistence-units available on,
420 * the class-path, the execution of the plugin will fail.
422 * Settings in this file will overwrite settings in the properties or the
423 * configuration file.
428 private String persistenceUnit;
431 * List of Hibernate-Mapping-Files (XML).
432 * Multiple files can be separated with white-spaces and/or commas.
434 * @parameter property="hibernate.mapping"
437 private String mappings;
441 public final void execute(String filename)
443 MojoFailureException,
444 MojoExecutionException
448 getLog().info("Execution of hibernate-maven-plugin was skipped!");
449 project.getProperties().setProperty(SKIPPED, "true");
453 ModificationTracker tracker;
456 tracker = new ModificationTracker(buildDirectory, filename, getLog());
458 catch (NoSuchAlgorithmException e)
460 throw new MojoFailureException("Digest-Algorithm MD5 is missing!", e);
463 final SimpleConnectionProvider connectionProvider =
464 new SimpleConnectionProvider(getLog());
468 /** Start extended logging */
469 MavenLogAppender.startPluginLog(this);
471 /** Load checksums for old mapping and configuration */
474 /** Create the ClassLoader */
475 MutableClassLoader classLoader = createClassLoader();
477 /** Create a BootstrapServiceRegistry with the created ClassLoader */
478 BootstrapServiceRegistry bootstrapServiceRegitry =
479 new BootstrapServiceRegistryBuilder()
480 .applyClassLoader(classLoader)
482 ClassLoaderService classLoaderService =
483 bootstrapServiceRegitry.getService(ClassLoaderService.class);
485 Properties properties = new Properties();
486 ConfigLoader configLoader = new ConfigLoader(bootstrapServiceRegitry);
488 /** Loading and merging configuration */
489 properties.putAll(loadProperties(configLoader));
490 LoadedConfig config = loadConfig(configLoader);
492 properties.putAll(config.getConfigurationValues());
493 ParsedPersistenceXmlDescriptor unit = loadPersistenceUnit(properties);
495 properties.putAll(unit.getProperties());
497 /** Overwriting/Completing configuration */
498 configure(properties, tracker);
500 /** Check configuration for modifications */
501 if(tracker.track(properties))
502 getLog().debug("Configuration has changed.");
504 getLog().debug("Configuration unchanged.");
506 /** Check, that the outputfile is writable */
507 final File output = getOutputFile(filename);
508 /** Check, if the outputfile is missing or was changed */
509 checkOutputFile(output, tracker);
511 /** Configure Hibernate */
512 final StandardServiceRegistry serviceRegistry =
513 new StandardServiceRegistryBuilder(bootstrapServiceRegitry)
514 .applySettings(properties)
515 .addService(ConnectionProvider.class, connectionProvider)
517 final MetadataSources sources = new MetadataSources(serviceRegistry);
519 /** Add the remaining class-path-elements */
520 completeClassPath(classLoader);
522 /** Apply mappings from hibernate-configuration, if present */
525 for (MappingReference mapping : config.getMappingReferences())
526 mapping.apply(sources);
532 /** No persistent unit: default behaviour */
533 if (scanClasses == null)
535 Set<URL> urls = new HashSet<URL>();
537 addRoot(urls, outputDirectory);
539 addRoot(urls, testOutputDirectory);
540 addDependencies(urls);
541 classes = scanUrls(urls);
545 /** Follow configuration in persisten unit */
546 if (scanClasses == null)
547 scanClasses = !unit.isExcludeUnlistedClasses();
548 Set<URL> urls = new HashSet<URL>();
552 * Scan the root of the persiten unit and configured jars for
555 urls.add(unit.getPersistenceUnitRootUrl());
556 for (URL url : unit.getJarFileUrls())
560 addRoot(urls, testOutputDirectory);
561 classes = scanUrls(urls);
562 for (String className : unit.getManagedClassNames())
563 classes.add(className);
565 * Add mappings from the default mapping-file
566 * <code>META-INF/orm.xml</code>, if present
568 boolean error = false;
570 is = classLoader.getResourceAsStream("META-INF/orm.xml");
573 getLog().info("Adding default JPA-XML-mapping from META-INF/orm.xml");
576 tracker.track("META-INF/orm.xml", is);
577 sources.addResource("META-INF/orm.xml");
579 catch (IOException e)
581 getLog().error("cannot read META-INF/orm.xml: " + e);
587 getLog().debug("no META-INF/orm.xml found");
590 * Add mappings from files, that are explicitly configured in the
593 for (String mapping : unit.getMappingFileNames())
595 getLog().info("Adding explicitly configured mapping from " + mapping);
596 is = classLoader.getResourceAsStream(mapping);
601 tracker.track(mapping, is);
602 sources.addResource(mapping);
604 catch (IOException e)
606 getLog().info("cannot read mapping-file " + mapping + ": " + e);
612 getLog().error("cannot find mapping-file " + mapping);
617 throw new MojoFailureException(
618 "error, while reading mappings configured in persistence-unit \"" +
624 /** Add the configured/collected annotated classes */
625 for (String className : classes)
626 addAnnotated(className, sources, classLoaderService, tracker);
628 /** Add explicitly configured classes */
629 addMappings(sources, tracker);
631 /** Skip execution, if mapping and configuration is unchanged */
632 if (!tracker.modified())
634 getLog().info("Mapping and configuration unchanged.");
636 getLog().info("Generation/execution is forced!");
639 getLog().info("Skipping schema generation!");
640 project.getProperties().setProperty(SKIPPED, "true");
646 /** Truncate output file */
649 new FileOutputStream(output).getChannel().truncate(0).close();
651 catch (IOException e)
654 "Error while truncating " + output.getAbsolutePath() + ": "
656 getLog().warn(error);
657 throw new MojoExecutionException(error);
660 /** Create a connection, if sufficient configuration infromation is available */
661 connectionProvider.open(classLoaderService, properties);
663 MetadataBuilder metadataBuilder = sources.getMetadataBuilder();
665 StrategySelector strategySelector =
666 serviceRegistry.getService(StrategySelector.class);
668 if (properties.containsKey(IMPLICIT_NAMING_STRATEGY))
670 metadataBuilder.applyImplicitNamingStrategy(
671 strategySelector.resolveStrategy(
672 ImplicitNamingStrategy.class,
673 properties.getProperty(IMPLICIT_NAMING_STRATEGY)
678 if (properties.containsKey(PHYSICAL_NAMING_STRATEGY))
680 metadataBuilder.applyPhysicalNamingStrategy(
681 strategySelector.resolveStrategy(
682 PhysicalNamingStrategy.class,
683 properties.getProperty(PHYSICAL_NAMING_STRATEGY)
688 /** Prepare the generation of the SQL */
689 Map settings = new HashMap();
692 .getService(ConfigurationService.class)
695 ExceptionHandlerCollectingImpl handler =
696 new ExceptionHandlerCollectingImpl();
697 ExecutionOptions options =
698 SchemaManagementToolCoordinator
699 .buildExecutionOptions(settings, handler);
700 final EnumSet<TargetType> targetTypes = EnumSet.of(TargetType.SCRIPT);
702 targetTypes.add(TargetType.DATABASE);
703 TargetDescriptor target = new TargetDescriptor()
706 public EnumSet<TargetType> getTargetTypes()
712 public ScriptTargetOutput getScriptTargetOutput()
717 .getService(ConfigurationService.class)
719 .get(AvailableSettings.HBM2DDL_CHARSET_NAME);
720 return new ScriptTargetOutputToFile(output, charset);
725 * Change class-loader of current thread.
726 * This is necessary, because still not all parts of Hibernate 5 use
727 * the newly introduced ClassLoaderService and will fail otherwise!
729 Thread thread = Thread.currentThread();
730 ClassLoader contextClassLoader = thread.getContextClassLoader();
733 thread.setContextClassLoader(classLoader);
734 build((MetadataImplementor)metadataBuilder.build(), options, target);
735 if (handler.getExceptions().size() > 0)
737 StringBuilder builder = new StringBuilder();
738 builder.append("Hibernate failed:");
739 for (Exception e : handler.getExceptions())
741 builder.append("\n * ");
742 builder.append(e.getMessage());
743 AbstractSchemaMojo.printStrackTrace(builder, e);
744 builder.append("\n");
746 String error = builder.toString();
747 getLog().error(error);
748 throw new MojoFailureException(error);
753 thread.setContextClassLoader(contextClassLoader);
754 /** Track, the content of the generated script */
755 checkOutputFile(output, tracker);
758 catch (MojoExecutionException e)
763 catch (MojoFailureException e)
768 catch (RuntimeException e)
775 /** Remember mappings and configuration */
778 /** Close the connection - if one was opened */
779 connectionProvider.close();
781 /** Stop Log-Capturing */
782 MavenLogAppender.endPluginLog(this);
788 MetadataImplementor metadata,
789 ExecutionOptions options,
790 TargetDescriptor target
793 MojoFailureException,
794 MojoExecutionException;
797 private MutableClassLoader createClassLoader() throws MojoExecutionException
801 getLog().debug("Creating ClassLoader for project-dependencies...");
802 LinkedHashSet<URL> urls = new LinkedHashSet<URL>();
805 file = new File(testOutputDirectory);
808 getLog().info("Creating test-output-directory: " + testOutputDirectory);
811 urls.add(file.toURI().toURL());
813 file = new File(outputDirectory);
816 getLog().info("Creating output-directory: " + outputDirectory);
819 urls.add(file.toURI().toURL());
821 return new MutableClassLoader(urls, getLog());
825 getLog().error("Error while creating ClassLoader!", e);
826 throw new MojoExecutionException(e.getMessage());
830 private void completeClassPath(MutableClassLoader classLoader)
832 MojoExecutionException
836 getLog().debug("Completing class-paths of the ClassLoader for project-dependencies...");
837 List<String> classpathFiles = project.getCompileClasspathElements();
839 classpathFiles.addAll(project.getTestClasspathElements());
840 LinkedHashSet<URL> urls = new LinkedHashSet<URL>();
841 for (String pathElement : classpathFiles)
843 getLog().debug("Dependency: " + pathElement);
844 urls.add(new File(pathElement).toURI().toURL());
846 classLoader.add(urls);
850 getLog().error("Error while creating ClassLoader!", e);
851 throw new MojoExecutionException(e.getMessage());
855 private Map loadProperties(ConfigLoader configLoader)
857 MojoExecutionException
859 /** Try to read configuration from properties-file */
860 if (hibernateProperties == null)
864 return configLoader.loadProperties("hibernate.properties");
866 catch (ConfigurationException e)
868 getLog().debug(e.getMessage());
869 return Collections.EMPTY_MAP;
876 File file = new File(hibernateProperties);
879 getLog().info("Reading settings from file " + hibernateProperties + "...");
880 return configLoader.loadProperties(file);
883 return configLoader.loadProperties(hibernateProperties);
885 catch (ConfigurationException e)
887 getLog().error("Error while reading properties!", e);
888 throw new MojoExecutionException(e.getMessage());
893 private LoadedConfig loadConfig(ConfigLoader configLoader)
894 throws MojoExecutionException
896 /** Try to read configuration from configuration-file */
897 if (hibernateConfig == null)
901 return configLoader.loadConfigXmlResource("hibernate.cfg.xml");
903 catch (ConfigurationException e)
905 getLog().debug(e.getMessage());
913 File file = new File(hibernateConfig);
916 getLog().info("Reading configuration from file " + hibernateConfig + "...");
917 return configLoader.loadConfigXmlFile(file);
921 return configLoader.loadConfigXmlResource(hibernateConfig);
924 catch (ConfigurationException e)
926 getLog().error("Error while reading configuration!", e);
927 throw new MojoExecutionException(e.getMessage());
932 private void configure(Properties properties, ModificationTracker tracker)
933 throws MojoFailureException
936 * Special treatment for the configuration-value "execute": if it is
937 * switched to "true", the genearation fo the schema should be forced!
939 if (tracker.check(EXECUTE, execute.toString()) && execute)
942 "hibernate.schema.execute was switched on: " +
943 "forcing generation/execution of SQL"
947 configure(properties, execute, EXECUTE);
950 * Configure the generation of the SQL.
951 * Overwrite values from properties-file if the configuration parameter is
952 * known to Hibernate.
954 configure(properties, dialect, DIALECT);
955 configure(properties, delimiter, HBM2DDL_DELIMITER);
956 configure(properties, format, FORMAT_SQL);
957 configure(properties, createNamespaces, HBM2DLL_CREATE_NAMESPACES);
958 configure(properties, implicitNamingStrategy, IMPLICIT_NAMING_STRATEGY);
959 configure(properties, physicalNamingStrategy, PHYSICAL_NAMING_STRATEGY);
960 configure(properties, outputDirectory, OUTPUTDIRECTORY);
961 configure(properties, scanDependencies, SCAN_DEPENDENCIES);
962 configure(properties, scanTestClasses, SCAN_TESTCLASSES);
963 configure(properties, testOutputDirectory, TEST_OUTPUTDIRECTORY);
966 * Special treatment for the configuration-value "show": a change of its
967 * configured value should not lead to a regeneration of the database
971 show = Boolean.valueOf(properties.getProperty(SHOW_SQL));
973 properties.setProperty(SHOW_SQL, show.toString());
976 * Configure the connection parameters.
977 * Overwrite values from properties-file.
979 configure(properties, driver, DRIVER, JPA_JDBC_DRIVER);
980 configure(properties, url, URL, JPA_JDBC_URL);
981 configure(properties, username, USER, JPA_JDBC_USER);
982 configure(properties, password, PASS, JPA_JDBC_PASSWORD);
984 if (properties.isEmpty())
986 getLog().error("No properties set!");
987 throw new MojoFailureException("Hibernate configuration is missing!");
990 getLog().info("Gathered configuration:");
991 for (Entry<Object,Object> entry : properties.entrySet())
992 getLog().info(" " + entry.getKey() + " = " + entry.getValue());
995 private void configure(
996 Properties properties,
999 String alternativeKey
1002 configure(properties, value, key);
1004 if (properties.containsKey(alternativeKey))
1006 if (properties.containsKey(key))
1009 "Ignoring property " + alternativeKey + "=\"" +
1010 properties.getProperty(alternativeKey) +
1011 "\" in favour for property " + key + "=\"" +
1012 properties.getProperty(key) + "\""
1014 properties.remove(alternativeKey);
1018 value = properties.getProperty(alternativeKey);
1019 properties.remove(alternativeKey);
1021 "Using value \"" + value + "\" from property " + alternativeKey +
1022 " for property " + key
1024 properties.setProperty(key, value);
1029 private void configure(Properties properties, String value, String key)
1033 if (properties.containsKey(key))
1035 if (!properties.getProperty(key).equals(value))
1038 "Overwriting property " + key + "=\"" +
1039 properties.getProperty(key) +
1040 "\" with value \"" + value + "\""
1042 properties.setProperty(key, value);
1047 getLog().debug("Using value \"" + value + "\" for property " + key);
1048 properties.setProperty(key, value);
1053 private void configure(Properties properties, Boolean value, String key)
1055 configure(properties, value == null ? null : value.toString(), key);
1058 private File getOutputFile(String filename)
1060 MojoExecutionException
1062 File output = new File(filename);
1064 if (!output.isAbsolute())
1066 // Interpret relative file path relative to build directory
1067 output = new File(buildDirectory, filename);
1069 getLog().debug("Output file: " + output.getPath());
1071 // Ensure that directory path for specified file exists
1072 File outFileParentDir = output.getParentFile();
1073 if (null != outFileParentDir && !outFileParentDir.exists())
1078 "Creating directory path for output file:" +
1079 outFileParentDir.getPath()
1081 outFileParentDir.mkdirs();
1086 "Error creating directory path for output file: " + e.getMessage();
1087 getLog().error(error);
1088 throw new MojoExecutionException(error);
1094 output.createNewFile();
1096 catch (IOException e)
1098 String error = "Error creating output file: " + e.getMessage();
1099 getLog().error(error);
1100 throw new MojoExecutionException(error);
1103 if (!output.canWrite())
1106 "Output file " + output.getAbsolutePath() + " is not writable!";
1107 getLog().error(error);
1108 throw new MojoExecutionException(error);
1114 private void checkOutputFile(File output, ModificationTracker tracker)
1116 MojoExecutionException
1120 if (output.exists())
1121 tracker.track(SCRIPT, new FileInputStream(output));
1123 tracker.track(SCRIPT, ZonedDateTime.now().toString());
1125 catch (IOException e)
1128 "Error while checking the generated script: " + e.getMessage();
1129 getLog().error(error);
1130 throw new MojoExecutionException(error);
1134 private void addMappings(MetadataSources sources, ModificationTracker tracker)
1135 throws MojoFailureException
1137 getLog().debug("Adding explicitly configured mappings...");
1138 if (mappings != null)
1142 for (String filename : mappings.split("[\\s,]+"))
1144 // First try the filename as absolute/relative path
1145 File file = new File(filename);
1148 // If the file was not found, search for it in the resource-directories
1149 for (Resource resource : project.getResources())
1151 file = new File(resource.getDirectory() + File.separator + filename);
1158 if (file.isDirectory())
1159 // TODO: add support to read all mappings under a directory
1160 throw new MojoFailureException(file.getAbsolutePath() + " is a directory");
1161 if (tracker.track(filename, new FileInputStream(file)))
1162 getLog().debug("Found new or modified mapping-file: " + filename);
1164 getLog().debug("Mapping-file unchanged: " + filename);
1166 sources.addFile(file);
1169 throw new MojoFailureException("File " + filename + " could not be found in any of the configured resource-directories!");
1172 catch (IOException e)
1174 throw new MojoFailureException("Cannot calculate MD5 sums!", e);
1179 private void addRoot(Set<URL> urls, String path) throws MojoFailureException
1183 File dir = new File(path);
1186 getLog().info("Adding " + dir.getAbsolutePath() + " to the list of roots to scan...");
1187 urls.add(dir.toURI().toURL());
1191 "the directory cannot be scanned for annotated classes, " +
1192 "because it does not exist: " +
1193 dir.getAbsolutePath()
1196 catch (MalformedURLException e)
1198 getLog().error("error while adding the project-root to the list of roots to scan!", e);
1199 throw new MojoFailureException(e.getMessage());
1203 private void addDependencies(Set<URL> urls) throws MojoFailureException
1207 if (scanDependencies != null)
1209 Matcher matcher = SPLIT.matcher(scanDependencies);
1210 while (matcher.find())
1212 getLog().info("Adding dependencies from scope " + matcher.group() + " to the list of roots to scan");
1213 for (Artifact artifact : project.getDependencyArtifacts())
1215 if (!artifact.getScope().equalsIgnoreCase(matcher.group()))
1217 if (artifact.getFile() == null)
1219 getLog().warn("Cannot add dependency " + artifact.getId() + ": no JAR-file available!");
1222 getLog().info("Adding dependencies from scope " + artifact.getId() + " to the list of roots to scan");
1223 urls.add(artifact.getFile().toURI().toURL());
1228 catch (MalformedURLException e)
1230 getLog().error("Error while adding dependencies to the list of roots to scan!", e);
1231 throw new MojoFailureException(e.getMessage());
1235 private Set<String> scanUrls(Set<URL> scanRoots)
1237 MojoFailureException
1241 AnnotationDB db = new AnnotationDB();
1242 for (URL root : scanRoots)
1243 db.scanArchives(root);
1245 Set<String> classes = new HashSet<String>();
1246 if (db.getAnnotationIndex().containsKey(Entity.class.getName()))
1247 classes.addAll(db.getAnnotationIndex().get(Entity.class.getName()));
1248 if (db.getAnnotationIndex().containsKey(MappedSuperclass.class.getName()))
1249 classes.addAll(db.getAnnotationIndex().get(MappedSuperclass.class.getName()));
1250 if (db.getAnnotationIndex().containsKey(Embeddable.class.getName()))
1251 classes.addAll(db.getAnnotationIndex().get(Embeddable.class.getName()));
1257 getLog().error("Error while scanning!", e);
1258 throw new MojoFailureException(e.getMessage());
1262 private void addAnnotated(
1264 MetadataSources sources,
1265 ClassLoaderService classLoaderService,
1266 ModificationTracker tracker
1269 MojoFailureException,
1270 MojoExecutionException
1274 getLog().info("Adding annotated resource: " + name);
1275 String packageName = null;
1277 boolean error = false;
1280 Class<?> annotatedClass = classLoaderService.classForName(name);
1281 String resourceName = annotatedClass.getName();
1283 resourceName.substring(
1284 resourceName.lastIndexOf(".") + 1,
1285 resourceName.length()
1287 InputStream is = annotatedClass.getResourceAsStream(resourceName);
1290 if (tracker.track(name, is))
1291 getLog().debug("New or modified class: " + name);
1293 getLog().debug("Unchanged class: " + name);
1294 sources.addAnnotatedClass(annotatedClass);
1295 packageName = annotatedClass.getPackage().getName();
1299 getLog().error("cannot find ressource " + resourceName + " for class " + name);
1303 catch(ClassLoadingException e)
1309 throw new MojoExecutionException("error while inspecting annotated class " + name);
1312 while (packageName != null)
1314 if (packages.contains(packageName))
1316 String resource = packageName.replace('.', '/') + "/package-info.class";
1317 InputStream is = classLoaderService.locateResourceStream(resource);
1320 // No compiled package-info available: no package-level annotations!
1321 getLog().debug("Package " + packageName + " is not annotated.");
1325 if (tracker.track(packageName, is))
1326 getLog().debug("New or modified package: " + packageName);
1328 getLog().debug("Unchanged package: " + packageName);
1329 getLog().info("Adding annotations from package " + packageName);
1330 sources.addPackage(packageName);
1332 packages.add(packageName);
1333 int i = packageName.lastIndexOf('.');
1337 packageName = packageName.substring(0,i);
1342 getLog().error("Error while adding the annotated class " + name, e);
1343 throw new MojoFailureException(e.getMessage());
1347 private ParsedPersistenceXmlDescriptor loadPersistenceUnit(
1348 Properties properties
1351 MojoFailureException
1353 List<ParsedPersistenceXmlDescriptor> units =
1354 PersistenceXmlParser.locatePersistenceUnits(properties);
1356 if (persistenceUnit == null)
1358 if (units.isEmpty())
1360 getLog().info("Found no META-INF/persistence.xml.");
1364 if (units.size() == 1)
1366 ParsedPersistenceXmlDescriptor descriptor = units.get(0);
1367 getLog().info("Using persistence-unit " + descriptor.getName());
1371 StringBuilder builder = new StringBuilder();
1372 builder.append("No name provided and multiple persistence units found: ");
1373 Iterator<ParsedPersistenceXmlDescriptor> it = units.iterator();
1376 builder.append(it.next().getName());
1378 builder.append(", ");
1380 builder.append('.');
1381 throw new MojoFailureException(builder.toString());
1384 Iterator<ParsedPersistenceXmlDescriptor> it = units.iterator();
1387 ParsedPersistenceXmlDescriptor descriptor = it.next();
1388 if (descriptor.getName().equals(persistenceUnit))
1390 getLog().info("Using configured persistence-unit " + persistenceUnit);
1395 throw new MojoFailureException("Could not find persistence-unit " + persistenceUnit);
1399 public static void printStrackTrace(StringBuilder builder, Throwable t)
1403 builder.append("\n\tCause: ");
1404 builder.append(t.getMessage() == null ? "" : t.getMessage().replaceAll("\\s+", " "));
1405 for (StackTraceElement trace : t.getStackTrace())
1407 builder.append("\n\t");
1408 builder.append(trace.getClassName());
1409 builder.append(".");
1410 builder.append(trace.getMethodName());
1411 builder.append("():");
1412 builder.append(trace.getLineNumber());