Found annotated classes get logged now
[hibernate4-maven-plugin] / src / main / java / de / juplo / plugins / hibernate4 / Hbm2DdlMojo.java
index f2fd232..04c8517 100644 (file)
@@ -27,14 +27,16 @@ import java.sql.Driver;
 import java.sql.DriverManager;
 import java.sql.DriverPropertyInfo;
 import java.sql.SQLException;
+import java.sql.SQLFeatureNotSupportedException;
 import java.util.Enumeration;
-import java.util.HashSet;
 import java.util.List;
 import java.util.Map.Entry;
 import java.util.Properties;
 import java.util.Set;
-import javax.persistence.Entity;
+import java.util.TreeSet;
+import java.util.logging.Logger;
 import javax.persistence.Embeddable;
+import javax.persistence.Entity;
 import javax.persistence.MappedSuperclass;
 import org.apache.maven.plugin.AbstractMojo;
 import org.apache.maven.plugin.MojoExecutionException;
@@ -58,6 +60,13 @@ import org.scannotation.AnnotationDB;
  */
 public class Hbm2DdlMojo extends AbstractMojo
 {
+  public final static String DRIVER_CLASS = "hibernate.connection.driver_class";
+  public final static String URL = "hibernate.connection.url";
+  public final static String USERNAME = "hibernate.connection.username";
+  public final static String PASSWORD = "hibernate.connection.password";
+  public final static String DIALECT = "hibernate.dialect";
+
+
   /**
    * The project whose project files to create.
    *
@@ -77,7 +86,7 @@ public class Hbm2DdlMojo extends AbstractMojo
   /**
    * Skip execution
    *
-   * @parameter default-value="false"
+   * @parameter expression="${maven.test.skip}"
    */
   private boolean skip;
 
@@ -171,24 +180,27 @@ public class Hbm2DdlMojo extends AbstractMojo
 
   @Override
   public void execute()
-      throws
-        MojoFailureException,
-        MojoExecutionException
+    throws
+      MojoFailureException,
+      MojoExecutionException
   {
     if (skip)
+    {
+      getLog().info("Exectuion of hibernate4-maven-plugin:export was skipped!");
       return;
+    }
 
     File dir = new File(outputDirectory);
     if (!dir.exists())
       throw new MojoExecutionException("Cannot scan for annotated classes in " + outputDirectory + ": directory does not exist!");
 
 
-    Set<String> classes = new HashSet<String>();
-    URL dirUrl = null;
-    try {
+    Set<String> classes = new TreeSet<String>();
+    try
+    {
       AnnotationDB db = new AnnotationDB();
       getLog().info("Scanning directory " + outputDirectory + " for annotated classes...");
-      dirUrl = dir.toURI().toURL();
+      URL dirUrl = dir.toURI().toURL();
       db.scanArchives(dirUrl);
       if (db.getAnnotationIndex().containsKey(Entity.class.getName()))
         classes.addAll(db.getAnnotationIndex().get(Entity.class.getName()));
@@ -197,107 +209,202 @@ public class Hbm2DdlMojo extends AbstractMojo
       if (db.getAnnotationIndex().containsKey(Embeddable.class.getName()))
         classes.addAll(db.getAnnotationIndex().get(Embeddable.class.getName()));
     }
-    catch (IOException e) {
+    catch (IOException e)
+    {
       getLog().error("Error while scanning!", e);
       throw new MojoFailureException(e.getMessage());
     }
     if (classes.isEmpty())
       throw new MojoFailureException("No annotated classes found in directory " + outputDirectory);
 
+    getLog().info("Detected classes with mapping-annotations:");
+    for (String classname : classes)
+      getLog().info("  " + classname);
+
     Properties properties = new Properties();
 
     /** Try to read configuration from properties-file */
-    try {
+    try
+    {
       File file = new File(hibernateProperties);
-      if (file.exists()) {
+      if (file.exists())
+      {
         getLog().info("Reading properties from file " + hibernateProperties + "...");
         properties.load(new FileInputStream(file));
       }
       else
-        getLog().info("Ignoring nonexistent properties-file " + hibernateProperties + "!");
+        getLog().info("No hibernate-properties-file found! Checked path: " + hibernateProperties);
     }
-    catch (IOException e) {
+    catch (IOException e)
+    {
       getLog().error("Error while reading properties!", e);
       throw new MojoExecutionException(e.getMessage());
     }
 
-    /** Overwrite values from propertie-file or set  if given */
+    /** Overwrite values from propertie-file or set, if given */
     if (driverClassName != null)
-      properties.setProperty("hibernate.connection.driver_class", driverClassName);
+    {
+      if (properties.containsKey(DRIVER_CLASS))
+        getLog().debug(
+            "Overwriting property " +
+            DRIVER_CLASS + "=" + properties.getProperty(DRIVER_CLASS) +
+            " with the value " + driverClassName +
+            " from the plugin-configuration-parameter driverClassName!"
+          );
+      else
+        getLog().debug(
+            "Using the value " + driverClassName +
+            " from the plugin-configuration-parameter driverClassName!"
+          );
+      properties.setProperty(DRIVER_CLASS, driverClassName);
+    }
     if (url != null)
-      properties.setProperty("hibernate.connection.url", url);
+    {
+      if (properties.containsKey(URL))
+        getLog().debug(
+            "Overwriting property " +
+            URL + "=" + properties.getProperty(URL) +
+            " with the value " + url +
+            " from the plugin-configuration-parameter url!"
+          );
+      else
+        getLog().debug(
+            "Using the value " + url +
+            " from the plugin-configuration-parameter url!"
+          );
+      properties.setProperty(URL, url);
+    }
     if (username != null)
-      properties.setProperty("hibernate.connection.username", username);
+    {
+      if (properties.containsKey(USERNAME))
+        getLog().debug(
+            "Overwriting property " +
+            USERNAME + "=" + properties.getProperty(USERNAME) +
+            " with the value " + username +
+            " from the plugin-configuration-parameter username!"
+          );
+      else
+        getLog().debug(
+            "Using the value " + username +
+            " from the plugin-configuration-parameter username!"
+          );
+      properties.setProperty(USERNAME, username);
+    }
     if (password != null)
-      properties.setProperty("hibernate.connection.password", password);
+    {
+      if (properties.containsKey(PASSWORD))
+        getLog().debug(
+            "Overwriting property " +
+            PASSWORD + "=" + properties.getProperty(PASSWORD) +
+            " with the value " + password +
+            " from the plugin-configuration-parameter password!"
+          );
+      else
+        getLog().debug(
+            "Using the value " + password +
+            " from the plugin-configuration-parameter password!"
+          );
+      properties.setProperty(PASSWORD, password);
+    }
     if (hibernateDialect != null)
-      properties.setProperty("hibernate.dialect", hibernateDialect);
+    {
+      if (properties.containsKey(DIALECT))
+        getLog().debug(
+            "Overwriting property " +
+            DIALECT + "=" + properties.getProperty(DIALECT) +
+            " with the value " + hibernateDialect +
+            " from the plugin-configuration-parameter hibernateDialect!"
+          );
+      else
+        getLog().debug(
+            "Using the value " + hibernateDialect +
+            " from the plugin-configuration-parameter hibernateDialect!"
+          );
+      properties.setProperty(DIALECT, hibernateDialect);
+    }
 
+    getLog().info("Gathered hibernate-configuration (turn on debugging for details):");
     if (properties.isEmpty())
-      getLog().warn("No properties set!");
+    {
+      getLog().error("No properties set!");
+      throw new MojoFailureException("Hibernate-Configuration is missing!");
+    }
     for (Entry<Object,Object> entry : properties.entrySet())
-      getLog().debug(entry.getKey() + " = " + entry.getValue());
+      getLog().info("  " + entry.getKey() + " = " + entry.getValue());
 
     ClassLoader classLoader = null;
-    try {
+    try
+    {
       getLog().debug("Creating ClassLoader for project-dependencies...");
       List<String> classpathFiles = project.getCompileClasspathElements();
       URL[] urls = new URL[classpathFiles.size()];
-      for (int i = 0; i < classpathFiles.size(); ++i) {
+      for (int i = 0; i < classpathFiles.size(); ++i)
+      {
         getLog().debug("Dependency: " + classpathFiles.get(i));
         urls[i] = new File(classpathFiles.get(i)).toURI().toURL();
       }
       classLoader = new URLClassLoader(urls, getClass().getClassLoader());
     }
-    catch (Exception e) {
+    catch (Exception e)
+    {
       getLog().error("Error while creating ClassLoader!", e);
       throw new MojoExecutionException(e.getMessage());
     }
 
     Configuration config = new Configuration();
     config.setProperties(properties);
-    try {
+    try
+    {
       getLog().debug("Adding annotated classes to hibernate-mapping-configuration...");
-      for (String annotatedClass : classes) {
+      for (String annotatedClass : classes)
+      {
         getLog().debug("Class " + annotatedClass);
         config.addAnnotatedClass(classLoader.loadClass(annotatedClass));
       }
     }
-    catch (ClassNotFoundException e) {
+    catch (ClassNotFoundException e)
+    {
       getLog().error("Error while adding annotated classes!", e);
       throw new MojoExecutionException(e.getMessage());
     }
 
     Target target = null;
-    try {
+    try
+    {
       target = Target.valueOf(this.target);
     }
-    catch (IllegalArgumentException e) {
+    catch (IllegalArgumentException e)
+    {
       getLog().error("Invalid value for configuration-option \"target\": " + this.target);
       getLog().error("Valid values are: NONE, SCRIPT, EXPORT, BOTH");
       throw new MojoExecutionException("Invalid value for configuration-option \"target\"");
     }
     Type type = null;
-    try {
+    try
+    {
       type = Type.valueOf(this.type);
     }
-    catch (IllegalArgumentException e) {
+    catch (IllegalArgumentException e)
+    {
       getLog().error("Invalid value for configuration-option \"type\": " + this.type);
       getLog().error("Valid values are: NONE, CREATE, DROP, BOTH");
       throw new MojoExecutionException("Invalid value for configuration-option \"type\"");
     }
 
     Connection connection = null;
-    try {
+    try
+    {
       /**
        * The connection must be established outside of hibernate, because
        * hibernate does not use the context-classloader of the current
        * thread and, hence, would not be able to resolve the driver-class!
        */
-      switch (target) {
+      switch (target)
+      {
         case EXPORT:
         case BOTH:
-          switch (type) {
+          switch (type)
+          {
             case CREATE:
             case DROP:
             case BOTH:
@@ -309,11 +416,13 @@ public class Hbm2DdlMojo extends AbstractMojo
           }
       }
     }
-    catch (ClassNotFoundException e) {
+    catch (ClassNotFoundException e)
+    {
       getLog().error("Dependency for driver-class " + driverClassName + " is missing!");
       throw new MojoExecutionException(e.getMessage());
     }
-    catch (Exception e) {
+    catch (Exception e)
+    {
       getLog().error("Cannot establish connection to database!");
       Enumeration<Driver> drivers = DriverManager.getDrivers();
       if (!drivers.hasMoreElements())
@@ -325,7 +434,8 @@ public class Hbm2DdlMojo extends AbstractMojo
 
     ClassLoader contextClassLoader = Thread.currentThread().getContextClassLoader();
     MavenLogAppender.startPluginLog(this);
-    try {
+    try
+    {
       /**
        * Change class-loader of current thread, so that hibernate can
        * see all dependencies!
@@ -341,7 +451,8 @@ public class Hbm2DdlMojo extends AbstractMojo
       for (Object exception : export.getExceptions())
         getLog().debug(exception.toString());
     }
-    finally {
+    finally
+    {
       /** Stop Log-Capturing */
       MavenLogAppender.endPluginLog(this);
 
@@ -349,10 +460,12 @@ public class Hbm2DdlMojo extends AbstractMojo
       Thread.currentThread().setContextClassLoader(contextClassLoader);
 
       /** Close the connection */
-      try {
+      try
+      {
         connection.close();
       }
-      catch (SQLException e) {
+      catch (SQLException e)
+      {
         getLog().error("Error while closing connection: " + e.getMessage());
       }
     }
@@ -364,70 +477,96 @@ public class Hbm2DdlMojo extends AbstractMojo
    * See:
    * http://stackoverflow.com/questions/288828/how-to-use-a-jdbc-driver-from-an-arbitrary-location
    */
-  static final class DriverProxy implements Driver {
-
+  static final class DriverProxy implements Driver
+  {
     private final Driver target;
 
-    DriverProxy(Driver target) {
-      if (target == null) {
+    DriverProxy(Driver target)
+    {
+      if (target == null)
         throw new NullPointerException();
-      }
       this.target = target;
     }
 
-    public java.sql.Driver getTarget() {
+    public java.sql.Driver getTarget()
+    {
       return target;
     }
 
     @Override
-    public boolean acceptsURL(String url) throws SQLException {
+    public boolean acceptsURL(String url) throws SQLException
+    {
       return target.acceptsURL(url);
     }
 
     @Override
     public java.sql.Connection connect(
-        String url, java.util.Properties info) throws SQLException {
+        String url,
+        java.util.Properties info
+      )
+      throws
+        SQLException
+    {
       return target.connect(url, info);
     }
 
     @Override
-    public int getMajorVersion() {
+    public int getMajorVersion()
+    {
       return target.getMajorVersion();
     }
 
     @Override
-    public int getMinorVersion() {
+    public int getMinorVersion()
+    {
       return target.getMinorVersion();
     }
 
     @Override
     public DriverPropertyInfo[] getPropertyInfo(
-        String url, Properties info) throws SQLException {
+        String url,
+        Properties info
+      )
+      throws
+        SQLException
+    {
       return target.getPropertyInfo(url, info);
     }
 
     @Override
-    public boolean jdbcCompliant() {
+    public boolean jdbcCompliant()
+    {
       return target.jdbcCompliant();
     }
 
+    /**
+     * This Method cannot be annotated with @Override, becaus the plugin
+     * will not compile then under Java 1.6!
+     */
+    public Logger getParentLogger() throws SQLFeatureNotSupportedException
+    {
+      throw new SQLFeatureNotSupportedException("Not supported, for backward-compatibility with Java 1.6");
+    }
+
     @Override
-    public String toString() {
+    public String toString()
+    {
       return "Proxy: " + target;
     }
 
     @Override
-    public int hashCode() {
+    public int hashCode()
+    {
       return target.hashCode();
     }
 
     @Override
-    public boolean equals(Object obj) {
-      if (!(obj instanceof DriverProxy)) {
+    public boolean equals(Object obj)
+    {
+      if (!(obj instanceof DriverProxy))
         return false;
-      }
       DriverProxy other = (DriverProxy) obj;
       return this.target.equals(other.target);
     }
-}
+  }
 }