Config (mangooio-core 3.6.0 API)

java.lang.Object
- io.mangoo.configuration.Config

```
public class Config
extends Object
```
Main configuration class for all properties configured in application.yaml

Author:

svenkubiak, williamdunne

Constructor Summary

Constructors
Constructor and Description

Config()

Config(String configFile, Mode mode)

Constructors
Constructor and Description
`Config()`
`Config(String configFile, Mode mode)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`decrypt()` Decrypts all encrypted config value
`String`	`getAdminAuthenticationPassword()`
`String`	`getAdminAuthenticationUser()`
`Map<String,String>`	`getAllConfigurations()`
`String`	`getApplicationHost()`
`String`	`getApplicationLanguage()`
`String`	`getApplicationName()`
`int`	`getApplicationPort()`
`String`	`getApplicationSecret()`
`String`	`getAssetsPath()`
`String`	`getAuthCookieVersion()`
`String`	`getAuthenticationCookieName()`
`long`	`getAuthenticationExpires()`
`long`	`getAuthenticationRememberExpires()`
`boolean`	`getBoolean(Key key)` Retrieves a configuration value with the given key constant (e.g.
`boolean`	`getBoolean(Key key, boolean defaultValue)` Retrieves a configuration value with the given key constant (e.g.
`boolean`	`getBoolean(String key)` Retrieves a configuration value with the given key
`boolean`	`getBoolean(String key, boolean defaultValue)` Retrieves a configuration value with the given key
`String`	`getCacheAddresses()`
`String`	`getCacheClass()`
`String`	`getControllerPackage()`
`String`	`getCookieVersion()`
`int`	`getExecutionPool()`
`String`	`getFlashCookieName()`
`String`	`getI18nCookieName()`
`int`	`getInt(Key key)` Retrieves a configuration value with the given key constant (e.g.
`int`	`getInt(Key key, int defaultValue)` Retrieves a configuration value with the given key constant (e.g.
`int`	`getInt(String key)` Retrieves a configuration value with the given key
`int`	`getInt(String key, int defaultValue)` Retrieves a configuration value with the given key
`String`	`getJwtsEncryptionKey()`
`String`	`getJwtsSignKey()`
`long`	`getLong(Key key)` Retrieves a configuration value with the given key constant (e.g.
`long`	`getLong(Key key, long defaultValue)` Retrieves a configuration value with the given key constant (e.g.
`long`	`getLong(String key)` Retrieves a configuration value with the given key
`long`	`getLong(String key, long defaultValue)` Retrieves a configuration value with the given key
`String`	`getMasterKey()`
`String`	`getSchedulerPackage()`
`String`	`getSessionCookieName()`
`long`	`getSessionExpires()`
`String`	`getSmtpFrom()`
`String`	`getSmtpHost()`
`String`	`getSmtpPassword()`
`int`	`getSmtpPort()`
`String`	`getSmtpUsername()`
`String`	`getString(Key key)` Retrieves a configuration value with the given key constant (e.g.
`String`	`getString(Key key, String defaultValue)` Retrieves a configuration value with the given key constant (e.g.
`String`	`getString(String key)` Retrieves a configuration value with the given key
`String`	`getString(String key, String defaultValue)` Retrieves a configuration value with the given key
`String`	`getTemplateEngineClass()`
`boolean`	`hasValidSecret()` Checks if the application.conf stored in conf/application.conf contains an application secret property (application.secret) that has at least 16 characters (128-Bit)
`boolean`	`isAdminEnabled()`
`boolean`	`isAuthenticationCookieEncrypt()`
`boolean`	`isAuthenticationCookieSecure()`
`boolean`	`isEncrypted(String value)` Checks if a value is encrypt by checking for the prefix crpytex
`boolean`	`isFlashCookieSecure()`
`boolean`	`isJwtsEncrypted()`
`boolean`	`isMinifyCSS()`
`boolean`	`isMinifyJS()`
`boolean`	`isPreprocessLess()`
`boolean`	`isPreprocessSass()`
`boolean`	`isSchedulerAutostart()`
`boolean`	`isSessionCookieEncrypt()`
`boolean`	`isSessionCookieSecure()`
`boolean`	`isSmtpSSL()`
`boolean`	`isTimerEnabled()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Config
```
public Config()
```
  - Config
```
public Config(String configFile,
              Mode mode)
```
- Method Detail
  - decrypt
```
public void decrypt()
```
    Decrypts all encrypted config value
  - getMasterKey
```
public String getMasterKey()
```
    Returns:
    
    The master key for encrypted config value, returns a default value if in test mode
  - isEncrypted
```
public boolean isEncrypted(String value)
```
    Checks if a value is encrypt by checking for the prefix crpytex
    
    Parameters:
    
    value - The value to check
    
    Returns:
    
    True if the value starts with cryptex, false othweise
  - getString
```
public String getString(String key)
```
    Retrieves a configuration value with the given key
    
    Parameters:
    
    key - The key of the configuration value (e.g. application.name)
    
    Returns:
    
    The configured value as String or null if the key is not configured
  - getString
```
public String getString(String key,
                        String defaultValue)
```
    Retrieves a configuration value with the given key
    
    Parameters:
    
    key - The key of the configuration value (e.g. application.name)
    
    defaultValue - The default value to return of no key is found
    
    Returns:
    
    The configured value as String or the passed defautlValue if the key is not configured
  - getInt
```
public int getInt(String key)
```
    Retrieves a configuration value with the given key
    
    Parameters:
    
    key - The key of the configuration value (e.g. application.name)
    
    Returns:
    
    The configured value as int or 0 if the key is not configured
  - getLong
```
public long getLong(String key)
```
    Retrieves a configuration value with the given key
    
    Parameters:
    
    key - The key of the configuration value (e.g. application.name)
    
    Returns:
    
    The configured value as long or 0 if the key is not configured
  - getLong
```
public long getLong(String key,
                    long defaultValue)
```
    Retrieves a configuration value with the given key
    
    Parameters:
    
    key - The key of the configuration value (e.g. application.name)
    
    defaultValue - The default value to return of no key is found
    
    Returns:
    
    The configured value as int or the passed defautlValue if the key is not configured
  - getInt
```
public int getInt(String key,
                  int defaultValue)
```
    Retrieves a configuration value with the given key
    
    Parameters:
    
    key - The key of the configuration value (e.g. application.name)
    
    defaultValue - The default value to return of no key is found
    
    Returns:
    
    The configured value as int or the passed defautlValue if the key is not configured
  - getBoolean
```
public boolean getBoolean(String key)
```
    Retrieves a configuration value with the given key
    
    Parameters:
    
    key - The key of the configuration value (e.g. application.name)
    
    Returns:
    
    The configured value as boolean or false if the key is not configured
  - getBoolean
```
public boolean getBoolean(String key,
                          boolean defaultValue)
```
    Retrieves a configuration value with the given key
    
    Parameters:
    
    key - The key of the configuration value (e.g. application.name)
    
    defaultValue - The default value to return of no key is found
    
    Returns:
    
    The configured value as boolean or the passed defautlValue if the key is not configured
  - getString
```
public String getString(Key key)
```
    Retrieves a configuration value with the given key constant (e.g. Key.APPLICATION_NAME)
    
    Parameters:
    
    key - The key of the configuration value (e.g. application.name)
    
    Returns:
    
    The configured value as String or null if the key is not configured
  - getString
```
public String getString(Key key,
                        String defaultValue)
```
    Retrieves a configuration value with the given key constant (e.g. Key.APPLICATION_NAME)
    
    Parameters:
    
    key - The key of the configuration value (e.g. application.name)
    
    defaultValue - The default value to return of no key is found
    
    Returns:
    
    The configured value as String or the passed defautlValue if the key is not configured
  - getLong
```
public long getLong(Key key)
```
    Retrieves a configuration value with the given key constant (e.g. Key.APPLICATION_NAME)
    
    Parameters:
    
    key - The key of the configuration value (e.g. application.name)
    
    Returns:
    
    The configured value as long or null if the key is not configured
  - getLong
```
public long getLong(Key key,
                    long defaultValue)
```
    Retrieves a configuration value with the given key constant (e.g. Key.APPLICATION_NAME)
    
    Parameters:
    
    key - The key of the configuration value (e.g. application.name)
    
    defaultValue - The default value to return of no key is found
    
    Returns:
    
    The configured value as long or the passed defautlValue if the key is not configured
  - getInt
```
public int getInt(Key key)
```
    Retrieves a configuration value with the given key constant (e.g. Key.APPLICATION_NAME)
    
    Parameters:
    
    key - The key of the configuration value (e.g. application.name)
    
    Returns:
    
    The configured value as int or 0 if the key is not configured
  - getInt
```
public int getInt(Key key,
                  int defaultValue)
```
    Retrieves a configuration value with the given key constant (e.g. Key.APPLICATION_NAME)
    
    Parameters:
    
    key - The key of the configuration value (e.g. application.name)
    
    defaultValue - The default value to return of no key is found
    
    Returns:
    
    The configured value as int or the passed defautlValue if the key is not configured
  - getBoolean
```
public boolean getBoolean(Key key)
```
    Retrieves a configuration value with the given key constant (e.g. Key.APPLICATION_NAME)
    
    Parameters:
    
    key - The key of the configuration value (e.g. application.name)
    
    Returns:
    
    The configured value as boolean or false if the key is not configured
  - getBoolean
```
public boolean getBoolean(Key key,
                          boolean defaultValue)
```
    Retrieves a configuration value with the given key constant (e.g. Key.APPLICATION_NAME)
    
    Parameters:
    
    key - The key of the configuration value (e.g. application.name)
    
    defaultValue - The default value to return of no key is found
    
    Returns:
    
    The configured value as boolean or the passed defautlValue if the key is not configured
  - getAllConfigurations
```
public Map<String,String> getAllConfigurations()
```
    Returns:
    
    All configuration options of the current environment
  - hasValidSecret
```
public boolean hasValidSecret()
```
    Checks if the application.conf stored in conf/application.conf contains an application secret property (application.secret) that has at least 16 characters (128-Bit)
    
    Returns:
    
    True if the configuration contains an application.secret property with at least 16 characters
  - getApplicationName
```
public String getApplicationName()
```
    Returns:
    
    application.name from application.yaml
  - getApplicationHost
```
public String getApplicationHost()
```
    Returns:
    
    application.host from application.yaml
  - getApplicationPort
```
public int getApplicationPort()
```
    Returns:
    
    appliction.port from application.yaml
  - getFlashCookieName
```
public String getFlashCookieName()
```
    Returns:
    
    default name of flash cookie name
  - getSessionCookieName
```
public String getSessionCookieName()
```
    Returns:
    
    cookie.name from application.yaml or default value if undefined
  - getApplicationSecret
```
public String getApplicationSecret()
```
    Returns:
    
    application.secret from application.yaml
  - getAuthenticationCookieName
```
public String getAuthenticationCookieName()
```
    Returns:
    
    auth.cookie.name from application.yaml or default value if undefined
  - getAuthenticationExpires
```
public long getAuthenticationExpires()
```
    Returns:
    
    auth.cookie.expires from application.yaml or default value if undefined
  - getSessionExpires
```
public long getSessionExpires()
```
    Returns:
    
    cookie.expires from application.yaml or default value if undefined
  - isSessionCookieSecure
```
public boolean isSessionCookieSecure()
```
    Returns:
    
    cookie.secure from application.yaml or default value if undefined
  - isAuthenticationCookieSecure
```
public boolean isAuthenticationCookieSecure()
```
    Returns:
    
    auth.cookie.secure from application.yaml or default value if undefined
  - getI18nCookieName
```
public String getI18nCookieName()
```
    Returns:
    
    cookie.i18n.name from application.yaml or default value if undefined
  - isFlashCookieSecure
```
public boolean isFlashCookieSecure()
```
    Returns:
    
    same value as isSessionCookieSecure()
  - getApplicationLanguage
```
public String getApplicationLanguage()
```
    Returns:
    
    application.language from application.yaml or default value if undefined
  - isAuthenticationCookieEncrypt
```
public boolean isAuthenticationCookieEncrypt()
```
    Returns:
    
    auth.cookie.encrypt from application.yaml or default value if undefined
  - getAuthCookieVersion
```
public String getAuthCookieVersion()
```
    Returns:
    
    auth.cookie.version from application.yaml or default value if undefined
  - getCookieVersion
```
public String getCookieVersion()
```
    Returns:
    
    cookie.version from application.yaml or default value if undefined
  - isSchedulerAutostart
```
public boolean isSchedulerAutostart()
```
    Returns:
    
    scheduler.autostart from application.yaml or default value if undefined
  - getAdminAuthenticationUser
```
public String getAdminAuthenticationUser()
```
    Returns:
    
    application.admin.username from application.yaml or null if undefined
  - getAdminAuthenticationPassword
```
public String getAdminAuthenticationPassword()
```
    Returns:
    
    application.admin.password from application.yaml or null if undefined
  - getSchedulerPackage
```
public String getSchedulerPackage()
```
    Returns:
    
    scheduler.package from application.yaml or default value if undefined
  - isSessionCookieEncrypt
```
public boolean isSessionCookieEncrypt()
```
    Returns:
    
    cookie.encryption from application.yaml or default value if undefined
  - getAuthenticationRememberExpires
```
public long getAuthenticationRememberExpires()
```
    Returns:
    
    auth.cookie.remember.expires from application.yaml or default value if undefined
  - getExecutionPool
```
public int getExecutionPool()
```
    Returns:
    
    execution.threadpool from application.yaml or default value if undefined
  - getControllerPackage
```
public String getControllerPackage()
```
    Returns:
    
    application.controller from application.yaml or default value if undefined
  - isTimerEnabled
```
public boolean isTimerEnabled()
```
    Returns:
    
    application.timer from application.yaml or default value if undefined
  - getCacheClass
```
public String getCacheClass()
```
    Returns:
    
    cache.class from application.yaml or default value if undefined
  - getCacheAddresses
```
public String getCacheAddresses()
```
    Returns:
    
    cache.addresses from application.yaml
  - getTemplateEngineClass
```
public String getTemplateEngineClass()
```
    Returns:
    
    templateengine.class from application.yaml
  - isMinifyJS
```
public boolean isMinifyJS()
```
    Returns:
    
    application.minify.js or default value if undefined
  - isMinifyCSS
```
public boolean isMinifyCSS()
```
    Returns:
    
    application.minify.css or default value if undefined
  - isPreprocessSass
```
public boolean isPreprocessSass()
```
    Returns:
    
    application.preprocess.sass or default value if undefined
  - isPreprocessLess
```
public boolean isPreprocessLess()
```
    Returns:
    
    application.preprocess.less or default value if undefined
  - getAssetsPath
```
public String getAssetsPath()
```
    Returns:
    
    application.assets.path (for testing purposes only)
  - isAdminEnabled
```
public boolean isAdminEnabled()
```
    Returns:
    
    application.admin.enable or default value if undefined
  - getSmtpHost
```
public String getSmtpHost()
```
    Returns:
    
    smtp.host or default value if undefined
  - getSmtpPort
```
public int getSmtpPort()
```
    Returns:
    
    smtp.port or default value if undefined
  - isSmtpSSL
```
public boolean isSmtpSSL()
```
    Returns:
    
    smtp.ssl or default value if undefined
  - getSmtpUsername
```
public String getSmtpUsername()
```
    Returns:
    
    smtp.username or null value if undefined
  - getSmtpPassword
```
public String getSmtpPassword()
```
    Returns:
    
    smtp.username or null value if undefined
  - getSmtpFrom
```
public String getSmtpFrom()
```
    Returns:
    
    smtp.from or default value if undefined
  - getJwtsSignKey
```
public String getJwtsSignKey()
```
    Returns:
    
    application.jwt.signkey
  - isJwtsEncrypted
```
public boolean isJwtsEncrypted()
```
    Returns:
    
    application.jwt.encrypt
  - getJwtsEncryptionKey
```
public String getJwtsEncryptionKey()
```
    Returns:
    
    application.jwt.encryptionkey

Class Config

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Config

Config

Method Detail

decrypt

getMasterKey

isEncrypted

getString

getString

getInt

getLong

getLong

getInt

getBoolean

getBoolean

getString

getString

getLong

getLong

getInt

getInt

getBoolean

getBoolean

getAllConfigurations

hasValidSecret

getApplicationName

getApplicationHost

getApplicationPort

getFlashCookieName

getSessionCookieName

getApplicationSecret

getAuthenticationCookieName

getAuthenticationExpires

getSessionExpires

isSessionCookieSecure

isAuthenticationCookieSecure

getI18nCookieName

isFlashCookieSecure

getApplicationLanguage

isAuthenticationCookieEncrypt

getAuthCookieVersion

getCookieVersion

isSchedulerAutostart

getAdminAuthenticationUser

getAdminAuthenticationPassword

getSchedulerPackage

isSessionCookieEncrypt

getAuthenticationRememberExpires

getExecutionPool

getControllerPackage

isTimerEnabled

getCacheClass

getCacheAddresses

getTemplateEngineClass

isMinifyJS

isMinifyCSS

isPreprocessSass

isPreprocessLess

getAssetsPath

isAdminEnabled

getSmtpHost

getSmtpPort

isSmtpSSL

getSmtpUsername

getSmtpPassword

getSmtpFrom

getJwtsSignKey

isJwtsEncrypted

getJwtsEncryptionKey