6.x
For Newbies
Getting Started
HMVC
Digging Deeper
Architecture Concepts
External links
System Settings (Java Properties and Environment Variables)
ColdBox makes it easy to access the configuration stored in your Java system properties and your server's environment variables, even if you don't know which one it is in! Three methods are provided for your convenience:
Name
Arguments
Description
getSystemSetting( key, defaultValue )Looks for
key in properties first, env second. Returns the defaultValue if neither exist.getSystemProperty( key, defaultValue )Returns the Java System property for
key. Returns the defaultValue if it does not exist.getEnv( key, defaultValue )Returns the server environment variable for
key. Returns the defaultValue if it does not exist.Accessing System Settings in config/ColdBox.cfc or a ModuleConfig.cfc
config/ColdBox.cfc or a ModuleConfig.cfcIf you are inside
config/ColdBox.cfc or a ModuleConfig.cfc or a config/WireBox.cfc you can use the three system settings functions directly! No additional work required.Accessing System Settings in Application.cfc
Application.cfcIf you would like to access these methods in your
Application.cfc, create an instance of coldbox.system.core.util.Util and access them off of that component. This is required when adding a datasource from environment variables.Example:
Application.cfc
1
component {
2
​
3
variables.util = new coldbox.system.core.util.Util();
4
​
5
this.datasources[ "my_datasource" ] = {
6
driver = util.getSystemSetting( "DB_DRIVER" ),
7
host = util.getSystemSetting( "DB_HOST" ),
8
port = util.getSystemSetting( "DB_PORT" ),
9
database = util.getSystemSetting( "DB_DATABASE" ),
10
username = util.getSystemSetting( "DB_USERNAME" ),
11
password = util.getSystemSetting( "DB_PASSWORD" )
12
};
13
​
14
}
Copied!
Accessing System Settings in other files
If you need to access these configuration values in other components, consider adding the values to your ColdBox settings and injecting the values into your other components via dependency injection.​
Last modified 11mo ago