org.spincast.plugins.configpropsfile

Class SpincastConfigPropsFileBased

java.lang.Object

org.spincast.plugins.config.SpincastConfigDefault

org.spincast.plugins.configpropsfile.SpincastConfigPropsFileBased

All Implemented Interfaces:

SpincastConfig, FreeKeyConfig

public class SpincastConfigPropsFileBased
extends SpincastConfigDefault
implements SpincastConfig, FreeKeyConfig

This configuration implementation will try to find a properties file to load the configurations.

Field Summary

Fields

Modifier and Type	Field and Description
static String	APP_PROPERTIES_KEY_ENVIRONMENT_IS_DEBUG
static String	APP_PROPERTIES_KEY_ENVIRONMENT_NAME
static String	APP_PROPERTIES_KEY_HTTP_SERVER_PORT
static String	APP_PROPERTIES_KEY_HTTPS_SERVER_KEYSTORE_KEYPASS
static String	APP_PROPERTIES_KEY_HTTPS_SERVER_KEYSTORE_PATH
static String	APP_PROPERTIES_KEY_HTTPS_SERVER_KEYSTORE_STOREPASS
static String	APP_PROPERTIES_KEY_HTTPS_SERVER_KEYSTORE_TYPE
static String	APP_PROPERTIES_KEY_HTTPS_SERVER_PORT
static String	APP_PROPERTIES_KEY_SERVER_HOST
protected org.slf4j.Logger	logger

Fields inherited from class org.spincast.plugins.config.SpincastConfigDefault

ENVIRONMENT_NAME_DEFAULT

Constructor Summary

Constructors

Constructor and Description
SpincastConfigPropsFileBased(SpincastUtils spincastUtils, String[] mainArgs, SpincastConfigPropsFileBasedConfig pluginConfig) Constructor

Method Summary

Modifier and Type	Method and Description
protected Properties	getAppProperties() Here is the algorithm used to find the configuration file : 1) If getSpecificAppPropertiesFilePath() is not null, we use it as the path.
String	getConfig(String key) Gets a String configuration and throws an exception if the specified key is not found.
protected Object	getConfig(String key, Object defaultValue, boolean useDefaultValue) Gets a configuration.
String	getConfig(String key, String defaultValue) Gets a String configuration and uses the specified default value if the key is not found.
Boolean	getConfigBoolean(String key) Gets a boolean configuration and throws an exception if the specified key is not found.
Boolean	getConfigBoolean(String key, Boolean defaultValue) Gets a boolean configuration and uses the specified default value if the key is not found.
Integer	getConfigInteger(String key) Gets a integer configuration and throws an exception if the specified key is not found.
Integer	getConfigInteger(String key, Integer defaultValue) Gets a integer configuration and uses the specified default value if the key is not found.
protected String	getConfigKeyEnvironmentIsDebug()
protected String	getConfigKeyEnvironmentName()
protected String	getConfigKeyHttpServerPort()
protected String	getConfigKeyHttpsServerKeystoreKeyPass()
protected String	getConfigKeyHttpsServerKeystorePath()
protected String	getConfigKeyHttpsServerKeystoreStorePass()
protected String	getConfigKeyHttpsServerKeystoreType()
protected String	getConfigKeyHttpsServerPort()
protected String	getConfigKeyServerHost()
String	getEnvironmentName() Returns the name of the environment.
protected String	getFoundPropertiesFilePath() The path to the acutally found .properties file.
int	getHttpServerPort() The HTTP (unsecure) port on which the server will listen on.
String	getHttpsKeyStoreKeypass() The "keypass" of the KeyStore, for SSL.
String	getHttpsKeyStorePath() The path to the KeyStore, for SSL.
String	getHttpsKeyStoreStorePass() The "storepass" of the KeyStore, for SSL.
String	getHttpsKeyStoreType() The type of the KeyStore, for SSL.
int	getHttpsServerPort() The HTTPS (secure) port on which the server will listen on.
protected String[]	getMainArgs()
protected SpincastConfigPropsFileBasedConfig	getPluginConfig()
String	getPublicServerSchemeHostPort() You should override this config!!!!
String	getQueryParamFlashMessageId() The name of the queryString parameter to use for a Flash Message id, when cookies are not available.
String	getServerHost() The host/IP on which the server will listen to.
protected String	getSpecificAppPropertiesFilePath()
protected SpincastUtils	getSpincastUtils()
boolean	isDebugEnabled() Let this to true on development environment, where errors can be publicly displayed, where cache can be disabled, etc.
protected String	lookForPropsFileSpecificPath() Look for a specific .properties file.

Methods inherited from class org.spincast.plugins.config.SpincastConfigDefault

cleanWritableSpincastDir, getContentTypesToSkipGziping, getCookieNameFlashMessage, getCookieNameLocale, getCookiesValidatorCookieName, getDefaultLocale, getDefaultRouteCacheFilterSecondsNbr, getDefaultRouteCacheFilterSecondsNbrCdns, getDefaultStaticResourceCacheConfig, getDefaultTemplateVariablesFilterPosition, getHostForDefaultPublicServerSchemeHostPort, getJsonPathArrayIndexMax, getKeyMaxLengthWhenConvertingMapToJsonObject, getMaxNumberOfKeysWhenConvertingMapToJsonObject, getPublicServerHost, getPublicServerPort, getPublicServerScheme, getPubliURI, getRouteForwardingMaxNumber, getServerMaxRequestBodyBytes, getSpincastModelRootVariableName, getSpincastTempDirName, getSpincastWritableDir, isAddDefaultTemplateVariablesFilter, isDefaultRouteCacheFilterPrivate, isDisableWriteToDiskDynamicStaticResource, isEnableCookiesValidator, isRoutesCaseSensitive, isValidateLocalhostHost

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.spincast.core.config.SpincastConfig

getContentTypesToSkipGziping, getCookieNameFlashMessage, getCookieNameLocale, getCookiesValidatorCookieName, getDefaultLocale, getDefaultRouteCacheFilterSecondsNbr, getDefaultRouteCacheFilterSecondsNbrCdns, getDefaultStaticResourceCacheConfig, getDefaultTemplateVariablesFilterPosition, getJsonPathArrayIndexMax, getKeyMaxLengthWhenConvertingMapToJsonObject, getMaxNumberOfKeysWhenConvertingMapToJsonObject, getPublicServerHost, getPublicServerPort, getPublicServerScheme, getRouteForwardingMaxNumber, getServerMaxRequestBodyBytes, getSpincastModelRootVariableName, getSpincastWritableDir, isAddDefaultTemplateVariablesFilter, isDefaultRouteCacheFilterPrivate, isDisableWriteToDiskDynamicStaticResource, isEnableCookiesValidator, isRoutesCaseSensitive, isValidateLocalhostHost

Field Detail

logger

protected final org.slf4j.Logger logger

APP_PROPERTIES_KEY_ENVIRONMENT_NAME

public static final String APP_PROPERTIES_KEY_ENVIRONMENT_NAME

See Also:

Constant Field Values

APP_PROPERTIES_KEY_ENVIRONMENT_IS_DEBUG

public static final String APP_PROPERTIES_KEY_ENVIRONMENT_IS_DEBUG

See Also:

Constant Field Values

APP_PROPERTIES_KEY_SERVER_HOST

public static final String APP_PROPERTIES_KEY_SERVER_HOST

See Also:

Constant Field Values

APP_PROPERTIES_KEY_HTTP_SERVER_PORT

public static final String APP_PROPERTIES_KEY_HTTP_SERVER_PORT

See Also:

Constant Field Values

APP_PROPERTIES_KEY_HTTPS_SERVER_PORT

public static final String APP_PROPERTIES_KEY_HTTPS_SERVER_PORT

See Also:

Constant Field Values

APP_PROPERTIES_KEY_HTTPS_SERVER_KEYSTORE_PATH

public static final String APP_PROPERTIES_KEY_HTTPS_SERVER_KEYSTORE_PATH

See Also:

Constant Field Values

APP_PROPERTIES_KEY_HTTPS_SERVER_KEYSTORE_TYPE

public static final String APP_PROPERTIES_KEY_HTTPS_SERVER_KEYSTORE_TYPE

See Also:

Constant Field Values

APP_PROPERTIES_KEY_HTTPS_SERVER_KEYSTORE_STOREPASS

public static final String APP_PROPERTIES_KEY_HTTPS_SERVER_KEYSTORE_STOREPASS

See Also:

Constant Field Values

APP_PROPERTIES_KEY_HTTPS_SERVER_KEYSTORE_KEYPASS

public static final String APP_PROPERTIES_KEY_HTTPS_SERVER_KEYSTORE_KEYPASS

See Also:

Constant Field Values

Constructor Detail

SpincastConfigPropsFileBased

@Inject
public SpincastConfigPropsFileBased(SpincastUtils spincastUtils,
                                             @Nullable
                                             String[] mainArgs,
                                             SpincastConfigPropsFileBasedConfig pluginConfig)

Constructor

Method Detail

getPluginConfig

protected SpincastConfigPropsFileBasedConfig getPluginConfig()

getSpincastUtils

protected SpincastUtils getSpincastUtils()

getMainArgs

protected String[] getMainArgs()

getSpecificAppPropertiesFilePath

protected String getSpecificAppPropertiesFilePath()

lookForPropsFileSpecificPath

protected String lookForPropsFileSpecificPath()

Look for a specific .properties file. You can override this to implement your own strategy to locate the .properties file to use.

getFoundPropertiesFilePath

protected String getFoundPropertiesFilePath()

The path to the acutally found .properties file.

Returns:

the path of the file or null if none was found.

getConfigKeyEnvironmentName

protected String getConfigKeyEnvironmentName()

getConfigKeyEnvironmentIsDebug

protected String getConfigKeyEnvironmentIsDebug()

getConfigKeyServerHost

protected String getConfigKeyServerHost()

getConfigKeyHttpServerPort

protected String getConfigKeyHttpServerPort()

getConfigKeyHttpsServerPort

protected String getConfigKeyHttpsServerPort()

getConfigKeyHttpsServerKeystorePath

protected String getConfigKeyHttpsServerKeystorePath()

getConfigKeyHttpsServerKeystoreType

protected String getConfigKeyHttpsServerKeystoreType()

getConfigKeyHttpsServerKeystoreStorePass

protected String getConfigKeyHttpsServerKeystoreStorePass()

getConfigKeyHttpsServerKeystoreKeyPass

protected String getConfigKeyHttpsServerKeystoreKeyPass()

getAppProperties

protected Properties getAppProperties()

Here is the algorithm used to find the configuration file : 1) If getSpecificAppPropertiesFilePath() is not null, we use it as the path. 2) Otherwise, we try to find the configuration file next to the ".jar" itself. 3) It we didn't found the configuration file next to the ".jar" file, or if there is no .jar file (the code is running from an IDE, for example), then we fallback to the default configurations which are defined in the SpincastConfig base class.

getConfig

public String getConfig(String key)

Gets a String configuration and throws an exception if the specified key is not found.

Specified by:

getConfig in interface FreeKeyConfig

getConfig

public String getConfig(String key,
                        String defaultValue)

Gets a String configuration and uses the specified default value if the key is not found.

Specified by:

getConfig in interface FreeKeyConfig

getConfigBoolean

public Boolean getConfigBoolean(String key)

Gets a boolean configuration and throws an exception if the specified key is not found.

Specified by:

getConfigBoolean in interface FreeKeyConfig

getConfigBoolean

public Boolean getConfigBoolean(String key,
                                Boolean defaultValue)

Gets a boolean configuration and uses the specified default value if the key is not found.

Specified by:

getConfigBoolean in interface FreeKeyConfig

getConfigInteger

public Integer getConfigInteger(String key)

Gets a integer configuration and throws an exception if the specified key is not found.

Specified by:

getConfigInteger in interface FreeKeyConfig

getConfigInteger

public Integer getConfigInteger(String key,
                                Integer defaultValue)

Gets a integer configuration and uses the specified default value if the key is not found.

Specified by:

getConfigInteger in interface FreeKeyConfig

getConfig

protected Object getConfig(String key,
                           Object defaultValue,
                           boolean useDefaultValue)

Gets a configuration. If 'useDefaultValue' is false, throws an exception if the key is not found. Otherwise, returns the 'defaultValue'.

getEnvironmentName

public String getEnvironmentName()

Description copied from interface: SpincastConfig

Returns the name of the environment. The default value is local.

Specified by:

getEnvironmentName in interface SpincastConfig

Overrides:

getEnvironmentName in class SpincastConfigDefault

Returns:

the name of the environment

isDebugEnabled

public boolean isDebugEnabled()

Description copied from interface: SpincastConfig

Let this to true on development environment, where errors can be publicly displayed, where cache can be disabled, etc. In production set it to false The default value is true.

Specified by:

isDebugEnabled in interface SpincastConfig

Overrides:

isDebugEnabled in class SpincastConfigDefault

Returns:

true if debug mode is enabled.

getServerHost

public String getServerHost()

Description copied from interface: SpincastConfig

The host/IP on which the server will listen to. The default value is 0.0.0.0.

Specified by:

getServerHost in interface SpincastConfig

Overrides:

getServerHost in class SpincastConfigDefault

Returns:

the host/IP

getHttpServerPort

public int getHttpServerPort()

Description copied from interface: SpincastConfig

The HTTP (unsecure) port on which the server will listen on. If <= 0, it won't be used. The default value is 44419 so HTTP is enabled by default.

Specified by:

getHttpServerPort in interface SpincastConfig

Overrides:

getHttpServerPort in class SpincastConfigDefault

Returns:

the HTTP port

getHttpsServerPort

public int getHttpsServerPort()

Description copied from interface: SpincastConfig

The HTTPS (secure) port on which the server will listen on. If <= 0, it won't be used. The default value is -1 so HTTPS is not enabled by default.

Specified by:

getHttpsServerPort in interface SpincastConfig

Overrides:

getHttpsServerPort in class SpincastConfigDefault

Returns:

the HTTPS port

getHttpsKeyStorePath

public String getHttpsKeyStorePath()

Description copied from interface: SpincastConfig

The path to the KeyStore, for SSL. Can be a classpath path or and absolute path. The classpath will be checked first. Only used if getHttpsServerPort() returns a port > 0. The default value is null.

Specified by:

getHttpsKeyStorePath in interface SpincastConfig

Overrides:

getHttpsKeyStorePath in class SpincastConfigDefault

Returns:

the path to the KeyStore

getHttpsKeyStoreType

public String getHttpsKeyStoreType()

Description copied from interface: SpincastConfig

The type of the KeyStore, for SSL. For example: "JKS". Only used if getHttpsServerPort() returns a port > 0. The default value is null.

Specified by:

getHttpsKeyStoreType in interface SpincastConfig

Overrides:

getHttpsKeyStoreType in class SpincastConfigDefault

Returns:

the type of the KeyStore

getHttpsKeyStoreStorePass

public String getHttpsKeyStoreStorePass()

Description copied from interface: SpincastConfig

The "storepass" of the KeyStore, for SSL. Only used if getHttpsServerPort() returns a port > 0. The default value is null.

Specified by:

getHttpsKeyStoreStorePass in interface SpincastConfig

Overrides:

getHttpsKeyStoreStorePass in class SpincastConfigDefault

Returns:

the "storepass" of the KeyStore

getHttpsKeyStoreKeypass

public String getHttpsKeyStoreKeypass()

Description copied from interface: SpincastConfig

The "keypass" of the KeyStore, for SSL. Only used if getHttpsServerPort() returns a port > 0. The default value is null.

Specified by:

getHttpsKeyStoreKeypass in interface SpincastConfig

Overrides:

getHttpsKeyStoreKeypass in class SpincastConfigDefault

Returns:

the "keypass" of the KeyStore

getPublicServerSchemeHostPort

public String getPublicServerSchemeHostPort()

Description copied from class: SpincastConfigDefault

You should override this config!!!!

Specified by:

getPublicServerSchemeHostPort in interface SpincastConfig

Overrides:

getPublicServerSchemeHostPort in class SpincastConfigDefault

getQueryParamFlashMessageId

public String getQueryParamFlashMessageId()

Description copied from interface: SpincastConfig

The name of the queryString parameter to use for a Flash Message id, when cookies are not available.

Specified by:

getQueryParamFlashMessageId in interface SpincastConfig

Overrides:

getQueryParamFlashMessageId in class SpincastConfigDefault