All Implemented Interfaces:
```
@Plugin(name = "ServerPackCreatorConfigFactory", category = "Core") 
public final class ApiProperties
extends ConfigurationFactory
                    
```
Base settings of ServerPackCreator, such as working directories, default list of clientside-only mods, default list of directories to include in a server pack, script templates, java paths and much more.

Author:

Griefed

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`ApiProperties.CustomXMLConfiguration`	Custom XmlConfiguration to pass our custom log4j2.xml config to log4j. Set up the XML configuration with the passed context and config source. For the config source being used, ApiProperties.getConfiguration where multiple attempts at creating a new private val log by lazy { cachedLoggerOf(this.javaClass) } using our own log4j2.xml are made before the default log4j setup is used.

Field Summary

Fields
Modifier and Type	Field	Description
`public final static String`	`DEFAULT_PREFERENCES_NODE`
`public final static String`	`PREFERENCES_NODE_PROPERTY`
`public final static String`	`PREFERENCES_NODE_ENV`
`private final File`	`home`
`private final GenerationConfig`	`generationConfig`
`private final NetworkConfig`	`networkConfig`
`private final TreeSet<String>`	`fallbackDirectoriesInclusion`
`private final TreeSet<String>`	`fallbackDirectoriesExclusion`
`private final TreeSet<String>`	`fallbackZipExclusions`
`private final TreeSet<String>`	`fallbackPostInstallCleanupFiles`
`private final TreeSet<String>`	`fallbackPreInstallCleanupFiles`
`private final String`	`fallbackAikarsFlags`
`private final String`	`fallbackUpdateURL`
`private final ExclusionFilter`	`fallbackExclusionFilter`
`private final Boolean`	`fallbackOverwriteEnabled`
`private final Boolean`	`fallbackJavaScriptAutoupdateEnabled`
`private final Boolean`	`fallbackCheckingForPreReleasesEnabled`
`private final Boolean`	`fallbackZipFileExclusionEnabled`
`private final Boolean`	`fallbackServerPackCleanupEnabled`
`private final Boolean`	`fallbackMinecraftPreReleasesAvailabilityEnabled`
`private final Boolean`	`fallbackAutoExcludingModsEnabled`
`private final String`	`fallbackCleanupSchedule`
`private final String`	`fallbackVersionSchedule`
`private final String`	`fallbackDatabaseCleanupSchedule`
`private final Boolean`	`fallbackUpdateServerPack`
`private final I18n4kConfigDefault`	`i18n4kConfig`
`private final UpdateConfig`	`updateConfig`
`private final I18nConfig`	`i18nConfig`
`private final LoggingConfig`	`loggingConfig`
`private final TreeSet<String>`	`clientsideMods`
`private final TreeSet<String>`	`modsWhitelist`
`private final TreeSet<String>`	`clientsideModsRegex`
`private final TreeSet<String>`	`modsWhitelistRegex`
`private Integer`	`networkConnectTimeout`
`private Integer`	`networkReadTimeout`
`private Integer`	`networkDownloadReadTimeout`
`private final Array<String>`	`supportedModloaders`
`private final String`	`apiVersion`
`private final Boolean`	`devBuild`
`private final Boolean`	`preRelease`
`private final String`	`configVersion`
`private final Boolean`	`firstRun`
`private String`	`logLevel`
`private TreeSet<String>`	`directoriesToInclude`
`private TreeSet<String>`	`directoriesToExclude`
`private TreeSet<String>`	`postInstallCleanupFiles`
`private TreeSet<String>`	`preInstallCleanupFiles`
`private TreeSet<String>`	`zipArchiveExclusions`
`private final JavaConfig`	`javaConfig`
`private HashMap<String, String>`	`javaPaths`
`private TreeSet<File>`	`scriptTemplates`
`private HashMap<String, String>`	`startScriptTemplates`
`private HashMap<String, String>`	`javaScriptTemplates`
`private URL`	`updateUrl`
`private ExclusionFilter`	`exclusionFilter`
`private Boolean`	`isCheckingForPreReleasesEnabled`
`private Boolean`	`isZipFileExclusionEnabled`
`private Boolean`	`isAutoExcludingModsEnabled`
`private Boolean`	`isServerPacksOverwriteEnabled`
`private Boolean`	`isServerPackCleanupEnabled`
`private Boolean`	`isMinecraftPreReleasesAvailabilityEnabled`
`private Boolean`	`isUpdatingServerPacksEnabled`
`private Boolean`	`isJavaScriptAutoupdateEnabled`
`private String`	`aikarsFlags`
`private final WebserviceConfig`	`webserviceConfig`
`private String`	`databaseUri`
`private Locale`	`language`
`private String`	`hasteBinServerUrl`
`private String`	`javaPath`
`private String`	`webserviceCleanupSchedule`
`private String`	`webserviceVersionSchedule`
`private String`	`webserviceDatabaseCleanupSchedule`
`private final PathsConfig`	`pathsConfig`
`private final ScriptTemplatesConfig`	`scriptTemplatesConfig`
`private File`	`homeDirectory`
`private final File`	`serverPackCreatorPropertiesFile`
`private final File`	`overridesPropertiesFile`
`private final File`	`defaultConfig`
`private final File`	`configsDirectory`
`private File`	`tomcatBaseDirectory`
`private File`	`serverPacksDirectory`
`private final File`	`logsDirectory`
`private File`	`tomcatLogsDirectory`
`private final File`	`manifestsDirectory`
`private final File`	`fabricIntermediariesManifest`
`private final File`	`legacyFabricGameManifest`
`private final File`	`legacyFabricLoaderManifest`
`private final File`	`legacyFabricInstallerManifest`
`private final File`	`fabricInstallerManifest`
`private final File`	`quiltVersionManifest`
`private final File`	`quiltInstallerManifest`
`private final File`	`forgeVersionManifest`
`private final File`	`oldNeoForgeVersionManifest`
`private final File`	`newNeoForgeVersionManifest`
`private final File`	`fabricVersionManifest`
`private final File`	`minecraftServerManifestsDirectory`
`private final File`	`minecraftVersionManifest`
`private final File`	`workDirectory`
`private final File`	`installerCacheDirectory`
`private final File`	`tempDirectory`
`private final File`	`modpacksDirectory`
`private final File`	`serverFilesDirectory`
`private final File`	`defaultShellScriptTemplate`
`private final File`	`defaultFishScriptTemplate`
`private final File`	`defaultPowerShellScriptTemplate`
`private final File`	`defaultBatchScriptTemplate`
`private final File`	`defaultJavaShellScriptTemplate`
`private final File`	`defaultJavaFishScriptTemplate`
`private final File`	`defaultJavaPowerShellScriptTemplate`
`private final File`	`defaultJavaBatchScriptTemplate`
`private final File`	`propertiesDirectory`
`private final File`	`iconsDirectory`
`private final File`	`defaultServerProperties`
`private final File`	`defaultServerIcon`
`private final File`	`defaultVariablesTemplate`
`private final File`	`pluginsDirectory`
`private final File`	`pluginsConfigsDirectory`
`private final Boolean`	`fallbackUpdated`
`private final File`	`installLocationXml`
`private final File`	`log4jXml`
`private final Boolean`	`isActive`
`private final String`	`version`
`private final String`	`defaultPrefix`
`private final Array<String>`	`supportedTypes`
`private final String`	`testPrefix`
`protected final StrSubstitutor`	`substitutor`

Constructor Summary

Constructors
Constructor	Description
`ApiProperties(File propertiesFile)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final File`	`getHome()`
`final GenerationConfig`	`getGenerationConfig()`
`final NetworkConfig`	`getNetworkConfig()`
`final TreeSet<String>`	`getFallbackDirectoriesInclusion()`
`final TreeSet<String>`	`getFallbackDirectoriesExclusion()`
`final TreeSet<String>`	`getFallbackZipExclusions()`
`final TreeSet<String>`	`getFallbackPostInstallCleanupFiles()`
`final TreeSet<String>`	`getFallbackPreInstallCleanupFiles()`
`final String`	`getFallbackAikarsFlags()`
`final String`	`getFallbackUpdateURL()`
`final ExclusionFilter`	`getFallbackExclusionFilter()`
`final Boolean`	`getFallbackOverwriteEnabled()`
`final Boolean`	`getFallbackJavaScriptAutoupdateEnabled()`
`final Boolean`	`getFallbackCheckingForPreReleasesEnabled()`
`final Boolean`	`getFallbackZipFileExclusionEnabled()`
`final Boolean`	`getFallbackServerPackCleanupEnabled()`
`final Boolean`	`getFallbackMinecraftPreReleasesAvailabilityEnabled()`
`final Boolean`	`getFallbackAutoExcludingModsEnabled()`
`final String`	`getFallbackCleanupSchedule()`
`final String`	`getFallbackVersionSchedule()`
`final String`	`getFallbackDatabaseCleanupSchedule()`
`final Boolean`	`getFallbackUpdateServerPack()`
`final I18n4kConfigDefault`	`getI18n4kConfig()`
`final UpdateConfig`	`getUpdateConfig()`
`final I18nConfig`	`getI18nConfig()`
`final LoggingConfig`	`getLoggingConfig()`
`final TreeSet<String>`	`getClientsideMods()`
`final TreeSet<String>`	`getModsWhitelist()`
`final TreeSet<String>`	`getClientsideModsRegex()`
`final TreeSet<String>`	`getModsWhitelistRegex()`
`final Integer`	`getNetworkConnectTimeout()`
`final Unit`	`setNetworkConnectTimeout(Integer value)`
`final Integer`	`getNetworkReadTimeout()`
`final Unit`	`setNetworkReadTimeout(Integer value)`
`final Integer`	`getNetworkDownloadReadTimeout()`
`final Unit`	`setNetworkDownloadReadTimeout(Integer value)`
`final Array<String>`	`getSupportedModloaders()`
`final String`	`getApiVersion()`
`final Boolean`	`getDevBuild()`
`final Boolean`	`getPreRelease()`
`final String`	`getConfigVersion()`
`final Boolean`	`getFirstRun()`
`final String`	`getLogLevel()`
`final Unit`	`setLogLevel(String value)`
`final TreeSet<String>`	`getDirectoriesToInclude()`
`final Unit`	`setDirectoriesToInclude(TreeSet<String> value)`
`final TreeSet<String>`	`getDirectoriesToExclude()`
`final Unit`	`setDirectoriesToExclude(TreeSet<String> value)`
`final TreeSet<String>`	`getPostInstallCleanupFiles()`
`final Unit`	`setPostInstallCleanupFiles(TreeSet<String> value)`
`final TreeSet<String>`	`getPreInstallCleanupFiles()`
`final Unit`	`setPreInstallCleanupFiles(TreeSet<String> value)`
`final TreeSet<String>`	`getZipArchiveExclusions()`
`final Unit`	`setZipArchiveExclusions(TreeSet<String> value)`
`final JavaConfig`	`getJavaConfig()`
`final HashMap<String, String>`	`getJavaPaths()`
`final Unit`	`setJavaPaths(HashMap<String, String> value)`
`final TreeSet<File>`	`getScriptTemplates()`
`final Unit`	`setScriptTemplates(TreeSet<File> value)`
`final HashMap<String, String>`	`getStartScriptTemplates()`
`final Unit`	`setStartScriptTemplates(HashMap<String, String> value)`
`final HashMap<String, String>`	`getJavaScriptTemplates()`
`final Unit`	`setJavaScriptTemplates(HashMap<String, String> value)`
`final URL`	`getUpdateUrl()`
`final Unit`	`setUpdateUrl(URL value)`
`final ExclusionFilter`	`getExclusionFilter()`
`final Unit`	`setExclusionFilter(ExclusionFilter value)`
`final Boolean`	`isCheckingForPreReleasesEnabled()`
`final Unit`	`setCheckingForPreReleasesEnabled(Boolean value)`
`final Boolean`	`isZipFileExclusionEnabled()`
`final Unit`	`setZipFileExclusionEnabled(Boolean value)`
`final Boolean`	`isAutoExcludingModsEnabled()`
`final Unit`	`setAutoExcludingModsEnabled(Boolean value)`
`final Boolean`	`isServerPacksOverwriteEnabled()`
`final Unit`	`setServerPacksOverwriteEnabled(Boolean value)`
`final Boolean`	`isServerPackCleanupEnabled()`
`final Unit`	`setServerPackCleanupEnabled(Boolean value)`
`final Boolean`	`isMinecraftPreReleasesAvailabilityEnabled()`
`final Unit`	`setMinecraftPreReleasesAvailabilityEnabled(Boolean value)`
`final Boolean`	`isUpdatingServerPacksEnabled()`
`final Unit`	`setUpdatingServerPacksEnabled(Boolean value)`
`final Boolean`	`isJavaScriptAutoupdateEnabled()`
`final Unit`	`setJavaScriptAutoupdateEnabled(Boolean value)`
`final String`	`getAikarsFlags()`
`final Unit`	`setAikarsFlags(String value)`
`final WebserviceConfig`	`getWebserviceConfig()`
`final String`	`getDatabaseUri()`
`final Unit`	`setDatabaseUri(String value)`
`final Locale`	`getLanguage()`
`final Unit`	`setLanguage(Locale value)`
`final String`	`getHasteBinServerUrl()`
`final Unit`	`setHasteBinServerUrl(String value)`
`final String`	`getJavaPath()`
`final Unit`	`setJavaPath(String value)`
`final String`	`getWebserviceCleanupSchedule()`
`final Unit`	`setWebserviceCleanupSchedule(String value)`
`final String`	`getWebserviceVersionSchedule()`
`final Unit`	`setWebserviceVersionSchedule(String value)`
`final String`	`getWebserviceDatabaseCleanupSchedule()`
`final Unit`	`setWebserviceDatabaseCleanupSchedule(String value)`
`final PathsConfig`	`getPathsConfig()`
`final ScriptTemplatesConfig`	`getScriptTemplatesConfig()`
`final File`	`getHomeDirectory()`
`final Unit`	`setHomeDirectory(File value)`
`final File`	`getServerPackCreatorPropertiesFile()`
`final File`	`getOverridesPropertiesFile()`
`final File`	`getDefaultConfig()`
`final File`	`getConfigsDirectory()`
`final File`	`getTomcatBaseDirectory()`
`final Unit`	`setTomcatBaseDirectory(File value)`
`final File`	`getServerPacksDirectory()`
`final Unit`	`setServerPacksDirectory(File value)`
`final File`	`getLogsDirectory()`
`final File`	`getTomcatLogsDirectory()`
`final Unit`	`setTomcatLogsDirectory(File value)`
`final File`	`getManifestsDirectory()`
`final File`	`getFabricIntermediariesManifest()`
`final File`	`getLegacyFabricGameManifest()`
`final File`	`getLegacyFabricLoaderManifest()`
`final File`	`getLegacyFabricInstallerManifest()`
`final File`	`getFabricInstallerManifest()`
`final File`	`getQuiltVersionManifest()`
`final File`	`getQuiltInstallerManifest()`
`final File`	`getForgeVersionManifest()`
`final File`	`getOldNeoForgeVersionManifest()`
`final File`	`getNewNeoForgeVersionManifest()`
`final File`	`getFabricVersionManifest()`
`final File`	`getMinecraftServerManifestsDirectory()`
`final File`	`getMinecraftVersionManifest()`
`final File`	`getWorkDirectory()`
`final File`	`getInstallerCacheDirectory()`
`final File`	`getTempDirectory()`
`final File`	`getModpacksDirectory()`
`final File`	`getServerFilesDirectory()`
`final File`	`getDefaultShellScriptTemplate()`
`final File`	`getDefaultFishScriptTemplate()`
`final File`	`getDefaultPowerShellScriptTemplate()`
`final File`	`getDefaultBatchScriptTemplate()`
`final File`	`getDefaultJavaShellScriptTemplate()`
`final File`	`getDefaultJavaFishScriptTemplate()`
`final File`	`getDefaultJavaPowerShellScriptTemplate()`
`final File`	`getDefaultJavaBatchScriptTemplate()`
`final File`	`getPropertiesDirectory()`
`final File`	`getIconsDirectory()`
`final File`	`getDefaultServerProperties()`
`final File`	`getDefaultServerIcon()`
`final File`	`getDefaultVariablesTemplate()`
`final File`	`getPluginsDirectory()`
`final File`	`getPluginsConfigsDirectory()`
`final Boolean`	`getFallbackUpdated()`
`final File`	`getInstallLocationXml()`
`final File`	`getLog4jXml()`
`final File`	`getJarFolder()`	The folder containing the ServerPackCreator.exe or JAR-file.
`final Boolean`	`isExe()`	Whether a .exe or JAR-file was used for running ServerPackCreator.
`final File`	`getJarFile()`	The .exe or JAR-file of ServerPackCreator.
`final String`	`getJarName()`	The name of the .exe or JAR-file.
`final String`	`getJavaVersion()`	The Java version used to run ServerPackCreator.
`final String`	`getOSArch()`	Architecture of the operating system on which ServerPackCreator is running on.
`final String`	`getOSName()`	The name of the operating system on which ServerPackCreator is running on.
`final String`	`getOSVersion()`	The version of the OS on which ServerPackCreator is running on.
`final Optional<String>`	`getPreference(String pref, String def)`	Read one value from SPC's `Preferences` node, or def when unset.
`final Unit`	`storePreference(String pref, String value)`	Write one value into SPC's `Preferences` node.
`final List<File>`	`defaultScriptTemplates()`	Default list of script templates used by ServerPackCreator.
`final HashMap<String, String>`	`defaultStartScriptTemplates()`	Default map of start-script templates: sh, ps1, bat.
`final HashMap<String, String>`	`defaultJavaScriptTemplates()`	Default map of java-install-script templates: sh, ps1.
`final Optional<String>`	`javaPath(Integer javaVersion)`	Get the path to the specified Java executable/binary, wrapped in an Optional for your convenience.
`final Optional<String>`	`javaPath(String javaVersion)`	Get the path to the specified Java executable/binary, wrapped in an Optional for your convenience.
`final String`	`defaultWebserviceDatabase()`	The default webservice database-URI, for resetting the configuration to factory-state.
`final File`	`defaultTomcatBaseDirectory()`	The default Tomcat base-directory: the home-directory.
`final File`	`defaultServerPacksDirectory()`	The default server-packs directory: server-packs inside the home-directory.
`final File`	`defaultTomcatLogsDirectory()`	The default Tomcat logs-directory: logs inside the home-directory.
`final Unit`	`loadOverrides(File properties)`	Loads the overrides-properties directly into the store, replacing already-loaded values.
`final Unit`	`loadProperties(Boolean saveProps)`	Load properties using the default file path.
`final Unit`	`loadProperties(File propertiesFile, Boolean saveProps)`	Reload from a specific properties-file.
`final String`	`acquireJavaPath(String pathToJava)`	Check the given path to a Java installation for validity and return it, if it is valid.
`final Unit`	`saveProperties(File propertiesFile)`	Store the ApplicationProperties to disk, overwriting the existing one.
`final Boolean`	`javaAvailable()`	Whether a viable path to a Java executable or binary has been configured for ServerPackCreator.
`final Unit`	`changeLocale(Locale locale)`	Writes the specified locale from -lang your_locale to a lang.properties file to ensure every subsequent start of serverpackcreator is executed using said locale.
`final List<String>`	`clientSideMods()`	Acquire the default fallback list of clientside-only mods.
`final List<String>`	`whitelistedMods()`	Acquire the default fallback list of whitelisted mods.
`final Boolean`	`updateFallback()`	Update the fallback clientside-only mod-list and whitelist from the configured update-URL.
`final String`	`storeCustomProperty(String property, String value)`	Store a custom property in the serverpackcreator.properties-file.
`final String`	`retrieveCustomProperty(String property)`	Retrieve a custom property in the serverpackcreator.properties-file.
`final Unit`	`setOldVersion(String version)`	Set the old version of ServerPackCreator used to perform necessary migrations between the old and the current version.
`final String`	`oldVersion()`	Get the old version of ServerPackCreator used to perform necessary migrations between the old and the current version.
`final Unit`	`clearPropertyFileList()`	Forget every properties file the store has loaded from.
`Array<String>`	`getSupportedTypes()`
`Configuration`	`getConfiguration(LoggerContext loggerContext, ConfigurationSource source)`	Depending on whether this is the first run of ServerPackCreator on a users machine, the default log4j2 configuration may be present at different locations.
`final static String`	`getSeparator()`
`final static String`	`resolvePreferencesNode(String property, String environment)`	Decide which `Preferences` node to store settings in: the PREFERENCES_NODE_PROPERTY system property first, then the PREFERENCES_NODE_ENV environment variable, else DEFAULT_PREFERENCES_NODE.
`final static String`	`resolvePreferencesNode(String property)`	Decide which `Preferences` node to store settings in: the PREFERENCES_NODE_PROPERTY system property first, then the PREFERENCES_NODE_ENV environment variable, else DEFAULT_PREFERENCES_NODE.
`final static String`	`resolvePreferencesNode()`	Decide which `Preferences` node to store settings in: the PREFERENCES_NODE_PROPERTY system property first, then the PREFERENCES_NODE_ENV environment variable, else DEFAULT_PREFERENCES_NODE.

Methods inherited from class org.apache.logging.log4j.core.config.ConfigurationFactory
getConfiguration, getConfiguration, getConfiguration, getDefaultPrefix, getInputFromString, getTestPrefix, getVersion, isActive
Methods inherited from class de.griefed.serverpackcreator.api.ApiProperties
getSupportedTypes
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ApiProperties
```
ApiProperties(File propertiesFile)
```
    Parameters:
    
    propertiesFile - serverpackcreator.properties-file containing settings and configurations to load the API with.
- Method Detail
  - getHome
```
 final File getHome()
```
  - getGenerationConfig
```
 final GenerationConfig getGenerationConfig()
```
  - getNetworkConfig
```
 final NetworkConfig getNetworkConfig()
```
  - getFallbackDirectoriesInclusion
```
 final TreeSet<String> getFallbackDirectoriesInclusion()
```
  - getFallbackDirectoriesExclusion
```
 final TreeSet<String> getFallbackDirectoriesExclusion()
```
  - getFallbackZipExclusions
```
 final TreeSet<String> getFallbackZipExclusions()
```
  - getFallbackPostInstallCleanupFiles
```
 final TreeSet<String> getFallbackPostInstallCleanupFiles()
```
  - getFallbackPreInstallCleanupFiles
```
 final TreeSet<String> getFallbackPreInstallCleanupFiles()
```
  - getFallbackAikarsFlags
```
 final String getFallbackAikarsFlags()
```
  - getFallbackUpdateURL
```
 final String getFallbackUpdateURL()
```
  - getFallbackExclusionFilter
```
 final ExclusionFilter getFallbackExclusionFilter()
```
  - getFallbackOverwriteEnabled
```
 final Boolean getFallbackOverwriteEnabled()
```
  - getFallbackJavaScriptAutoupdateEnabled
```
 final Boolean getFallbackJavaScriptAutoupdateEnabled()
```
  - getFallbackCheckingForPreReleasesEnabled
```
 final Boolean getFallbackCheckingForPreReleasesEnabled()
```
  - getFallbackZipFileExclusionEnabled
```
 final Boolean getFallbackZipFileExclusionEnabled()
```
  - getFallbackServerPackCleanupEnabled
```
 final Boolean getFallbackServerPackCleanupEnabled()
```
  - getFallbackMinecraftPreReleasesAvailabilityEnabled
```
 final Boolean getFallbackMinecraftPreReleasesAvailabilityEnabled()
```
  - getFallbackAutoExcludingModsEnabled
```
 final Boolean getFallbackAutoExcludingModsEnabled()
```
  - getFallbackCleanupSchedule
```
 final String getFallbackCleanupSchedule()
```
  - getFallbackVersionSchedule
```
 final String getFallbackVersionSchedule()
```
  - getFallbackDatabaseCleanupSchedule
```
 final String getFallbackDatabaseCleanupSchedule()
```
  - getFallbackUpdateServerPack
```
 final Boolean getFallbackUpdateServerPack()
```
  - getI18n4kConfig
```
 final I18n4kConfigDefault getI18n4kConfig()
```
  - getUpdateConfig
```
 final UpdateConfig getUpdateConfig()
```
  - getI18nConfig
```
 final I18nConfig getI18nConfig()
```
  - getLoggingConfig
```
 final LoggingConfig getLoggingConfig()
```
  - getClientsideMods
```
 final TreeSet<String> getClientsideMods()
```
  - getModsWhitelist
```
 final TreeSet<String> getModsWhitelist()
```
  - getClientsideModsRegex
```
 final TreeSet<String> getClientsideModsRegex()
```
  - getModsWhitelistRegex
```
 final TreeSet<String> getModsWhitelistRegex()
```
  - getNetworkConnectTimeout
```
 final Integer getNetworkConnectTimeout()
```
  - setNetworkConnectTimeout
```
 final Unit setNetworkConnectTimeout(Integer value)
```
  - getNetworkReadTimeout
```
 final Integer getNetworkReadTimeout()
```
  - setNetworkReadTimeout
```
 final Unit setNetworkReadTimeout(Integer value)
```
  - getNetworkDownloadReadTimeout
```
 final Integer getNetworkDownloadReadTimeout()
```
  - setNetworkDownloadReadTimeout
```
 final Unit setNetworkDownloadReadTimeout(Integer value)
```
  - getSupportedModloaders
```
 final Array<String> getSupportedModloaders()
```
  - getApiVersion
```
 final String getApiVersion()
```
  - getDevBuild
```
 final Boolean getDevBuild()
```
  - getPreRelease
```
 final Boolean getPreRelease()
```
  - getConfigVersion
```
 final String getConfigVersion()
```
  - getFirstRun
```
 final Boolean getFirstRun()
```
  - getLogLevel
```
 final String getLogLevel()
```
  - setLogLevel
```
 final Unit setLogLevel(String value)
```
  - getDirectoriesToInclude
```
 final TreeSet<String> getDirectoriesToInclude()
```
  - setDirectoriesToInclude
```
 final Unit setDirectoriesToInclude(TreeSet<String> value)
```
  - getDirectoriesToExclude
```
 final TreeSet<String> getDirectoriesToExclude()
```
  - setDirectoriesToExclude
```
 final Unit setDirectoriesToExclude(TreeSet<String> value)
```
  - getPostInstallCleanupFiles
```
 final TreeSet<String> getPostInstallCleanupFiles()
```
  - setPostInstallCleanupFiles
```
 final Unit setPostInstallCleanupFiles(TreeSet<String> value)
```
  - getPreInstallCleanupFiles
```
 final TreeSet<String> getPreInstallCleanupFiles()
```
  - setPreInstallCleanupFiles
```
 final Unit setPreInstallCleanupFiles(TreeSet<String> value)
```
  - getZipArchiveExclusions
```
 final TreeSet<String> getZipArchiveExclusions()
```
  - setZipArchiveExclusions
```
 final Unit setZipArchiveExclusions(TreeSet<String> value)
```
  - getJavaConfig
```
 final JavaConfig getJavaConfig()
```
  - getJavaPaths
```
 final HashMap<String, String> getJavaPaths()
```
  - setJavaPaths
```
 final Unit setJavaPaths(HashMap<String, String> value)
```
  - getScriptTemplates
```
 final TreeSet<File> getScriptTemplates()
```
  - setScriptTemplates
```
 final Unit setScriptTemplates(TreeSet<File> value)
```
  - getStartScriptTemplates
```
 final HashMap<String, String> getStartScriptTemplates()
```
  - setStartScriptTemplates
```
 final Unit setStartScriptTemplates(HashMap<String, String> value)
```
  - getJavaScriptTemplates
```
 final HashMap<String, String> getJavaScriptTemplates()
```
  - setJavaScriptTemplates
```
 final Unit setJavaScriptTemplates(HashMap<String, String> value)
```
  - getUpdateUrl
```
 final URL getUpdateUrl()
```
  - setUpdateUrl
```
 final Unit setUpdateUrl(URL value)
```
  - getExclusionFilter
```
 final ExclusionFilter getExclusionFilter()
```
  - setExclusionFilter
```
 final Unit setExclusionFilter(ExclusionFilter value)
```
  - isCheckingForPreReleasesEnabled
```
 final Boolean isCheckingForPreReleasesEnabled()
```
  - setCheckingForPreReleasesEnabled
```
 final Unit setCheckingForPreReleasesEnabled(Boolean value)
```
  - isZipFileExclusionEnabled
```
 final Boolean isZipFileExclusionEnabled()
```
  - setZipFileExclusionEnabled
```
 final Unit setZipFileExclusionEnabled(Boolean value)
```
  - isAutoExcludingModsEnabled
```
 final Boolean isAutoExcludingModsEnabled()
```
  - setAutoExcludingModsEnabled
```
 final Unit setAutoExcludingModsEnabled(Boolean value)
```
  - isServerPacksOverwriteEnabled
```
 final Boolean isServerPacksOverwriteEnabled()
```
  - setServerPacksOverwriteEnabled
```
 final Unit setServerPacksOverwriteEnabled(Boolean value)
```
  - isServerPackCleanupEnabled
```
 final Boolean isServerPackCleanupEnabled()
```
  - setServerPackCleanupEnabled
```
 final Unit setServerPackCleanupEnabled(Boolean value)
```
  - isMinecraftPreReleasesAvailabilityEnabled
```
 final Boolean isMinecraftPreReleasesAvailabilityEnabled()
```
  - setMinecraftPreReleasesAvailabilityEnabled
```
 final Unit setMinecraftPreReleasesAvailabilityEnabled(Boolean value)
```
  - isUpdatingServerPacksEnabled
```
 final Boolean isUpdatingServerPacksEnabled()
```
  - setUpdatingServerPacksEnabled
```
 final Unit setUpdatingServerPacksEnabled(Boolean value)
```
  - isJavaScriptAutoupdateEnabled
```
 final Boolean isJavaScriptAutoupdateEnabled()
```
  - setJavaScriptAutoupdateEnabled
```
 final Unit setJavaScriptAutoupdateEnabled(Boolean value)
```
  - getAikarsFlags
```
 final String getAikarsFlags()
```
  - setAikarsFlags
```
 final Unit setAikarsFlags(String value)
```
  - getWebserviceConfig
```
 final WebserviceConfig getWebserviceConfig()
```
  - getDatabaseUri
```
 final String getDatabaseUri()
```
  - setDatabaseUri
```
 final Unit setDatabaseUri(String value)
```
  - getLanguage
```
 final Locale getLanguage()
```
  - setLanguage
```
 final Unit setLanguage(Locale value)
```
  - getHasteBinServerUrl
```
 final String getHasteBinServerUrl()
```
  - setHasteBinServerUrl
```
 final Unit setHasteBinServerUrl(String value)
```
  - getJavaPath
```
 final String getJavaPath()
```
  - setJavaPath
```
 final Unit setJavaPath(String value)
```
  - getWebserviceCleanupSchedule
```
 final String getWebserviceCleanupSchedule()
```
  - setWebserviceCleanupSchedule
```
 final Unit setWebserviceCleanupSchedule(String value)
```
  - getWebserviceVersionSchedule
```
 final String getWebserviceVersionSchedule()
```
  - setWebserviceVersionSchedule
```
 final Unit setWebserviceVersionSchedule(String value)
```
  - getWebserviceDatabaseCleanupSchedule
```
 final String getWebserviceDatabaseCleanupSchedule()
```
  - setWebserviceDatabaseCleanupSchedule
```
 final Unit setWebserviceDatabaseCleanupSchedule(String value)
```
  - getPathsConfig
```
 final PathsConfig getPathsConfig()
```
  - getScriptTemplatesConfig
```
 final ScriptTemplatesConfig getScriptTemplatesConfig()
```
  - getHomeDirectory
```
 final File getHomeDirectory()
```
  - setHomeDirectory
```
 final Unit setHomeDirectory(File value)
```
  - getServerPackCreatorPropertiesFile
```
 final File getServerPackCreatorPropertiesFile()
```
  - getOverridesPropertiesFile
```
 final File getOverridesPropertiesFile()
```
  - getDefaultConfig
```
 final File getDefaultConfig()
```
  - getConfigsDirectory
```
 final File getConfigsDirectory()
```
  - getTomcatBaseDirectory
```
 final File getTomcatBaseDirectory()
```
  - setTomcatBaseDirectory
```
 final Unit setTomcatBaseDirectory(File value)
```
  - getServerPacksDirectory
```
 final File getServerPacksDirectory()
```
  - setServerPacksDirectory
```
 final Unit setServerPacksDirectory(File value)
```
  - getLogsDirectory
```
 final File getLogsDirectory()
```
  - getTomcatLogsDirectory
```
 final File getTomcatLogsDirectory()
```
  - setTomcatLogsDirectory
```
 final Unit setTomcatLogsDirectory(File value)
```
  - getManifestsDirectory
```
 final File getManifestsDirectory()
```
  - getFabricIntermediariesManifest
```
 final File getFabricIntermediariesManifest()
```
  - getLegacyFabricGameManifest
```
 final File getLegacyFabricGameManifest()
```
  - getLegacyFabricLoaderManifest
```
 final File getLegacyFabricLoaderManifest()
```
  - getLegacyFabricInstallerManifest
```
 final File getLegacyFabricInstallerManifest()
```
  - getFabricInstallerManifest
```
 final File getFabricInstallerManifest()
```
  - getQuiltVersionManifest
```
 final File getQuiltVersionManifest()
```
  - getQuiltInstallerManifest
```
 final File getQuiltInstallerManifest()
```
  - getForgeVersionManifest
```
 final File getForgeVersionManifest()
```
  - getOldNeoForgeVersionManifest
```
 final File getOldNeoForgeVersionManifest()
```
  - getNewNeoForgeVersionManifest
```
 final File getNewNeoForgeVersionManifest()
```
  - getFabricVersionManifest
```
 final File getFabricVersionManifest()
```
  - getMinecraftServerManifestsDirectory
```
 final File getMinecraftServerManifestsDirectory()
```
  - getMinecraftVersionManifest
```
 final File getMinecraftVersionManifest()
```
  - getWorkDirectory
```
 final File getWorkDirectory()
```
  - getInstallerCacheDirectory
```
 final File getInstallerCacheDirectory()
```
  - getTempDirectory
```
 final File getTempDirectory()
```
  - getModpacksDirectory
```
 final File getModpacksDirectory()
```
  - getServerFilesDirectory
```
 final File getServerFilesDirectory()
```
  - getDefaultShellScriptTemplate
```
 final File getDefaultShellScriptTemplate()
```
  - getDefaultFishScriptTemplate
```
 final File getDefaultFishScriptTemplate()
```
  - getDefaultPowerShellScriptTemplate
```
 final File getDefaultPowerShellScriptTemplate()
```
  - getDefaultBatchScriptTemplate
```
 final File getDefaultBatchScriptTemplate()
```
  - getDefaultJavaShellScriptTemplate
```
 final File getDefaultJavaShellScriptTemplate()
```
  - getDefaultJavaFishScriptTemplate
```
 final File getDefaultJavaFishScriptTemplate()
```
  - getDefaultJavaPowerShellScriptTemplate
```
 final File getDefaultJavaPowerShellScriptTemplate()
```
  - getDefaultJavaBatchScriptTemplate
```
 final File getDefaultJavaBatchScriptTemplate()
```
  - getPropertiesDirectory
```
 final File getPropertiesDirectory()
```
  - getIconsDirectory
```
 final File getIconsDirectory()
```
  - getDefaultServerProperties
```
 final File getDefaultServerProperties()
```
  - getDefaultServerIcon
```
 final File getDefaultServerIcon()
```
  - getDefaultVariablesTemplate
```
 final File getDefaultVariablesTemplate()
```
  - getPluginsDirectory
```
 final File getPluginsDirectory()
```
  - getPluginsConfigsDirectory
```
 final File getPluginsConfigsDirectory()
```
  - getFallbackUpdated
```
 final Boolean getFallbackUpdated()
```
  - getInstallLocationXml
```
 final File getInstallLocationXml()
```
  - getLog4jXml
```
 final File getLog4jXml()
```
  - getJarFolder
```
 final File getJarFolder()
```
    The folder containing the ServerPackCreator.exe or JAR-file.
    
    Returns:
    
    Folder containing the ServerPackCreator.exe or JAR-file.
  - isExe
```
 final Boolean isExe()
```
    Whether a .exe or JAR-file was used for running ServerPackCreator.
    
    Returns:
    
    true if a .exe was/is used.
  - getJarFile
```
 final File getJarFile()
```
    The .exe or JAR-file of ServerPackCreator.
    
    Returns:
    
    The .exe or JAR-file of ServerPackCreator.
  - getJarName
```
 final String getJarName()
```
    The name of the .exe or JAR-file.
    
    Returns:
    
    The name of the .exe or JAR-file.
  - getJavaVersion
```
 final String getJavaVersion()
```
    The Java version used to run ServerPackCreator.
    
    Returns:
    
    Java version.
  - getOSArch
```
 final String getOSArch()
```
    Architecture of the operating system on which ServerPackCreator is running on.
    
    Returns:
    
    Arch.
  - getOSName
```
 final String getOSName()
```
    The name of the operating system on which ServerPackCreator is running on.
    
    Returns:
    
    OS name.
  - getOSVersion
```
 final String getOSVersion()
```
    The version of the OS on which ServerPackCreator is running on.
    
    Returns:
    
    Version of the OS.
  - getPreference
```
 final Optional<String> getPreference(String pref, String def)
```
    Read one value from SPC's Preferences node, or def when unset.
    Landmine: which node that is depends on resolvePreferencesNode — a host claiming its own node (the grinder daemon, every test JVM) reads and writes a different store than the default installation, deliberately.
  - storePreference
```
 final Unit storePreference(String pref, String value)
```
    Write one value into SPC's Preferences node. Same node caveat as getPreference.
  - defaultScriptTemplates
```
@Deprecated(message = "Deprecated as of 6.0.0", replaceWith = @ReplaceWith(expression = "defaultStartScriptTemplates()")) final List<File> defaultScriptTemplates()
```
    Default list of script templates used by ServerPackCreator.
  - defaultStartScriptTemplates
```
 final HashMap<String, String> defaultStartScriptTemplates()
```
    Default map of start-script templates: sh, ps1, bat.
  - defaultJavaScriptTemplates
```
 final HashMap<String, String> defaultJavaScriptTemplates()
```
    Default map of java-install-script templates: sh, ps1.
  - javaPath
```
 final Optional<String> javaPath(Integer javaVersion)
```
    Get the path to the specified Java executable/binary, wrapped in an Optional for your convenience.
  - javaPath
```
 final Optional<String> javaPath(String javaVersion)
```
    Get the path to the specified Java executable/binary, wrapped in an Optional for your convenience.
  - defaultWebserviceDatabase
```
 final String defaultWebserviceDatabase()
```
    The default webservice database-URI, for resetting the configuration to factory-state.
  - defaultTomcatBaseDirectory
```
 final File defaultTomcatBaseDirectory()
```
    The default Tomcat base-directory: the home-directory.
  - defaultServerPacksDirectory
```
 final File defaultServerPacksDirectory()
```
    The default server-packs directory: server-packs inside the home-directory.
  - defaultTomcatLogsDirectory
```
 final File defaultTomcatLogsDirectory()
```
    The default Tomcat logs-directory: logs inside the home-directory.
  - loadOverrides
```
 final Unit loadOverrides(File properties)
```
    Loads the overrides-properties directly into the store, replacing already-loaded values.
  - loadProperties
```
 final Unit loadProperties(Boolean saveProps)
```
    Load properties using the default file path. Only call this method on an already initialized ApiProperties-object.
  - loadProperties
```
 final Unit loadProperties(File propertiesFile, Boolean saveProps)
```
    Reload from a specific properties-file.
    
    Parameters:
    
    propertiesFile - The properties-file with which to loadProperties the settings and configuration.
  - acquireJavaPath
```
 final String acquireJavaPath(String pathToJava)
```
    Check the given path to a Java installation for validity and return it, if it is valid. Invalid paths yield the automatically acquired system-Java.
  - saveProperties
```
 final Unit saveProperties(File propertiesFile)
```
    Store the ApplicationProperties to disk, overwriting the existing one.
    
    Parameters:
    
    propertiesFile - The file to store the properties to.
  - javaAvailable
```
 final Boolean javaAvailable()
```
    Whether a viable path to a Java executable or binary has been configured for ServerPackCreator.
  - changeLocale
```
 final Unit changeLocale(Locale locale)
```
    Writes the specified locale from -lang your_locale to a lang.properties file to ensure every subsequent start of serverpackcreator is executed using said locale.
    
    Parameters:
    
    locale - The locale the user specified when they ran serverpackcreator with -lang -your_locale.
  - clientSideMods
```
 final List<String> clientSideMods()
```
    Acquire the default fallback list of clientside-only mods. If de.griefed.serverpackcreator.serverpack.autodiscovery.filter is set to ExclusionFilter.REGEX, a regex fallback list is returned.
    
    Returns:
    
    The fallback list of clientside-only mods.
  - whitelistedMods
```
 final List<String> whitelistedMods()
```
    Acquire the default fallback list of whitelisted mods. If de.griefed.serverpackcreator.serverpack.autodiscovery.filter is set to ExclusionFilter.REGEX, a regex fallback list is returned.
    
    Returns:
    
    The fallback list of whitelisted mods.
  - updateFallback
```
 final Boolean updateFallback()
```
    Update the fallback clientside-only mod-list and whitelist from the configured update-URL.
    
    Returns:
    
    true if either fallback-list was updated.
  - storeCustomProperty
```
 final String storeCustomProperty(String property, String value)
```
    Store a custom property in the serverpackcreator.properties-file. Beware that every property you add receives a prefix, to prevent clashes with any other properties.
    Said prefix consists of custom.property. followed by the property you specified coming in last.
    Say you have a value in the property saved, then the resulting property in the serverpackcreator.properties would be:
    custom.property.saved
  - retrieveCustomProperty
```
 final String retrieveCustomProperty(String property)
```
    Retrieve a custom property in the serverpackcreator.properties-file. Beware that every property you retrieve this way contains a prefix, to prevent clashes with any other properties.
    Said prefix consists of custom.property. followed by the property you specified coming in last.
    Say you have a property saved, then the resulting property in the serverpackcreator.properties would be: custom.property.saved
  - setOldVersion
```
 final Unit setOldVersion(String version)
```
    Set the old version of ServerPackCreator used to perform necessary migrations between the old and the current version.
    
    Parameters:
    
    version - Old version used before upgrading to the current version.
  - oldVersion
```
 final String oldVersion()
```
    Get the old version of ServerPackCreator used to perform necessary migrations between the old and the current version.
    
    Returns:
    
    Old version used before updating. Empty if this is the first run of ServerPackCreator.
  - clearPropertyFileList
```
 final Unit clearPropertyFileList()
```
    Forget every properties file the store has loaded from.
    PropertyStore writes to all tracked files on every save, so a file loaded once keeps being rewritten for the life of the process — which is how a daemon started from a checkout dropped a settings file into the repository root. Call this when a host wants its saves confined to the file it just pointed SPC at.
  - getSupportedTypes
```
 Array<String> getSupportedTypes()
```
  - getConfiguration
```
 Configuration getConfiguration(LoggerContext loggerContext, ConfigurationSource source)
```
    Depending on whether this is the first run of ServerPackCreator on a users machine, the default log4j2 configuration may be present at different locations. The default one is the config inside the home-directory of SPC, of which we will try to set up our logging with. If said file fails for whatever reason, we will try to use a config inside the directory from which SPC was executed. Should that fail, too, the config from the classpath is used, to ensure we always have default configs available. Should that fail, too, though, log4j is set up with its own default settings.
    
    Parameters:
    
    loggerContext - logger context passed from log4j itself
    
    source - configuration source passed from log4j itself.
    
    Returns:
    
    Custom configuration with proper logs-directory set.
  - getSeparator
```
 final static String getSeparator()
```
  - resolvePreferencesNode
```
@JvmOverloads() final static String resolvePreferencesNode(String property, String environment)
```
    Decide which Preferences node to store settings in: the PREFERENCES_NODE_PROPERTY system property first, then the PREFERENCES_NODE_ENV environment variable, else DEFAULT_PREFERENCES_NODE.
    Why this is overridable at all: the node is per-user and machine-wide, and PathsConfig.homeDirectory re-reads it on every access while writing back what it resolved. With a single hard-coded node, any SPC process could relocate any other running process's home directory — a test suite moved a live grinder daemon's home into its own scratch directory and then deleted it, and equally, running the suites moved the developer's own GUI home. Giving each host its own node makes that impossible.
    A blank override falls back to the default rather than being honoured: userRoot().node("") is the root node, shared with every other Java application on the account.
    
    Parameters:
    
    property - The system-property value (injectable for tests).
    
    environment - The environment-variable value (injectable for tests).
  - resolvePreferencesNode
```
@JvmOverloads() final static String resolvePreferencesNode(String property)
```
    Decide which Preferences node to store settings in: the PREFERENCES_NODE_PROPERTY system property first, then the PREFERENCES_NODE_ENV environment variable, else DEFAULT_PREFERENCES_NODE.
    Why this is overridable at all: the node is per-user and machine-wide, and PathsConfig.homeDirectory re-reads it on every access while writing back what it resolved. With a single hard-coded node, any SPC process could relocate any other running process's home directory — a test suite moved a live grinder daemon's home into its own scratch directory and then deleted it, and equally, running the suites moved the developer's own GUI home. Giving each host its own node makes that impossible.
    A blank override falls back to the default rather than being honoured: userRoot().node("") is the root node, shared with every other Java application on the account.
    
    Parameters:
    
    property - The system-property value (injectable for tests).
  - resolvePreferencesNode
```
@JvmOverloads() final static String resolvePreferencesNode()
```
    Decide which Preferences node to store settings in: the PREFERENCES_NODE_PROPERTY system property first, then the PREFERENCES_NODE_ENV environment variable, else DEFAULT_PREFERENCES_NODE.
    Why this is overridable at all: the node is per-user and machine-wide, and PathsConfig.homeDirectory re-reads it on every access while writing back what it resolved. With a single hard-coded node, any SPC process could relocate any other running process's home directory — a test suite moved a live grinder daemon's home into its own scratch directory and then deleted it, and equally, running the suites moved the developer's own GUI home. Giving each host its own node makes that impossible.
    A blank override falls back to the default rather than being honoured: userRoot().node("") is the root node, shared with every other Java application on the account.

Class ApiProperties

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class org.apache.logging.log4j.core.config.ConfigurationFactory

Methods inherited from class de.griefed.serverpackcreator.api.ApiProperties

Methods inherited from class java.lang.Object

Constructor Detail

ApiProperties

Method Detail

getHome

getGenerationConfig

getNetworkConfig

getFallbackDirectoriesInclusion

getFallbackDirectoriesExclusion

getFallbackZipExclusions

getFallbackPostInstallCleanupFiles

getFallbackPreInstallCleanupFiles

getFallbackAikarsFlags

getFallbackUpdateURL

getFallbackExclusionFilter

getFallbackOverwriteEnabled

getFallbackJavaScriptAutoupdateEnabled

getFallbackCheckingForPreReleasesEnabled

getFallbackZipFileExclusionEnabled

getFallbackServerPackCleanupEnabled

getFallbackMinecraftPreReleasesAvailabilityEnabled

getFallbackAutoExcludingModsEnabled

getFallbackCleanupSchedule

getFallbackVersionSchedule

getFallbackDatabaseCleanupSchedule

getFallbackUpdateServerPack

getI18n4kConfig

getUpdateConfig

getI18nConfig

getLoggingConfig

getClientsideMods

getModsWhitelist

getClientsideModsRegex

getModsWhitelistRegex

getNetworkConnectTimeout

setNetworkConnectTimeout

getNetworkReadTimeout

setNetworkReadTimeout

getNetworkDownloadReadTimeout

setNetworkDownloadReadTimeout

getSupportedModloaders

getApiVersion

getDevBuild

getPreRelease

getConfigVersion

getFirstRun

getLogLevel

setLogLevel

getDirectoriesToInclude

setDirectoriesToInclude

getDirectoriesToExclude

setDirectoriesToExclude

getPostInstallCleanupFiles

setPostInstallCleanupFiles

getPreInstallCleanupFiles

setPreInstallCleanupFiles

getZipArchiveExclusions

setZipArchiveExclusions

getJavaConfig

getJavaPaths

setJavaPaths

getScriptTemplates

setScriptTemplates

getStartScriptTemplates

setStartScriptTemplates

getJavaScriptTemplates

setJavaScriptTemplates

getUpdateUrl

setUpdateUrl

getExclusionFilter

setExclusionFilter

isCheckingForPreReleasesEnabled