org.liquibase.maven.plugins

Class AbstractLiquibaseMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.liquibase.maven.plugins.AbstractLiquibaseMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractLiquibaseChangeLogMojo, AbstractLiquibaseChecksMojo, LiquibaseClearChecksumsMojo, LiquibaseGenerateChangeLogMojo, LiquibaseHistoryMojo, LiquibaseListLocksMojo, LiquibaseReleaseLocksMojo, LiquibaseTag

public abstract class AbstractLiquibaseMojo
extends org.apache.maven.plugin.AbstractMojo

A base class for providing Liquibase Liquibase functionality.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	changelogCatalogName Specifies the schema Liquibase will use to create your changelog tables.
protected String	changelogSchemaName Specifies the schema Liquibase will use to create your changelog table.
protected boolean	clearCheckSums A flag that forces checksums to be cleared from the DATABASECHANGELOG table.
protected String	commandName
protected String	databaseChangeLogLockTableName Specifies the table name to use for the DATABASECHANGELOGLOCK table.
protected String	databaseChangeLogTableName Specifies the table name to use for the DATABASECHANGELOG table.
protected String	databaseClass Specifies the database object class.
protected String	defaultCatalogName Specifies the default catalog name to use for the database connection.
protected String	defaultSchemaName Specifies the default schema name to use for the database connection.
protected String	driver Specifies the driver class name to use for the database connection.
protected boolean	emptyPassword Deprecated. Use an empty or null value for the password instead.
protected boolean	includeArtifact Includes a Maven project artifact in the class loader which obtains the liquibase.properties and changelog files.
protected boolean	includeTestOutputDirectory Includes the Maven test output directory in the class loader which obtains the liquibase.properties and changelog files.
protected String	logging Deprecated. Logging managed by maven
protected boolean	outputDefaultCatalog Specifies whether to ignore the catalog/database name.
protected boolean	outputDefaultSchema Specifies whether to ignore the schema name.
protected String	outputFileEncoding A flag which indicates you want to set the character encoding of the output file during the updateSQL phase.
protected String	password Specifies the database password for database connection.
protected Boolean	preserveSchemaCase Specifies whether to preserve the case of schemas and catalogs
protected org.apache.maven.project.MavenProject	project The Maven project that plugin is running under.
protected boolean	promptOnNonLocalDatabase Deprecated. No longer prompts
protected String	propertyFile Specifies the liquibase.properties you want to use to configure Liquibase.
protected boolean	propertyFileWillOverride A flag which indicates you want the liquibase.properties file to override any settings provided in the Maven plugin configuration.
protected String	propertyProviderClass Specifies the property provider which must be a java.util.Properties implementation.
protected boolean	showBanner Show the liquibase banner in output.
protected boolean	skip Specifies whether to skip running Liquibase.
protected Properties	systemProperties Specifies a list of system properties you want to to pass to the database.
protected String	url Specifies the database URL you want to use to execute Liquibase.
protected String	username Specifies the database username for database connection.
protected boolean	verbose Controls the amount of output detail when you call the plugin.
protected org.apache.maven.artifact.manager.WagonManager	wagonManager The Maven Wagon manager to use when obtaining server authentication details.

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractLiquibaseMojo()

Method Summary

Modifier and Type	Method and Description
protected void	checkRequiredParametersAreSpecified() Performs some validation after the properties file has been loaded checking that all properties required have been specified.
protected void	cleanup(Database db)
protected void	configureChangeLogProperties()
void	configureFieldsAndValues()
protected Liquibase	createLiquibase(Database db)
boolean	databaseConnectionRequired() Optionally, an implementation of this mojo can override this to indicate that a connection to the database is not required.
void	execute()
protected ClassLoader	getClassLoaderIncludingProjectClasspath() Returns an isolated classloader.
protected Field	getField(Class clazz, String name)
protected String	getLicenseKey() Get the specified license key.
protected Liquibase	getLiquibase()
protected ClassLoader	getMavenArtifactClassLoader()
protected Writer	getOutputWriter(File outputFile)
protected ResourceAccessor	getResourceAccessor(ClassLoader cl)
protected boolean	isPromptOnNonLocalDatabase() Deprecated. no longer prompts
protected void	parsePropertiesFile(InputStream propertiesInputStream) Parses a properties file and sets the associated fields in the plugin.
protected abstract void	performLiquibaseTask(Liquibase liquibase)
protected void	printSettings(String indent) Prints the settings that have been set of defaulted for the plugin.
protected void	setupBindInfoPackage()

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

preserveSchemaCase

@PropertyElement
protected Boolean preserveSchemaCase

Specifies whether to preserve the case of schemas and catalogs

driver

@PropertyElement
protected String driver

Specifies the driver class name to use for the database connection.

url

@PropertyElement
protected String url

Specifies the database URL you want to use to execute Liquibase.

wagonManager

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

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

username

@PropertyElement
protected String username

Specifies the database username for database connection.

password

@PropertyElement
protected String password

Specifies the database password for database connection.

emptyPassword

@PropertyElement
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.

outputDefaultSchema

@PropertyElement
protected boolean outputDefaultSchema

Specifies whether to ignore the schema name.

outputDefaultCatalog

@PropertyElement
protected boolean outputDefaultCatalog

Specifies whether to ignore the catalog/database name.

defaultCatalogName

@PropertyElement
protected String defaultCatalogName

Specifies the default catalog name to use for the database connection.

defaultSchemaName

@PropertyElement
protected String defaultSchemaName

Specifies the default schema name to use for the database connection.

databaseClass

@PropertyElement
protected String databaseClass

Specifies the database object class.

propertyProviderClass

@PropertyElement
protected String propertyProviderClass

Specifies the property provider which must be a java.util.Properties implementation.

promptOnNonLocalDatabase

@PropertyElement
protected boolean promptOnNonLocalDatabase

Deprecated. No longer prompts

(DEPRECATED) Controls whether users are prompted before executing changeSet to a non-local database.

includeArtifact

@PropertyElement
protected boolean includeArtifact

Includes a Maven project artifact in the class loader which obtains the liquibase.properties and changelog files.

includeTestOutputDirectory

@PropertyElement
protected boolean includeTestOutputDirectory

Includes the Maven test output directory in the class loader which obtains the liquibase.properties and changelog files.

verbose

@PropertyElement
protected boolean verbose

Controls the amount of output detail when you call the plugin.

logging

@PropertyElement
protected String logging

Deprecated. Logging managed by maven

Deprecated and ignored configuration property. Logging is managed via the standard maven logging system either using the -e, -X or -q flags or the ${maven.home}/conf/logging/simplelogger.properties file. See https://maven.apache.org/maven-logging.html for more information.

propertyFile

@PropertyElement
protected String propertyFile

Specifies the liquibase.properties you want to use to configure Liquibase.

propertyFileWillOverride

@PropertyElement
protected boolean propertyFileWillOverride

A flag which indicates you want the liquibase.properties file to override any settings provided in the Maven plugin configuration. By default, if a property is explicitly specified it is not overridden if it also appears in the properties file.

clearCheckSums

@PropertyElement
protected boolean clearCheckSums

A flag that forces checksums to be cleared from the DATABASECHANGELOG table.

systemProperties

@PropertyElement
protected Properties systemProperties

Specifies a list of system properties you want to to pass to the database.

project

protected org.apache.maven.project.MavenProject project

The Maven project that plugin is running under.

skip

@PropertyElement
protected boolean skip

Specifies whether to skip running Liquibase. The use of this parameter is NOT RECOMMENDED but can be used when needed.

outputFileEncoding

@PropertyElement
protected String outputFileEncoding

A flag which indicates you want to set the character encoding of the output file during the updateSQL phase.

changelogCatalogName

@PropertyElement
protected String changelogCatalogName

Specifies the schema Liquibase will use to create your changelog tables.

changelogSchemaName

@PropertyElement
protected String changelogSchemaName

Specifies the schema Liquibase will use to create your changelog table.

databaseChangeLogTableName

@PropertyElement
protected String databaseChangeLogTableName

Specifies the table name to use for the DATABASECHANGELOG table.

databaseChangeLogLockTableName

@PropertyElement
protected String databaseChangeLogLockTableName

Specifies the table name to use for the DATABASECHANGELOGLOCK table.

showBanner

@PropertyElement
protected boolean showBanner

Show the liquibase banner in output.

commandName

protected String commandName

Constructor Detail

AbstractLiquibaseMojo

public AbstractLiquibaseMojo()

Method Detail

getLicenseKey

protected String getLicenseKey()

Get the specified license key. This first checks liquibaseLicenseKey and if no key is found, then returns liquibaseProLicenseKey.

getOutputWriter

protected Writer getOutputWriter(File outputFile)
                          throws IOException

Throws:

IOException

execute

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

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

getField

protected Field getField(Class clazz,
                         String name)
                  throws NoSuchFieldException

Throws:

NoSuchFieldException

getLiquibase

protected Liquibase getLiquibase()

setupBindInfoPackage

protected void setupBindInfoPackage()

performLiquibaseTask

protected abstract void performLiquibaseTask(Liquibase liquibase)
                                      throws LiquibaseException

Throws:

LiquibaseException

isPromptOnNonLocalDatabase

protected boolean isPromptOnNonLocalDatabase()

Deprecated. no longer prompts

createLiquibase

protected Liquibase createLiquibase(Database db)
                             throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

configureFieldsAndValues

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

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

configureChangeLogProperties

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

Throws:

org.apache.maven.plugin.MojoFailureException

org.apache.maven.plugin.MojoExecutionException

getMavenArtifactClassLoader

protected ClassLoader getMavenArtifactClassLoader()
                                           throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getClassLoaderIncludingProjectClasspath

protected ClassLoader getClassLoaderIncludingProjectClasspath()
                                                       throws org.apache.maven.plugin.MojoExecutionException

Returns an isolated classloader.

Returns:

ClassLoader

Throws:

org.apache.maven.plugin.MojoExecutionException

getResourceAccessor

protected ResourceAccessor getResourceAccessor(ClassLoader cl)

checkRequiredParametersAreSpecified

protected void checkRequiredParametersAreSpecified()
                                            throws org.apache.maven.plugin.MojoFailureException

Performs some validation after the properties file has been loaded checking that all properties required have been specified.

Throws:

org.apache.maven.plugin.MojoFailureException - If any property that is required has not been specified.

databaseConnectionRequired

public boolean databaseConnectionRequired()

Optionally, an implementation of this mojo can override this to indicate that a connection to the database is not required.

printSettings

protected void printSettings(String indent)

Prints the settings that have been set of defaulted for the plugin. These will only be shown in verbose mode.

Parameters:

indent - The indent string to use when printing the settings.

cleanup

protected void cleanup(Database db)

parsePropertiesFile

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

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

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.