com.xpn.xwiki.store.migration

Interface DataMigrationStatus

public interface DataMigrationStatus

Common interface to report data migration status.

Since:

4.4.1

Version:

$Id: 22cc507f7b3d445ccedee9d2d5da43b3825be6b2 $

Method Summary

Modifier and Type	Method and Description
XWikiDBVersion	getDBVersion()
Exception	getLastMigrationException()
boolean	hasBeenSuccessfullyMigrated()
boolean	hasDataMigrationBeenAttempted()

Method Detail

getDBVersion

XWikiDBVersion getDBVersion()
                     throws DataMigrationException

Returns:

current DB version or null for a new database

Throws:

DataMigrationException - if any error

xwiki.cfg configuration:

xwiki.store.migration.version - override data version

hasDataMigrationBeenAttempted

boolean hasDataMigrationBeenAttempted()

Returns:

true if any migration has been attempted on current database

hasBeenSuccessfullyMigrated

boolean hasBeenSuccessfullyMigrated()

Returns:

true if all attempted migrations has been successfully applied on current database

getLastMigrationException

Exception getLastMigrationException()

Returns:

the exception returned on failure by the last attempted migration on this database