liquibase.integration.ant

Class BaseLiquibaseTask

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

liquibase.integration.ant.BaseLiquibaseTask

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

ChangeLogSyncTask, DatabaseRollbackFutureTask, DatabaseRollbackTask, DatabaseUpdateTask, DatabaseUpdateTestingRollbackTask, DBDocTask, DiffDatabaseTask, DropAllTask, GenerateChangeLogTask, MarkNextChangeSetRanTask, TagDatabaseTask

public abstract class BaseLiquibaseTask
extends org.apache.tools.ant.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
protected static class	BaseLiquibaseTask.LogRedirector Redirector of logs from java.util.logging to ANT's loggging

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.tools.ant.types.Path	classpath

Fields inherited from class org.apache.tools.ant.Task

target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

description, location, project

Constructor Summary

Constructors

Constructor and Description
BaseLiquibaseTask()

Method Summary

Methods

Modifier and Type	Method and Description
void	addConfiguredChangeLogProperty(BaseLiquibaseTask.ChangeLogProperty changeLogProperty)
protected void	closeDatabase(Liquibase liquibase)
org.apache.tools.ant.types.Path	createClasspath()
protected Database	createDatabaseObject(java.lang.String driverClassName, java.lang.String databaseUrl, java.lang.String username, java.lang.String password, java.lang.String defaultCatalogName, java.lang.String defaultSchemaName, java.lang.String databaseClass)
protected Liquibase	createLiquibase()
java.io.Writer	createOutputWriter()
java.io.PrintStream	createPrintStream()
void	execute()
protected abstract void	executeWithLiquibaseClassloader()
java.lang.String	getChangeLogFile()
java.lang.String	getContexts()
java.lang.String	getCurrentDateTimeFunction()
java.lang.String	getDatabaseChangeLogLockTableName()
java.lang.String	getDatabaseChangeLogTableName()
java.lang.String	getDatabaseClass()
java.lang.String	getDefaultCatalogName()
java.lang.String	getDefaultSchemaName()
java.lang.String	getDriver()
java.lang.String	getLogLevel()
java.lang.String	getOutputFile()
java.lang.String	getPassword()
java.lang.String	getUrl()
java.lang.String	getUsername()
boolean	isPromptOnNonLocalDatabase()
void	setChangeLogFile(java.lang.String changeLogFile)
void	setClasspathRef(org.apache.tools.ant.types.Reference r)
void	setContexts(java.lang.String cntx)
void	setCurrentDateTimeFunction(java.lang.String currentDateTimeFunction)
void	setDatabaseChangeLogLockTableName(java.lang.String tableName)
void	setDatabaseChangeLogTableName(java.lang.String tableName)
void	setDatabaseClass(java.lang.String databaseClass)
void	setDefaultCatalogName(java.lang.String defaultCatalogName)
void	setDefaultSchemaName(java.lang.String defaultSchemaName)
void	setDriver(java.lang.String driver)
void	setLogLevel(java.lang.String level)
void	setOutputFile(java.lang.String outputFile)
void	setPassword(java.lang.String password)
void	setPromptOnNonLocalDatabase(boolean promptOnNonLocalDatabase)
void	setUrl(java.lang.String url)
void	setUsername(java.lang.String username)
protected boolean	shouldRun()

Methods inherited from class org.apache.tools.ant.Task

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject

Methods inherited from class java.lang.Object

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

Field Detail

classpath

protected org.apache.tools.ant.types.Path classpath

Constructor Detail

BaseLiquibaseTask

public BaseLiquibaseTask()

Method Detail

execute

public final void execute()
                   throws org.apache.tools.ant.BuildException

Overrides:

execute in class org.apache.tools.ant.Task

Throws:

org.apache.tools.ant.BuildException

executeWithLiquibaseClassloader

protected abstract void executeWithLiquibaseClassloader()
                                                 throws org.apache.tools.ant.BuildException

Throws:

org.apache.tools.ant.BuildException

isPromptOnNonLocalDatabase

public boolean isPromptOnNonLocalDatabase()

setPromptOnNonLocalDatabase

public void setPromptOnNonLocalDatabase(boolean promptOnNonLocalDatabase)

getDriver

public java.lang.String getDriver()

setDriver

public void setDriver(java.lang.String driver)

getUrl

public java.lang.String getUrl()

setUrl

public void setUrl(java.lang.String url)

getUsername

public java.lang.String getUsername()

setUsername

public void setUsername(java.lang.String username)

getPassword

public java.lang.String getPassword()

setPassword

public void setPassword(java.lang.String password)

getChangeLogFile

public java.lang.String getChangeLogFile()

setChangeLogFile

public void setChangeLogFile(java.lang.String changeLogFile)

createClasspath

public org.apache.tools.ant.types.Path createClasspath()

setClasspathRef

public void setClasspathRef(org.apache.tools.ant.types.Reference r)

getCurrentDateTimeFunction

public java.lang.String getCurrentDateTimeFunction()

setCurrentDateTimeFunction

public void setCurrentDateTimeFunction(java.lang.String currentDateTimeFunction)

getOutputFile

public java.lang.String getOutputFile()

setOutputFile

public void setOutputFile(java.lang.String outputFile)

createOutputWriter

public java.io.Writer createOutputWriter()
                                  throws java.io.IOException

Throws:

java.io.IOException

createPrintStream

public java.io.PrintStream createPrintStream()
                                      throws java.io.IOException

Throws:

java.io.IOException

getDefaultCatalogName

public java.lang.String getDefaultCatalogName()

setDefaultCatalogName

public void setDefaultCatalogName(java.lang.String defaultCatalogName)

getDefaultSchemaName

public java.lang.String getDefaultSchemaName()

setDefaultSchemaName

public void setDefaultSchemaName(java.lang.String defaultSchemaName)

addConfiguredChangeLogProperty

public void addConfiguredChangeLogProperty(BaseLiquibaseTask.ChangeLogProperty changeLogProperty)

createLiquibase

protected Liquibase createLiquibase()
                             throws java.lang.Exception

Throws:

java.lang.Exception

createDatabaseObject

protected Database createDatabaseObject(java.lang.String driverClassName,
                            java.lang.String databaseUrl,
                            java.lang.String username,
                            java.lang.String password,
                            java.lang.String defaultCatalogName,
                            java.lang.String defaultSchemaName,
                            java.lang.String databaseClass)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getContexts

public java.lang.String getContexts()

setContexts

public void setContexts(java.lang.String cntx)

shouldRun

protected boolean shouldRun()

closeDatabase

protected void closeDatabase(Liquibase liquibase)

getDatabaseClass

public java.lang.String getDatabaseClass()

setDatabaseClass

public void setDatabaseClass(java.lang.String databaseClass)

getDatabaseChangeLogTableName

public java.lang.String getDatabaseChangeLogTableName()

setDatabaseChangeLogTableName

public void setDatabaseChangeLogTableName(java.lang.String tableName)

getDatabaseChangeLogLockTableName

public java.lang.String getDatabaseChangeLogLockTableName()

setDatabaseChangeLogLockTableName

public void setDatabaseChangeLogLockTableName(java.lang.String tableName)

getLogLevel

public java.lang.String getLogLevel()

setLogLevel

public void setLogLevel(java.lang.String level)