org.spincast.plugins.config

Class SpincastConfigPluginConfigDefault

java.lang.Object

org.spincast.plugins.config.SpincastConfigPluginConfigDefault

All Implemented Interfaces:

SpincastConfigPluginConfig

public class SpincastConfigPluginConfigDefault
extends Object
implements SpincastConfigPluginConfig

Default configuration for the Spincast Config plugin.

WARNING : Beware of circular dependencies here... In general, this component should not depend on anything else, since pretty much all other components depend on it.

One dependency you can use, is @MainArgs String[] (or @MainArgs List<String>) to get access to the application arguments.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIG_FILE_NAME_DEFAULT
static String	PREFIX_DEFAULT

Constructor Summary

Constructors

Constructor and Description
SpincastConfigPluginConfigDefault()

Method Summary

Modifier and Type	Method and Description
String	getClasspathFilePath() The path to a configuration file to load from the classpath.
List<String>	getEnvironmentVariablesPrefixes() The allowed prefixes an environment variable can have to be used as a configuration.
String	getExternalFilePath() The path to a configuration file to load from the file system.
List<String>	getSystemPropertiesPrefixes() The allowed prefixes a system property can have to be used as a configuration.
boolean	isEnvironmentVariablesStripPrefix() Should the prefix of an environment variable be stripped? For example, if #environmentVariablesPrefixes indicates that "app." is an environment variable prefix, then "app.admin.email" will result in a "admin.email" key.
boolean	isExternalFileConfigsOverrideEnvironmentVariables() If an external configuration file is used and environment variables too, should configurations from the file override those from environment variables?
boolean	isSystemPropertiesStripPrefix() Should the prefix of an system property be stripped? For example, if #systemPropertiesPrefixes indicates that "app." is an system property prefix, then "app.admin.email" will result in a "admin.email" key.
boolean	isThrowExceptionIfSpecifiedClasspathConfigFileIsNotFound() Should an exception be thrown if a classpath config file is specified (is not null) but is not found.
boolean	isThrowExceptionIfSpecifiedExternalConfigFileIsNotFound() Should an exception be thrown if an external config file is specified (is not null) but is not found.

Methods inherited from class java.lang.Object

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

Field Detail

CONFIG_FILE_NAME_DEFAULT

public static final String CONFIG_FILE_NAME_DEFAULT

See Also:

Constant Field Values

PREFIX_DEFAULT

public static final String PREFIX_DEFAULT

See Also:

Constant Field Values

Constructor Detail

SpincastConfigPluginConfigDefault

public SpincastConfigPluginConfigDefault()

Method Detail

getClasspathFilePath

public String getClasspathFilePath()

Description copied from interface: SpincastConfigPluginConfig

The path to a configuration file to load from the classpath.

Defaults to "app-config.yaml". This means you can simply create that file in your /src/main/resources/ folder and it will be used.

Specified by:

getClasspathFilePath in interface SpincastConfigPluginConfig

getExternalFilePath

public String getExternalFilePath()

Description copied from interface: SpincastConfigPluginConfig

The path to a configuration file to load from the file system.

The path can be relative or absolute. Spincast will check this using : File configFile = new File(thePath); if(configFile.isAbsolute()) {...}

If the path is relative, it is from the executable .jar.

Defaults to "app-config.yaml".

Specified by:

getExternalFilePath in interface SpincastConfigPluginConfig

getEnvironmentVariablesPrefixes

public List<String> getEnvironmentVariablesPrefixes()

Description copied from interface: SpincastConfigPluginConfig

The allowed prefixes an environment variable can have to be used as a configuration.

Defaults to "app.".

Specified by:

getEnvironmentVariablesPrefixes in interface SpincastConfigPluginConfig

Returns:

the allowed prefixes or null to disable environment variables as a source for configurations.

isEnvironmentVariablesStripPrefix

public boolean isEnvironmentVariablesStripPrefix()

Description copied from interface: SpincastConfigPluginConfig

Should the prefix of an environment variable be stripped? For example, if #environmentVariablesPrefixes indicates that "app." is an environment variable prefix, then "app.admin.email" will result in a "admin.email" key.

Defaults to false.

Specified by:

isEnvironmentVariablesStripPrefix in interface SpincastConfigPluginConfig

getSystemPropertiesPrefixes

public List<String> getSystemPropertiesPrefixes()

Description copied from interface: SpincastConfigPluginConfig

The allowed prefixes a system property can have to be used as a configuration.

Defaults to "app.".

Specified by:

getSystemPropertiesPrefixes in interface SpincastConfigPluginConfig

Returns:

the allowed prefixes or null to disable system properties as a source for configurations.

isSystemPropertiesStripPrefix

public boolean isSystemPropertiesStripPrefix()

Description copied from interface: SpincastConfigPluginConfig

Should the prefix of an system property be stripped? For example, if #systemPropertiesPrefixes indicates that "app." is an system property prefix, then "app.admin.email" will result in a "admin.email" key.

Defaults to false.

Specified by:

isSystemPropertiesStripPrefix in interface SpincastConfigPluginConfig

isExternalFileConfigsOverrideEnvironmentVariables

public boolean isExternalFileConfigsOverrideEnvironmentVariables()

Description copied from interface: SpincastConfigPluginConfig

If an external configuration file is used and environment variables too, should configurations from the file override those from environment variables?

The default is false : environment variables have priority.

Specified by:

isExternalFileConfigsOverrideEnvironmentVariables in interface SpincastConfigPluginConfig

isThrowExceptionIfSpecifiedClasspathConfigFileIsNotFound

public boolean isThrowExceptionIfSpecifiedClasspathConfigFileIsNotFound()

Description copied from interface: SpincastConfigPluginConfig

Should an exception be thrown if a classpath config file is specified (is not null) but is not found.

If set to false, a message will be logged but no exception will be thrown.

Defaults to false.

Specified by:

isThrowExceptionIfSpecifiedClasspathConfigFileIsNotFound in interface SpincastConfigPluginConfig

isThrowExceptionIfSpecifiedExternalConfigFileIsNotFound

public boolean isThrowExceptionIfSpecifiedExternalConfigFileIsNotFound()

Description copied from interface: SpincastConfigPluginConfig

Should an exception be thrown if an external config file is specified (is not null) but is not found.

If set to false, a message will be logged but no exception will be thrown.

Defaults to false.

Specified by:

isThrowExceptionIfSpecifiedExternalConfigFileIsNotFound in interface SpincastConfigPluginConfig