org.kualigan.maven.plugins.liquibase

Class CopyMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.liquibase.maven.plugins.AbstractLiquibaseMojo

org.liquibase.maven.plugins.AbstractLiquibaseChangeLogMojo

org.kualigan.maven.plugins.liquibase.CopyMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="copy-database",
      requiresProject=false)
public class CopyMojo
extends org.liquibase.maven.plugins.AbstractLiquibaseChangeLogMojo

Copies a database including DDL/DML from one location to another.

Author:

Leo Przybylski

Field Summary

Fields

Modifier and Type	Field and Description
protected String	changeLogFile Deprecated.
protected File	changeLogSavePath
static String	DEFAULT_CHANGELOG_PATH
protected boolean	dropFirst Whether or not to perform a drop on the database before executing the change.
protected Boolean	interactiveMode User settings use to check the interactiveMode.
protected String	logging Controls the level of logging from Liquibase when executing.
protected File	mavenHome The M2_HOME parameter to use for forked Maven invocations.
protected MigrateHelper	migrator The Maven Wagon manager to use when obtaining server authentication details.
protected org.apache.maven.project.MavenProject	project
protected String	propertyFile The Liquibase properties file used to configure the Liquibase Liquibase.
protected boolean	stateSaved Property to flag whether to copy data as well as structure of the database schema
protected boolean	verbose Controls the verbosity of the output from invoking the plugin.
protected org.apache.maven.artifact.manager.WagonManager	wagonManager The Maven Wagon manager to use when obtaining server authentication details.

Fields inherited from class org.liquibase.maven.plugins.AbstractLiquibaseChangeLogMojo

contexts

Fields inherited from class org.liquibase.maven.plugins.AbstractLiquibaseMojo

changelogCatalogName, changelogSchemaName, clearCheckSums, databaseClass, defaultCatalogName, defaultSchemaName, driver, emptyPassword, includeArtifact, includeTestOutputDirectory, outputDefaultCatalog, outputDefaultSchema, outputFileEncoding, password, promptOnNonLocalDatabase, propertyFileWillOverride, skip, systemProperties, url, username

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
CopyMojo()

Method Summary

Methods

Modifier and Type	Method and Description
protected liquibase.database.Database	createSourceDatabase()
protected liquibase.database.Database	createTargetDatabase()
protected void	doCopy()
protected void	doFieldHack()
protected void	dropAll(liquibase.Liquibase liquibase) Drops the database.
void	execute()
protected void	export(liquibase.database.Database source, liquibase.database.Database target, String sourceTypes, String suffix)
protected void	exportConstraints(liquibase.database.Database source, liquibase.database.Database target)
protected void	exportIndexes(liquibase.database.Database source, liquibase.database.Database target)
protected void	exportSchema(liquibase.database.Database source, liquibase.database.Database target)
protected void	exportSequences(liquibase.database.Database source, liquibase.database.Database target)
protected void	exportTables(liquibase.database.Database source, liquibase.database.Database target)
protected void	exportViews(liquibase.database.Database source, liquibase.database.Database target)
void	generateArchetype(File mavenHome, Properties archetypeProperties) Invokes the maven goal archetype:generate with the appropriate properties.
protected File	getBasedir()
protected String	getChangeLogFile()
protected Field	getDeclaredField(Class clazz, String fieldName) Recursively searches for the field specified by the fieldName in the class and all the super classes until it either finds it, or runs out of parents.
protected liquibase.resource.ResourceAccessor	getFileOpener(ClassLoader cl)
ClassLoader	getMavenArtifactClassloader()
File	getMavenHome()
void	invokeCopy(File mavenHome, Properties copyProperties) Invokes the maven goal archetype:generate with the appropriate properties.
protected Boolean	isStateSaved()
String	lookupDriverFor(String url)
protected liquibase.database.jvm.JdbcConnection	openConnection(String url, String username, String password, String className, String schema)
protected void	parsePropertiesFile(InputStream propertiesInputStream) Parses a properties file and sets the assocaited fields in the plugin.
protected void	printSettings(String indent)
void	setMavenHome(File mavenHome)
protected void	setupRequest(org.apache.maven.shared.invoker.InvocationRequest req, String additionalArguments)
protected void	updateConstraints(liquibase.database.Database target, ClassLoader artifactClassLoader)
protected void	updateIndexes(liquibase.database.Database target, ClassLoader artifactClassLoader)
protected void	updateSchema(liquibase.database.Database target)
protected void	updateSequences(liquibase.database.Database target, ClassLoader artifactClassLoader)
protected void	updateTables(liquibase.database.Database target, ClassLoader artifactClassLoader)
protected void	updateViews(liquibase.database.Database target, ClassLoader artifactClassLoader)

Methods inherited from class org.liquibase.maven.plugins.AbstractLiquibaseChangeLogMojo

checkRequiredParametersAreSpecified, createLiquibase, performLiquibaseTask

Methods inherited from class org.liquibase.maven.plugins.AbstractLiquibaseMojo

cleanup, configureFieldsAndValues, getClassLoaderIncludingProjectClasspath, getLiquibase, getMavenArtifactClassLoader, getOutputWriter, isPromptOnNonLocalDatabase

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_CHANGELOG_PATH

public static final String DEFAULT_CHANGELOG_PATH

See Also:

Constant Field Values

project

@Parameter(property="project",
           defaultValue="${project}")
protected org.apache.maven.project.MavenProject project

interactiveMode

@Parameter(property="interactiveMode",
           defaultValue="${settings.interactiveMode}")
protected Boolean interactiveMode

User settings use to check the interactiveMode.

wagonManager

@Component(role=org.apache.maven.artifact.manager.WagonManager.class)
protected org.apache.maven.artifact.manager.WagonManager wagonManager

The Maven Wagon manager to use when obtaining server authentication details.

migrator

@Component(role=MigrateHelper.class)
protected MigrateHelper migrator

The Maven Wagon manager to use when obtaining server authentication details.

verbose

@Parameter(property="liquibase.verbose",
           defaultValue="false")
protected boolean verbose

Controls the verbosity of the output from invoking the plugin.

logging

@Parameter(property="liquibase.logging",
           defaultValue="INFO")
protected String logging

Controls the level of logging from Liquibase when executing. The value can be "all", "finest", "finer", "fine", "info", "warning", "severe" or "off". The value is case insensitive.

propertyFile

@Parameter(property="liquibase.propertyFile")
protected String propertyFile

The Liquibase properties file used to configure the Liquibase Liquibase.

changeLogFile

@Parameter(property="liquibase.changeLogFile")
protected String changeLogFile

Deprecated.

Specifies the change log file to use for Liquibase. No longer needed with updatePath.

changeLogSavePath

@Parameter(property="liquibase.changeLogSavePath",
           defaultValue="${project.basedir}/target/changelogs")
protected File changeLogSavePath

dropFirst

@Parameter(property="liquibase.dropFirst",
           defaultValue="false")
protected boolean dropFirst

Whether or not to perform a drop on the database before executing the change.

stateSaved

@Parameter(property="lb.copy.data",
           defaultValue="true")
protected boolean stateSaved

Property to flag whether to copy data as well as structure of the database schema

mavenHome

@Parameter(defaultValue="${maven.home}")
protected File mavenHome

The M2_HOME parameter to use for forked Maven invocations.

Constructor Detail

CopyMojo

public CopyMojo()

Method Detail

isStateSaved

protected Boolean isStateSaved()

getBasedir

protected File getBasedir()

getChangeLogFile

protected String getChangeLogFile()
                           throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

doFieldHack

protected void doFieldHack()

getMavenArtifactClassloader

public ClassLoader getMavenArtifactClassloader()
                                        throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

lookupDriverFor

public String lookupDriverFor(String url)

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Overrides:

execute in class org.liquibase.maven.plugins.AbstractLiquibaseMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

invokeCopy

public void invokeCopy(File mavenHome,
              Properties copyProperties)
                throws org.apache.maven.plugin.MojoExecutionException

Invokes the maven goal archetype:generate with the appropriate properties.

Throws:

org.apache.maven.plugin.MojoExecutionException

generateArchetype

public void generateArchetype(File mavenHome,
                     Properties archetypeProperties)
                       throws org.apache.maven.plugin.MojoExecutionException

Invokes the maven goal archetype:generate with the appropriate properties.

Throws:

org.apache.maven.plugin.MojoExecutionException

setupRequest

protected void setupRequest(org.apache.maven.shared.invoker.InvocationRequest req,
                String additionalArguments)
                     throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

doCopy

protected void doCopy()
               throws org.apache.maven.plugin.MojoExecutionException,
                      org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

updateSchema

protected void updateSchema(liquibase.database.Database target)
                     throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

updateTables

protected void updateTables(liquibase.database.Database target,
                ClassLoader artifactClassLoader)
                     throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

updateSequences

protected void updateSequences(liquibase.database.Database target,
                   ClassLoader artifactClassLoader)
                        throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

updateViews

protected void updateViews(liquibase.database.Database target,
               ClassLoader artifactClassLoader)
                    throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

updateIndexes

protected void updateIndexes(liquibase.database.Database target,
                 ClassLoader artifactClassLoader)
                      throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

updateConstraints

protected void updateConstraints(liquibase.database.Database target,
                     ClassLoader artifactClassLoader)
                          throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

createSourceDatabase

protected liquibase.database.Database createSourceDatabase()
                                                    throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

createTargetDatabase

protected liquibase.database.Database createTargetDatabase()
                                                    throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

dropAll

protected void dropAll(liquibase.Liquibase liquibase)
                throws liquibase.exception.LiquibaseException

Drops the database. Makes sure it's done right the first time.

Parameters:

liquibase -

Throws:

liquibase.exception.LiquibaseException

printSettings

protected void printSettings(String indent)

Overrides:

printSettings in class org.liquibase.maven.plugins.AbstractLiquibaseChangeLogMojo

parsePropertiesFile

protected void parsePropertiesFile(InputStream propertiesInputStream)
                            throws org.apache.maven.plugin.MojoExecutionException

Parses a properties file and sets the assocaited fields in the plugin.

Overrides:

parsePropertiesFile in class org.liquibase.maven.plugins.AbstractLiquibaseMojo

Parameters:

propertiesInputStream - The input stream which is the Liquibase properties that needs to be parsed.

Throws:

org.apache.maven.plugin.MojoExecutionException - If there is a problem parsing the file.

getDeclaredField

protected Field getDeclaredField(Class clazz,
                     String fieldName)
                          throws NoSuchFieldException

Recursively searches for the field specified by the fieldName in the class and all the super classes until it either finds it, or runs out of parents.

Parameters:

clazz - The Class to start searching from.

fieldName - The name of the field to retrieve.

Returns:

The Field identified by the field name.

Throws:

NoSuchFieldException - If the field was not found in the class or any of its super classes.

exportConstraints

protected void exportConstraints(liquibase.database.Database source,
                     liquibase.database.Database target)
                          throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

exportIndexes

protected void exportIndexes(liquibase.database.Database source,
                 liquibase.database.Database target)
                      throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

exportViews

protected void exportViews(liquibase.database.Database source,
               liquibase.database.Database target)
                    throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

exportTables

protected void exportTables(liquibase.database.Database source,
                liquibase.database.Database target)
                     throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

exportSequences

protected void exportSequences(liquibase.database.Database source,
                   liquibase.database.Database target)
                        throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

export

protected void export(liquibase.database.Database source,
          liquibase.database.Database target,
          String sourceTypes,
          String suffix)
               throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

exportSchema

protected void exportSchema(liquibase.database.Database source,
                liquibase.database.Database target)
                     throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

openConnection

protected liquibase.database.jvm.JdbcConnection openConnection(String url,
                                                   String username,
                                                   String password,
                                                   String className,
                                                   String schema)
                                                        throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getFileOpener

protected liquibase.resource.ResourceAccessor getFileOpener(ClassLoader cl)

Overrides:

getFileOpener in class org.liquibase.maven.plugins.AbstractLiquibaseChangeLogMojo

setMavenHome

public void setMavenHome(File mavenHome)

getMavenHome

public File getMavenHome()