Description

• org.joget.commons.util.SetupManager
• Under wflow-commons module
• Service method used to manage system settings

Code Sample

import org.joget.commons.util.SetupManager;
import org.joget.apps.app.service.AppUtil;
 
SetupManager setupManager = (SetupManager) AppUtil.getApplicationContext().getBean("setupManager");
 
//Get the system setting
String systemDateFormat = setupManager.getSettingValue("systemDateFormat");

Fields

DIRECTORY_PROFILES

public static final java.lang.String DIRECTORY_PROFILES = "app_profiles";

MASTER_LOGIN_PASSWORD

public static final java.lang.String MASTER_LOGIN_PASSWORD = "masterLoginPassword";

Property key use to retrieve the password of a master login

SECURE_VALUE

public static final java.lang.String SECURE_VALUE = "****SECURE VALUE*****";

A dummy value used to replace password when render to the user. 

SYSTEM_PROPERTY_WFLOW_HOME

public static final java.lang.String SYSTEM_PROPERTY_WFLOW_HOME = "wflow.home";

A system property used to set the directory of wflow folder.

Methods

clearCache

public void clearCache()

Method used by system to clear cache

deleteSetting

public void deleteSetting(java.lang.String property)

Delete system setting by property key.

getBaseDirectory

public static java.lang.String getBaseDirectory()

Gets the path of base storing folder for a profile

getBaseSharedDirectory

public static java.lang.String getBaseSharedDirectory()

Gets the path of wflow folder

getSettingByProperty

public org.joget.commons.spring.model.Setting getSettingByProperty(java.lang.String property)

Gets system setting by property key. Cached if possible.

getSettingList

public java.util.Collection<org.joget.commons.spring.model.Setting> getSettingList(java.lang.String propertyFilter, java.lang.String sort, java.lang.Boolean desc, java.lang.Integer start, java.lang.Integer rows)

Retrieve a list of System settings based on search criteria

getSettingValue

public java.lang.String getSettingValue(java.lang.String property)

Gets the system setting value by property key. Cached if possible.

getSetupDao

public org.joget.commons.util.SetupDao getSetupDao()

Method used by system to gets the SetupDao implementation

refreshCache

public void refreshCache()

Method used by system to refresh cache 

saveSetting

public void saveSetting(org.joget.commons.spring.model.Setting setting)

Save a system setting

setCache

public void setCache(net.sf.ehcache.Cache cache)

Method used by system to set cache object

setSetupDao

public void setSetupDao(org.joget.commons.util.SetupDao setupDao)

Method used by system to sets the SetupDao implementation