TopiaMigrationEngine (ToPIA :: Service Migration 3.0-beta-5 API)

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 root context (initialise en pre-init)
`protected AbstractTopiaMigrationCallback`	`callback` CallbackHandler list (initialise en pre-init)
`protected TopiaSchemaListener`	`contextListener` delegate context listener.
`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.util.Version`	`dbVersion` Version courante de la base (initialise en pre-init)
`protected boolean`	`init` Un drapeau pour savoir si le service a bien ete initialise (i.e a bien fini la methode init)
`protected org.hibernate.cfg.Configuration`	`legacyVersionConfiguration` Configuration hibernate ne mappant que l'entite version de l'ancien systeme de migration (initialise en pre-init)
`protected boolean`	`legacyVersionTableExist` Un drapeau pour savoir si la table version (de l'ancien service Manual) existe en base (initialise en pre-init)
`protected boolean`	`migrateOnInit` Un drapeau pour effectuer la migration au demarrage (initialise en pre-init)
`protected boolean`	`showProgression` Un drapeau pour afficher la progression des requetes sql executees
`protected boolean`	`showSql` Un drapeau pour afficher les requetes sql executees
`protected TopiaTransactionVetoable`	`transactionVetoable` delgate transaction listener
`protected org.hibernate.cfg.Configuration`	`versionConfiguration` Configuration hibernate ne mappant que l'entite version (initialise en pre-init)
`protected boolean`	`versionDetected` A flag to check if version was detected in database.
`protected boolean`	`versionTableExist` Un drapeau pour savoir si la table version existe en base (initialise en pre-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()

Constructors
Constructor and Description
`TopiaMigrationEngine()`

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`checkInit()`
`protected org.hibernate.cfg.Configuration`	`createHibernateConfiguration(org.hibernate.cfg.Configuration configuration)` 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`
`void`	`doMigrateSchema()`
`protected org.nuiton.util.Version`	`getApplicationVersion()`
`Class<?>[]`	`getPersistenceClasses()`
`protected String`	`getSafeParameter(Properties config, String key)`
`protected org.nuiton.util.Version`	`getVersion(boolean versionTableExist, String tableName)`
`void`	`initOnCreateSchema()`
`void`	`initTopiaService(TopiaApplicationContext topiaApplicationContext, Map<String,String> serviceConfiguration)`
`boolean`	`migrateSchema()`
`void`	`runSchemaMigration()`
`protected void`	`saveApplicationVersion()` Enregistre la version donnee en base avec creation de la table si elle n'existe pas.

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
```
    Configuration hibernate ne mappant que l'entite version (initialise en pre-init)
  - versionTableExist
```
protected boolean versionTableExist
```
    Un drapeau pour savoir si la table version existe en base (initialise en pre-init)
  - legacyVersionConfiguration
```
protected org.hibernate.cfg.Configuration legacyVersionConfiguration
```
    Configuration hibernate ne mappant que l'entite version de l'ancien systeme de migration (initialise en pre-init)
  - legacyVersionTableExist
```
protected boolean legacyVersionTableExist
```
    Un drapeau pour savoir si la table version (de l'ancien service Manual) existe en base (initialise en pre-init)
  - dbVersion
```
protected org.nuiton.util.Version dbVersion
```
    Version courante de la base (initialise en pre-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
  - migrateOnInit
```
protected boolean migrateOnInit
```
    Un drapeau pour effectuer la migration au demarrage (initialise en pre-init)
  - callback
```
protected AbstractTopiaMigrationCallback callback
```
    CallbackHandler list (initialise en pre-init)
  - applicationContext
```
protected TopiaApplicationContext applicationContext
```
    topia root context (initialise en pre-init)
  - init
```
protected boolean init
```
    Un drapeau pour savoir si le service a bien ete initialise (i.e a bien fini la methode init)
  - 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
```
    Un drapeau pour afficher les requetes sql executees
  - showProgression
```
protected boolean showProgression
```
    Un drapeau pour afficher la progression des requetes sql executees
  - contextListener
```
protected final TopiaSchemaListener contextListener
```
    delegate context listener.
  - transactionVetoable
```
protected final TopiaTransactionVetoable transactionVetoable
```
    delgate transaction listener
- Constructor Detail
  - TopiaMigrationEngine
```
public TopiaMigrationEngine()
```
- Method Detail
  - getPersistenceClasses
```
public Class<?>[] getPersistenceClasses()
```
    Specified by:
    
    getPersistenceClasses in interface TopiaService
  - initTopiaService
```
public void initTopiaService(TopiaApplicationContext topiaApplicationContext,
                    Map<String,String> serviceConfiguration)
```
    Specified by:
    
    initTopiaService in interface TopiaService
  - doMigrateSchema
```
public void doMigrateSchema()
                     throws MigrationServiceException
```
    Throws:
    
    MigrationServiceException
  - migrateSchema
```
public boolean migrateSchema()
                      throws MigrationServiceException
```
    Throws:
    
    MigrationServiceException
  - saveApplicationVersion
```
protected void saveApplicationVersion()
```
    Enregistre la version donnee en base avec creation de la table si elle n'existe pas.
  - getApplicationVersion
```
protected org.nuiton.util.Version getApplicationVersion()
```
  - detectDbVersion
```
protected void detectDbVersion()
```
    Recupere depuis la base les états internes du service :
  - 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
  - getVersion
```
protected org.nuiton.util.Version getVersion(boolean versionTableExist,
                                 String tableName)
```
  - getSafeParameter
```
protected String getSafeParameter(Properties config,
                      String key)
```
  - checkInit
```
protected void checkInit()
```
  - createHibernateConfiguration
```
protected org.hibernate.cfg.Configuration createHibernateConfiguration(org.hibernate.cfg.Configuration configuration)
```
    Creates the hibernate configuration to be used by the service.
    
    Parameters:
    configuration - the incoming hibernate configuration
    
    Returns:
    the complete configuration usable by the service
    Since:
    
    2.5.3
  - initOnCreateSchema
```
public void initOnCreateSchema()
```
    Specified by:
    
    initOnCreateSchema in interface TopiaMigrationService
  - runSchemaMigration
```
public void runSchemaMigration()
```
    Specified by:
    
    runSchemaMigration in interface TopiaMigrationService

Class TopiaMigrationEngine

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

versionConfiguration

versionTableExist

legacyVersionConfiguration

legacyVersionTableExist

dbVersion

dbNotVersioned

dbEmpty

migrateOnInit

callback

applicationContext

init

versionDetected

showSql

showProgression

contextListener

transactionVetoable

Constructor Detail

TopiaMigrationEngine

Method Detail

getPersistenceClasses

initTopiaService

doMigrateSchema

migrateSchema

saveApplicationVersion

getApplicationVersion

detectDbVersion

detectDbEmpty

getVersion

getSafeParameter

checkInit

createHibernateConfiguration

initOnCreateSchema

runSchemaMigration