com.communote.server.core.common.database

Class DatabaseUpdater

java.lang.Object

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

Direct Known Subclasses:

AbstractLiquibaseDatabaseUpdater

public abstract class DatabaseUpdater
extends Object

Component for installing and updating a Communote database to the latest state.

Since the updater is run as a part of the startup process, implementors have to make sure that the individual changes to the schema or content are not run again if they have already been executed before.

Author:

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

Constructor Summary

Constructors

Constructor and Description
DatabaseUpdater()

Method Summary

Modifier and Type	Method and Description
protected abstract void	doExecute(DatabaseUpdateType updateType) Will be invoked by execute(DatabaseUpdateType) to do the actual update.
void	execute(DatabaseUpdateType updateType) Execute the given update.
boolean	skipUpdates() Return whether updates should be skipped.
void	updateDatabase() Executes the first and second pass updates if updates should not be skipped.
abstract boolean	updaterRunBefore() Returns whether the updater run at least once against the database.
boolean	updateRunInSession(DatabaseUpdateType updateType) Return whether this updater has run the given update after this instance was created.

Methods inherited from class java.lang.Object

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

Constructor Detail

DatabaseUpdater

public DatabaseUpdater()

Method Detail

doExecute

protected abstract void doExecute(DatabaseUpdateType updateType)
                           throws DatabaseUpdateException

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

Parameters:

updateType - the type of update that should be executed

Throws:

DatabaseUpdateException - in case of an error database update error

execute

public void execute(DatabaseUpdateType updateType)
             throws DatabaseUpdateException

Execute the given update. This method will not check whether updates should be skipped.

Parameters:

updateType - the type of update that should be executed

Throws:

DatabaseUpdateException - in case of an error database update error

skipUpdates

public boolean skipUpdates()

Return whether updates should be skipped. This method will return true if the system property is set and has the value "true" (case-insensitive).

Returns:

true if updates should be skipped

updateDatabase

public void updateDatabase()
                    throws DatabaseUpdateException

Executes the first and second pass updates if updates should not be skipped.

Throws:

DatabaseUpdateException

updaterRunBefore

public abstract boolean updaterRunBefore()

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

Returns:

true if the updater was run before

updateRunInSession

public boolean updateRunInSession(DatabaseUpdateType updateType)

Return whether this updater has run the given update after this instance was created.

Parameters:

updateType - the update type to check for having been run

Returns:

true if the update was run