SpincastConfigPropsFileBased (org.spincast:spincast-plugins-config-properties-file 0.9.8 API)

java.lang.Object
- org.spincast.plugins.config.SpincastConfig
- - org.spincast.plugins.configpropsfile.SpincastConfigPropsFileBased

All Implemented Interfaces:

ISpincastConfig
```
public class SpincastConfigPropsFileBased
extends SpincastConfig
implements ISpincastConfig
```
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_FILE_NAME`
`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`

Constructor Summary

Constructors
Constructor and Description

SpincastConfigPropsFileBased(ISpincastUtils spincastUtils, String[] mainArgs)
Constructor

Constructors
Constructor and Description
`SpincastConfigPropsFileBased(ISpincastUtils spincastUtils, String[] mainArgs)` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
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.
`protected 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.
`protected String`	`getConfig(String key, String defaultValue)` Gets a String configuration and uses the specified default value if the key is not found.
`protected Boolean`	`getConfigBoolean(String key)` Gets a boolean configuration and throws an exception if the specified key is not found.
`protected Boolean`	`getConfigBoolean(String key, Boolean defaultValue)` Gets a boolean configuration and uses the specified default value if the key is not found.
`protected String`	`getConfigFileName()`
`protected Integer`	`getConfigInteger(String key)` Gets a integer configuration and throws an exception if the specified key is not found.
`protected 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()`
`protected String`	`getFoundPropertiesFilePath()` The path to the acutally found .properties file.
`int`	`getHttpServerPort()`
`String`	`getHttpsKeyStoreKeypass()`
`String`	`getHttpsKeyStorePath()`
`String`	`getHttpsKeyStoreStorePass()`
`String`	`getHttpsKeyStoreType()`
`int`	`getHttpsServerPort()`
`String`	`getServerHost()`
`protected String`	`getSpecificAppPropertiesFilePath()`
`protected ISpincastUtils`	`getSpincastUtils()`
`boolean`	`isDebugEnabled()`
`protected String`	`lookForPropsFileSpecificPath(String[] mainArgs)` If the properties file is not at the default location where this plugin will search for it, it is possible to simply reuturn the path here.

Methods inherited from class org.spincast.plugins.config.SpincastConfig
getContentTypesToSkipGziping, getDefaultLocale, getRouteForwardingMaxNumber, getServerMaxRequestBodyBytes, getSpincastWritableDir, isRoutesCaseSensitive

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.ISpincastConfig
getContentTypesToSkipGziping, getDefaultLocale, getRouteForwardingMaxNumber, getServerMaxRequestBodyBytes, getSpincastWritableDir, isRoutesCaseSensitive

- Field Detail
  - logger
```
protected final org.slf4j.Logger logger
```
  - APP_PROPERTIES_FILE_NAME
```
public static final String APP_PROPERTIES_FILE_NAME
```
    See Also:
    
    Constant Field Values
  - 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(ISpincastUtils spincastUtils,
                                             @Nullable
                                             String[] mainArgs)
```
    Constructor
- Method Detail
  - lookForPropsFileSpecificPath
```
protected String lookForPropsFileSpecificPath(String[] mainArgs)
```
    If the properties file is not at the default location where this plugin will search for it, it is possible to simply reuturn the path here. By default, if a main arg as been pased when starting the applciation, we considere it as the path to the configuration file. You could also override this to use a envrironment variable to specify the path, for example.
    
    Returns:
    
    the path to the configuration file or NULL to let the plugin search for it on the default locations.
  - getSpincastUtils
```
protected ISpincastUtils getSpincastUtils()
```
  - getSpecificAppPropertiesFilePath
```
protected String getSpecificAppPropertiesFilePath()
```
  - getFoundPropertiesFilePath
```
protected String getFoundPropertiesFilePath()
```
    The path to the acutally found .properties file.
    
    Returns:
    
    the path of the file or null if none was found.
  - getConfigFileName
```
protected String getConfigFileName()
```
  - 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
```
protected String getConfig(String key)
```
    Gets a String configuration and throws an exception if the specified key is not found.
  - getConfig
```
protected String getConfig(String key,
                           String defaultValue)
```
    Gets a String configuration and uses the specified default value if the key is not found.
  - getConfigBoolean
```
protected Boolean getConfigBoolean(String key)
```
    Gets a boolean configuration and throws an exception if the specified key is not found.
  - getConfigBoolean
```
protected Boolean getConfigBoolean(String key,
                                   Boolean defaultValue)
```
    Gets a boolean configuration and uses the specified default value if the key is not found.
  - getConfigInteger
```
protected Integer getConfigInteger(String key)
```
    Gets a integer configuration and throws an exception if the specified key is not found.
  - getConfigInteger
```
protected Integer getConfigInteger(String key,
                                   Integer defaultValue)
```
    Gets a integer configuration and uses the specified default value if the key is not found.
  - 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()
```
    Specified by:
    
    getEnvironmentName in interface ISpincastConfig
    
    Overrides:
    
    getEnvironmentName in class SpincastConfig
  - isDebugEnabled
```
public boolean isDebugEnabled()
```
    Specified by:
    
    isDebugEnabled in interface ISpincastConfig
    
    Overrides:
    
    isDebugEnabled in class SpincastConfig
  - getServerHost
```
public String getServerHost()
```
    Specified by:
    
    getServerHost in interface ISpincastConfig
    
    Overrides:
    
    getServerHost in class SpincastConfig
  - getHttpServerPort
```
public int getHttpServerPort()
```
    Specified by:
    
    getHttpServerPort in interface ISpincastConfig
    
    Overrides:
    
    getHttpServerPort in class SpincastConfig
  - getHttpsServerPort
```
public int getHttpsServerPort()
```
    Specified by:
    
    getHttpsServerPort in interface ISpincastConfig
    
    Overrides:
    
    getHttpsServerPort in class SpincastConfig
  - getHttpsKeyStorePath
```
public String getHttpsKeyStorePath()
```
    Specified by:
    
    getHttpsKeyStorePath in interface ISpincastConfig
    
    Overrides:
    
    getHttpsKeyStorePath in class SpincastConfig
  - getHttpsKeyStoreType
```
public String getHttpsKeyStoreType()
```
    Specified by:
    
    getHttpsKeyStoreType in interface ISpincastConfig
    
    Overrides:
    
    getHttpsKeyStoreType in class SpincastConfig
  - getHttpsKeyStoreStorePass
```
public String getHttpsKeyStoreStorePass()
```
    Specified by:
    
    getHttpsKeyStoreStorePass in interface ISpincastConfig
    
    Overrides:
    
    getHttpsKeyStoreStorePass in class SpincastConfig
  - getHttpsKeyStoreKeypass
```
public String getHttpsKeyStoreKeypass()
```
    Specified by:
    
    getHttpsKeyStoreKeypass in interface ISpincastConfig
    
    Overrides:
    
    getHttpsKeyStoreKeypass in class SpincastConfig

Class SpincastConfigPropsFileBased

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

logger

APP_PROPERTIES_FILE_NAME

APP_PROPERTIES_KEY_ENVIRONMENT_NAME

APP_PROPERTIES_KEY_ENVIRONMENT_IS_DEBUG

APP_PROPERTIES_KEY_SERVER_HOST

APP_PROPERTIES_KEY_HTTP_SERVER_PORT

APP_PROPERTIES_KEY_HTTPS_SERVER_PORT

APP_PROPERTIES_KEY_HTTPS_SERVER_KEYSTORE_PATH

APP_PROPERTIES_KEY_HTTPS_SERVER_KEYSTORE_TYPE

APP_PROPERTIES_KEY_HTTPS_SERVER_KEYSTORE_STOREPASS

APP_PROPERTIES_KEY_HTTPS_SERVER_KEYSTORE_KEYPASS

Constructor Detail

SpincastConfigPropsFileBased

Method Detail

lookForPropsFileSpecificPath

getSpincastUtils

getSpecificAppPropertiesFilePath

getFoundPropertiesFilePath

getConfigFileName

getConfigKeyEnvironmentName

getConfigKeyEnvironmentIsDebug

getConfigKeyServerHost

getConfigKeyHttpServerPort

getConfigKeyHttpsServerPort

getConfigKeyHttpsServerKeystorePath

getConfigKeyHttpsServerKeystoreType

getConfigKeyHttpsServerKeystoreStorePass

getConfigKeyHttpsServerKeystoreKeyPass

getAppProperties

getConfig

getConfig

getConfigBoolean

getConfigBoolean

getConfigInteger

getConfigInteger

getConfig

getEnvironmentName

isDebugEnabled

getServerHost

getHttpServerPort

getHttpsServerPort

getHttpsKeyStorePath

getHttpsKeyStoreType

getHttpsKeyStoreStorePass

getHttpsKeyStoreKeypass