de.griefed.serverpackcreator

Class ApplicationProperties

java.lang.Object

java.util.Dictionary<K,V>

java.util.Hashtable<java.lang.Object,java.lang.Object>

java.util.Properties

de.griefed.serverpackcreator.ApplicationProperties

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.Object,java.lang.Object>

@Component
public class ApplicationProperties
extends java.util.Properties

Our properties-class. Extends Properties. Sets up default properties loaded from the local serverpackcreator.properties and allows reloading of said properties if the file has changed.

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.Properties

defaults

Constructor Summary

Constructors

Constructor and Description
ApplicationProperties() Constructor for our properties.

Method Summary

Modifier and Type	Method and Description
void	addToListOfDirectoriesToExclude(java.lang.String entry) Adder for the list of directories to exclude from server packs.
boolean	checkForAvailablePreReleases() Getter for whether the search for available PreReleases is enabled or disabled. Depending on de.griefed.serverpackcreator.versioncheck.prerelease, returns true if checks for available PreReleases are enabled, false if no checks for available PreReleases should be made.
java.io.File	DEFAULT_CONFIG() Default configuration-file for a server pack generation.
java.io.File	DEFAULT_SERVER_ICON() Default server-icon.png-file used by Minecraft servers.
java.io.File	DEFAULT_SERVER_PROPERTIES() Default server.properties-file used by Minecraft servers.
java.lang.String	DIRECTORY_PLUGINS() Directory where plugins are stored in.
java.lang.String	DIRECTORY_SERVER_FILES() Directory where server-files are stored in, for example the default server-icon and server.properties.
java.io.File	FABRIC_INSTALLER_VERSION_MANIFEST_LOCATION() Path to the Fabric installer version manifest-file, as a file.
java.io.File	FABRIC_INSTALLER_VERSION_MANIFEST() Fabric installer version manifest-file.
java.io.File	FABRIC_VERSION_MANIFEST_LOCATION() Path to the Fabric version manifest-file, as a file.
java.io.File	FABRIC_VERSION_MANIFEST() Fabric version manifest-file.
java.util.List<java.lang.String>	FALLBACK_CLIENTSIDE_MODS() String-list of fallback clientside-only mods.
java.io.File	FORGE_VERSION_MANIFEST_LOCATION() Path to the Forge version manifest-file, as a file.
java.io.File	FORGE_VERSION_MANIFEST() Forge version manifest-file.
java.lang.String	getDirectoryServerPacks() Getter for the directory in which the server packs are stored/generated in.
java.util.List<java.lang.String>	getListFallbackMods() Getter for the fallback list of clientside-only mods.
java.util.List<java.lang.String>	getListOfDirectoriesToExclude() Getter for the list of directories to exclude from server packs.
int	getQueueMaxDiskUsage() Getter for the maximum disk usage at which JMS/Artemis will stop storing queues on disk.
boolean	getSaveLoadedConfiguration() Getter for whether the last loaded configuration file should be saved to as well.
java.io.File	MINECRAFT_VERSION_MANIFEST_LOCATION() Path to the Minecraft version manifest-file, as a file.
java.io.File	MINECRAFT_VERSION_MANIFEST() Minecraft version manifest-file.
java.io.File	OLD_CONFIG() Old configuration-file used for automated migration in case anyone upgrades from 1.x.
java.io.File	QUILT_INSTALLER_VERSION_MANIFEST_LOCATION() Path to the Quilt installer version manifest-file, as a file.
java.io.File	QUILT_INSTALLER_VERSION_MANIFEST() Quilt installer version manifest-file.
java.io.File	QUILT_VERSION_MANIFEST_LOCATION() Path to the Quilt version manifest-file, as a file.
java.io.File	QUILT_VERSION_MANIFEST() Quilt version manifest-file.
ApplicationProperties	reload() Reload serverpackcreator.properties.
java.io.File	SERVERPACKCREATOR_DATABASE() ServerPackCreator-database when running as a webservice.
java.io.File	SERVERPACKCREATOR_PROPERTIES() Properties file used by ServerPackCreator, containing the configuration for this instance of it.
java.lang.String	SERVERPACKCREATOR_VERSION() Getter for the version of ServerPackCreator. If a JAR-file compiled from a release-job from a CI/CD-pipeline is used, it should contain a VERSION.txt-file which contains the version of said release.
java.io.File	START_SCRIPT_LINUX() Start script for server packs, used by UNIX/Linux.
java.io.File	START_SCRIPT_WINDOWS() Start script for server packs, used by Windows.
java.lang.String[]	SUPPORTED_MODLOADERS() String-array of modloaders supported by ServerPackCreator.
java.lang.String	toString()
boolean	updateFallback() Update the fallback clientside-only modlist of our serverpackcreator.properties from the main-repository or one of its mirrors.
java.io.File	USER_JVM_ARGS() JVM args file used by Forge MC 1.17+

Methods inherited from class java.util.Properties

getProperty, getProperty, list, list, load, load, loadFromXML, propertyNames, save, setProperty, store, store, storeToXML, storeToXML, stringPropertyNames

Methods inherited from class java.util.Hashtable

clear, clone, compute, computeIfAbsent, computeIfPresent, contains, containsKey, containsValue, elements, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keys, keySet, merge, put, putAll, putIfAbsent, rehash, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ApplicationProperties

@Autowired
public ApplicationProperties()

Constructor for our properties. Sets a couple of default values for use in ServerPackCreator.

Method Detail

reload

public ApplicationProperties reload()

Reload serverpackcreator.properties.

Returns:

ApplicationProperties The updated instance of this object.

SERVERPACKCREATOR_PROPERTIES

public java.io.File SERVERPACKCREATOR_PROPERTIES()

Properties file used by ServerPackCreator, containing the configuration for this instance of it.

Returns:

File serverpackcreator.properties-file.

START_SCRIPT_WINDOWS

public java.io.File START_SCRIPT_WINDOWS()

Start script for server packs, used by Windows.

Returns:

File start.bat-file.

START_SCRIPT_LINUX

public java.io.File START_SCRIPT_LINUX()

Start script for server packs, used by UNIX/Linux.

Returns:

File start.sh-file.

USER_JVM_ARGS

public java.io.File USER_JVM_ARGS()

JVM args file used by Forge MC 1.17+

Returns:

File user_jvm_args.txt-file.

FALLBACK_CLIENTSIDE_MODS

public java.util.List<java.lang.String> FALLBACK_CLIENTSIDE_MODS()

String-list of fallback clientside-only mods.

Returns:

String-list of fallback clientside-only mods.

DEFAULT_CONFIG

public java.io.File DEFAULT_CONFIG()

Default configuration-file for a server pack generation.

Returns:

File serverpackcreator.conf-file.

OLD_CONFIG

public java.io.File OLD_CONFIG()

Old configuration-file used for automated migration in case anyone upgrades from 1.x.

Returns:

File creator.conf-file.

DEFAULT_SERVER_PROPERTIES

public java.io.File DEFAULT_SERVER_PROPERTIES()

Default server.properties-file used by Minecraft servers.

Returns:

File server.properties-file.

DEFAULT_SERVER_ICON

public java.io.File DEFAULT_SERVER_ICON()

Default server-icon.png-file used by Minecraft servers.

Returns:

File server-icon.png-file.

MINECRAFT_VERSION_MANIFEST

public java.io.File MINECRAFT_VERSION_MANIFEST()

Minecraft version manifest-file.

Returns:

File minecraft-manifest.json-file.

FORGE_VERSION_MANIFEST

public java.io.File FORGE_VERSION_MANIFEST()

Forge version manifest-file.

Returns:

File forge-manifest.json-file.

FABRIC_VERSION_MANIFEST

public java.io.File FABRIC_VERSION_MANIFEST()

Fabric version manifest-file.

Returns:

File fabric-manifest.xml-file

FABRIC_INSTALLER_VERSION_MANIFEST

public java.io.File FABRIC_INSTALLER_VERSION_MANIFEST()

Fabric installer version manifest-file.

Returns:

File fabric-installer-manifest.xml-file.

QUILT_VERSION_MANIFEST

public java.io.File QUILT_VERSION_MANIFEST()

Quilt version manifest-file.

Returns:

File quilt-manifest.xml-file

QUILT_INSTALLER_VERSION_MANIFEST

public java.io.File QUILT_INSTALLER_VERSION_MANIFEST()

Quilt installer version manifest-file.

Returns:

File quilt-installer-manifest.xml-file.

SERVERPACKCREATOR_DATABASE

public java.io.File SERVERPACKCREATOR_DATABASE()

ServerPackCreator-database when running as a webservice.

Returns:

File serverpackcreator.db-file.

MINECRAFT_VERSION_MANIFEST_LOCATION

public java.io.File MINECRAFT_VERSION_MANIFEST_LOCATION()

Path to the Minecraft version manifest-file, as a file.

Returns:

File ./work/minecraft-manifest.json

FORGE_VERSION_MANIFEST_LOCATION

public java.io.File FORGE_VERSION_MANIFEST_LOCATION()

Path to the Forge version manifest-file, as a file.

Returns:

File ./work/forge-manifest.json

FABRIC_VERSION_MANIFEST_LOCATION

public java.io.File FABRIC_VERSION_MANIFEST_LOCATION()

Path to the Fabric version manifest-file, as a file.

Returns:

File ./work/fabric-manifest.xml

FABRIC_INSTALLER_VERSION_MANIFEST_LOCATION

public java.io.File FABRIC_INSTALLER_VERSION_MANIFEST_LOCATION()

Path to the Fabric installer version manifest-file, as a file.

Returns:

File ./work/fabric-installer-manifest.xml

QUILT_VERSION_MANIFEST_LOCATION

public java.io.File QUILT_VERSION_MANIFEST_LOCATION()

Path to the Quilt version manifest-file, as a file.

Returns:

File ./work/quilt-manifest.xml

QUILT_INSTALLER_VERSION_MANIFEST_LOCATION

public java.io.File QUILT_INSTALLER_VERSION_MANIFEST_LOCATION()

Path to the Quilt installer version manifest-file, as a file.

Returns:

File ./work/quilt-installer-manifest.xml

SERVERPACKCREATOR_VERSION

public java.lang.String SERVERPACKCREATOR_VERSION()

Getter for the version of ServerPackCreator.
If a JAR-file compiled from a release-job from a CI/CD-pipeline is used, it should contain a VERSION.txt-file which contains the version of said release. If a non-release-version is used, from a regular pipeline or local dev-build, then this will be set to dev.

Returns:

String. Returns the version of ServerPackCreator.

SUPPORTED_MODLOADERS

public java.lang.String[] SUPPORTED_MODLOADERS()

String-array of modloaders supported by ServerPackCreator.

Returns:

String-array of modloaders supported by ServerPackCreator.

DIRECTORY_SERVER_FILES

public java.lang.String DIRECTORY_SERVER_FILES()

Directory where server-files are stored in, for example the default server-icon and server.properties.

Returns:

String server-files directory.

DIRECTORY_PLUGINS

public java.lang.String DIRECTORY_PLUGINS()

Directory where plugins are stored in.

Returns:

String plugins directory.

getDirectoryServerPacks

public java.lang.String getDirectoryServerPacks()

Getter for the directory in which the server packs are stored/generated in.

Returns:

String. Returns the directory in which the server packs are stored/generated in.

getListFallbackMods

public java.util.List<java.lang.String> getListFallbackMods()

Getter for the fallback list of clientside-only mods.

Returns:

List String. Returns the fallback list of clientside-only mods.

getListOfDirectoriesToExclude

public java.util.List<java.lang.String> getListOfDirectoriesToExclude()

Getter for the list of directories to exclude from server packs.

Returns:

List String. Returns the list of directories to exclude from server packs.

addToListOfDirectoriesToExclude

public void addToListOfDirectoriesToExclude(java.lang.String entry)

Adder for the list of directories to exclude from server packs.

Parameters:

entry - String. The directory to add to the list of directories to exclude from server packs.

getSaveLoadedConfiguration

public boolean getSaveLoadedConfiguration()

Getter for whether the last loaded configuration file should be saved to as well.

Returns:

Boolean. Whether the last loaded configuration file should be saved to as well.

getQueueMaxDiskUsage

public int getQueueMaxDiskUsage()

Getter for the maximum disk usage at which JMS/Artemis will stop storing queues on disk.

Returns:

Integer. The maximum disk usage at which JMS/Artemis will stop storing queues on disk.

checkForAvailablePreReleases

public boolean checkForAvailablePreReleases()

Getter for whether the search for available PreReleases is enabled or disabled.
Depending on de.griefed.serverpackcreator.versioncheck.prerelease, returns true if checks for available PreReleases are enabled, false if no checks for available PreReleases should be made.

Returns:

Boolean. Whether checks for available PreReleases are enabled.

updateFallback

public boolean updateFallback()

Update the fallback clientside-only modlist of our serverpackcreator.properties from the main-repository or one of its mirrors.

Returns:

true if the fallback-property was updated.

toString

public java.lang.String toString()

Overrides:

toString in class java.util.Hashtable<java.lang.Object,java.lang.Object>