de.griefed.serverpackcreator

Class MigrationManager

java.lang.Object

de.griefed.serverpackcreator.MigrationManager

public final class MigrationManager
extends java.lang.Object

The migration manager of ServerPackCreator is responsible for determining update-steps between a given old version and a given new version. The determined steps between updates are then executed in order to ensure a users environment is up-to-date, even when skipping multiple versions when updating.

This does not guarantee a safe update when updating between major versions, as major versions tend to contain breaking changes, and depending on those changes there will still be a need for the user to ensure they can safely update. One example would be major version 3 to major version 4, where the Java version required by ServerPackCreator will rise from Java 8 to Java 17 or later.
Aas this is not something ServerPackCreator can take care of, it is a good example for a migration which this manager can not take care of.

Other migrations, such as updating the log4j2.xml and the logs-directory inside said file can and will be taken care of.

Some migrations will require the user to restart ServerPackCreator for the executed migrations to take full effect. A given migration method which executes such migrations should register a migration message informing the user about the need to restart SPC.

Migration messages are displayed in a dialog when using the GUI as well as printed to the serverpackcreator.log.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	MigrationManager.MigrationMessage A migration message include any and all information for a particular migration which has taken place during the startup of ServerPackCreator.

Method Summary

Modifier and Type	Method and Description
@NotNull java.util.List<MigrationManager.MigrationMessage>	getMigrationMessages() A list of migration messages, if any, to display in logs, GUI or any other place you can think of.

Methods inherited from class java.lang.Object

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

Method Detail

getMigrationMessages

@NotNull
public @NotNull java.util.List<MigrationManager.MigrationMessage> getMigrationMessages()

A list of migration messages, if any, to display in logs, GUI or any other place you can think of. A migration message includes the versions from which and to which version the migration took place, as well as a list of changes made during it, if any.

Returns:

A list of migrations that took place.