Package 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:
Cloneable
Direct Known Subclasses:
AbstractChangeLogBasedTask, AbstractDatabaseDiffTask, DBDocTask, DropAllTask, GenerateChangeLogTask, 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.

  • Constructor Details

    • BaseLiquibaseTask

      public BaseLiquibaseTask()

  • Method Details

    • init

      public void init() throws org.apache.tools.ant.BuildException
      Overrides:
      init in class org.apache.tools.ant.Task
      Throws:
      org.apache.tools.ant.BuildException

    • 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

    • createDatabaseFromConfiguredDatabaseType

      protected Database createDatabaseFromConfiguredDatabaseType()

    • createDatabaseFromType

      protected Database createDatabaseFromType(DatabaseType databaseType, ResourceAccessor resourceAccessor)

    • getLiquibase

      protected Liquibase getLiquibase()

    • getResourceAccessor

      protected ResourceAccessor getResourceAccessor()

    • 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:

    • getSearchPath

      public String getSearchPath()
      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.

    • 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:

    • 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 org.apache.tools.ant.types.Path createClasspath()

    • setClasspathRef

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

    • addDatabase

      public void addDatabase(DatabaseType databaseType)

    • setDatabaseRef

      public void setDatabaseRef(org.apache.tools.ant.types.Reference databaseRef)

    • addChangeLogParameters

      public void addChangeLogParameters(ChangeLogParametersType changeLogParameters)

    • setChangeLogParametersRef

      public void setChangeLogParametersRef(org.apache.tools.ant.types.Reference changeLogParametersRef)

    • isPromptOnNonLocalDatabase

      public boolean isPromptOnNonLocalDatabase()
      Deprecated.
      no longer prompts

    • setPromptOnNonLocalDatabase

      public void setPromptOnNonLocalDatabase(boolean promptOnNonLocalDatabase)
      Deprecated.
      no longer prompts