com.agimatec.dbmigrate

Class BaseMigrationTool

java.lang.Object

com.agimatec.dbmigrate.BaseMigrationTool

All Implemented Interfaces:

MigrationTool

Direct Known Subclasses:

AutoMigrationTool

public abstract class BaseMigrationTool
extends Object
implements MigrationTool

Description: Base class for Migration and Testcases. Provides infrastructure and common utilities.

development: 2007-2014

Author:

Roman Stumm

Field Summary

Fields

Modifier and Type	Field and Description
protected DatabaseLocker	databaseLocker
protected DBVersionMeta	dbVersionMeta
protected static org.slf4j.Logger	log
protected String	migrateConfigFileName
protected JdbcDatabase	targetDatabase

Constructor Summary

Constructors

Constructor and Description
BaseMigrationTool()

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	acceptDirectoryForSQLParser(File aDirectory) overwrite in subclasses
protected void	applyEnvironment(JdbcConfig jdbcConfig) ensure that the env-variables are used immediately to connect the database!
protected Connection	assertConnection()
void	checkObjectsValid(String databaseType) callback - invoke DatabaseSchemaChecker for invalid triggers, views, ...
void	checkSchemaComplete(String dev) callback - invoke DatabaseSchemaChecker for completeness of schema (columns, tables, foreign keys, indices, ...)
protected void	commit() Deprecated.
void	connectTargetDatabase()
void	copyFiles(String configKey) copy the files from source to target
protected JdbcDatabase	createDatabase(JdbcConfig databaseConfig)
void	dbDump(String file) callback - invoke dbunit example: "data.XML"
void	dbSetup(String files) callback - invoke dbunit
void	disconnectDatabase()
void	doGroovyScript(String scriptInvocation) callback - invoke a groovy script
void	doMethodOperation(String methodName, String methodParam)
void	doSQLLines(String scriptName) callback - read the script and execute each SQL line
void	doSQLLinesIgnoreErrors(String scriptName) callback - read the script and execute each SQL line
void	doSQLScript(String scriptName) callback - parse the script and execute each SQL statement
void	doSQLScriptIgnoreErrors(String scriptName) callback - parse the script and execute each SQL statement
void	execSQLScript(String scriptName) execute the content of a file as a single SQL statement.
protected Method	findMethod(Class clazz, String methodName, int paramCount)
DatabaseLocker	getDatabaseLocker()
DBVersionMeta	getDbVersionMeta()
Map	getEnvironment() a map for environment properties (JVM System-Properties overwrite these properties) (to be used to conditional execution of statements in SQL scripts)
String[]	getGroovyScriptsDirs()
protected String	getJdbcConfigFile()
org.slf4j.Logger	getLog()
Config	getMigrateConfig()
protected List	getOperations(String name)
String	getScriptsDir()
JdbcDatabase	getTargetDatabase()
void	halt(String message) callback -
protected void	handleException(String msg, Exception ex)
void	invokeBean(String classMethod) invoke a n-arg-method on a new instance of a class.
protected void	invokeBeanCallbacks(Object receiver)
protected void	invokeClassMethod(boolean isStatic, String classMethod)
void	invokeStatic(String classMethod) invoke a static n-arg-method on a class.
protected boolean	isFailOnError()
protected void	iterateSQLLines(ScriptVisitor visitor, String scriptName, boolean failOnError) iterate sql script.
protected void	iterateSQLScript(ScriptVisitor visitor, String scriptName, boolean failOnError) iterate sql script.
void	lockBusy()
void	log(Object obj)
protected List<DatabaseSchemaChecker.Options>	parseOptions(StringTokenizer t)
protected void	perform(List operations)
void	print(Object obj)
protected void	replaceProperties(Map env)
void	rollback()
void	setConfigRootUrl(String configRoot)
void	setDatabaseLocker(DatabaseLocker busyLocker)
void	setMigrateConfigFileName(String migrateConfigFileName)
void	setScriptsDir(String scriptsDir)
void	setTargetDatabase(JdbcDatabase targetDatabase)
void	setUp()
protected void	setupDatabaseLocker()
protected void	setupVersionMeta()
protected Object[]	splitMethodArgs(String classMethod)
protected List<String>	splitParams(String methodName)
protected int	sqlExec(String sql)
protected SQLCursor	sqlSelect(String sql) utility method to exec a JDBC SELECT statement directly
void	tearDown()
void	terminateTransactions()
void	unlockBusy()
void	version(String dbVersion) callback - update the version

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static final org.slf4j.Logger log

targetDatabase

protected JdbcDatabase targetDatabase

migrateConfigFileName

protected String migrateConfigFileName

dbVersionMeta

protected final DBVersionMeta dbVersionMeta

databaseLocker

protected DatabaseLocker databaseLocker

Since:

2.5.23

Constructor Detail

BaseMigrationTool

public BaseMigrationTool()

Method Detail

setUp

public void setUp()

setConfigRootUrl

public void setConfigRootUrl(String configRoot)

setupVersionMeta

protected void setupVersionMeta()

setupDatabaseLocker

protected void setupDatabaseLocker()

tearDown

public void tearDown()
              throws Exception

Throws:

Exception

halt

public void halt(String message)

callback -

version

public void version(String dbVersion)
             throws JdbcException

callback - update the version

Throws:

JdbcException

lockBusy

public void lockBusy()

unlockBusy

public void unlockBusy()

getDatabaseLocker

public DatabaseLocker getDatabaseLocker()

Returns:

Since:

2.5.23

setDatabaseLocker

public void setDatabaseLocker(DatabaseLocker busyLocker)

Parameters:

busyLocker -

Since:

2.5.23

execSQLScript

public void execSQLScript(String scriptName)
                   throws SQLException,
                          IOException

execute the content of a file as a single SQL statement. You can use this, when you need not parse the file or when the file cannot be parsed. Example: use this to execute a PL/SQL package, that is stored in a single file (1 file for the spec, 1 file for the body).

Parameters:

scriptName - - may contain properties, but not supported are: -- #if conditions, reconnect, subscripts etc.

Throws:

SQLException

IOException

doSQLScript

public void doSQLScript(String scriptName)
                 throws IOException,
                        SQLException

callback - parse the script and execute each SQL statement

Throws:

IOException

SQLException

doSQLScriptIgnoreErrors

public void doSQLScriptIgnoreErrors(String scriptName)
                             throws Exception

callback - parse the script and execute each SQL statement

Throws:

Exception

doSQLLines

public void doSQLLines(String scriptName)
                throws IOException,
                       SQLException

callback - read the script and execute each SQL line

Throws:

IOException

SQLException

doSQLLinesIgnoreErrors

public void doSQLLinesIgnoreErrors(String scriptName)
                            throws Exception

callback - read the script and execute each SQL line

Throws:

Exception

iterateSQLLines

protected void iterateSQLLines(ScriptVisitor visitor,
                   String scriptName,
                   boolean failOnError)
                        throws IOException,
                               SQLException

iterate sql script.

Throws:

IOException

SQLException

checkObjectsValid

public void checkObjectsValid(String databaseType)
                       throws Exception

callback - invoke DatabaseSchemaChecker for invalid triggers, views, ...

Throws:

Exception

checkSchemaComplete

public void checkSchemaComplete(String dev)
                         throws Exception

callback - invoke DatabaseSchemaChecker for completeness of schema (columns, tables, foreign keys, indices, ...)

Throws:

Exception

parseOptions

protected List<DatabaseSchemaChecker.Options> parseOptions(StringTokenizer t)
                                                    throws MalformedURLException

Throws:

MalformedURLException

dbSetup

public void dbSetup(String files)
             throws Exception

callback - invoke dbunit

Parameters:

files - - comma-separated delete and insert DB-Unit script, example: "delete_data.xml,data.XML" example: "data.XML"

Throws:

Exception

copyFiles

public void copyFiles(String configKey)
               throws IOException

copy the files from source to target

Parameters:

configKey - - key in the env, value is list of source_1, target_1, ... URLs

Throws:

IOException

dbDump

public void dbDump(String file)
            throws Exception

callback - invoke dbunit example: "data.XML"

Throws:

Exception

invokeStatic

public void invokeStatic(String classMethod)
                  throws Exception

invoke a static n-arg-method on a class. All parameters of the target method must be of type String!!

Throws:

Exception

invokeBean

public void invokeBean(String classMethod)
                throws Exception

invoke a n-arg-method on a new instance of a class. All parameters of the target method must be of type String!!

Throws:

Exception

invokeClassMethod

protected void invokeClassMethod(boolean isStatic,
                     String classMethod)
                          throws Exception

Throws:

Exception

doGroovyScript

public void doGroovyScript(String scriptInvocation)
                    throws Exception

callback - invoke a groovy script

Throws:

IOException

Exception

invokeBeanCallbacks

protected void invokeBeanCallbacks(Object receiver)

findMethod

protected Method findMethod(Class clazz,
                String methodName,
                int paramCount)

splitMethodArgs

protected Object[] splitMethodArgs(String classMethod)

splitParams

protected List<String> splitParams(String methodName)

iterateSQLScript

protected void iterateSQLScript(ScriptVisitor visitor,
                    String scriptName,
                    boolean failOnError)
                         throws IOException,
                                SQLException

iterate sql script.

Throws:

IOException

SQLException

getDbVersionMeta

public DBVersionMeta getDbVersionMeta()

getEnvironment

public Map getEnvironment()

a map for environment properties (JVM System-Properties overwrite these properties) (to be used to conditional execution of statements in SQL scripts)

Specified by:

getEnvironment in interface MigrationTool

Returns:

a map (do not modify!)

replaceProperties

protected void replaceProperties(Map env)

getTargetDatabase

public JdbcDatabase getTargetDatabase()

Specified by:

getTargetDatabase in interface MigrationTool

getMigrateConfig

public Config getMigrateConfig()

setMigrateConfigFileName

public void setMigrateConfigFileName(String migrateConfigFileName)

getOperations

protected List getOperations(String name)

getScriptsDir

public String getScriptsDir()

getGroovyScriptsDirs

public String[] getGroovyScriptsDirs()

setScriptsDir

public void setScriptsDir(String scriptsDir)

perform

protected void perform(List operations)
                throws Exception

Throws:

Exception

doMethodOperation

public void doMethodOperation(String methodName,
                     String methodParam)
                       throws Exception

Throws:

Exception

connectTargetDatabase

public void connectTargetDatabase()

handleException

protected void handleException(String msg,
                   Exception ex)

createDatabase

protected JdbcDatabase createDatabase(JdbcConfig databaseConfig)

applyEnvironment

protected void applyEnvironment(JdbcConfig jdbcConfig)

ensure that the env-variables are used immediately to connect the database!

commit

@Deprecated
protected void commit()

Deprecated.

getJdbcConfigFile

protected String getJdbcConfigFile()

print

public void print(Object obj)

log

public void log(Object obj)

getLog

public org.slf4j.Logger getLog()

rollback

public void rollback()
              throws Exception

Throws:

Exception

terminateTransactions

public void terminateTransactions()
                           throws Exception

Throws:

Exception

disconnectDatabase

public void disconnectDatabase()
                        throws Exception

Throws:

Exception

acceptDirectoryForSQLParser

protected boolean acceptDirectoryForSQLParser(File aDirectory)

overwrite in subclasses

sqlSelect

protected SQLCursor sqlSelect(String sql)
                       throws SQLException

utility method to exec a JDBC SELECT statement directly

Throws:

SQLException

assertConnection

protected Connection assertConnection()
                               throws JdbcException

Throws:

JdbcException

sqlExec

protected int sqlExec(String sql)
               throws SQLException

Throws:

SQLException

setTargetDatabase

public void setTargetDatabase(JdbcDatabase targetDatabase)

isFailOnError

protected boolean isFailOnError()