org.nuiton.topia.migration

Class TopiaMigrationEngine

java.lang.Object

org.nuiton.topia.migration.TopiaMigrationEngine

All Implemented Interfaces:

TopiaMigrationService, TopiaService

public class TopiaMigrationEngine
extends Object
implements TopiaMigrationService

Le moteur de migration proposé par topia. Il est basé sur un AbstractTopiaMigrationCallback qui donne la version de l'application, les version de mises à jour disponibles. Le call back offre aussi les commandes sql à passer pour chaque version de mise à jour. FIXME Finir cette documentation

Since:

2.3.4

Author:

tchemit

Field Summary

Fields

Modifier and Type	Field and Description
protected TopiaApplicationContext	applicationContext Topia application context (set during init)
protected AbstractTopiaMigrationCallback	callback CallbackHandler list (set during init)
protected boolean	dbEmpty A flag to know if none of the dealed entities tables exists in db.
protected boolean	dbNotVersioned Drapeau pour savoir si la base est versionnée ou non
protected org.nuiton.version.Version	dbVersion Current database version (set during init)
protected boolean	init Flag to know if the service is correctly initialized
protected org.hibernate.boot.Metadata	metaData
protected org.hibernate.SessionFactory	sessionFactory
protected boolean	showProgression Flag to display progress or not
protected boolean	showSql Flag to display SQL requests or not
protected org.hibernate.cfg.Configuration	versionConfiguration Hibernate Configuration only with TMSVersion entity (set during init)
protected boolean	versionDetected A flag to check if version was detected in database.
protected boolean	versionTableExist Flag to know if the TMSVersion table is existing (set during init)

Fields inherited from interface org.nuiton.topia.migration.TopiaMigrationService

MIGRATION_CALLBACK, MIGRATION_MIGRATE_ON_INIT, MIGRATION_SHOW_PROGRESSION, MIGRATION_SHOW_SQL

Constructor Summary

Constructors

Constructor and Description
TopiaMigrationEngine()

Method Summary

Modifier and Type	Method and Description
protected void	checkInit()
void	close()
protected static org.hibernate.cfg.Configuration	createTMSHibernateConfiguration(TopiaApplicationContext appContext) Creates the hibernate configuration to be used by the service.
protected boolean	detectDbEmpty() Detects if there is some schema existing for at least one of the dealed entity of the underlying db context.
protected void	detectDbVersion() Recupere depuis la base les états internes du service : versionTableExist dbVersion dbEmpty
static List<org.nuiton.version.Version>	filterVersions(Set<org.nuiton.version.Version> versions, org.nuiton.version.Version min, org.nuiton.version.Version max, boolean includeMin, boolean includeMax) Filter versions.
protected org.nuiton.version.Version	getApplicationVersion()
protected String	getSafeParameter(Properties config, String key)
String	getSchemaVersion()
void	initOnCreateSchema()
void	initTopiaService(TopiaApplicationContext topiaApplicationContext, Map<String,String> serviceConfiguration)
boolean	migrateSchema() Deprecated.
void	runSchemaMigration()
protected void	saveApplicationVersion() Save the application's model version in the database.

Methods inherited from class java.lang.Object

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

Field Detail

versionConfiguration

protected org.hibernate.cfg.Configuration versionConfiguration

Hibernate Configuration only with TMSVersion entity (set during init)

versionTableExist

protected boolean versionTableExist

Flag to know if the TMSVersion table is existing (set during init)

dbVersion

protected org.nuiton.version.Version dbVersion

Current database version (set during init)

dbNotVersioned

protected boolean dbNotVersioned

Drapeau pour savoir si la base est versionnée ou non

dbEmpty

protected boolean dbEmpty

A flag to know if none of the dealed entities tables exists in db.

Since:

2.5.3

callback

protected AbstractTopiaMigrationCallback callback

CallbackHandler list (set during init)

applicationContext

protected TopiaApplicationContext applicationContext

Topia application context (set during init)

init

protected boolean init

Flag to know if the service is correctly initialized

versionDetected

protected boolean versionDetected

A flag to check if version was detected in database. This flag is set to true at the end of method detectDbVersion().

showSql

protected boolean showSql

Flag to display SQL requests or not

showProgression

protected boolean showProgression

Flag to display progress or not

sessionFactory

protected org.hibernate.SessionFactory sessionFactory

metaData

protected org.hibernate.boot.Metadata metaData

Constructor Detail

TopiaMigrationEngine

public TopiaMigrationEngine()

Method Detail

initTopiaService

public void initTopiaService(TopiaApplicationContext topiaApplicationContext,
                             Map<String,String> serviceConfiguration)

Specified by:

initTopiaService in interface TopiaService

migrateSchema

@Deprecated
public boolean migrateSchema()
                                  throws MigrationServiceException

Deprecated.

Throws:

MigrationServiceException

getSchemaVersion

public String getSchemaVersion()
                        throws TopiaMigrationServiceException

Specified by:

getSchemaVersion in interface TopiaMigrationService

Throws:

TopiaMigrationServiceException

initOnCreateSchema

public void initOnCreateSchema()

Specified by:

initOnCreateSchema in interface TopiaMigrationService

filterVersions

public static List<org.nuiton.version.Version> filterVersions(Set<org.nuiton.version.Version> versions,
                                                              org.nuiton.version.Version min,
                                                              org.nuiton.version.Version max,
                                                              boolean includeMin,
                                                              boolean includeMax)

Filter versions.

Parameters:

versions - versions to filter

min - min version to accept

max - max version to accept

includeMin - flag to include min version

includeMax - flag to include max version

Returns:

versions between min and max

runSchemaMigration

public void runSchemaMigration()

Specified by:

runSchemaMigration in interface TopiaMigrationService

saveApplicationVersion

protected void saveApplicationVersion()

Save the application's model version in the database.

getApplicationVersion

protected org.nuiton.version.Version getApplicationVersion()

detectDbVersion

protected void detectDbVersion()

Recupere depuis la base les états internes du service :

• versionTableExist
• dbVersion
• dbEmpty

detectDbEmpty

protected boolean detectDbEmpty()

Detects if there is some schema existing for at least one of the dealed entity of the underlying db context.

Returns:

true if there is no schema for any of the dealed entities, false otherwise.

Since:

2.5.3

getSafeParameter

protected String getSafeParameter(Properties config,
                                  String key)

checkInit

protected void checkInit()

createTMSHibernateConfiguration

protected static org.hibernate.cfg.Configuration createTMSHibernateConfiguration(TopiaApplicationContext appContext)

Creates the hibernate configuration to be used by the service.

Parameters:

appContext - the topia application context used to copy database credentials

Since:

2.5.3

close

public void close()

Specified by:

close in interface TopiaService