org.dbmaintain.launch.task
Class CheckScriptUpdatesTask

java.lang.Object
  org.dbmaintain.launch.task.DbMaintainTask
      org.dbmaintain.launch.task.DbMaintainDatabaseTask
          org.dbmaintain.launch.task.CheckScriptUpdatesTask

public class CheckScriptUpdatesTask
extends DbMaintainDatabaseTask

Performs a dry run of the database update. May be used to verify if there are any updates or in a test that fails if it appears that an irregular script update was performed.

Since:

10-feb-2009

Author:

Filip Neven, Tim Ducheyne

Field Summary

protected Boolean	allowOutOfSequenceExecutionOfPatches
protected Boolean	autoCreateDbMaintainScriptsTable
protected String	excludedQualifiers
protected Boolean	fromScratchEnabled
protected String	includedQualifiers
protected String	patchQualifiers
protected String	postProcessingScriptDirectoryName
protected String	qualifiers
protected String	scriptEncoding
protected String	scriptFileExtensions
protected String	scriptLocations
protected Boolean	useLastModificationDates

Fields inherited from class org.dbmaintain.launch.task.DbMaintainDatabaseTask

databases

Constructor Summary

CheckScriptUpdatesTask()

CheckScriptUpdatesTask(List<DbMaintainDatabase> taskDatabases, String scriptLocations, String scriptEncoding, String postProcessingScriptDirectoryName, Boolean fromScratchEnabled, Boolean autoCreateDbMaintainScriptsTable, Boolean allowOutOfSequenceExecutionOfPatches, String qualifiers, String patchQualifiers, String includedQualifiers, String excludedQualifiers, String scriptFileExtensions, Boolean useLastModificationDates)

Method Summary

protected void	addTaskConfiguration(TaskConfiguration taskConfiguration) Implement by adding specific configuration for this task
protected boolean	doExecute(MainFactory mainFactory) Implement by invoking the actual behavior
void	setAllowOutOfSequenceExecutionOfPatches(Boolean allowOutOfSequenceExecutionOfPatches)
void	setAutoCreateDbMaintainScriptsTable(Boolean autoCreateDbMaintainScriptsTable)
void	setExcludedQualifiers(String excludedQualifiers)
void	setFromScratchEnabled(Boolean fromScratchEnabled)
void	setIncludedQualifiers(String includedQualifiers)
void	setPatchQualifiers(String patchQualifiers)
void	setPostProcessingScriptDirectoryName(String postProcessingScriptDirectoryName)
void	setQualifiers(String qualifiers)
void	setScriptEncoding(String scriptEncoding)
void	setScriptFileExtensions(String scriptFileExtensions)
void	setScriptLocations(String scriptLocations)
void	setUseLastModificationDates(Boolean useLastModificationDates)

Methods inherited from class org.dbmaintain.launch.task.DbMaintainDatabaseTask

setDatabases

Methods inherited from class org.dbmaintain.launch.task.DbMaintainTask

createMainFactory, execute, getTaskConfiguration, setConfigFile, setEnvironmentProperties

Methods inherited from class java.lang.Object

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

Field Detail

scriptLocations

protected String scriptLocations

scriptEncoding

protected String scriptEncoding

postProcessingScriptDirectoryName

protected String postProcessingScriptDirectoryName

fromScratchEnabled

protected Boolean fromScratchEnabled

autoCreateDbMaintainScriptsTable

protected Boolean autoCreateDbMaintainScriptsTable

allowOutOfSequenceExecutionOfPatches

protected Boolean allowOutOfSequenceExecutionOfPatches

qualifiers

protected String qualifiers

patchQualifiers

protected String patchQualifiers

includedQualifiers

protected String includedQualifiers

excludedQualifiers

protected String excludedQualifiers

scriptFileExtensions

protected String scriptFileExtensions

useLastModificationDates

protected Boolean useLastModificationDates

Constructor Detail

CheckScriptUpdatesTask

public CheckScriptUpdatesTask()

CheckScriptUpdatesTask

public CheckScriptUpdatesTask(List<DbMaintainDatabase> taskDatabases,
                              String scriptLocations,
                              String scriptEncoding,
                              String postProcessingScriptDirectoryName,
                              Boolean fromScratchEnabled,
                              Boolean autoCreateDbMaintainScriptsTable,
                              Boolean allowOutOfSequenceExecutionOfPatches,
                              String qualifiers,
                              String patchQualifiers,
                              String includedQualifiers,
                              String excludedQualifiers,
                              String scriptFileExtensions,
                              Boolean useLastModificationDates)

Method Detail

addTaskConfiguration

protected void addTaskConfiguration(TaskConfiguration taskConfiguration)

Description copied from class: DbMaintainTask

Implement by adding specific configuration for this task

Specified by:

addTaskConfiguration in class DbMaintainTask

Parameters:

taskConfiguration - the configuration object that assembles all dbmaintain property values, not null

doExecute

protected boolean doExecute(MainFactory mainFactory)

Description copied from class: DbMaintainTask

Implement by invoking the actual behavior

Specified by:

doExecute in class DbMaintainTask

Parameters:

mainFactory - The main factory, not null

Returns:

True if the task was performed

setScriptLocations

public void setScriptLocations(String scriptLocations)

setScriptEncoding

public void setScriptEncoding(String scriptEncoding)

setPostProcessingScriptDirectoryName

public void setPostProcessingScriptDirectoryName(String postProcessingScriptDirectoryName)

setFromScratchEnabled

public void setFromScratchEnabled(Boolean fromScratchEnabled)

setAutoCreateDbMaintainScriptsTable

public void setAutoCreateDbMaintainScriptsTable(Boolean autoCreateDbMaintainScriptsTable)

setAllowOutOfSequenceExecutionOfPatches

public void setAllowOutOfSequenceExecutionOfPatches(Boolean allowOutOfSequenceExecutionOfPatches)

setQualifiers

public void setQualifiers(String qualifiers)

setPatchQualifiers

public void setPatchQualifiers(String patchQualifiers)

setIncludedQualifiers

public void setIncludedQualifiers(String includedQualifiers)

setExcludedQualifiers

public void setExcludedQualifiers(String excludedQualifiers)

setUseLastModificationDates

public void setUseLastModificationDates(Boolean useLastModificationDates)

setScriptFileExtensions

public void setScriptFileExtensions(String scriptFileExtensions)