de.viaboxx.dbmigrate.spring
Class DBMigrateBean

java.lang.Object
  de.viaboxx.dbmigrate.spring.DBMigrateBean

All Implemented Interfaces:

org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean

public class DBMigrateBean
extends java.lang.Object
implements org.springframework.beans.factory.InitializingBean, org.springframework.beans.factory.BeanNameAware

Description: Bean to integrate and configure dbmigrate via spring.

Supports spring access common options of AutoMigrationTool:
- sim: simulation (false)
- migrateConfigFileName: xml setup file (migration.xml)

Currently not supported features via spring-configuration:
- script: ScriptAction
- op: OperationAction

User: roman.stumm
Date: 03.11.2011
Time: 08:06:42
viaboxx GmbH, 2011

Field Summary

protected java.lang.String	beanName
protected de.viaboxx.dbmigrate.spring.DBCPAdapter	dataSourceConfigurator

Constructor Summary

DBMigrateBean()

Method Summary

void	afterPropertiesSet() Automatically start dbmigrate.
AutoMigrationTool	getTool()
boolean	isDisabled()
boolean	isStopOnException()
void	setBeanName(java.lang.String name)
void	setConfigFile(java.lang.String fileName)
void	setConfigRootUrl(java.lang.String configRoot)
void	setDataSource(javax.sql.DataSource dataSource) you can optionally configure the database connection for dbmigrate by providing a BasicDataSource.
void	setDisabled(boolean disabled)
void	setEnvironment(java.util.Map<java.lang.String,java.lang.Object> env)
void	setFromVersion(java.lang.String version)
void	setMigrateConfig(java.util.Map<java.lang.Object,java.lang.Object> conf)
void	setSimulation(boolean sim)
void	setStopOnException(boolean stopOnException)
void	setToVersion(java.lang.String version)

Methods inherited from class java.lang.Object

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

Field Detail

beanName

protected java.lang.String beanName

dataSourceConfigurator

protected de.viaboxx.dbmigrate.spring.DBCPAdapter dataSourceConfigurator

Constructor Detail

DBMigrateBean

public DBMigrateBean()

Method Detail

setConfigFile

public void setConfigFile(java.lang.String fileName)

Parameters:

fileName - - default is "migration.xml", see BaseMigrationTool#migrateConfigFileName

isDisabled

public boolean isDisabled()

setDisabled

public void setDisabled(boolean disabled)

isStopOnException

public boolean isStopOnException()

setStopOnException

public void setStopOnException(boolean stopOnException)

setSimulation

public void setSimulation(boolean sim)

Parameters:

sim - - default is 'false'

setConfigRootUrl

public void setConfigRootUrl(java.lang.String configRoot)

setToVersion

public void setToVersion(java.lang.String version)

setFromVersion

public void setFromVersion(java.lang.String version)

setEnvironment

public void setEnvironment(java.util.Map<java.lang.String,java.lang.Object> env)

setMigrateConfig

public void setMigrateConfig(java.util.Map<java.lang.Object,java.lang.Object> conf)

getTool

public AutoMigrationTool getTool()

Returns:

the underlying dbmigrate tool instance (never null)

afterPropertiesSet

public void afterPropertiesSet()
                        throws java.lang.Exception

Automatically start dbmigrate. Throw exception when something goes wrong.

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

java.lang.Exception - - all exceptions when dbmigrate not successful

setBeanName

public void setBeanName(java.lang.String name)

Specified by:

setBeanName in interface org.springframework.beans.factory.BeanNameAware

setDataSource

public void setDataSource(javax.sql.DataSource dataSource)

you can optionally configure the database connection for dbmigrate by providing a BasicDataSource. Otherwise dbmigrate uses its proprietary database connection settings. (for proprietary configuration, see properties file configured with

 <file name="JdbcConfig" file="dbconnect.properties"/>

or provide these information in the xml configuration, read more here: DBMigrateConfigFile

Parameters:

dataSource -