org.kualigan.maven.plugins.liquibase

Class MigrateMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.liquibase.maven.plugins.AbstractLiquibaseMojo

org.liquibase.maven.plugins.AbstractLiquibaseChangeLogMojo

org.liquibase.maven.plugins.AbstractLiquibaseUpdateMojo

org.kualigan.maven.plugins.liquibase.MigrateMojo

All Implemented Interfaces:

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

public class MigrateMojo
extends org.liquibase.maven.plugins.AbstractLiquibaseUpdateMojo

Migrate Liquibase changelogs

Author:

Leo Przybylski

Field Summary

Fields

Modifier and Type	Field and Description
protected File	changeLogSavePath
protected URL	changeLogTagUrl
protected boolean	clearCheckSums Flag for forcing the checksums to be cleared from teh DatabaseChangeLog table.
protected String	databaseClass The class to use as the database object.
static String	DEFAULT_CHANGELOG_PATH
static String	DEFAULT_LBPROP_PATH
static String	DEFAULT_UPDATE_FILE
static String	DEFAULT_UPDATE_PATH
protected String	defaultSchemaName The default schema name to use the for database connection.
protected String	driver The fully qualified name of the driver class to use to connect to the database.
protected boolean	dropFirst Whether or not to perform a drop on the database before executing the change.
protected boolean	emptyPassword Deprecated. Use an empty or null value for the password instead.
protected boolean	includeArtifact Allows for the maven project artifact to be included in the class loader for obtaining the Liquibase property and DatabaseChangeLog files.
protected boolean	includeTestOutputDirectory Allows for the maven test output directory to be included in the class loader for obtaining the Liquibase property and DatabaseChangeLog files.
protected String	logging Controls the level of logging from Liquibase when executing.
protected String	password The database password to use to connect to the specified database.
protected org.apache.maven.project.MavenProject	project The Maven project that plugin is running under.
protected boolean	promptOnNonLocalDatabase Controls the prompting of users as to whether or not they really want to run the changes on a database that is not local to the machine that the user is current executing the plugin on.
protected String	propertyFile The Liquibase properties file used to configure the Liquibase Liquibase.
protected boolean	propertyFileWillOverride Flag allowing for the Liquibase properties file to override any settings provided in the Maven plugin configuration.
protected String	svnPassword
protected String	svnServer The server id in settings.xml to use when authenticating with.
protected String	svnUsername
protected Properties	systemProperties List of system properties to pass to the database.
static String	TEST_ROLLBACK_TAG
protected File	updatePath Location of an update.xml
protected String	url The Database URL to connect to for executing Liquibase.
protected String	username The database username to use to connect to the specified database.
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.AbstractLiquibaseUpdateMojo

changesToApply

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

changeLogFile, contexts

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

changelogCatalogName, changelogSchemaName, defaultCatalogName, outputDefaultCatalog, outputDefaultSchema, outputFileEncoding, skip

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

ROLE

Constructor Summary

Constructors

Constructor and Description
MigrateMojo()

Method Summary

Modifier and Type	Method and Description
protected org.tmatesoft.svn.core.wc.SVNClientManager	clientManager()
protected void	doFieldHack()
protected void	doUpdate(liquibase.Liquibase liquibase)
protected void	dropAll(liquibase.Liquibase liquibase) Drops the database.
void	execute()
protected void	generateUpdateLog(File changeLogFile, Collection<File> changelogs)
protected File	getBasedir()
protected org.tmatesoft.svn.core.SVNURL	getChangeLogTagUrl()
protected Long	getCurrentRevision()
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 File[]	getLiquibasePropertiesFiles()
protected Long	getLocalRevision()
protected String	getLocalTagPath(org.tmatesoft.svn.core.SVNURL tag)
protected org.tmatesoft.svn.core.SVNURL	getProjectSvnUrlFrom(File path)
protected Long	getTagRevision(String tag)
protected Collection<org.tmatesoft.svn.core.SVNURL>	getTagUrls()
protected org.tmatesoft.svn.core.wc.SVNWCClient	getWCClient()
protected Element	includeNode(Document parentChangeLog, File changelog)
protected boolean	isUpdateRequired()
protected void	parsePropertiesFile(InputStream propertiesInputStream) Parses a properties file and sets the assocaited fields in the plugin.
protected void	printSettings(String indent)
protected Collection<File>	scanForChangelogs(File searchPath)

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

performLiquibaseTask

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

checkRequiredParametersAreSpecified, createLiquibase, getFileOpener

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

DEFAULT_UPDATE_FILE

public static final String DEFAULT_UPDATE_FILE

See Also:

Constant Field Values

DEFAULT_UPDATE_PATH

public static final String DEFAULT_UPDATE_PATH

See Also:

Constant Field Values

DEFAULT_LBPROP_PATH

public static final String DEFAULT_LBPROP_PATH

See Also:

Constant Field Values

TEST_ROLLBACK_TAG

public static final String TEST_ROLLBACK_TAG

See Also:

Constant Field Values

driver

protected String driver

The fully qualified name of the driver class to use to connect to the database.

url

protected String url

The Database URL to connect to for executing Liquibase.

wagonManager

protected org.apache.maven.artifact.manager.WagonManager wagonManager

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

username

protected String username

The database username to use to connect to the specified database.

password

protected String password

The database password to use to connect to the specified database.

emptyPassword

protected boolean emptyPassword

Deprecated. Use an empty or null value for the password instead.

Use an empty string as the password for the database connection. This should not be used along side the password setting.

defaultSchemaName

protected String defaultSchemaName

The default schema name to use the for database connection.

databaseClass

protected String databaseClass

The class to use as the database object.

promptOnNonLocalDatabase

protected boolean promptOnNonLocalDatabase

Controls the prompting of users as to whether or not they really want to run the changes on a database that is not local to the machine that the user is current executing the plugin on.

includeArtifact

protected boolean includeArtifact

Allows for the maven project artifact to be included in the class loader for obtaining the Liquibase property and DatabaseChangeLog files.

includeTestOutputDirectory

protected boolean includeTestOutputDirectory

Allows for the maven test output directory to be included in the class loader for obtaining the Liquibase property and DatabaseChangeLog files.

verbose

protected boolean verbose

Controls the verbosity of the output from invoking the plugin.

logging

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

protected String propertyFile

The Liquibase properties file used to configure the Liquibase Liquibase.

propertyFileWillOverride

protected boolean propertyFileWillOverride

Flag allowing for the Liquibase properties file to override any settings provided in the Maven plugin configuration. By default if a property is explicity specified it is not overridden if it also appears in the properties file.

clearCheckSums

protected boolean clearCheckSums

Flag for forcing the checksums to be cleared from teh DatabaseChangeLog table.

systemProperties

protected Properties systemProperties

List of system properties to pass to the database.

svnUsername

protected String svnUsername

svnPassword

protected String svnPassword

svnServer

protected String svnServer

The server id in settings.xml to use when authenticating with.

changeLogSavePath

protected File changeLogSavePath

changeLogTagUrl

protected URL changeLogTagUrl

updatePath

protected File updatePath

Location of an update.xml

project

@Parameter(property="project",
           required=true)
protected org.apache.maven.project.MavenProject project

The Maven project that plugin is running under.

dropFirst

protected boolean dropFirst

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

Constructor Detail

MigrateMojo

public MigrateMojo()

Method Detail

getBasedir

protected File getBasedir()

getChangeLogTagUrl

protected org.tmatesoft.svn.core.SVNURL getChangeLogTagUrl()
                                                    throws org.tmatesoft.svn.core.SVNException

Throws:

org.tmatesoft.svn.core.SVNException

doFieldHack

protected void doFieldHack()

getLiquibasePropertiesFiles

protected File[] getLiquibasePropertiesFiles()
                                      throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

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

getLocalTagPath

protected String getLocalTagPath(org.tmatesoft.svn.core.SVNURL tag)

isUpdateRequired

protected boolean isUpdateRequired()
                            throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getProjectSvnUrlFrom

protected org.tmatesoft.svn.core.SVNURL getProjectSvnUrlFrom(File path)
                                                      throws org.tmatesoft.svn.core.SVNException

Throws:

org.tmatesoft.svn.core.SVNException

getCurrentRevision

protected Long getCurrentRevision()
                           throws org.tmatesoft.svn.core.SVNException

Throws:

org.tmatesoft.svn.core.SVNException

getLocalRevision

protected Long getLocalRevision()
                         throws org.tmatesoft.svn.core.SVNException

Throws:

org.tmatesoft.svn.core.SVNException

getTagRevision

protected Long getTagRevision(String tag)
                       throws org.tmatesoft.svn.core.SVNException

Throws:

org.tmatesoft.svn.core.SVNException

getTagUrls

protected Collection<org.tmatesoft.svn.core.SVNURL> getTagUrls()
                                                        throws org.tmatesoft.svn.core.SVNException

Throws:

org.tmatesoft.svn.core.SVNException

getWCClient

protected org.tmatesoft.svn.core.wc.SVNWCClient getWCClient()

scanForChangelogs

protected Collection<File> scanForChangelogs(File searchPath)

clientManager

protected org.tmatesoft.svn.core.wc.SVNClientManager clientManager()

generateUpdateLog

protected void generateUpdateLog(File changeLogFile,
                                 Collection<File> changelogs)
                          throws FileNotFoundException,
                                 IOException

Throws:

FileNotFoundException

IOException

includeNode

protected Element includeNode(Document parentChangeLog,
                              File changelog)
                       throws IOException

Throws:

IOException

doUpdate

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

Specified by:

doUpdate in class org.liquibase.maven.plugins.AbstractLiquibaseUpdateMojo

Throws:

liquibase.exception.LiquibaseException

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.AbstractLiquibaseUpdateMojo

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.