com.communote.server.core.database.liquibase

Class AbstractLiquibaseDatabaseUpdater

java.lang.Object

com.communote.server.core.common.database.DatabaseUpdater

com.communote.server.core.database.liquibase.AbstractLiquibaseDatabaseUpdater

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.context.ResourceLoaderAware

Direct Known Subclasses:

StandaloneLiquibaseDatabaseUpdater

public abstract class AbstractLiquibaseDatabaseUpdater
extends DatabaseUpdater
implements org.springframework.context.ResourceLoaderAware

Database updater using the liquibase framework and a configured Hibernate session factory implementor to get the database connection.
Implementation is inspired by liquibase.spring.SpringLiquibase

Author:

Communote GmbH - http://www.communote.com/

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	CHANGESET_CONTEXT_CLIENT Context to be used in change-sets which should be run on all databases.
protected static String	CHANGESET_CONTEXT_GLOBAL Context to be used in change-sets which should only be run on the master (aka global) database.
protected static String	CHANGESET_CONTEXT_STANDALONE Context to be used in change-sets which should be run if the installation is a standalone installation.

Constructor Summary

Constructors

Constructor and Description
AbstractLiquibaseDatabaseUpdater()

Method Summary

Modifier and Type	Method and Description
protected void	beforeDatabaseUpdate(DatabaseUpdateType updateType) Is called before a database update is started.
protected void	doExecute(DatabaseUpdateType updateType) Will be invoked by DatabaseUpdater.execute(DatabaseUpdateType) to do the actual update.
protected Connection	getConnection()
protected abstract String[]	getContexts() The contexts of the update.
protected abstract String	getDatabaseInformation(Connection connection) Get some information about the database.
org.springframework.core.io.ResourceLoader	getResourceLoader()
protected org.hibernate.engine.SessionFactoryImplementor	getSessionFactoryImplementor()
protected LiquibaseUpdateDataProvider	getUpdateDataProvider()
protected void	prepareLiquibase(liquibase.Liquibase liquibase, Map<String,Object> changeLogParameters) Prepare the liquibase instance before doing the actual update.
void	setResourceLoader(org.springframework.core.io.ResourceLoader resourceLoader)
void	setSessionFactoryImplementor(org.hibernate.engine.SessionFactoryImplementor sessionFactoryImplementor) Set the hibernate session factory implementor to use for retrieving a connection for updating the database.
void	setUpdateDataProvider(LiquibaseUpdateDataProvider updateDataProvider) Set the data provider to use for the update
protected void	updateDatabase(String changeLog, Map<String,Object> changeLogParameters) Update the database that is returned by getConnection() with the given change-log file and change-log parameters.
boolean	updaterRunBefore() Returns whether the updater run at least once against the database.

Methods inherited from class com.communote.server.core.common.database.DatabaseUpdater

execute, skipUpdates, updateDatabase, updateRunInSession

Methods inherited from class java.lang.Object

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

Field Detail

CHANGESET_CONTEXT_CLIENT

protected static final String CHANGESET_CONTEXT_CLIENT

Context to be used in change-sets which should be run on all databases. For a standalone installation this is the one and only database. For an installation supporting multi-tenancy this refers to the databases of all tenants. Using this context has the same effect as providing no context at a change-set.

See Also:

Constant Field Values

CHANGESET_CONTEXT_GLOBAL

protected static final String CHANGESET_CONTEXT_GLOBAL

Context to be used in change-sets which should only be run on the master (aka global) database. For a standalone installation this is the one and only database. For an installation supporting multi-tenancy this refers to the database of the master tenant, which is the one that was created first and allows creating other tenants.

See Also:

Constant Field Values

CHANGESET_CONTEXT_STANDALONE

protected static final String CHANGESET_CONTEXT_STANDALONE

Context to be used in change-sets which should be run if the installation is a standalone installation. For an installation supporting multi-tenancy change-sets with this context should be ignored.

See Also:

Constant Field Values

Constructor Detail

AbstractLiquibaseDatabaseUpdater

public AbstractLiquibaseDatabaseUpdater()

Method Detail

beforeDatabaseUpdate

protected void beforeDatabaseUpdate(DatabaseUpdateType updateType)
                             throws DatabaseUpdateException

Is called before a database update is started. Default implementation does nothing

Parameters:

updateType - the type of the update which should be run

Throws:

DatabaseUpdateException - in case of an error, like some missing preconditions

doExecute

protected void doExecute(DatabaseUpdateType updateType)
                  throws DatabaseUpdateException

Description copied from class: DatabaseUpdater

Will be invoked by DatabaseUpdater.execute(DatabaseUpdateType) to do the actual update.

Specified by:

doExecute in class DatabaseUpdater

Parameters:

updateType - the type of update that should be executed

Throws:

DatabaseUpdateException - in case of an error database update error

getConnection

protected Connection getConnection()
                            throws SQLException

Returns:

the connection that can be used to update the database

Throws:

SQLException - in case of an sql exception

getContexts

protected abstract String[] getContexts()

The contexts of the update. Any liquibase change-set which has a context which is not the returned array will be ignored. A change-set without context, however, will be executed.

Returns:

the contexts

getDatabaseInformation

protected abstract String getDatabaseInformation(Connection connection)

Get some information about the database. This method is only called if the update resulted in an error to create a useful log message.

Parameters:

connection - the database connection that was used in the update or null if the update failed because no connection could be retrieved

Returns:

the database information to add to the error log message

getResourceLoader

public org.springframework.core.io.ResourceLoader getResourceLoader()

Returns:

the resourceLoader

getSessionFactoryImplementor

protected org.hibernate.engine.SessionFactoryImplementor getSessionFactoryImplementor()

Returns:

the configured sessionFactoryImplementor

getUpdateDataProvider

protected LiquibaseUpdateDataProvider getUpdateDataProvider()

Returns:

the set liquibase data provider or an instance of LiquibaseUpdateDataProvider if no custom provider was set with setUpdateDataProvider(LiquibaseUpdateDataProvider)

prepareLiquibase

protected void prepareLiquibase(liquibase.Liquibase liquibase,
                                Map<String,Object> changeLogParameters)
                         throws DatabaseUpdateException

Prepare the liquibase instance before doing the actual update. This implementation sets the change-log parameters.

Parameters:

liquibase - the liquibase instance to prepare for the update

changeLogParameters - the parameters to replace placeholders in the change-log file. Can be null.

Throws:

DatabaseUpdateException - in case the preparation lead to an error

setResourceLoader

public void setResourceLoader(org.springframework.core.io.ResourceLoader resourceLoader)

Specified by:

setResourceLoader in interface org.springframework.context.ResourceLoaderAware

setSessionFactoryImplementor

public void setSessionFactoryImplementor(org.hibernate.engine.SessionFactoryImplementor sessionFactoryImplementor)

Set the hibernate session factory implementor to use for retrieving a connection for updating the database.

Parameters:

sessionFactoryImplementor - the sessionFactoryImplementor to set

setUpdateDataProvider

public void setUpdateDataProvider(LiquibaseUpdateDataProvider updateDataProvider)

Set the data provider to use for the update

Parameters:

updateDataProvider - the data provider

updateDatabase

protected void updateDatabase(String changeLog,
                              Map<String,Object> changeLogParameters)
                       throws DatabaseUpdateException

Update the database that is returned by getConnection() with the given change-log file and change-log parameters.

Parameters:

changeLog - the location of the change-log file on the classpath

changeLogParameters - mapping from key to value where the key represents a palceholder in a change-set of the change-log file which should be replaced by the value. Can be null.

Throws:

DatabaseUpdateException - in case the update failed

updaterRunBefore

public boolean updaterRunBefore()

Description copied from class: DatabaseUpdater

Returns whether the updater run at least once against the database. It does not matter which DatabaseUpdateType was executed.

Specified by:

updaterRunBefore in class DatabaseUpdater

Returns:

true if the updater was run before