package de.juplo.plugins.hibernate4;
/*
* Copyright 2001-2005 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import com.pyx4j.log4j.MavenLogAppender;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.net.URL;
import java.net.URLClassLoader;
import java.sql.Connection;
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.List;
import java.util.Map.Entry;
import java.util.Properties;
import java.util.Set;
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;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.project.MavenProject;
import org.hibernate.cfg.Configuration;
import org.hibernate.tool.hbm2ddl.SchemaExport;
import org.hibernate.tool.hbm2ddl.SchemaExport.Type;
import org.hibernate.tool.hbm2ddl.Target;
import org.scannotation.AnnotationDB;
/**
* Goal which extracts the hibernate-mapping-configuration and
* exports an according SQL-database-schema.
*
* @goal export
* @phase process-classes
* @threadSafe
* @requiresDependencyResolution runtime
*/
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.
*
* @parameter expression="${project}"
* @required
* @readonly
*/
private MavenProject project;
/**
* Directories to scan.
*
* @parameter expression="${project.build.outputDirectory}"
*/
private String outputDirectory;
/**
* Skip execution
*
* @parameter expression="${maven.test.skip}"
*/
private boolean skip;
/**
* SQL-Driver name.
*
* @parameter expression="${hibernate.connection.driver_class}
*/
private String driverClassName;
/**
* Database URL.
*
* @parameter expression="${hibernate.connection.url}"
*/
private String url;
/**
* Database username
*
* @parameter expression="${hibernate.connection.username}"
*/
private String username;
/**
* Database password
*
* @parameter expression="${hibernate.connection.password}"
*/
private String password;
/**
* Hibernate dialect.
*
* @parameter expression="${hibernate.dialect}"
*/
private String hibernateDialect;
/**
* Hibernate configuration file.
*
* @parameter default-value="${project.build.outputDirectory}/hibernate.properties"
*/
private String hibernateProperties;
/**
* Target of execution:
*
*
NONE do nothing - just validate the configuration
*
EXPORT create database (DEFAULT!)
*
SCRIPT export schema to SQL-script
*
BOTH
*
* @parameter default-value="EXPORT"
*/
private String target;
/**
* Type of export.
*
*
NONE do nothing - just validate the configuration
*
CREATE create database-schema
*
DROP drop database-schema
*
BOTH(DEFAULT!)
*
* @parameter default-value="BOTH"
*/
private String type;
/**
* Output file.
*
* @parameter default-value="${project.build.outputDirectory}/schema.sql"
*/
private String outputFile;
/**
* Delimiter in output-file.
*
* @parameter default-value=";"
*/
private String delimiter;
/**
* Format output-file.
*
* @parameter default-value="true"
*/
private boolean format;
@Override
public void execute()
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 classes = new TreeSet();
try
{
AnnotationDB db = new AnnotationDB();
getLog().info("Scanning directory " + outputDirectory + " for annotated classes...");
URL dirUrl = dir.toURI().toURL();
db.scanArchives(dirUrl);
if (db.getAnnotationIndex().containsKey(Entity.class.getName()))
classes.addAll(db.getAnnotationIndex().get(Entity.class.getName()));
if (db.getAnnotationIndex().containsKey(MappedSuperclass.class.getName()))
classes.addAll(db.getAnnotationIndex().get(MappedSuperclass.class.getName()));
if (db.getAnnotationIndex().containsKey(Embeddable.class.getName()))
classes.addAll(db.getAnnotationIndex().get(Embeddable.class.getName()));
}
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
{
File file = new File(hibernateProperties);
if (file.exists())
{
getLog().info("Reading properties from file " + hibernateProperties + "...");
properties.load(new FileInputStream(file));
}
else
getLog().info("No hibernate-properties-file found! Checked path: " + hibernateProperties);
}
catch (IOException e)
{
getLog().error("Error while reading properties!", e);
throw new MojoExecutionException(e.getMessage());
}
/** Overwrite values from propertie-file or set, if given */
if (driverClassName != null)
{
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)
{
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)
{
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)
{
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)
{
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().error("No properties set!");
throw new MojoFailureException("Hibernate-Configuration is missing!");
}
for (Entry