liquibase.integration.ant

Class BaseLiquibaseTask

java.lang.Object

Task

liquibase.integration.ant.BaseLiquibaseTask

Direct Known Subclasses:

AbstractChangeLogBasedTask, AbstractDatabaseDiffTask, DBDocTask, DropAllTask, GenerateChangeLogTask, TagDatabaseTask

public abstract class BaseLiquibaseTask
extends Task

Base class for all Ant Liquibase tasks. This class sets up Liquibase and defines parameters that are common to all tasks.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BaseLiquibaseTask.ChangeLogProperty Deprecated. Use ChangeLogParametersType instead.
protected static class	BaseLiquibaseTask.LogRedirector Deprecated.

Constructor Summary

Constructors

Constructor and Description
BaseLiquibaseTask()

Method Summary

Modifier and Type	Method and Description
void	addChangeLogParameters(ChangeLogParametersType changeLogParameters)
void	addConfiguredChangeLogProperty(BaseLiquibaseTask.ChangeLogProperty changeLogProperty) Deprecated. Use ChangeLogParametersType.addConfiguredChangeLogParameter(Property) instead.
void	addDatabase(DatabaseType databaseType)
protected void	closeDatabase(Database database) Convenience method to safely close the database connection.
protected void	closeDatabase(Liquibase liquibase) Deprecated. Use closeDatabase(liquibase.database.Database) instead.
Path	createClasspath()
protected Database	createDatabaseFromConfiguredDatabaseType()
protected Database	createDatabaseFromType(DatabaseType databaseType)
protected Database	createDatabaseObject(String driverClassName, String databaseUrl, String username, String password, String defaultCatalogName, String defaultSchemaName, String databaseClass) Deprecated. Use createDatabaseFromType(DatabaseType) instead.
protected Liquibase	createLiquibase() Deprecated. The Liquibase class is now created automatically when the Ant task is executed. Use getLiquibase() instead.
Writer	createOutputWriter() Deprecated. Subclasses of this class should either instantiate their own output writers or use AbstractChangeLogBasedTask if their task involves a change log.
PrintStream	createPrintStream() Deprecated. Subclasses of this class should either instantiate their own output writers or use AbstractChangeLogBasedTask if the task involves a change log.
void	execute()
protected abstract void	executeWithLiquibaseClassloader()
String	getChangeLogDirectory() This method is designed to be overridden by subclasses when a change log is needed.
protected String	getChangeLogFile() This method is designed to be overridden by subclasses when a change log is needed.
String	getContexts() This method no longer does anything.
String	getCurrentDateTimeFunction() Deprecated. Use DatabaseType.getCurrentDateTimeFunction() instead.
String	getDatabaseChangeLogLockTableName() Deprecated. Use DatabaseType.getDatabaseChangeLogLockTableName() instead.
String	getDatabaseChangeLogObjectsTablespace() Deprecated. Use DatabaseType.getLiquibaseTablespaceName() instead.
String	getDatabaseChangeLogTableName() Deprecated. Use DatabaseType.getDatabaseChangeLogTableName() instead.
String	getDatabaseClass() Deprecated. Use DatabaseType.getDatabaseClass() instead.
String	getDefaultCatalogName() Deprecated. Use DatabaseType.getDefaultCatalogName() instead.
protected String	getDefaultOutputEncoding()
String	getDefaultSchemaName() Deprecated. Use DatabaseType.getDefaultSchemaName() instead.
String	getDriver() Deprecated. Use DatabaseType.getDriver() instead.
protected Liquibase	getLiquibase()
FileResource	getOutputFile() This method does nothing.
String	getPassword() Deprecated. Use DatabaseType.getPassword() instead.
String	getUrl() Deprecated. Use DatabaseType.getUrl() instead.
String	getUsername() Deprecated. Use DatabaseType.getUser() instead.
void	init()
boolean	isOutputDefaultCatalog() Deprecated. Use DatabaseType.isOutputDefaultCatalog() instead.
boolean	isOutputDefaultSchema() Deprecated. Use DatabaseType.isOutputDefaultSchema() instead.
boolean	isPromptOnNonLocalDatabase()
void	setChangeLogFile(String changeLogFile)
void	setChangeLogParametersRef(Reference changeLogParametersRef)
void	setClasspathRef(Reference r)
void	setContexts(String cntx) This method no longer does anything.
void	setCurrentDateTimeFunction(String currentDateTimeFunction) Deprecated. Use DatabaseType.setCurrentDateTimeFunction(String) instead.
void	setDatabaseChangeLogLockTableName(String tableName) Deprecated.
void	setDatabaseChangeLogObjectsTablespace(String tablespaceName) Deprecated. Use DatabaseType.setLiquibaseTablespaceName(String) instead.
void	setDatabaseChangeLogTableName(String tableName) Deprecated. Use DatabaseType.setDatabaseChangeLogTableName(String) instead.
void	setDatabaseClass(String databaseClass) Deprecated. Use DatabaseType.setDatabaseClass(String) instead.
void	setDatabaseRef(Reference databaseRef)
void	setDefaultCatalogName(String defaultCatalogName) Deprecated. Use DatabaseType.setDefaultCatalogName(String) instead.
void	setDefaultSchemaName(String defaultSchemaName) Deprecated. Use DatabaseType.setDefaultSchemaName(String) instead.
void	setDriver(String driver) Deprecated. Use DatabaseType.setDriver(String) instead.
void	setOutputDefaultCatalog(boolean outputDefaultCatalog) Deprecated. Use DatabaseType.setOutputDefaultCatalog(boolean) instead.
void	setOutputDefaultSchema(boolean outputDefaultSchema) Deprecated. Use a nested DatabaseType instead.
void	setOutputEncoding(String outputEncoding)
void	setOutputFile(FileResource outputFile) This method does nothing.
void	setPassword(String password) Deprecated. Use DatabaseType.setPassword(String) instead.
void	setPromptOnNonLocalDatabase(boolean promptOnNonLocalDatabase) Deprecated parameters *
void	setUrl(String url) Deprecated. Use DatabaseType.setUrl(String) instead.
void	setUsername(String username) Deprecated. Use DatabaseType.setUser(String) instead.
protected boolean	shouldRun()
protected void	validateParameters() Subclasses that override this method must always call super.validateParameters() method.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseLiquibaseTask

public BaseLiquibaseTask()

Method Detail

init

public void init()
          throws BuildException

Throws:

BuildException

execute

public final void execute()
                   throws BuildException

Throws:

BuildException

executeWithLiquibaseClassloader

protected abstract void executeWithLiquibaseClassloader()
                                                 throws BuildException

Throws:

BuildException

createDatabaseFromConfiguredDatabaseType

protected Database createDatabaseFromConfiguredDatabaseType()

createDatabaseFromType

protected Database createDatabaseFromType(DatabaseType databaseType)

getLiquibase

protected Liquibase getLiquibase()

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:

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

See Also:

AbstractChangeLogBasedTask.getChangeLogDirectory()

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:

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

See Also:

AbstractChangeLogBasedTask.getChangeLogFile()

setChangeLogFile

public void setChangeLogFile(String changeLogFile)

shouldRun

protected boolean shouldRun()

getDefaultOutputEncoding

protected String getDefaultOutputEncoding()

validateParameters

protected void validateParameters()

Subclasses that override this method must always call super.validateParameters() method.

closeDatabase

protected void closeDatabase(Database database)

Convenience method to safely close the database connection.

Parameters:

database - The database to close.

createClasspath

public Path createClasspath()

setClasspathRef

public void setClasspathRef(Reference r)

addDatabase

public void addDatabase(DatabaseType databaseType)

setDatabaseRef

public void setDatabaseRef(Reference databaseRef)

addChangeLogParameters

public void addChangeLogParameters(ChangeLogParametersType changeLogParameters)

setChangeLogParametersRef

public void setChangeLogParametersRef(Reference changeLogParametersRef)

isPromptOnNonLocalDatabase

public boolean isPromptOnNonLocalDatabase()

setPromptOnNonLocalDatabase

public void setPromptOnNonLocalDatabase(boolean promptOnNonLocalDatabase)

Deprecated parameters *

getDriver

@Deprecated
public String getDriver()

Deprecated. Use DatabaseType.getDriver() instead.

setDriver

@Deprecated
public void setDriver(String driver)

Deprecated. Use DatabaseType.setDriver(String) instead.

getUrl

@Deprecated
public String getUrl()

Deprecated. Use DatabaseType.getUrl() instead.

setUrl

@Deprecated
public void setUrl(String url)

Deprecated. Use DatabaseType.setUrl(String) instead.

getUsername

@Deprecated
public String getUsername()

Deprecated. Use DatabaseType.getUser() instead.

setUsername

@Deprecated
public void setUsername(String username)

Deprecated. Use DatabaseType.setUser(String) instead.

getPassword

@Deprecated
public String getPassword()

Deprecated. Use DatabaseType.getPassword() instead.

setPassword

@Deprecated
public void setPassword(String password)

Deprecated. Use DatabaseType.setPassword(String) instead.

getCurrentDateTimeFunction

@Deprecated
public String getCurrentDateTimeFunction()

Deprecated. Use DatabaseType.getCurrentDateTimeFunction() instead.

setCurrentDateTimeFunction

@Deprecated
public void setCurrentDateTimeFunction(String currentDateTimeFunction)

Deprecated. Use DatabaseType.setCurrentDateTimeFunction(String) instead.

getOutputFile

public FileResource getOutputFile()

This method does nothing. Use child implementations.

setOutputFile

public void setOutputFile(FileResource outputFile)

This method does nothing. Use child implementations.

createOutputWriter

@Deprecated
public Writer createOutputWriter()
                                       throws IOException

Deprecated. Subclasses of this class should either instantiate their own output writers or use AbstractChangeLogBasedTask if their task involves a change log.

Throws:

IOException

createPrintStream

@Deprecated
public PrintStream createPrintStream()
                                           throws IOException

Deprecated. Subclasses of this class should either instantiate their own output writers or use AbstractChangeLogBasedTask if the task involves a change log.

Throws:

IOException

setOutputEncoding

public void setOutputEncoding(String outputEncoding)

getDefaultCatalogName

@Deprecated
public String getDefaultCatalogName()

Deprecated. Use DatabaseType.getDefaultCatalogName() instead.

setDefaultCatalogName

@Deprecated
public void setDefaultCatalogName(String defaultCatalogName)

Deprecated. Use DatabaseType.setDefaultCatalogName(String) instead.

getDefaultSchemaName

@Deprecated
public String getDefaultSchemaName()

Deprecated. Use DatabaseType.getDefaultSchemaName() instead.

setDefaultSchemaName

@Deprecated
public void setDefaultSchemaName(String defaultSchemaName)

Deprecated. Use DatabaseType.setDefaultSchemaName(String) instead.

addConfiguredChangeLogProperty

@Deprecated
public void addConfiguredChangeLogProperty(BaseLiquibaseTask.ChangeLogProperty changeLogProperty)

Deprecated. Use ChangeLogParametersType.addConfiguredChangeLogParameter(Property) instead.

createLiquibase

@Deprecated
protected Liquibase createLiquibase()
                                          throws Exception

Deprecated. The Liquibase class is now created automatically when the Ant task is executed. Use getLiquibase() instead.

Throws:

Exception

createDatabaseObject

@Deprecated
protected Database createDatabaseObject(String driverClassName,
                                                     String databaseUrl,
                                                     String username,
                                                     String password,
                                                     String defaultCatalogName,
                                                     String defaultSchemaName,
                                                     String databaseClass)
                                              throws Exception

Deprecated. Use createDatabaseFromType(DatabaseType) instead.

Throws:

Exception

getContexts

public String getContexts()

This method no longer does anything. Please extend from AbstractChangeLogBasedTask which has the equivalent method.

setContexts

public void setContexts(String cntx)

This method no longer does anything. Please extend from AbstractChangeLogBasedTask which has the equivalent method.

closeDatabase

@Deprecated
protected void closeDatabase(Liquibase liquibase)

Deprecated. Use closeDatabase(liquibase.database.Database) instead.

getDatabaseClass

@Deprecated
public String getDatabaseClass()

Deprecated. Use DatabaseType.getDatabaseClass() instead.

setDatabaseClass

@Deprecated
public void setDatabaseClass(String databaseClass)

Deprecated. Use DatabaseType.setDatabaseClass(String) instead.

getDatabaseChangeLogTableName

@Deprecated
public String getDatabaseChangeLogTableName()

Deprecated. Use DatabaseType.getDatabaseChangeLogTableName() instead.

setDatabaseChangeLogTableName

@Deprecated
public void setDatabaseChangeLogTableName(String tableName)

Deprecated. Use DatabaseType.setDatabaseChangeLogTableName(String) instead.

getDatabaseChangeLogLockTableName

@Deprecated
public String getDatabaseChangeLogLockTableName()

Deprecated. Use DatabaseType.getDatabaseChangeLogLockTableName() instead.

setDatabaseChangeLogLockTableName

@Deprecated
public void setDatabaseChangeLogLockTableName(String tableName)

Deprecated.

getDatabaseChangeLogObjectsTablespace

@Deprecated
public String getDatabaseChangeLogObjectsTablespace()

Deprecated. Use DatabaseType.getLiquibaseTablespaceName() instead.

setDatabaseChangeLogObjectsTablespace

@Deprecated
public void setDatabaseChangeLogObjectsTablespace(String tablespaceName)

Deprecated. Use DatabaseType.setLiquibaseTablespaceName(String) instead.

isOutputDefaultSchema

@Deprecated
public boolean isOutputDefaultSchema()

Deprecated. Use DatabaseType.isOutputDefaultSchema() instead.

setOutputDefaultSchema

@Deprecated
public void setOutputDefaultSchema(boolean outputDefaultSchema)

Deprecated. Use a nested DatabaseType instead.

If not set, defaults to true.

Parameters:

outputDefaultSchema - True to output the default schema.

isOutputDefaultCatalog

@Deprecated
public boolean isOutputDefaultCatalog()

Deprecated. Use DatabaseType.isOutputDefaultCatalog() instead.

setOutputDefaultCatalog

@Deprecated
public void setOutputDefaultCatalog(boolean outputDefaultCatalog)

Deprecated. Use DatabaseType.setOutputDefaultCatalog(boolean) instead.

If not set, defaults to true

Parameters:

outputDefaultCatalog - True to output the default catalog.