de.griefed.serverpackcreator

Class ServerPackCreator

java.lang.Object

de.griefed.serverpackcreator.ServerPackCreator

@SpringBootApplication
 @EnableScheduling
public class ServerPackCreator
extends java.lang.Object

Main-class of ServerPackCreator. Run either via main(String[]), or getInstance(String[]), or getInstance() to work with ServerPackCreator. For available arguments to initialize and run SPC with, check ServerPackCreator.Mode and ServerPackCreator.CommandlineParser for how the initialization is prioritized. An instance of SPC will have the base amount of class-instances available to it. If a given instance of a class is null, then calling the appropriate getter will ensure a new instance is initialized first, hence the huge amount of synchronized-methods.

When running as a web-service, Spring Boot will read and parse the serverpackcreator.properties-file to set Spring Boot properties. So if you want to change Spring Boot specific properties, that's the file to do that in.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ServerPackCreator.CommandlineParser The Commandline Parser checks the passed commandline arguments to determine the mode to run in.
static class	ServerPackCreator.Mode Available mods of ServerPackCreator and their respective CLI-arguments required to be activated/used.

Constructor Summary

Constructors

Constructor and Description
ServerPackCreator(@NotNull java.lang.String[] args) Initialize ServerPackCreator and determine the ServerPackCreator.Mode to run in from the passed entries in the String-array.

Method Summary

Modifier and Type	Method and Description
void	checkDatabase() Ensures serverpackcreator.db exists.
boolean	checkForConfig() Check whether a serverpackcreator.conf-file exists.
boolean	checkServerFilesFile(@NotNull java.io.File fileToCheckFor) Check whether the specified server-files file exists and create it if it doesn't.
@NotNull AnnotationScanner	getAnnotationScanner() This instances annotation scanner used to determine the sideness of Forge mods for Minecraft 1.12.2 and older.
@NotNull ApplicationAddons	getApplicationAddons() This instances addon manager for ServerPackCreator-addons, if any are installed.
@NotNull ApplicationProperties	getApplicationProperties() This instances settings used across ServerPackCreator, such as the working-directories, files and other settings.
@NotNull java.lang.String[]	getArgs() This instances arguments with which ServerPackCreator was started.
@NotNull BooleanUtilities	getBooleanUtilities() This instances common boolean utilities used across ServerPackCreator.
@NotNull ConfigurationEditor	getConfigurationEditor() This instances configuration editor used when running in ServerPackCreator.Mode.CLI.
@NotNull ConfigurationHandler	getConfigurationHandler() This instances ConfigurationHandler for checking a given ConfigurationModel for validity, so a server pack can safely be created from it.
@Nullable javax.xml.parsers.DocumentBuilder	getDocumentBuilder() This instances DocumentBuilder for working with XML-data.
@NotNull FabricScanner	getFabricScanner() This instances scanner to determine the sideness of Fabric mods.
@NotNull FileUtilities	getFileUtilities() This instances common file utilities used across ServerPackCreator.
@NotNull I18n	getI18n() This instances internationalization used in the GUI and error messages displayed in the very same.
static @NotNull ServerPackCreator	getInstance() Acquire an instance of ServerPackCreator using the --setup-argument so a prepared environment is present after acquiring the instance.
static @NotNull ServerPackCreator	getInstance(java.lang.String[] args) Acquire an instance of ServerPackCreator using the specified argument.
@NotNull JarUtilities	getJarUtilities() This instances common JAR-utilities used across ServerPackCreator.
@NotNull JsonUtilities	getJsonUtilities() This instances common JSON utilities used across ServerPackCreator.
@NotNull ListUtilities	getListUtilities() This instances common list utilities used across ServerPackCreator.
@NotNull MigrationManager	getMigrationManager() This instances MigrationManager responsible for checking and executing any required migration-steps between version upgrades.
@NotNull ModScanner	getModScanner() This instances modscanner to determine the sideness of a given Forge, Fabric, LegacyFabric or Quilt mod.
@NotNull com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper() This instances JSON-ObjectMapper used across ServerPackCreator with which this instance was initialized.
@NotNull QuiltScanner	getQuiltScanner() This instances scanner to determine the sideness of Quilt mods.
@NotNull ServerPackCreatorWindow	getServerPackCreatorGui() This instances frame holding the GUI allowing the user to run and configure their server packs.
@NotNull ServerPackCreatorSplash	getServerPackCreatorSplash() Splash screen displayed during the boot up of ServerPackCreator if a graphical environment is supported and SPC is started in GUI-mode.
@NotNull ServerPackHandler	getServerPackHandler() This instances ServerPackHandler used to turn a ConfigurationModel into a server pack.
@NotNull org.springframework.context.ConfigurableApplicationContext	getSpringBootApplicationContext(@NotNull java.lang.String[] args) This instances application context when running as a webservice.
@NotNull StringUtilities	getStringUtilities() This instances common String utilities used across ServerPackCreator.
@NotNull SystemUtilities	getSystemUtilities() This instances common system utilities used across ServerPackCreator.
@NotNull com.electronwill.nightconfig.toml.TomlParser	getTomlParser() This instances toml parser to read and parse various .toml-files during modscanning, addon- and extension config loading and provisioning, serverpackcreator.conf reading and more.
@NotNull TomlScanner	getTomlScanner() This instances toml scanner to determine the sideness of Forge mods for Minecraft 1.13.x and newer.
@NotNull UpdateChecker	getUpdateChecker() This instances update checker to inform the user about any potentially available update, including links to said update, if any.
@NotNull Utilities	getUtilities() This instances collection of common utilities used across ServerPackCreator.
@NotNull VersionMeta	getVersionMeta() This instances version meta used for checking version-correctness of Minecraft and supported modloaders, as well as gathering information about Minecraft servers and modloader installers.
@NotNull WebUtilities	getWebUtilities() This instances common web utilities used across ServerPackCreator.
@NotNull XmlUtilities	getXmlUtilities() This instances common XML utilities used across ServerPackCreator.
static void	main(java.lang.String[] args) Initialize ServerPackCreator with the passed commandline-arguments and run.
void	overwriteServerFilesFile(@NotNull java.io.File fileToOverwrite) Overwrite the specified server-files file, even when it exists.
void	run() Run ServerPackCreator with the mode acquired from ServerPackCreator.CommandlineParser.
void	run(@NotNull ServerPackCreator.Mode modeToRunIn) Run ServerPackCreator in a specific ServerPackCreator.Mode.
void	updateCheck(boolean logToConsole) Check for update-availability.
void	web(java.lang.String[] args) Run the ServerPackCreator webservice and provide Spring Boot with arguments.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerPackCreator

public ServerPackCreator(@NotNull
                         @NotNull java.lang.String[] args)

Initialize ServerPackCreator and determine the ServerPackCreator.Mode to run in from the passed entries in the String-array. A new instance of SPC will initialize an instance of ApplicationProperties, required for just about everything, as well as I18n for localization purposes. FileUtilities, SystemUtilities, ListUtilities and JarUtilities are also setup, so feel free to use them right away.

Parameters:

args - Commandline arguments with which ServerPackCreator is run. Determines which mode ServerPackCreator will enter and which locale is used. In order to see which argument results in which mode, see ServerPackCreator.Mode.

Method Detail

getFileUtilities

@NotNull
public @NotNull FileUtilities getFileUtilities()

This instances common file utilities used across ServerPackCreator.

Returns:

Common file utilities used across ServerPackCreator.

getSystemUtilities

@NotNull
public @NotNull SystemUtilities getSystemUtilities()

This instances common system utilities used across ServerPackCreator.

Returns:

Common system utilities used across ServerPackCreator.

getListUtilities

@NotNull
public @NotNull ListUtilities getListUtilities()

This instances common list utilities used across ServerPackCreator.

Returns:

Common list utilities used across ServerPackCreator.

getJarUtilities

@NotNull
public @NotNull JarUtilities getJarUtilities()

This instances common JAR-utilities used across ServerPackCreator.

Returns:

Common JAR-utilities used across ServerPackCreator.

getInstance

@NotNull
public static @NotNull ServerPackCreator getInstance()

Acquire an instance of ServerPackCreator using the --setup-argument so a prepared environment is present after acquiring the instance. If a new instance of ServerPackCreator is created as the result of calling this method, then the setup is run to ensure a properly prepared environment, otherwise the already existing instance of ServerPackCreator is returned, allowing you to do your operations.

Returns:

ServerPackCreator-instance using the --setup-argument, or the already existing instance, if one was initialized already.

getInstance

@NotNull
public static @NotNull ServerPackCreator getInstance(java.lang.String[] args)

Acquire an instance of ServerPackCreator using the specified argument. If a new instance of ServerPackCreator is created as the result of calling this method, then the setup is run to ensure a properly prepared environment. Afterwards, the instance of ServerPackCreator is returned.

Parameters:

args - Arguments with which to instantiate ServerPackCreator. Possible arguments can be found at ServerPackCreator.Mode.

Returns:

ServerPackCreator-instance with the specified argument.

main

public static void main(java.lang.String[] args)
                 throws java.io.IOException,
                        javax.xml.parsers.ParserConfigurationException,
                        org.xml.sax.SAXException

Initialize ServerPackCreator with the passed commandline-arguments and run.

For a list of available commandline arguments, check out ServerPackCreator.Mode

Parameters:

args - Commandline arguments with which ServerPackCreator is run. Determines which mode ServerPackCreator will enter and which locale is used.

Throws:

javax.xml.parsers.ParserConfigurationException - indicates a serious configuration error.

java.io.IOException - if any IO errors occur.

org.xml.sax.SAXException - if any parse errors occur.

web

public void web(java.lang.String[] args)

Run the ServerPackCreator webservice and provide Spring Boot with arguments.

Parameters:

args - Arguments passed from invocation in main(String[]).

getArgs

@NotNull
public @NotNull java.lang.String[] getArgs()

This instances arguments with which ServerPackCreator was started.

Returns:

All arguments with which ServerPackCreator was started.

getI18n

@NotNull
public @NotNull I18n getI18n()

This instances internationalization used in the GUI and error messages displayed in the very same.

Returns:

Instance of ServerPackCreators Internationalization used in this instance.

getObjectMapper

@NotNull
public @NotNull com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()

This instances JSON-ObjectMapper used across ServerPackCreator with which this instance was initialized. By default, the ObjectMapper used across ServerPackCreator has the following features set:

• disabled: DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES
• enabled: DeserializationFeature.ACCEPT_SINGLE_VALUE_AS_ARRAY
• enabled: JsonReadFeature.ALLOW_UNESCAPED_CONTROL_CHARS

Returns:

Json-ObjectMapper to parse and read JSON.

getApplicationProperties

@NotNull
public @NotNull ApplicationProperties getApplicationProperties()

This instances settings used across ServerPackCreator, such as the working-directories, files and other settings.

Returns:

ApplicationProperties used across this ServerPackCreator-instance.

getBooleanUtilities

@NotNull
public @NotNull BooleanUtilities getBooleanUtilities()

This instances common boolean utilities used across ServerPackCreator.

Returns:

Common boolean utilities used across ServerPackCreator.

getJsonUtilities

@NotNull
public @NotNull JsonUtilities getJsonUtilities()

This instances common JSON utilities used across ServerPackCreator.

Returns:

Common JSON utilities used across ServerPackCreator.

getXmlUtilities

@NotNull
public @NotNull XmlUtilities getXmlUtilities()

This instances common XML utilities used across ServerPackCreator.

Returns:

Common XML utilities used across ServerPackCreator.

getDocumentBuilder

@Nullable
public @Nullable javax.xml.parsers.DocumentBuilder getDocumentBuilder()

This instances DocumentBuilder for working with XML-data.

Returns:

DocumentBuilder for working with XML.

getStringUtilities

@NotNull
public @NotNull StringUtilities getStringUtilities()

This instances common String utilities used across ServerPackCreator.

Returns:

Common String utilities used across ServerPackCreator.

getWebUtilities

@NotNull
public @NotNull WebUtilities getWebUtilities()

This instances common web utilities used across ServerPackCreator.

Returns:

Common web utilities used across ServerPackCreator.

getUtilities

@NotNull
public @NotNull Utilities getUtilities()

This instances collection of common utilities used across ServerPackCreator.

Returns:

Collection of common utilities used across ServerPackCreator.

getMigrationManager

@NotNull
public @NotNull MigrationManager getMigrationManager()

This instances MigrationManager responsible for checking and executing any required migration-steps between version upgrades.

Returns:

MigrationManager responsible for checking and executing any required migration-steps.

getVersionMeta

@NotNull
public @NotNull VersionMeta getVersionMeta()
                                             throws java.io.IOException,
                                                    javax.xml.parsers.ParserConfigurationException,
                                                    org.xml.sax.SAXException

This instances version meta used for checking version-correctness of Minecraft and supported modloaders, as well as gathering information about Minecraft servers and modloader installers.

Returns:

Meta used for checking version-correctness of Minecraft and supported modloaders.

Throws:

java.io.IOException - When manifests couldn't be parsed.

javax.xml.parsers.ParserConfigurationException - When xml-manifests couldn't be read.

org.xml.sax.SAXException - When xml-manifests couldn't be read.

getConfigurationHandler

@NotNull
public @NotNull ConfigurationHandler getConfigurationHandler()
                                                               throws java.io.IOException,
                                                                      javax.xml.parsers.ParserConfigurationException,
                                                                      org.xml.sax.SAXException

This instances ConfigurationHandler for checking a given ConfigurationModel for validity, so a server pack can safely be created from it.

Returns:

Handler for config checking.

Throws:

java.io.IOException - When the VersionMeta had to be instantiated, but an error occured during the parsing of a manifest.

javax.xml.parsers.ParserConfigurationException - When the VersionMeta had to be instantiated, but an error occured during the parsing of a manifest.

org.xml.sax.SAXException - When the VersionMeta had to be instantiated, but an error occured during the parsing of a manifest.

getApplicationAddons

@NotNull
public @NotNull ApplicationAddons getApplicationAddons()
                                                         throws java.io.IOException,
                                                                javax.xml.parsers.ParserConfigurationException,
                                                                org.xml.sax.SAXException

This instances addon manager for ServerPackCreator-addons, if any are installed. This gives you access to the available extensions, should any be available in your instance of ServerPackCreator.

Returns:

Addon manager for ServerPackCreator-addons, if any are installed.

Throws:

java.io.IOException - When the VersionMeta had to be instantiated, but an error occurred during the parsing of a manifest.

javax.xml.parsers.ParserConfigurationException - When the VersionMeta had to be instantiated, but an error occurred during the parsing of a manifest.

org.xml.sax.SAXException - When the VersionMeta had to be instantiated, but an error occurred during the parsing of a manifest.

getServerPackHandler

@NotNull
public @NotNull ServerPackHandler getServerPackHandler()
                                                         throws java.io.IOException,
                                                                javax.xml.parsers.ParserConfigurationException,
                                                                org.xml.sax.SAXException

This instances ServerPackHandler used to turn a ConfigurationModel into a server pack.

Returns:

The ServerPackHandler with which config models can be used to create server packs.

Throws:

java.io.IOException - When the VersionMeta had to be instantiated, but an error occurred during the parsing of a manifest.

javax.xml.parsers.ParserConfigurationException - When the VersionMeta had to be instantiated, but an error occurred during the parsing of a manifest.

org.xml.sax.SAXException - When the VersionMeta had to be instantiated, but an error occurred during the parsing of a manifest.

getServerPackCreatorSplash

@NotNull
public @NotNull ServerPackCreatorSplash getServerPackCreatorSplash()

Splash screen displayed during the boot up of ServerPackCreator if a graphical environment is supported and SPC is started in GUI-mode.

Returns:

Boot splash screen displayed during startup.

getUpdateChecker

@NotNull
public @NotNull UpdateChecker getUpdateChecker()

This instances update checker to inform the user about any potentially available update, including links to said update, if any.

Returns:

This instances update checker to perform update checks and information acquirement.

getModScanner

@NotNull
public @NotNull ModScanner getModScanner()

This instances modscanner to determine the sideness of a given Forge, Fabric, LegacyFabric or Quilt mod.

Returns:

Modscanner to determine the sideness of a given Forge, Fabric, LegacyFabric or Quilt mod.

getAnnotationScanner

@NotNull
public @NotNull AnnotationScanner getAnnotationScanner()

This instances annotation scanner used to determine the sideness of Forge mods for Minecraft 1.12.2 and older.

Returns:

Annotation scanner used to determine the sideness of Forge mods for Minecraft 1.12.2 and older.

getFabricScanner

@NotNull
public @NotNull FabricScanner getFabricScanner()

This instances scanner to determine the sideness of Fabric mods.

Returns:

Scanner to determine the sideness of Fabric mods.

getQuiltScanner

@NotNull
public @NotNull QuiltScanner getQuiltScanner()

This instances scanner to determine the sideness of Quilt mods.

Returns:

Scanner to determine the sideness of Quilt mods.

getTomlParser

@NotNull
public @NotNull com.electronwill.nightconfig.toml.TomlParser getTomlParser()

This instances toml parser to read and parse various .toml-files during modscanning, addon- and extension config loading and provisioning, serverpackcreator.conf reading and more.

Returns:

Toml parser to read and parse .toml-files.

getTomlScanner

@NotNull
public @NotNull TomlScanner getTomlScanner()

This instances toml scanner to determine the sideness of Forge mods for Minecraft 1.13.x and newer.

Returns:

Scanner to determine the sideness of Forge mods for Minecraft 1.13.x and newer.

getConfigurationEditor

@NotNull
public @NotNull ConfigurationEditor getConfigurationEditor()
                                                             throws java.io.IOException,
                                                                    javax.xml.parsers.ParserConfigurationException,
                                                                    org.xml.sax.SAXException

This instances configuration editor used when running in ServerPackCreator.Mode.CLI. Bear in mind that the CLI config editor only provides limited functionality.

Returns:

Config editor to load, edit and save serverpackcreator.conf-files from the CLI.

Throws:

java.io.IOException - When the VersionMeta had to be instantiated, but an error occurred during the parsing of a manifest.

javax.xml.parsers.ParserConfigurationException - When the VersionMeta had to be instantiated, but an error occurred during the parsing of a manifest.

org.xml.sax.SAXException - When the VersionMeta had to be instantiated, but an error occurred during the parsing of a manifest.

getServerPackCreatorGui

@NotNull
public @NotNull ServerPackCreatorWindow getServerPackCreatorGui()
                                                                  throws java.io.IOException,
                                                                         javax.xml.parsers.ParserConfigurationException,
                                                                         org.xml.sax.SAXException

This instances frame holding the GUI allowing the user to run and configure their server packs.

Returns:

Frame holding the GUI allowing the user to run and configure their server packs.

Throws:

java.io.IOException - When the VersionMeta had to be instantiated, but an error occurred during the parsing of a manifest.

javax.xml.parsers.ParserConfigurationException - When the VersionMeta had to be instantiated, but an error occurred during the parsing of a manifest.

org.xml.sax.SAXException - When the VersionMeta had to be instantiated, but an error occurred during the parsing of a manifest.

getSpringBootApplicationContext

@NotNull
public @NotNull org.springframework.context.ConfigurableApplicationContext getSpringBootApplicationContext(@NotNull
                                                                                                                    @NotNull java.lang.String[] args)

This instances application context when running as a webservice. When no instance of the Spring Boot application context is available yet, it will be created and the Spring Boot application will be started with the given arguments.

Parameters:

args - CLI arguments to pass to Spring Boot when it has not yet been started.

Returns:

Application context of Spring Boot.

run

public void run()
         throws java.io.IOException,
                javax.xml.parsers.ParserConfigurationException,
                org.xml.sax.SAXException

Run ServerPackCreator with the mode acquired from ServerPackCreator.CommandlineParser.

Throws:

java.io.IOException - When the VersionMeta had to be instantiated, but an error occurred during the parsing of a manifest.

javax.xml.parsers.ParserConfigurationException - When the VersionMeta had to be instantiated, but an error occurred during the parsing of a manifest.

org.xml.sax.SAXException - When the VersionMeta had to be instantiated, but an error occurred during the parsing of a manifest.

run

public void run(@NotNull
                @NotNull ServerPackCreator.Mode modeToRunIn)
         throws java.io.IOException,
                javax.xml.parsers.ParserConfigurationException,
                org.xml.sax.SAXException

Run ServerPackCreator in a specific ServerPackCreator.Mode.

Parameters:

modeToRunIn - Mode to run in.

Throws:

java.io.IOException - When the VersionMeta had to be instantiated, but an error occurred during the parsing of a manifest.

javax.xml.parsers.ParserConfigurationException - When the VersionMeta had to be instantiated, but an error occurred during the parsing of a manifest.

org.xml.sax.SAXException - When the VersionMeta had to be instantiated, but an error occurred during the parsing of a manifest.

checkForConfig

public boolean checkForConfig()

Check whether a serverpackcreator.conf-file exists. If it doesn't exist, and we are not running in ServerPackCreator.Mode.CLI or ServerPackCreator.Mode.CGEN, create an unconfigured default one which can then be loaded into the GUI.

Returns:

true if a serverpackcreator.conf-file was created.

checkServerFilesFile

public boolean checkServerFilesFile(@NotNull
                                    @NotNull java.io.File fileToCheckFor)

Check whether the specified server-files file exists and create it if it doesn't.

Parameters:

fileToCheckFor - The file which is to be checked for whether it exists and if it doesn't, should be created.

Returns:

true if the file was generated.

overwriteServerFilesFile

public void overwriteServerFilesFile(@NotNull
                                     @NotNull java.io.File fileToOverwrite)

Overwrite the specified server-files file, even when it exists. Used to ensure files like the default script templates are always up to date.

Parameters:

fileToOverwrite - The file which is to be overwritten. If it exists. it is first deleted, then extracted from our JAR-file.

checkDatabase

public void checkDatabase()

Ensures serverpackcreator.db exists. If the database does not exist, it is created.

updateCheck

public void updateCheck(boolean logToConsole)

Check for update-availability. If an update is present, information about said update is printed to the console.

Parameters:

logToConsole - Whether to log update information to console or to logs.