org.dbmaintain.launch.task
Class CreateScriptArchiveTask

java.lang.Object
  extended by org.dbmaintain.launch.task.DbMaintainTask
      extended by org.dbmaintain.launch.task.CreateScriptArchiveTask

public class CreateScriptArchiveTask
extends DbMaintainTask

Task that enables creating a jar file that packages all database update scripts. to apply changes on a target database. This way, database updates can be distributed in the form of a deliverable, just like a war or ear file.

The jar file that's created contains all configuration that concerns the organization of the scripts in this jar in a properties file.

Author:
Filip Neven, Tim Ducheyne

Field Summary
protected  String archiveFileName
           
protected  String patchQualifiers
           
protected  String postProcessingScriptDirectoryName
           
protected  String qualifiers
           
protected  String scriptEncoding
           
protected  String scriptFileExtensions
           
protected  String scriptLocations
           
 
Constructor Summary
CreateScriptArchiveTask()
           
CreateScriptArchiveTask(String archiveFileName, String scriptLocations, String scriptEncoding, String postProcessingScriptDirectoryName, String qualifiers, String patchQualifiers, String scriptFileExtensions)
           
 
Method Summary
protected  void addTaskConfiguration(TaskConfiguration taskConfiguration)
          Implement by adding specific configuration for this task
 boolean doExecute(MainFactory mainFactory)
          Implement by invoking the actual behavior
 void setArchiveFileName(String archiveFileName)
           
 void setPatchQualifiers(String patchQualifiers)
           
 void setPostProcessingScriptDirectoryName(String postProcessingScriptDirectoryName)
           
 void setQualifiers(String qualifiers)
           
 void setScriptEncoding(String scriptEncoding)
           
 void setScriptFileExtensions(String scriptFileExtensions)
           
 void setScriptLocations(String scriptLocations)
           
 
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

archiveFileName

protected String archiveFileName

scriptLocations

protected String scriptLocations

scriptEncoding

protected String scriptEncoding

postProcessingScriptDirectoryName

protected String postProcessingScriptDirectoryName

qualifiers

protected String qualifiers

patchQualifiers

protected String patchQualifiers

scriptFileExtensions

protected String scriptFileExtensions
Constructor Detail

CreateScriptArchiveTask

public CreateScriptArchiveTask()

CreateScriptArchiveTask

public CreateScriptArchiveTask(String archiveFileName,
                               String scriptLocations,
                               String scriptEncoding,
                               String postProcessingScriptDirectoryName,
                               String qualifiers,
                               String patchQualifiers,
                               String scriptFileExtensions)
Method Detail

doExecute

public 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

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

setArchiveFileName

public void setArchiveFileName(String archiveFileName)

setScriptLocations

public void setScriptLocations(String scriptLocations)

setScriptEncoding

public void setScriptEncoding(String scriptEncoding)

setPostProcessingScriptDirectoryName

public void setPostProcessingScriptDirectoryName(String postProcessingScriptDirectoryName)

setQualifiers

public void setQualifiers(String qualifiers)

setPatchQualifiers

public void setPatchQualifiers(String patchQualifiers)

setScriptFileExtensions

public void setScriptFileExtensions(String scriptFileExtensions)


Copyright © 2011. All Rights Reserved.