com.helger.photon.basic.migration

Class SystemMigrationManager

java.lang.Object

com.helger.photon.basic.app.dao.impl.AbstractDAO

com.helger.photon.basic.app.dao.impl.AbstractSimpleDAO

com.helger.photon.basic.migration.SystemMigrationManager

All Implemented Interfaces:

IAutoSaveAware, IChangeable, IDAO

@ThreadSafe
public class SystemMigrationManager
extends AbstractSimpleDAO

Nested Class Summary

Nested classes/interfaces inherited from interface com.helger.photon.basic.app.dao.IDAO

IDAO.EMode

Field Summary

Fields

Modifier and Type	Field and Description
static com.helger.commons.type.ObjectType	OT_SYSTEM_MIGRATION_RESULT

Fields inherited from class com.helger.photon.basic.app.dao.impl.AbstractDAO

DEFAULT_AUTO_SAVE_ENABLED, m_aRWLock

Constructor Summary

Constructors

Constructor and Description
SystemMigrationManager(String sFilename)

Method Summary

Modifier and Type	Method and Description
void	addMigrationResult(SystemMigrationResult aMigrationResult)
void	addMigrationResultError(String sMigrationID, String sErrorMsg) Mark the specified migration as failed.
void	addMigrationResultSuccess(String sMigrationID) Mark the specified migration as success.
protected com.helger.xml.microdom.IMicroDocument	createWriteData() Create the XML document that should be saved to the file.
com.helger.commons.collection.ext.ICommonsList<SystemMigrationResult>	getAllFailedMigrationResults(String sMigrationID)
com.helger.commons.collection.ext.ICommonsSet<String>	getAllMigrationIDs()
com.helger.commons.collection.ext.ICommonsList<SystemMigrationResult>	getAllMigrationResults(String sMigrationID)
com.helger.commons.collection.ext.ICommonsList<SystemMigrationResult>	getAllMigrationResultsFlattened()
protected com.helger.commons.state.EChange	onRead(com.helger.xml.microdom.IMicroDocument aDoc) Fill the internal structures with from the passed XML document.
void	performMigrationIfNecessary(String sMigrationID, Runnable aMigrationAction) Perform a migration if it was not performed yet.
void	performMigrationIfNecessary(String sMigrationID, Supplier<com.helger.commons.state.SuccessWithValue<String>> aMigrationAction) Perform a migration if it was not performed yet.
String	toString()
boolean	wasMigrationExecutedSuccessfully(String sMigrationID)

Methods inherited from class com.helger.photon.basic.app.dao.impl.AbstractSimpleDAO

beforeWriteToFile, getDAOIO, getFilenameProvider, getInitCount, getLastFilename, getLastInitDateTime, getLastReadDateTime, getLastWriteDateTime, getReadCount, getSafeFile, getWriteCount, getXMLWriterSettings, initialRead, markAsChanged, modifyWriteData, onFilenameChange, onInit, triggerExceptionHandlersRead, triggerExceptionHandlersWrite, writeToFileOnPendingChanges

Methods inherited from class com.helger.photon.basic.app.dao.impl.AbstractDAO

beginWithoutAutoSave, endWithoutAutoSave, getExceptionHandlersRead, getExceptionHandlersWrite, hasPendingChanges, internalHasPendingChanges, internalIsAutoSaveEnabled, internalSetPendingChanges, isAutoSaveEnabled, isDebugLogging, performWithoutAutoSave, performWithoutAutoSave, performWithoutAutoSaveThrowing, performWithoutAutoSaveThrowing

Methods inherited from class java.lang.Object

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

Field Detail

OT_SYSTEM_MIGRATION_RESULT

public static final com.helger.commons.type.ObjectType OT_SYSTEM_MIGRATION_RESULT

Constructor Detail

SystemMigrationManager

public SystemMigrationManager(@Nullable
                              String sFilename)
                       throws DAOException

Throws:

DAOException

Method Detail

onRead

protected com.helger.commons.state.EChange onRead(com.helger.xml.microdom.IMicroDocument aDoc)

Description copied from class: AbstractSimpleDAO

Fill the internal structures with from the passed XML document. This method is only called within a write lock!

Specified by:

onRead in class AbstractSimpleDAO

Parameters:

aDoc - The XML document to read from. Never null.

Returns:

EChange.CHANGED if reading the data changed something in the internal structures that requires a writing.

createWriteData

protected com.helger.xml.microdom.IMicroDocument createWriteData()

Description copied from class: AbstractSimpleDAO

Create the XML document that should be saved to the file. This method is only called within a write lock!

Specified by:

createWriteData in class AbstractSimpleDAO

Returns:

The non-null document to write to the file.

addMigrationResult

public void addMigrationResult(@Nonnull
                               SystemMigrationResult aMigrationResult)

addMigrationResultSuccess

public void addMigrationResultSuccess(@Nonnull @Nonempty
                                      String sMigrationID)

Mark the specified migration as success.

Parameters:

sMigrationID - The migration ID to be added. May neither be null nor empty.

addMigrationResultError

public void addMigrationResultError(@Nonnull @Nonempty
                                    String sMigrationID,
                                    @Nonnull
                                    String sErrorMsg)

Mark the specified migration as failed.

Parameters:

sMigrationID - The migration ID to be added. May neither be null nor empty.

sErrorMsg - The error message. May not be null.

getAllMigrationResults

@Nonnull
 @ReturnsMutableCopy
public com.helger.commons.collection.ext.ICommonsList<SystemMigrationResult> getAllMigrationResults(@Nullable
                                                                                                                                    String sMigrationID)

getAllMigrationResultsFlattened

@Nonnull
 @ReturnsMutableCopy
public com.helger.commons.collection.ext.ICommonsList<SystemMigrationResult> getAllMigrationResultsFlattened()

getAllFailedMigrationResults

@Nonnull
 @ReturnsMutableCopy
public com.helger.commons.collection.ext.ICommonsList<SystemMigrationResult> getAllFailedMigrationResults(@Nullable
                                                                                                                                          String sMigrationID)

wasMigrationExecutedSuccessfully

public boolean wasMigrationExecutedSuccessfully(@Nullable
                                                String sMigrationID)

getAllMigrationIDs

@Nonnull
 @ReturnsMutableCopy
public com.helger.commons.collection.ext.ICommonsSet<String> getAllMigrationIDs()

performMigrationIfNecessary

public void performMigrationIfNecessary(@Nonnull @Nonempty
                                        String sMigrationID,
                                        @Nonnull
                                        Runnable aMigrationAction)

Perform a migration if it was not performed yet. The performed callback may not throw an error or return an error. All migrations executed with this method will be handled as a success only.

Parameters:

sMigrationID - The migration ID to handle. May neither be null nor empty.

aMigrationAction - The action to be performed. May not be null.

performMigrationIfNecessary

public void performMigrationIfNecessary(@Nonnull @Nonempty
                                        String sMigrationID,
                                        @Nonnull
                                        Supplier<com.helger.commons.state.SuccessWithValue<String>> aMigrationAction)

Perform a migration if it was not performed yet.

Parameters:

sMigrationID - The migration ID to handle. May neither be null nor empty.

aMigrationAction - The action to be performed. May not be null.

toString

public String toString()

Overrides:

toString in class AbstractSimpleDAO