org.liquibase.maven.plugins

Class AbstractLiquibaseChangeLogMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.liquibase.maven.plugins.AbstractLiquibaseMojo

org.liquibase.maven.plugins.AbstractLiquibaseChangeLogMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractLiquibaseUpdateMojo, LiquibaseChangeLogSyncMojo, LiquibaseChangeLogSyncSQLMojo, LiquibaseChangeLogSyncToTagMojo, LiquibaseChangeLogSyncToTagSQLMojo, LiquibaseDatabaseDiff, LiquibaseDBDocMojo, LiquibaseDeactivateChangeLogMojo, LiquibaseDropAll, LiquibaseRegisterChangeLogMojo, LiquibaseReportStatusMojo, LiquibaseRollback, LiquibaseRollbackOneChangeSetMojo, LiquibaseRollbackOneChangeSetSQL, LiquibaseRollbackOneUpdateMojo, LiquibaseRollbackOneUpdateSQL, LiquibaseSyncHubMojo, LiquibaseUnexpectedChangeSetsMojo, LiquibaseValidate

public abstract class AbstractLiquibaseChangeLogMojo
extends AbstractLiquibaseMojo

A Liquibase MOJO that requires the user to provide a DatabaseChangeLogFile to be able to perform any actions on the database.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	changeLogDirectory Specifies the directory where Liquibase can find your changelog file.
protected String	changeLogFile Specifies the changelog file for Liquibase to use.
protected String	contexts Specifies which contexts Liquibase will execute, which can be separated by a commaif multiple contexts are required.
protected String	hubApiKey Specifies the Liquibase Hub API key for Liquibase to use.
protected String	hubMode Specifies the Liquibase Hub URL for Liquibase to use.
protected String	hubUrl Specifies the Liquibase Hub URL for Liquibase to use.
protected String	labels Specifies which Liquibase labels Liquibase will execute, which can be separated by a commaif multiple labels are required or you need to designate a more complex expression.

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

changelogCatalogName, changelogSchemaName, clearCheckSums, commandName, databaseChangeLogLockTableName, databaseChangeLogTableName, databaseClass, defaultCatalogName, defaultSchemaName, driver, emptyPassword, includeArtifact, includeTestOutputDirectory, liquibaseProLicenseKey, logging, outputDefaultCatalog, outputDefaultSchema, outputFileEncoding, password, project, promptOnNonLocalDatabase, propertyFile, propertyFileWillOverride, propertyProviderClass, skip, systemProperties, url, username, verbose, wagonManager

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractLiquibaseChangeLogMojo()

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 Liquibase	createLiquibase(Database db)
protected ResourceAccessor	getResourceAccessor(ClassLoader cl)
protected void	performLiquibaseTask(Liquibase liquibase) Performs the actual Liquibase task on the database using the fully configured Liquibase.
protected void	printSettings(String indent) Prints the settings that have been set of defaulted for the plugin.

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

cleanup, configureChangeLogProperties, configureFieldsAndValues, execute, getClassLoaderIncludingProjectClasspath, getField, getLiquibase, getMavenArtifactClassLoader, getOutputWriter, hasProLicense, isPromptOnNonLocalDatabase, parsePropertiesFile, 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

changeLogDirectory

@PropertyElement
protected String changeLogDirectory

Specifies the directory where Liquibase can find your changelog file.

changeLogFile

@PropertyElement
protected String changeLogFile

Specifies the changelog file for Liquibase to use.

contexts

@PropertyElement
protected String contexts

Specifies which contexts Liquibase will execute, which can be separated by a commaif multiple contexts are required. If a context is not specified, then ALL contexts will be executed.

labels

@PropertyElement
protected String labels

Specifies which Liquibase labels Liquibase will execute, which can be separated by a commaif multiple labels are required or you need to designate a more complex expression. If a label is not specified, then ALL labels will be executed.

hubApiKey

@PropertyElement(key="liquibase.hub.apiKey")
protected String hubApiKey

Specifies the Liquibase Hub API key for Liquibase to use.

hubUrl

@PropertyElement(key="liquibase.hub.url")
protected String hubUrl

Specifies the Liquibase Hub URL for Liquibase to use.

hubMode

@PropertyElement(key="liquibase.hub.mode")
protected String hubMode

Specifies the Liquibase Hub URL for Liquibase to use.

Constructor Detail

AbstractLiquibaseChangeLogMojo

public AbstractLiquibaseChangeLogMojo()

Method Detail

checkRequiredParametersAreSpecified

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

Description copied from class: AbstractLiquibaseMojo

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

Overrides:

checkRequiredParametersAreSpecified in class AbstractLiquibaseMojo

Throws:

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

performLiquibaseTask

protected void performLiquibaseTask(Liquibase liquibase)
                             throws LiquibaseException

Performs the actual Liquibase task on the database using the fully configured Liquibase.

Specified by:

performLiquibaseTask in class AbstractLiquibaseMojo

Parameters:

liquibase - The Liquibase that has been fully configured to run the desired database task.

Throws:

LiquibaseException

printSettings

protected void printSettings(String indent)

Description copied from class: AbstractLiquibaseMojo

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

Overrides:

printSettings in class AbstractLiquibaseMojo

Parameters:

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

getResourceAccessor

protected ResourceAccessor getResourceAccessor(ClassLoader cl)

Overrides:

getResourceAccessor in class AbstractLiquibaseMojo

createLiquibase

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

Overrides:

createLiquibase in class AbstractLiquibaseMojo

Throws:

org.apache.maven.plugin.MojoExecutionException