Liquibase 4.26.0 · liquibase.integration.ant.BaseLiquibaseTask

Modifier and Type	Field and Description
private ChangeLogParametersType	changeLogParameters
private AntClassLoader	classLoader
private Path	classpath
private static final ResourceBundle	coreBundle
private DatabaseType	databaseType
private Liquibase	liquibase
private ResourceAccessor	resourceAccessor
private final Map<String, Object>	scopeValues

Access	Constructor and Description
public	BaseLiquibaseTask()

Method Summary

Modifier and Type	Method and Description
public void	addChangeLogParameters(ChangeLogParametersType changeLogParameters)
public void	addDatabase(DatabaseType databaseType)
protected void	closeDatabase(Database The database to close. database) Convenience method to safely close the database connection.
public Path	createClasspath()
protected Database	createDatabaseFromConfiguredDatabaseType()
protected Database	createDatabaseFromType(DatabaseType databaseType, ResourceAccessor resourceAccessor)
private ResourceAccessor	Returns: A ResourceAccessor. createResourceAccessor(AntClassLoader The ClassLoader to use in the ResourceAccessor. It is preferable that it is an AntClassLoader. classLoader) Creates a suitable ResourceAccessor for use in an Ant task..
public final void	execute() Overrides org.apache.tools.ant.Task.execute. Called by the project to let the task do its work.
protected abstract void	executeWithLiquibaseClassloader()
public String	Returns: Returns null in this implementation. Subclasses that need a change log should implement. getChangeLogDirectory() This method is designed to be overridden by subclasses when a change log is needed.
protected String	Returns: Returns null in this implementation. Subclasses that need a change log should implement. getChangeLogFile() This method is designed to be overridden by subclasses when a change log is needed.
protected String	getDefaultOutputEncoding()
protected Liquibase	getLiquibase()
protected ResourceAccessor	getResourceAccessor()
public String	Returns: Returns null in this implementation. Subclasses that need a change log should implement. getSearchPath() This method is designed to be overridden by subclasses when a change log is needed.
public void	init() Overrides org.apache.tools.ant.Task.init. Called by the project to let the task initialize properly.
public boolean	isPromptOnNonLocalDatabase() Deprecated no longer prompts
public void	setChangeLogParametersRef(Reference changeLogParametersRef)
public void	setClasspathRef(Reference r)
public void	setDatabaseRef(Reference databaseRef)
public void	setPromptOnNonLocalDatabase(boolean promptOnNonLocalDatabase) Deprecated no longer prompts
protected boolean	shouldRun()
protected void	validateParameters() Subclasses that override this method must always call `super.validateParameters()` method.

changeLogParameters	back to summary
private ChangeLogParametersType changeLogParameters

classLoader	back to summary
private AntClassLoader classLoader

classpath	back to summary
private Path classpath

coreBundle	back to summary
private static final ResourceBundle coreBundle

databaseType	back to summary
private DatabaseType databaseType

liquibase	back to summary
private Liquibase liquibase

resourceAccessor	back to summary
private ResourceAccessor resourceAccessor

scopeValues	back to summary
private final Map<String, Object> scopeValues

BaseLiquibaseTask	back to summary
public BaseLiquibaseTask()

Method Detail

addChangeLogParameters	back to summary
public void addChangeLogParameters(ChangeLogParametersType changeLogParameters)

addDatabase	back to summary
public void addDatabase(DatabaseType databaseType)

closeDatabase	back to summary
protected void closeDatabase(Database database) Convenience method to safely close the database connection. Parameters database:Database The database to close.

closeDatabase

back to summary

protected void closeDatabase(Database database)

Convenience method to safely close the database connection.

Parameters

database:Database: The database to close.

createClasspath	back to summary
public Path createClasspath()

createDatabaseFromConfiguredDatabaseType	back to summary
protected Database createDatabaseFromConfiguredDatabaseType()

createDatabaseFromType	back to summary
protected Database createDatabaseFromType(DatabaseType databaseType, ResourceAccessor resourceAccessor)

createResourceAccessor	back to summary
private ResourceAccessor createResourceAccessor(AntClassLoader classLoader) Creates a suitable ResourceAccessor for use in an Ant task.. Parameters classLoader:AntClassLoader The ClassLoader to use in the ResourceAccessor. It is preferable that it is an AntClassLoader. Returns:ResourceAccessor A ResourceAccessor. Annotations @SuppressWarnings:java:S2095

createResourceAccessor

back to summary

private ResourceAccessor createResourceAccessor(AntClassLoader classLoader)

Creates a suitable ResourceAccessor for use in an Ant task..

Parameters

classLoader:AntClassLoader: The ClassLoader to use in the ResourceAccessor. It is preferable that it is an AntClassLoader.

Returns:ResourceAccessor

A ResourceAccessor.

Annotations

@SuppressWarnings:java:S2095

execute	back to summary
public final void execute() throws BuildException Overrides org.apache.tools.ant.Task.execute. Doc from org.apache.tools.ant.Task.execute. Called by the project to let the task do its work. This method may be called more than once, if the task is invoked more than once. For example, if target1 and target2 both depend on target3, then running "ant target1 target2" will run all tasks in target3 twice. Annotations @Override Exceptions BuildException: if something goes wrong with the build.

execute

back to summary

public final void execute() throws BuildException

Overrides org.apache.tools.ant.Task.execute.

Doc from org.apache.tools.ant.Task.execute.

Called by the project to let the task do its work. This method may be called more than once, if the task is invoked more than once. For example, if target1 and target2 both depend on target3, then running "ant target1 target2" will run all tasks in target3 twice.

Annotations

@Override

Exceptions

BuildException:: if something goes wrong with the build.

executeWithLiquibaseClassloader	back to summary
protected abstract void executeWithLiquibaseClassloader() throws BuildException

getChangeLogDirectory back to summary

getChangeLogDirectory	back to summary
public String getChangeLogDirectory() This method is designed to be overridden by subclasses when a change log is needed. By default it returns null. Returns:String Returns null in this implementation. Subclasses that need a change log should implement. See Also `AbstractChangeLogBasedTask#getChangeLogDirectory()`

public String getChangeLogDirectory()

This method is designed to be overridden by subclasses when a change log is needed. By default it returns null.

Returns:String: Returns null in this implementation. Subclasses that need a change log should implement.
See Also: AbstractChangeLogBasedTask#getChangeLogDirectory()

getChangeLogFile back to summary

getChangeLogFile	back to summary
protected String getChangeLogFile() This method is designed to be overridden by subclasses when a change log is needed. By default it returns null. Returns:String Returns null in this implementation. Subclasses that need a change log should implement. See Also `AbstractChangeLogBasedTask#getChangeLogFile()`

protected String getChangeLogFile()

This method is designed to be overridden by subclasses when a change log is needed. By default it returns null.

Returns:String: Returns null in this implementation. Subclasses that need a change log should implement.
See Also: AbstractChangeLogBasedTask#getChangeLogFile()

getDefaultOutputEncoding	back to summary
protected String getDefaultOutputEncoding()

getLiquibase	back to summary
protected Liquibase getLiquibase()

getResourceAccessor	back to summary
protected ResourceAccessor getResourceAccessor()

getSearchPath	back to summary
public String getSearchPath() This method is designed to be overridden by subclasses when a change log is needed. By default it returns null. Returns:String Returns null in this implementation. Subclasses that need a change log should implement.

getSearchPath

back to summary

public String getSearchPath()

This method is designed to be overridden by subclasses when a change log is needed. By default it returns null.

Returns:String: Returns null in this implementation. Subclasses that need a change log should implement.

init	back to summary
public void init() throws BuildException Overrides org.apache.tools.ant.Task.init. Doc from org.apache.tools.ant.Task.init. Called by the project to let the task initialize properly. The default implementation is a no-op. Annotations @Override Exceptions BuildException: if something goes wrong with the build

init

back to summary

public void init() throws BuildException

Overrides org.apache.tools.ant.Task.init.

Doc from org.apache.tools.ant.Task.init.

Called by the project to let the task initialize properly. The default implementation is a no-op.

Annotations

@Override

Exceptions

BuildException:: if something goes wrong with the build

isPromptOnNonLocalDatabase	back to summary
public boolean isPromptOnNonLocalDatabase() Deprecated no longer prompts

setChangeLogParametersRef	back to summary
public void setChangeLogParametersRef(Reference changeLogParametersRef)

setClasspathRef	back to summary
public void setClasspathRef(Reference r)

setDatabaseRef	back to summary
public void setDatabaseRef(Reference databaseRef)

setPromptOnNonLocalDatabase	back to summary
public void setPromptOnNonLocalDatabase(boolean promptOnNonLocalDatabase) Deprecated no longer prompts

shouldRun	back to summary
protected boolean shouldRun()

validateParameters	back to summary
protected void validateParameters() Subclasses that override this method must always call `super.validateParameters()` method.

public abstract Class BaseLiquibaseTask

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail