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          * Add mappings from the default mapping-file
 547          * <code>META-INF/orm.xml</code>, if present
 548          */
 549         try
 550         {
 551           InputStream is = classLoader.getResourceAsStream("META-INF/orm.xml");
 552           if (is != null)
 553           {
 554             getLog().info("Adding default JPA-XML-mapping from META-INF/orm.xml");
 555             tracker.track("META-INF/orm.xml", is);
 556             sources.addResource("META-INF/orm.xml");
 557           }
 558           /**
 559            * Add mappings from files, that are explicitly configured in the
 560            * persistence unit
 561            */
 562           for (String mapping : unit.getMappingFileNames())
 563           {
 564             getLog().info("Adding explicitly configured mapping from " + mapping);
 565             tracker.track(mapping, classLoader.getResourceAsStream(mapping));
 566             sources.addResource(mapping);
 567           }
 568         }
 569         catch (IOException e)
 570         {
 571           throw new MojoFailureException("Error reading XML-mappings", e);
 572         }
 573       }
 574
 575       /** Add the configured/collected annotated classes */
 576       for (String className : classes)
 577         addAnnotated(className, sources, classLoaderService, tracker);
 578
 579       /** Add explicitly configured classes */
 580       addMappings(sources, tracker);
 581
 582       /** Skip execution, if mapping and configuration is unchanged */
 583       if (!tracker.modified())
 584       {
 585         getLog().info(
 586             "Mapping and configuration unchanged."
 587             );
 588         if (force)
 589           getLog().info("Schema generation is forced!");
 590         else
 591         {
 592           getLog().info("Skipping schema generation!");
 593           project.getProperties().setProperty(SKIPPED, "true");
 594           return;
 595         }
 596       }
 597
 598
 599       /** Create a connection, if sufficient configuration infromation is available */
 600       connectionProvider.open(classLoaderService, properties);
 601
 602       MetadataBuilder metadataBuilder = sources.getMetadataBuilder();
 603
 604       StrategySelector strategySelector =
 605           serviceRegistry.getService(StrategySelector.class);
 606
 607       if (properties.containsKey(IMPLICIT_NAMING_STRATEGY))
 608       {
 609         metadataBuilder.applyImplicitNamingStrategy(
 610             strategySelector.resolveStrategy(
 611                 ImplicitNamingStrategy.class,
 612                 properties.getProperty(IMPLICIT_NAMING_STRATEGY)
 613                 )
 614             );
 615       }
 616
 617       if (properties.containsKey(PHYSICAL_NAMING_STRATEGY))
 618       {
 619         metadataBuilder.applyPhysicalNamingStrategy(
 620             strategySelector.resolveStrategy(
 621                 PhysicalNamingStrategy.class,
 622                 properties.getProperty(PHYSICAL_NAMING_STRATEGY)
 623                 )
 624             );
 625       }
 626
 627       /**
 628        * Change class-loader of current thread.
 629        * This is necessary, because still not all parts of Hibernate 5 use
 630        * the newly introduced ClassLoaderService and will fail otherwise!
 631        */
 632       Thread thread = Thread.currentThread();
 633       ClassLoader contextClassLoader = thread.getContextClassLoader();
 634       try
 635       {
 636         thread.setContextClassLoader(classLoader);
 637         build((MetadataImplementor)metadataBuilder.build());
 638       }
 639       finally
 640       {
 641         thread.setContextClassLoader(contextClassLoader);
 642       }
 643     }
 644     finally
 645     {
 646       /** Remember mappings and configuration */
 647       tracker.save();
 648
 649       /** Close the connection - if one was opened */
 650       connectionProvider.close();
 651
 652       /** Stop Log-Capturing */
 653       MavenLogAppender.endPluginLog(this);
 654     }
 655   }
 656
 657
 658   abstract void build(MetadataImplementor metadata)
 659     throws
 660       MojoFailureException,
 661       MojoExecutionException;
 662
 663
 664   private MutableClassLoader createClassLoader() throws MojoExecutionException
 665   {
 666     try
 667     {
 668       getLog().debug("Creating ClassLoader for project-dependencies...");
 669       LinkedHashSet<URL> urls = new LinkedHashSet<URL>();
 670       File file;
 671
 672       file = new File(testOutputDirectory);
 673       if (!file.exists())
 674       {
 675         getLog().info("Creating test-output-directory: " + testOutputDirectory);
 676         file.mkdirs();
 677       }
 678       urls.add(file.toURI().toURL());
 679
 680       file = new File(outputDirectory);
 681       if (!file.exists())
 682       {
 683         getLog().info("Creating output-directory: " + outputDirectory);
 684         file.mkdirs();
 685       }
 686       urls.add(file.toURI().toURL());
 687
 688       return new MutableClassLoader(urls, getLog());
 689     }
 690     catch (Exception e)
 691     {
 692       getLog().error("Error while creating ClassLoader!", e);
 693       throw new MojoExecutionException(e.getMessage());
 694     }
 695   }
 696
 697   private void completeClassPath(MutableClassLoader classLoader)
 698       throws
 699         MojoExecutionException
 700   {
 701     try
 702     {
 703       getLog().debug("Completing class-paths of the ClassLoader for project-dependencies...");
 704       List<String> classpathFiles = project.getCompileClasspathElements();
 705       if (scanTestClasses)
 706         classpathFiles.addAll(project.getTestClasspathElements());
 707       LinkedHashSet<URL> urls = new LinkedHashSet<URL>();
 708       for (String pathElement : classpathFiles)
 709       {
 710         getLog().debug("Dependency: " + pathElement);
 711         urls.add(new File(pathElement).toURI().toURL());
 712       }
 713       classLoader.add(urls);
 714     }
 715     catch (Exception e)
 716     {
 717       getLog().error("Error while creating ClassLoader!", e);
 718       throw new MojoExecutionException(e.getMessage());
 719     }
 720   }
 721
 722   private Map loadProperties(ConfigLoader configLoader)
 723       throws
 724         MojoExecutionException
 725   {
 726     /** Try to read configuration from properties-file */
 727     if (hibernateProperties == null)
 728     {
 729       try
 730       {
 731         return configLoader.loadProperties("hibernate.properties");
 732       }
 733       catch (ConfigurationException e)
 734       {
 735         getLog().debug(e.getMessage());
 736         return Collections.EMPTY_MAP;
 737       }
 738     }
 739     else
 740     {
 741       try
 742       {
 743         File file = new File(hibernateProperties);
 744         if (file.exists())
 745         {
 746           getLog().info("Reading settings from file " + hibernateProperties + "...");
 747           return configLoader.loadProperties(file);
 748         }
 749         else
 750           return configLoader.loadProperties(hibernateProperties);
 751       }
 752       catch (ConfigurationException e)
 753       {
 754         getLog().error("Error while reading properties!", e);
 755         throw new MojoExecutionException(e.getMessage());
 756       }
 757     }
 758   }
 759
 760   private LoadedConfig loadConfig(ConfigLoader configLoader)
 761       throws MojoExecutionException
 762   {
 763     /** Try to read configuration from configuration-file */
 764     if (hibernateConfig == null)
 765     {
 766       try
 767       {
 768         return configLoader.loadConfigXmlResource("hibernate.cfg.xml");
 769       }
 770       catch (ConfigurationException e)
 771       {
 772         getLog().debug(e.getMessage());
 773         return null;
 774       }
 775     }
 776     else
 777     {
 778       try
 779       {
 780         File file = new File(hibernateConfig);
 781         if (file.exists())
 782         {
 783           getLog().info("Reading configuration from file " + hibernateConfig + "...");
 784           return configLoader.loadConfigXmlFile(file);
 785         }
 786         else
 787         {
 788           return configLoader.loadConfigXmlResource(hibernateConfig);
 789         }
 790       }
 791       catch (ConfigurationException e)
 792       {
 793         getLog().error("Error while reading configuration!", e);
 794         throw new MojoExecutionException(e.getMessage());
 795       }
 796     }
 797   }
 798
 799   private void configure(Properties properties, ModificationTracker tracker)
 800       throws MojoFailureException
 801   {
 802     /**
 803      * Special treatment for the configuration-value "export": if it is
 804      * switched to "true", the genearation fo the schema should be forced!
 805      */
 806     if (tracker.check(EXPORT, export.toString()) && export)
 807       tracker.touch();
 808
 809     /**
 810      * Configure the generation of the SQL.
 811      * Overwrite values from properties-file if the configuration parameter is
 812      * known to Hibernate.
 813      */
 814     dialect = configure(properties, dialect, DIALECT);
 815     tracker.track(DELIMITER, delimiter); // << not reflected in hibernate configuration!
 816     format = configure(properties, format, FORMAT_SQL);
 817     createNamespaces = configure(properties, createNamespaces, HBM2DLL_CREATE_NAMESPACES);
 818     implicitNamingStrategy = configure(properties, implicitNamingStrategy, IMPLICIT_NAMING_STRATEGY);
 819     physicalNamingStrategy = configure(properties, physicalNamingStrategy, PHYSICAL_NAMING_STRATEGY);
 820     tracker.track(OUTPUTDIRECTORY, outputDirectory); // << not reflected in hibernate configuration!
 821     tracker.track(SCAN_DEPENDENCIES, scanDependencies); // << not reflected in hibernate configuration!
 822     tracker.track(SCAN_TESTCLASSES, scanTestClasses.toString()); // << not reflected in hibernate configuration!
 823     tracker.track(TEST_OUTPUTDIRECTORY, testOutputDirectory); // << not reflected in hibernate configuration!
 824
 825     /**
 826      * Special treatment for the configuration-value "show": a change of its
 827      * configured value should not lead to a regeneration of the database
 828      * schama!
 829      */
 830     if (show == null)
 831       show = Boolean.valueOf(properties.getProperty(SHOW_SQL));
 832     else
 833       properties.setProperty(SHOW_SQL, show.toString());
 834
 835     /**
 836      * Configure the connection parameters.
 837      * Overwrite values from properties-file.
 838      */
 839     driver = configure(properties, driver, DRIVER, JDBC_DRIVER);
 840     url = configure(properties, url, URL, JDBC_URL);
 841     username = configure(properties, username, USER, JDBC_USER);
 842     password = configure(properties, password, PASS, JDBC_PASSWORD);
 843
 844     if (properties.isEmpty())
 845     {
 846       getLog().error("No properties set!");
 847       throw new MojoFailureException("Hibernate configuration is missing!");
 848     }
 849
 850     getLog().info("Gathered hibernate-configuration (turn on debugging for details):");
 851     for (Entry<Object,Object> entry : properties.entrySet())
 852       getLog().info("  " + entry.getKey() + " = " + entry.getValue());
 853   }
 854
 855   private String configure(
 856       Properties properties,
 857       String value,
 858       String key,
 859       String alternativeKey
 860       )
 861   {
 862     value = configure(properties, value, key);
 863     if (value == null)
 864       return properties.getProperty(alternativeKey);
 865
 866     if (properties.containsKey(alternativeKey))
 867     {
 868       getLog().warn(
 869           "Ignoring property " + alternativeKey + "=" +
 870           properties.getProperty(alternativeKey) + " in favour for property " +
 871           key + "=" + properties.getProperty(key)
 872           );
 873       properties.remove(alternativeKey);
 874     }
 875     return properties.getProperty(alternativeKey);
 876   }
 877
 878   private String configure(Properties properties, String value, String key)
 879   {
 880     if (value != null)
 881     {
 882       if (properties.containsKey(key))
 883         getLog().debug(
 884             "Overwriting property " + key + "=" + properties.getProperty(key) +
 885             " with the value " + value
 886             );
 887       else
 888         getLog().debug("Using the value " + value + " for property " + key);
 889       properties.setProperty(key, value);
 890     }
 891     return properties.getProperty(key);
 892   }
 893
 894   private boolean configure(Properties properties, Boolean value, String key)
 895   {
 896     if (value != null)
 897     {
 898       if (properties.containsKey(key))
 899         getLog().debug(
 900             "Overwriting property " + key + "=" + properties.getProperty(key) +
 901             " with the value " + value
 902             );
 903       else
 904         getLog().debug("Using the value " + value + " for property " + key);
 905       properties.setProperty(key, value.toString());
 906     }
 907     return Boolean.valueOf(properties.getProperty(key));
 908   }
 909
 910   private void addMappings(MetadataSources sources, ModificationTracker tracker)
 911       throws MojoFailureException
 912   {
 913     getLog().debug("Adding explicitly configured mappings...");
 914     if (mappings != null)
 915     {
 916       try
 917       {
 918         for (String filename : mappings.split("[\\s,]+"))
 919         {
 920           // First try the filename as absolute/relative path
 921           File file = new File(filename);
 922           if (!file.exists())
 923           {
 924             // If the file was not found, search for it in the resource-directories
 925             for (Resource resource : project.getResources())
 926             {
 927               file = new File(resource.getDirectory() + File.separator + filename);
 928               if (file.exists())
 929                 break;
 930             }
 931           }
 932           if (file.exists())
 933           {
 934             if (file.isDirectory())
 935               // TODO: add support to read all mappings under a directory
 936               throw new MojoFailureException(file.getAbsolutePath() + " is a directory");
 937             if (tracker.track(filename, new FileInputStream(file)))
 938               getLog().debug("Found new or modified mapping-file: " + filename);
 939             else
 940               getLog().debug("Mapping-file unchanged: " + filename);
 941
 942             sources.addFile(file);
 943           }
 944           else
 945             throw new MojoFailureException("File " + filename + " could not be found in any of the configured resource-directories!");
 946         }
 947       }
 948       catch (IOException e)
 949       {
 950         throw new MojoFailureException("Cannot calculate MD5 sums!", e);
 951       }
 952     }
 953   }
 954
 955   private void addRoot(Set<URL> urls, String path) throws MojoFailureException
 956   {
 957     try
 958     {
 959       File dir = new File(outputDirectory);
 960       if (dir.exists())
 961       {
 962         getLog().info("Adding " + dir.getAbsolutePath() + " to the list of roots to scan...");
 963         urls.add(dir.toURI().toURL());
 964       }
 965     }
 966     catch (MalformedURLException e)
 967     {
 968       getLog().error("error while adding the project-root to the list of roots to scan!", e);
 969       throw new MojoFailureException(e.getMessage());
 970     }
 971   }
 972
 973   private void addDependencies(Set<URL> urls) throws MojoFailureException
 974   {
 975     try
 976     {
 977       if (scanDependencies != null)
 978       {
 979         Matcher matcher = SPLIT.matcher(scanDependencies);
 980         while (matcher.find())
 981         {
 982           getLog().info("Adding dependencies from scope " + matcher.group() + " to the list of roots to scan");
 983           for (Artifact artifact : project.getDependencyArtifacts())
 984           {
 985             if (!artifact.getScope().equalsIgnoreCase(matcher.group()))
 986               continue;
 987             if (artifact.getFile() == null)
 988             {
 989               getLog().warn("Cannot add dependency " + artifact.getId() + ": no JAR-file available!");
 990               continue;
 991             }
 992             getLog().info("Adding dependencies from scope " + artifact.getId() + " to the list of roots to scan");
 993             urls.add(artifact.getFile().toURI().toURL());
 994           }
 995         }
 996       }
 997     }
 998     catch (MalformedURLException e)
 999     {
1000       getLog().error("Error while adding dependencies to the list of roots to scan!", e);
1001       throw new MojoFailureException(e.getMessage());
1002     }
1003   }
1004
1005   private Set<String> scanUrls(Set<URL> scanRoots)
1006       throws
1007         MojoFailureException
1008   {
1009     try
1010     {
1011       AnnotationDB db = new AnnotationDB();
1012       for (URL root : scanRoots)
1013         db.scanArchives(root);
1014
1015       Set<String> classes = new HashSet<String>();
1016       if (db.getAnnotationIndex().containsKey(Entity.class.getName()))
1017         classes.addAll(db.getAnnotationIndex().get(Entity.class.getName()));
1018       if (db.getAnnotationIndex().containsKey(MappedSuperclass.class.getName()))
1019         classes.addAll(db.getAnnotationIndex().get(MappedSuperclass.class.getName()));
1020       if (db.getAnnotationIndex().containsKey(Embeddable.class.getName()))
1021         classes.addAll(db.getAnnotationIndex().get(Embeddable.class.getName()));
1022
1023       return classes;
1024     }
1025     catch (Exception e)
1026     {
1027       getLog().error("Error while scanning!", e);
1028       throw new MojoFailureException(e.getMessage());
1029     }
1030   }
1031
1032   private void addAnnotated(
1033       String name,
1034       MetadataSources sources,
1035       ClassLoaderService classLoaderService,
1036       ModificationTracker tracker
1037       )
1038       throws
1039         MojoFailureException,
1040         MojoExecutionException
1041   {
1042     try
1043     {
1044       getLog().info("Adding annotated resource: " + name);
1045       String packageName;
1046
1047       try
1048       {
1049         Class<?> annotatedClass = classLoaderService.classForName(name);
1050         String resourceName = annotatedClass.getName();
1051         resourceName =
1052             resourceName.substring(
1053                 resourceName.lastIndexOf(".") + 1,
1054                 resourceName.length()
1055                 ) + ".class";
1056         InputStream is = annotatedClass.getResourceAsStream(resourceName);
1057         if (tracker.track(name, is))
1058           getLog().debug("New or modified class: " + name);
1059         else
1060           getLog().debug("Unchanged class: " + name);
1061         sources.addAnnotatedClass(annotatedClass);
1062         packageName = annotatedClass.getPackage().getName();
1063       }
1064       catch(ClassLoadingException e)
1065       {
1066         packageName = name;
1067       }
1068
1069       if (!packages.contains(packageName))
1070       {
1071         String resource = packageName.replace('.', '/') + "/package-info.class";
1072         InputStream is = classLoaderService.locateResourceStream(resource);
1073         if (is == null)
1074         {
1075           // No compiled package-info available: no package-level annotations!
1076           getLog().debug("Package " + packageName + " is not annotated.");
1077         }
1078         else
1079         {
1080           if (tracker.track(packageName, is))
1081             getLog().debug("New or modified package: " + packageName);
1082           else
1083            getLog().debug("Unchanged package: " + packageName);
1084           getLog().info("Adding annotations from package " + packageName);
1085           sources.addPackage(packageName);
1086         }
1087         packages.add(packageName);
1088       }
1089     }
1090     catch (Exception e)
1091     {
1092       getLog().error("Error while adding the annotated class " + name, e);
1093       throw new MojoFailureException(e.getMessage());
1094     }
1095   }
1096
1097   private ParsedPersistenceXmlDescriptor loadPersistenceUnit(
1098       ClassLoaderService classLoaderService,
1099       Properties properties
1100       )
1101       throws
1102         MojoFailureException
1103   {
1104     PersistenceXmlParser parser =
1105         new PersistenceXmlParser(
1106             classLoaderService,
1107             PersistenceUnitTransactionType.RESOURCE_LOCAL
1108              );
1109
1110     List<ParsedPersistenceXmlDescriptor> units = parser.doResolve(properties);
1111
1112     if (persistenceUnit == null)
1113     {
1114       switch (units.size())
1115       {
1116         case 0:
1117           getLog().info("Found no META-INF/persistence.xml.");
1118           return null;
1119         case 1:
1120           getLog().info("Using persistence-unit " + units.get(0).getName());
1121           return units.get(0);
1122         default:
1123           StringBuilder builder = new StringBuilder();
1124           builder.append("No name provided and multiple persistence units found: ");
1125           Iterator<ParsedPersistenceXmlDescriptor> it = units.iterator();
1126           builder.append(it.next().getName());
1127           while (it.hasNext())
1128           {
1129             builder.append(", ");
1130             builder.append(it.next().getName());
1131           }
1132           builder.append('.');
1133           throw new MojoFailureException(builder.toString());
1134       }
1135     }
1136
1137     for (ParsedPersistenceXmlDescriptor unit : units)
1138     {
1139       getLog().debug("Found persistence-unit " + unit.getName());
1140       if (!unit.getName().equals(persistenceUnit))
1141         continue;
1142
1143       // See if we (Hibernate) are the persistence provider
1144       if (!ProviderChecker.isProvider(unit, properties))
1145       {
1146         getLog().debug("Wrong provider: " + unit.getProviderClassName());
1147         continue;
1148       }
1149
1150       getLog().info("Using persistence-unit " + unit.getName());
1151       return unit;
1152     }
1153
1154     throw new MojoFailureException("Could not find persistence-unit " + persistenceUnit);
1155   }
1156 }