juplo.de Git - hibernate4-maven-plugin/blob - src/main/java/de/juplo/plugins/hibernate/AbstractSchemaMojo.java

   1 package de.juplo.plugins.hibernate;
   2
   3
   4 import com.pyx4j.log4j.MavenLogAppender;
   5 import java.io.File;
   6 import java.io.FileInputStream;
   7 import java.io.IOException;
   8 import java.io.InputStream;
   9 import java.net.MalformedURLException;
  10 import java.net.URL;
  11 import java.security.NoSuchAlgorithmException;
  12 import java.util.Collections;
  13 import java.util.HashSet;
  14 import java.util.Iterator;
  15 import java.util.LinkedHashSet;
  16 import java.util.List;
  17 import java.util.Map;
  18 import java.util.Map.Entry;
  19 import java.util.Properties;
  20 import java.util.Set;
  21 import java.util.regex.Matcher;
  22 import java.util.regex.Pattern;
  23 import javax.persistence.Embeddable;
  24 import javax.persistence.Entity;
  25 import javax.persistence.MappedSuperclass;
  26 import javax.persistence.spi.PersistenceUnitTransactionType;
  27 import org.apache.maven.artifact.Artifact;
  28 import org.apache.maven.model.Resource;
  29 import org.apache.maven.plugin.AbstractMojo;
  30 import org.apache.maven.plugin.MojoExecutionException;
  31 import org.apache.maven.plugin.MojoFailureException;
  32 import org.apache.maven.project.MavenProject;
  33 import org.hibernate.boot.MetadataBuilder;
  34 import org.hibernate.boot.MetadataSources;
  35 import org.hibernate.boot.cfgxml.internal.ConfigLoader;
  36 import org.hibernate.boot.cfgxml.spi.LoadedConfig;
  37 import org.hibernate.boot.cfgxml.spi.MappingReference;
  38 import org.hibernate.boot.model.naming.ImplicitNamingStrategy;
  39 import org.hibernate.boot.model.naming.PhysicalNamingStrategy;
  40 import org.hibernate.boot.registry.BootstrapServiceRegistry;
  41 import org.hibernate.boot.registry.BootstrapServiceRegistryBuilder;
  42 import org.hibernate.boot.registry.StandardServiceRegistry;
  43 import org.hibernate.boot.registry.StandardServiceRegistryBuilder;
  44 import org.hibernate.boot.registry.classloading.spi.ClassLoaderService;
  45 import org.hibernate.boot.registry.classloading.spi.ClassLoadingException;
  46 import org.hibernate.boot.registry.selector.spi.StrategySelector;
  47 import org.hibernate.boot.spi.MetadataImplementor;
  48 import static org.hibernate.cfg.AvailableSettings.DIALECT;
  49 import static org.hibernate.cfg.AvailableSettings.DRIVER;
  50 import static org.hibernate.cfg.AvailableSettings.FORMAT_SQL;
  51 import static org.hibernate.cfg.AvailableSettings.HBM2DLL_CREATE_NAMESPACES;
  52 import static org.hibernate.cfg.AvailableSettings.IMPLICIT_NAMING_STRATEGY;
  53 import static org.hibernate.cfg.AvailableSettings.PASS;
  54 import static org.hibernate.cfg.AvailableSettings.PHYSICAL_NAMING_STRATEGY;
  55 import static org.hibernate.cfg.AvailableSettings.SHOW_SQL;
  56 import static org.hibernate.cfg.AvailableSettings.USER;
  57 import static org.hibernate.cfg.AvailableSettings.URL;
  58 import org.hibernate.engine.jdbc.connections.spi.ConnectionProvider;
  59 import org.hibernate.internal.util.config.ConfigurationException;
  60 import static org.hibernate.jpa.AvailableSettings.JDBC_DRIVER;
  61 import static org.hibernate.jpa.AvailableSettings.JDBC_PASSWORD;
  62 import static org.hibernate.jpa.AvailableSettings.JDBC_URL;
  63 import static org.hibernate.jpa.AvailableSettings.JDBC_USER;
  64 import org.hibernate.jpa.boot.internal.ParsedPersistenceXmlDescriptor;
  65 import org.hibernate.jpa.boot.internal.PersistenceXmlParser;
  66 import org.hibernate.jpa.boot.spi.ProviderChecker;
  67 import org.scannotation.AnnotationDB;
  68
  69
  70 /**
  71  * Baseclass with common attributes and methods.
  72  *
  73  * @phase process-classes
  74  * @threadSafe
  75  * @requiresDependencyResolution runtime
  76  */
  77 public abstract class AbstractSchemaMojo extends AbstractMojo
  78 {
  79   public final static String EXPORT = "hibernate.schema.export";
  80   public final static String DELIMITER = "hibernate.schema.delimiter";
  81   public final static String OUTPUTDIRECTORY = "project.build.outputDirectory";
  82   public final static String SCAN_CLASSES = "hibernate.schema.scan.classes";
  83   public final static String SCAN_DEPENDENCIES = "hibernate.schema.scan.dependencies";
  84   public final static String SCAN_TESTCLASSES = "hibernate.schema.scan.test_classes";
  85   public final static String TEST_OUTPUTDIRECTORY = "project.build.testOutputDirectory";
  86   public final static String SKIPPED = "hibernate.schema.skipped";
  87
  88   private final static Pattern SPLIT = Pattern.compile("[^,\\s]+");
  89
  90   private final Set<String> packages = new HashSet<String>();
  91
  92   /**
  93    * The maven project.
  94    * <p>
  95    * Only needed internally.
  96    *
  97    * @parameter property="project"
  98    * @required
  99    * @readonly
 100    */
 101   private MavenProject project;
 102
 103   /**
 104    * Build-directory.
 105    * <p>
 106    * Only needed internally.
 107    *
 108    * @parameter property="project.build.directory"
 109    * @required
 110    * @readonly
 111    */
 112   String buildDirectory;
 113
 114
 115   /** Parameters to configure the genaration of the SQL *********************/
 116
 117   /**
 118    * Export the database-schma to the database.
 119    * If set to <code>false</code>, only the SQL-script is created and the
 120    * database is not touched.
 121    * <p>
 122    * <strong>Important:</strong>
 123    * This configuration value can only be configured through the
 124    * <code>pom.xml</code>, or by the definition of a system-property, because
 125    * it is not known by Hibernate nor JPA and, hence, not picked up from
 126    * their configuration!
 127    *
 128    * @parameter property="hibernate.schema.export" default-value="true"
 129    * @since 2.0
 130    */
 131   Boolean export;
 132
 133   /**
 134    * Skip execution
 135    * <p>
 136    * If set to <code>true</code>, the execution is skipped.
 137    * <p>
 138    * A skipped execution is signaled via the maven-property
 139    * <code>${hibernate.export.skipped}</code>.
 140    * <p>
 141    * The execution is skipped automatically, if no modified or newly added
 142    * annotated classes are found and the dialect was not changed.
 143    * <p>
 144    * <strong>Important:</strong>
 145    * This configuration value can only be configured through the
 146    * <code>pom.xml</code>, or by the definition of a system-property, because
 147    * it is not known by Hibernate nor JPA and, hence, not picked up from
 148    * their configuration!
 149    *
 150    * @parameter property="hibernate.schema.skip" default-value="${maven.test.skip}"
 151    * @since 1.0
 152    */
 153   private boolean skip;
 154
 155   /**
 156    * Force execution
 157    * <p>
 158    * Force execution, even if no modified or newly added annotated classes
 159    * where found and the dialect was not changed.
 160    * <p>
 161    * <code>skip</code> takes precedence over <code>force</code>.
 162    * <p>
 163    * <strong>Important:</strong>
 164    * This configuration value can only be configured through the
 165    * <code>pom.xml</code>, or by the definition of a system-property, because
 166    * it is not known by Hibernate nor JPA and, hence, not picked up from
 167    * their configuration!
 168    *
 169    * @parameter property="hibernate.schema.force" default-value="false"
 170    * @since 1.0
 171    */
 172   private boolean force;
 173
 174   /**
 175    * Hibernate dialect.
 176    *
 177    * @parameter property="hibernate.dialect"
 178    * @since 1.0
 179    */
 180   private String dialect;
 181
 182   /**
 183    * Delimiter in output-file.
 184    * <p>
 185    * <strong>Important:</strong>
 186    * This configuration value can only be configured through the
 187    * <code>pom.xml</code>, or by the definition of a system-property, because
 188    * it is not known by Hibernate nor JPA and, hence, not picked up from
 189    * their configuration!
 190    *
 191    * @parameter property="hibernate.schema.delimiter" default-value=";"
 192    * @since 1.0
 193    */
 194   String delimiter;
 195
 196   /**
 197    * Show the generated SQL in the command-line output.
 198    *
 199    * @parameter property="hibernate.show_sql"
 200    * @since 1.0
 201    */
 202   Boolean show;
 203
 204   /**
 205    * Format output-file.
 206    *
 207    * @parameter property="hibernate.format_sql"
 208    * @since 1.0
 209    */
 210   Boolean format;
 211
 212   /**
 213    * Specifies whether to automatically create also the database schema/catalog.
 214    *
 215    * @parameter property="hibernate.hbm2dll.create_namespaces" default-value="false"
 216    * @since 2.0
 217    */
 218   Boolean createNamespaces;
 219
 220   /**
 221    * Implicit naming strategy
 222    *
 223    * @parameter property="hibernate.implicit_naming_strategy"
 224    * @since 2.0
 225    */
 226   private String implicitNamingStrategy;
 227
 228   /**
 229    * Physical naming strategy
 230    *
 231    * @parameter property="hibernate.physical_naming_strategy"
 232    * @since 2.0
 233    */
 234   private String physicalNamingStrategy;
 235
 236   /**
 237    * Wether the project should be scanned for annotated-classes, or not
 238    * <p>
 239    * This parameter is intended to allow overwriting of the parameter
 240    * <code>exclude-unlisted-classes</code> of a <code>persistence-unit</code>.
 241    * If not specified, it defaults to <code>true</code>
 242    *
 243    * @parameter property="hibernate.schema.scan.classes"
 244    * @since 2.0
 245    */
 246   private Boolean scanClasses;
 247
 248   /**
 249    * Classes-Directory to scan.
 250    * <p>
 251    * This parameter defaults to the maven build-output-directory for classes.
 252    * Additionally, all dependencies are scanned for annotated classes.
 253    * <p>
 254    * <strong>Important:</strong>
 255    * This configuration value can only be configured through the
 256    * <code>pom.xml</code>, or by the definition of a system-property, because
 257    * it is not known by Hibernate nor JPA and, hence, not picked up from
 258    * their configuration!
 259    *
 260    * @parameter property="project.build.outputDirectory"
 261    * @since 1.0
 262    */
 263   private String outputDirectory;
 264
 265   /**
 266    * Dependency-Scopes, that should be scanned for annotated classes.
 267    * <p>
 268    * By default, only dependencies in the scope <code>compile</code> are
 269    * scanned for annotated classes. Multiple scopes can be seperated by
 270    * white space or commas.
 271    * <p>
 272    * If you do not want any dependencies to be scanned for annotated
 273    * classes, set this parameter to <code>none</code>.
 274    * <p>
 275    * The plugin does not scan for annotated classes in transitive
 276    * dependencies. If some of your annotated classes are hidden in a
 277    * transitive dependency, you can simply add that dependency explicitly.
 278    *
 279    * @parameter property="hibernate.schema.scan.dependencies" default-value="compile"
 280    * @since 1.0.3
 281    */
 282   private String scanDependencies;
 283
 284   /**
 285    * Whether to scan the test-branch of the project for annotated classes, or
 286    * not.
 287    * <p>
 288    * If this parameter is set to <code>true</code> the test-classes of the
 289    * artifact will be scanned for hibernate-annotated classes additionally.
 290    * <p>
 291    * <strong>Important:</strong>
 292    * This configuration value can only be configured through the
 293    * <code>pom.xml</code>, or by the definition of a system-property, because
 294    * it is not known by Hibernate nor JPA and, hence, not picked up from
 295    * their configuration!
 296    *
 297    * @parameter property="hibernate.schema.scan.test_classes" default-value="false"
 298    * @since 1.0.1
 299    */
 300   private Boolean scanTestClasses;
 301
 302   /**
 303    * Test-Classes-Directory to scan.
 304    * <p>
 305    * This parameter defaults to the maven build-output-directory for
 306    * test-classes.
 307    * <p>
 308    * This parameter is only used, when <code>scanTestClasses</code> is set
 309    * to <code>true</code>!
 310    * <p>
 311    * <strong>Important:</strong>
 312    * This configuration value can only be configured through the
 313    * <code>pom.xml</code>, or by the definition of a system-property, because
 314    * it is not known by Hibernate nor JPA and, hence, not picked up from
 315    * their configuration!
 316    *
 317    * @parameter property="project.build.testOutputDirectory"
 318    * @since 1.0.2
 319    */
 320   private String testOutputDirectory;
 321
 322
 323   /** Conection parameters *************************************************/
 324
 325   /**
 326    * SQL-Driver name.
 327    *
 328    * @parameter property="hibernate.connection.driver_class"
 329    * @since 1.0
 330    */
 331   private String driver;
 332
 333   /**
 334    * Database URL.
 335    *
 336    * @parameter property="hibernate.connection.url"
 337    * @since 1.0
 338    */
 339   private String url;
 340
 341   /**
 342    * Database username
 343    *
 344    * @parameter property="hibernate.connection.username"
 345    * @since 1.0
 346    */
 347   private String username;
 348
 349   /**
 350    * Database password
 351    *
 352    * @parameter property="hibernate.connection.password"
 353    * @since 1.0
 354    */
 355   private String password;
 356
 357
 358   /** Parameters to locate configuration sources ****************************/
 359
 360   /**
 361    * Path to a file or name of a ressource with hibernate properties.
 362    * If this parameter is specified, the plugin will try to load configuration
 363    * values from a file with the given path or a ressource on the classpath with
 364    * the given name. If both fails, the execution of the plugin will fail.
 365    * <p>
 366    * If this parameter is not set the plugin will load configuration values
 367    * from a ressource named <code>hibernate.properties</code> on the classpath,
 368    * if it is present, but will not fail if there is no such ressource.
 369    * <p>
 370    * During ressource-lookup, the test-classpath takes precedence.
 371    *
 372    * @parameter
 373    * @since 1.0
 374    */
 375   private String hibernateProperties;
 376
 377   /**
 378    * Path to Hibernate configuration file (.cfg.xml).
 379    * If this parameter is specified, the plugin will try to load configuration
 380    * values from a file with the given path or a ressource on the classpath with
 381    * the given name. If both fails, the execution of the plugin will fail.
 382    * <p>
 383    * If this parameter is not set the plugin will load configuration values
 384    * from a ressource named <code>hibernate.cfg.xml</code> on the classpath,
 385    * if it is present, but will not fail if there is no such ressource.
 386    * <p>
 387    * During ressource-lookup, the test-classpath takes precedence.
 388    * <p>
 389    * Settings in this file will overwrite settings in the properties file.
 390    *
 391    * @parameter
 392    * @since 1.1.0
 393    */
 394   private String hibernateConfig;
 395
 396   /**
 397    * Name of the persistence-unit.
 398    * If this parameter is specified, the plugin will try to load configuration
 399    * values from a persistence-unit with the specified name. If no such
 400    * persistence-unit can be found, the plugin will throw an exception.
 401    * <p>
 402    * If this parameter is not set and there is only one persistence-unit
 403    * available, that unit will be used automatically. But if this parameter is
 404    * not set and there are multiple persistence-units available on,
 405    * the class-path, the execution of the plugin will fail.
 406    * <p>
 407    * Settings in this file will overwrite settings in the properties or the
 408    * configuration file.
 409    *
 410    * @parameter
 411    * @since 1.1.0
 412    */
 413   private String persistenceUnit;
 414
 415   /**
 416    * List of Hibernate-Mapping-Files (XML).
 417    * Multiple files can be separated with white-spaces and/or commas.
 418    *
 419    * @parameter property="hibernate.mapping"
 420    * @since 1.0.2
 421    */
 422   private String mappings;
 423
 424
 425
 426   public final void execute(String filename)
 427     throws
 428       MojoFailureException,
 429       MojoExecutionException
 430   {
 431     if (skip)
 432     {
 433       getLog().info("Execution of hibernate-maven-plugin was skipped!");
 434       project.getProperties().setProperty(SKIPPED, "true");
 435       return;
 436     }
 437
 438     ModificationTracker tracker;
 439     try
 440     {
 441       tracker = new ModificationTracker(buildDirectory, filename, getLog());
 442     }
 443     catch (NoSuchAlgorithmException e)
 444     {
 445       throw new MojoFailureException("Digest-Algorithm MD5 is missing!", e);
 446     }
 447
 448     SimpleConnectionProvider connectionProvider =
 449         new SimpleConnectionProvider(getLog());
 450
 451     try
 452     {
 453       /** Start extended logging */
 454       MavenLogAppender.startPluginLog(this);
 455
 456       /** Load checksums for old mapping and configuration */
 457       tracker.load();
 458
 459       /** Create the ClassLoader */
 460       MutableClassLoader classLoader = createClassLoader();
 461
 462       /** Create a BootstrapServiceRegistry with the created ClassLoader */
 463       BootstrapServiceRegistry bootstrapServiceRegitry =
 464           new BootstrapServiceRegistryBuilder()
 465               .applyClassLoader(classLoader)
 466               .build();
 467       ClassLoaderService classLoaderService =
 468           bootstrapServiceRegitry.getService(ClassLoaderService.class);
 469
 470       Properties properties = new Properties();
 471       ConfigLoader configLoader = new ConfigLoader(bootstrapServiceRegitry);
 472
 473       /** Loading and merging configuration */
 474       properties.putAll(loadProperties(configLoader));
 475       LoadedConfig config = loadConfig(configLoader);
 476       if (config != null)
 477         properties.putAll(config.getConfigurationValues());
 478       ParsedPersistenceXmlDescriptor unit =
 479           loadPersistenceUnit(classLoaderService, properties);
 480       if (unit != null)
 481         properties.putAll(unit.getProperties());
 482
 483       /** Overwriting/Completing configuration */
 484       configure(properties, tracker);
 485
 486       /** Check configuration for modifications */
 487       if(tracker.track(properties))
 488         getLog().debug("Configuration has changed.");
 489       else
 490         getLog().debug("Configuration unchanged.");
 491
 492       /** Configure Hibernate */
 493       StandardServiceRegistry serviceRegistry =
 494           new StandardServiceRegistryBuilder(bootstrapServiceRegitry)
 495               .applySettings(properties)
 496               .addService(ConnectionProvider.class, connectionProvider)
 497               .build();
 498       MetadataSources sources = new MetadataSources(serviceRegistry);
 499
 500       /** Add the remaining class-path-elements */
 501       completeClassPath(classLoader);
 502
 503       /** Apply mappings from hibernate-configuration, if present */
 504       if (config != null)
 505       {
 506         for (MappingReference mapping : config.getMappingReferences())
 507           mapping.apply(sources);
 508       }
 509
 510       Set<String> classes;
 511       if (unit == null)
 512       {
 513         /** No persistent unit: default behaviour */
 514         if (scanClasses == null)
 515           scanClasses = true;
 516         Set<URL> urls = new HashSet<URL>();
 517         if (scanClasses)
 518           addRoot(urls, outputDirectory);
 519         if (scanTestClasses)
 520           addRoot(urls, testOutputDirectory);
 521         addDependencies(urls);
 522         classes = scanUrls(urls);
 523       }
 524       else
 525       {
 526         /** Follow configuration in persisten unit */
 527         if (scanClasses == null)
 528           scanClasses = !unit.isExcludeUnlistedClasses();
 529         Set<URL> urls = new HashSet<URL>();
 530         if (scanClasses)
 531         {
 532           /**
 533            * Scan the root of the persiten unit and configured jars for
 534            * annotated classes
 535            */
 536           urls.add(unit.getPersistenceUnitRootUrl());
 537           for (URL url : unit.getJarFileUrls())
 538             urls.add(url);
 539         }
 540         if (scanTestClasses)
 541           addRoot(urls, testOutputDirectory);
 542         classes = scanUrls(urls);
 543         for (String className : unit.getManagedClassNames())
 544           classes.add(className);
 545       }
 546
 547       /** Add the configured/collected annotated classes */
 548       for (String className : classes)
 549         addAnnotated(className, sources, classLoaderService, tracker);
 550
 551       /** Add explicitly configured classes */
 552       addMappings(sources, tracker);
 553
 554       /** Skip execution, if mapping and configuration is unchanged */
 555       if (!tracker.modified())
 556       {
 557         getLog().info(
 558             "Mapping and configuration unchanged."
 559             );
 560         if (force)
 561           getLog().info("Schema generation is forced!");
 562         else
 563         {
 564           getLog().info("Skipping schema generation!");
 565           project.getProperties().setProperty(SKIPPED, "true");
 566           return;
 567         }
 568       }
 569
 570
 571       /** Create a connection, if sufficient configuration infromation is available */
 572       connectionProvider.open(classLoaderService, properties);
 573
 574       MetadataBuilder metadataBuilder = sources.getMetadataBuilder();
 575
 576       StrategySelector strategySelector =
 577           serviceRegistry.getService(StrategySelector.class);
 578
 579       if (properties.containsKey(IMPLICIT_NAMING_STRATEGY))
 580       {
 581         metadataBuilder.applyImplicitNamingStrategy(
 582             strategySelector.resolveStrategy(
 583                 ImplicitNamingStrategy.class,
 584                 properties.getProperty(IMPLICIT_NAMING_STRATEGY)
 585                 )
 586             );
 587       }
 588
 589       if (properties.containsKey(PHYSICAL_NAMING_STRATEGY))
 590       {
 591         metadataBuilder.applyPhysicalNamingStrategy(
 592             strategySelector.resolveStrategy(
 593                 PhysicalNamingStrategy.class,
 594                 properties.getProperty(PHYSICAL_NAMING_STRATEGY)
 595                 )
 596             );
 597       }
 598
 599       /**
 600        * Change class-loader of current thread.
 601        * This is necessary, because still not all parts of Hibernate 5 use
 602        * the newly introduced ClassLoaderService and will fail otherwise!
 603        */
 604       Thread thread = Thread.currentThread();
 605       ClassLoader contextClassLoader = thread.getContextClassLoader();
 606       try
 607       {
 608         thread.setContextClassLoader(classLoader);
 609         build((MetadataImplementor)metadataBuilder.build());
 610       }
 611       finally
 612       {
 613         thread.setContextClassLoader(contextClassLoader);
 614       }
 615     }
 616     finally
 617     {
 618       /** Remember mappings and configuration */
 619       tracker.save();
 620
 621       /** Close the connection - if one was opened */
 622       connectionProvider.close();
 623
 624       /** Stop Log-Capturing */
 625       MavenLogAppender.endPluginLog(this);
 626     }
 627   }
 628
 629
 630   abstract void build(MetadataImplementor metadata)
 631     throws
 632       MojoFailureException,
 633       MojoExecutionException;
 634
 635
 636   private MutableClassLoader createClassLoader() throws MojoExecutionException
 637   {
 638     try
 639     {
 640       getLog().debug("Creating ClassLoader for project-dependencies...");
 641       LinkedHashSet<URL> urls = new LinkedHashSet<URL>();
 642       File file;
 643
 644       file = new File(testOutputDirectory);
 645       if (!file.exists())
 646       {
 647         getLog().info("Creating test-output-directory: " + testOutputDirectory);
 648         file.mkdirs();
 649       }
 650       urls.add(file.toURI().toURL());
 651
 652       file = new File(outputDirectory);
 653       if (!file.exists())
 654       {
 655         getLog().info("Creating output-directory: " + outputDirectory);
 656         file.mkdirs();
 657       }
 658       urls.add(file.toURI().toURL());
 659
 660       return new MutableClassLoader(urls, getLog());
 661     }
 662     catch (Exception e)
 663     {
 664       getLog().error("Error while creating ClassLoader!", e);
 665       throw new MojoExecutionException(e.getMessage());
 666     }
 667   }
 668
 669   private void completeClassPath(MutableClassLoader classLoader)
 670       throws
 671         MojoExecutionException
 672   {
 673     try
 674     {
 675       getLog().debug("Completing class-paths of the ClassLoader for project-dependencies...");
 676       List<String> classpathFiles = project.getCompileClasspathElements();
 677       if (scanTestClasses)
 678         classpathFiles.addAll(project.getTestClasspathElements());
 679       LinkedHashSet<URL> urls = new LinkedHashSet<URL>();
 680       for (String pathElement : classpathFiles)
 681       {
 682         getLog().debug("Dependency: " + pathElement);
 683         urls.add(new File(pathElement).toURI().toURL());
 684       }
 685       classLoader.add(urls);
 686     }
 687     catch (Exception e)
 688     {
 689       getLog().error("Error while creating ClassLoader!", e);
 690       throw new MojoExecutionException(e.getMessage());
 691     }
 692   }
 693
 694   private Map loadProperties(ConfigLoader configLoader)
 695       throws
 696         MojoExecutionException
 697   {
 698     /** Try to read configuration from properties-file */
 699     if (hibernateProperties == null)
 700     {
 701       try
 702       {
 703         return configLoader.loadProperties("hibernate.properties");
 704       }
 705       catch (ConfigurationException e)
 706       {
 707         getLog().debug(e.getMessage());
 708         return Collections.EMPTY_MAP;
 709       }
 710     }
 711     else
 712     {
 713       try
 714       {
 715         File file = new File(hibernateProperties);
 716         if (file.exists())
 717         {
 718           getLog().info("Reading settings from file " + hibernateProperties + "...");
 719           return configLoader.loadProperties(file);
 720         }
 721         else
 722           return configLoader.loadProperties(hibernateProperties);
 723       }
 724       catch (ConfigurationException e)
 725       {
 726         getLog().error("Error while reading properties!", e);
 727         throw new MojoExecutionException(e.getMessage());
 728       }
 729     }
 730   }
 731
 732   private LoadedConfig loadConfig(ConfigLoader configLoader)
 733       throws MojoExecutionException
 734   {
 735     /** Try to read configuration from configuration-file */
 736     if (hibernateConfig == null)
 737     {
 738       try
 739       {
 740         return configLoader.loadConfigXmlResource("hibernate.cfg.xml");
 741       }
 742       catch (ConfigurationException e)
 743       {
 744         getLog().debug(e.getMessage());
 745         return null;
 746       }
 747     }
 748     else
 749     {
 750       try
 751       {
 752         File file = new File(hibernateConfig);
 753         if (file.exists())
 754         {
 755           getLog().info("Reading configuration from file " + hibernateConfig + "...");
 756           return configLoader.loadConfigXmlFile(file);
 757         }
 758         else
 759         {
 760           return configLoader.loadConfigXmlResource(hibernateConfig);
 761         }
 762       }
 763       catch (ConfigurationException e)
 764       {
 765         getLog().error("Error while reading configuration!", e);
 766         throw new MojoExecutionException(e.getMessage());
 767       }
 768     }
 769   }
 770
 771   private void configure(Properties properties, ModificationTracker tracker)
 772       throws MojoFailureException
 773   {
 774     /**
 775      * Special treatment for the configuration-value "export": if it is
 776      * switched to "true", the genearation fo the schema should be forced!
 777      */
 778     if (tracker.check(EXPORT, export.toString()) && export)
 779       tracker.touch();
 780
 781     /**
 782      * Configure the generation of the SQL.
 783      * Overwrite values from properties-file if the configuration parameter is
 784      * known to Hibernate.
 785      */
 786     dialect = configure(properties, dialect, DIALECT);
 787     tracker.track(DELIMITER, delimiter); // << not reflected in hibernate configuration!
 788     format = configure(properties, format, FORMAT_SQL);
 789     createNamespaces = configure(properties, createNamespaces, HBM2DLL_CREATE_NAMESPACES);
 790     implicitNamingStrategy = configure(properties, implicitNamingStrategy, IMPLICIT_NAMING_STRATEGY);
 791     physicalNamingStrategy = configure(properties, physicalNamingStrategy, PHYSICAL_NAMING_STRATEGY);
 792     tracker.track(OUTPUTDIRECTORY, outputDirectory); // << not reflected in hibernate configuration!
 793     tracker.track(SCAN_DEPENDENCIES, scanDependencies); // << not reflected in hibernate configuration!
 794     tracker.track(SCAN_TESTCLASSES, scanTestClasses.toString()); // << not reflected in hibernate configuration!
 795     tracker.track(TEST_OUTPUTDIRECTORY, testOutputDirectory); // << not reflected in hibernate configuration!
 796
 797     /**
 798      * Special treatment for the configuration-value "show": a change of its
 799      * configured value should not lead to a regeneration of the database
 800      * schama!
 801      */
 802     if (show == null)
 803       show = Boolean.valueOf(properties.getProperty(SHOW_SQL));
 804     else
 805       properties.setProperty(SHOW_SQL, show.toString());
 806
 807     /**
 808      * Configure the connection parameters.
 809      * Overwrite values from properties-file.
 810      */
 811     driver = configure(properties, driver, DRIVER, JDBC_DRIVER);
 812     url = configure(properties, url, URL, JDBC_URL);
 813     username = configure(properties, username, USER, JDBC_USER);
 814     password = configure(properties, password, PASS, JDBC_PASSWORD);
 815
 816     if (properties.isEmpty())
 817     {
 818       getLog().error("No properties set!");
 819       throw new MojoFailureException("Hibernate configuration is missing!");
 820     }
 821
 822     getLog().info("Gathered hibernate-configuration (turn on debugging for details):");
 823     for (Entry<Object,Object> entry : properties.entrySet())
 824       getLog().info("  " + entry.getKey() + " = " + entry.getValue());
 825   }
 826
 827   private String configure(
 828       Properties properties,
 829       String value,
 830       String key,
 831       String alternativeKey
 832       )
 833   {
 834     value = configure(properties, value, key);
 835     if (value == null)
 836       return properties.getProperty(alternativeKey);
 837
 838     if (properties.containsKey(alternativeKey))
 839     {
 840       getLog().warn(
 841           "Ignoring property " + alternativeKey + "=" +
 842           properties.getProperty(alternativeKey) + " in favour for property " +
 843           key + "=" + properties.getProperty(key)
 844           );
 845       properties.remove(alternativeKey);
 846     }
 847     return properties.getProperty(alternativeKey);
 848   }
 849
 850   private String configure(Properties properties, String value, String key)
 851   {
 852     if (value != null)
 853     {
 854       if (properties.containsKey(key))
 855         getLog().debug(
 856             "Overwriting property " + key + "=" + properties.getProperty(key) +
 857             " with the value " + value
 858             );
 859       else
 860         getLog().debug("Using the value " + value + " for property " + key);
 861       properties.setProperty(key, value);
 862     }
 863     return properties.getProperty(key);
 864   }
 865
 866   private boolean configure(Properties properties, Boolean value, String key)
 867   {
 868     if (value != null)
 869     {
 870       if (properties.containsKey(key))
 871         getLog().debug(
 872             "Overwriting property " + key + "=" + properties.getProperty(key) +
 873             " with the value " + value
 874             );
 875       else
 876         getLog().debug("Using the value " + value + " for property " + key);
 877       properties.setProperty(key, value.toString());
 878     }
 879     return Boolean.valueOf(properties.getProperty(key));
 880   }
 881
 882   private void addMappings(MetadataSources sources, ModificationTracker tracker)
 883       throws MojoFailureException
 884   {
 885     getLog().debug("Adding explicitly configured mappings...");
 886     if (mappings != null)
 887     {
 888       try
 889       {
 890         for (String filename : mappings.split("[\\s,]+"))
 891         {
 892           // First try the filename as absolute/relative path
 893           File file = new File(filename);
 894           if (!file.exists())
 895           {
 896             // If the file was not found, search for it in the resource-directories
 897             for (Resource resource : project.getResources())
 898             {
 899               file = new File(resource.getDirectory() + File.separator + filename);
 900               if (file.exists())
 901                 break;
 902             }
 903           }
 904           if (file.exists())
 905           {
 906             if (file.isDirectory())
 907               // TODO: add support to read all mappings under a directory
 908               throw new MojoFailureException(file.getAbsolutePath() + " is a directory");
 909             if (tracker.track(filename, new FileInputStream(file)))
 910               getLog().debug("Found new or modified mapping-file: " + filename);
 911             else
 912               getLog().debug("Mapping-file unchanged: " + filename);
 913
 914             sources.addFile(file);
 915           }
 916           else
 917             throw new MojoFailureException("File " + filename + " could not be found in any of the configured resource-directories!");
 918         }
 919       }
 920       catch (IOException e)
 921       {
 922         throw new MojoFailureException("Cannot calculate MD5 sums!", e);
 923       }
 924     }
 925   }
 926
 927   private void addRoot(Set<URL> urls, String path) throws MojoFailureException
 928   {
 929     try
 930     {
 931       File dir = new File(outputDirectory);
 932       if (dir.exists())
 933       {
 934         getLog().info("Adding " + dir.getAbsolutePath() + " to the list of roots to scan...");
 935         urls.add(dir.toURI().toURL());
 936       }
 937     }
 938     catch (MalformedURLException e)
 939     {
 940       getLog().error("error while adding the project-root to the list of roots to scan!", e);
 941       throw new MojoFailureException(e.getMessage());
 942     }
 943   }
 944
 945   private void addDependencies(Set<URL> urls) throws MojoFailureException
 946   {
 947     try
 948     {
 949       if (scanDependencies != null)
 950       {
 951         Matcher matcher = SPLIT.matcher(scanDependencies);
 952         while (matcher.find())
 953         {
 954           getLog().info("Adding dependencies from scope " + matcher.group() + " to the list of roots to scan");
 955           for (Artifact artifact : project.getDependencyArtifacts())
 956           {
 957             if (!artifact.getScope().equalsIgnoreCase(matcher.group()))
 958               continue;
 959             if (artifact.getFile() == null)
 960             {
 961               getLog().warn("Cannot add dependency " + artifact.getId() + ": no JAR-file available!");
 962               continue;
 963             }
 964             getLog().info("Adding dependencies from scope " + artifact.getId() + " to the list of roots to scan");
 965             urls.add(artifact.getFile().toURI().toURL());
 966           }
 967         }
 968       }
 969     }
 970     catch (MalformedURLException e)
 971     {
 972       getLog().error("Error while adding dependencies to the list of roots to scan!", e);
 973       throw new MojoFailureException(e.getMessage());
 974     }
 975   }
 976
 977   private Set<String> scanUrls(Set<URL> scanRoots)
 978       throws
 979         MojoFailureException
 980   {
 981     try
 982     {
 983       AnnotationDB db = new AnnotationDB();
 984       for (URL root : scanRoots)
 985         db.scanArchives(root);
 986
 987       Set<String> classes = new HashSet<String>();
 988       if (db.getAnnotationIndex().containsKey(Entity.class.getName()))
 989         classes.addAll(db.getAnnotationIndex().get(Entity.class.getName()));
 990       if (db.getAnnotationIndex().containsKey(MappedSuperclass.class.getName()))
 991         classes.addAll(db.getAnnotationIndex().get(MappedSuperclass.class.getName()));
 992       if (db.getAnnotationIndex().containsKey(Embeddable.class.getName()))
 993         classes.addAll(db.getAnnotationIndex().get(Embeddable.class.getName()));
 994
 995       return classes;
 996     }
 997     catch (Exception e)
 998     {
 999       getLog().error("Error while scanning!", e);
1000       throw new MojoFailureException(e.getMessage());
1001     }
1002   }
1003
1004   private void addAnnotated(
1005       String name,
1006       MetadataSources sources,
1007       ClassLoaderService classLoaderService,
1008       ModificationTracker tracker
1009       )
1010       throws
1011         MojoFailureException,
1012         MojoExecutionException
1013   {
1014     try
1015     {
1016       getLog().info("Adding annotated resource: " + name);
1017       String packageName;
1018
1019       try
1020       {
1021         Class<?> annotatedClass = classLoaderService.classForName(name);
1022         String resourceName = annotatedClass.getName();
1023         resourceName =
1024             resourceName.substring(
1025                 resourceName.lastIndexOf(".") + 1,
1026                 resourceName.length()
1027                 ) + ".class";
1028         InputStream is = annotatedClass.getResourceAsStream(resourceName);
1029         if (tracker.track(name, is))
1030           getLog().debug("New or modified class: " + name);
1031         else
1032           getLog().debug("Unchanged class: " + name);
1033         sources.addAnnotatedClass(annotatedClass);
1034         packageName = annotatedClass.getPackage().getName();
1035       }
1036       catch(ClassLoadingException e)
1037       {
1038         packageName = name;
1039       }
1040
1041       if (!packages.contains(packageName))
1042       {
1043         String resource = packageName.replace('.', '/') + "/package-info.class";
1044         InputStream is = classLoaderService.locateResourceStream(resource);
1045         if (is == null)
1046         {
1047           // No compiled package-info available: no package-level annotations!
1048           getLog().debug("Package " + packageName + " is not annotated.");
1049         }
1050         else
1051         {
1052           if (tracker.track(packageName, is))
1053             getLog().debug("New or modified package: " + packageName);
1054           else
1055            getLog().debug("Unchanged package: " + packageName);
1056           getLog().info("Adding annotated package " + packageName);
1057           sources.addPackage(packageName);
1058         }
1059         packages.add(packageName);
1060       }
1061     }
1062     catch (Exception e)
1063     {
1064       getLog().error("Error while adding the annotated class " + name, e);
1065       throw new MojoFailureException(e.getMessage());
1066     }
1067   }
1068
1069   private ParsedPersistenceXmlDescriptor loadPersistenceUnit(
1070       ClassLoaderService classLoaderService,
1071       Properties properties
1072       )
1073       throws
1074         MojoFailureException
1075   {
1076     PersistenceXmlParser parser =
1077         new PersistenceXmlParser(
1078             classLoaderService,
1079             PersistenceUnitTransactionType.RESOURCE_LOCAL
1080              );
1081
1082     List<ParsedPersistenceXmlDescriptor> units = parser.doResolve(properties);
1083
1084     if (persistenceUnit == null)
1085     {
1086       switch (units.size())
1087       {
1088         case 0:
1089           getLog().info("Found no META-INF/persistence.xml.");
1090           return null;
1091         case 1:
1092           getLog().info("Using persistence-unit " + units.get(0).getName());
1093           return units.get(0);
1094         default:
1095           StringBuilder builder = new StringBuilder();
1096           builder.append("No name provided and multiple persistence units found: ");
1097           Iterator<ParsedPersistenceXmlDescriptor> it = units.iterator();
1098           builder.append(it.next().getName());
1099           while (it.hasNext())
1100           {
1101             builder.append(", ");
1102             builder.append(it.next().getName());
1103           }
1104           builder.append('.');
1105           throw new MojoFailureException(builder.toString());
1106       }
1107     }
1108
1109     for (ParsedPersistenceXmlDescriptor unit : units)
1110     {
1111       getLog().debug("Found persistence-unit " + unit.getName());
1112       if (!unit.getName().equals(persistenceUnit))
1113         continue;
1114
1115       // See if we (Hibernate) are the persistence provider
1116       if (!ProviderChecker.isProvider(unit, properties))
1117       {
1118         getLog().debug("Wrong provider: " + unit.getProviderClassName());
1119         continue;
1120       }
1121
1122       getLog().info("Using persistence-unit " + unit.getName());
1123       return unit;
1124     }
1125
1126     throw new MojoFailureException("Could not find persistence-unit " + persistenceUnit);
1127   }
1128 }