org.pentaho.platform.api.engine
Interface ISystemSettings

All Known Implementing Classes:

PathBasedSystemSettings, SimpleSystemSettings, SystemSettings, XmlSimpleSystemSettings

public interface ISystemSettings

The SystemSettings manages the platform's overall configuration settings. These settings by default can be found in the system tree in an xml file named "pentaho.xml."

Method Summary

java.lang.String	getSystemCfgSourceName() Gets the name of the source of the system configurations.
java.lang.String	getSystemSetting(java.lang.String settingName, java.lang.String defaultValue) Gets a system setting from the system configuration file
java.lang.String	getSystemSetting(java.lang.String path, java.lang.String settingName, java.lang.String defaultValue) Gets a system setting from the system path
java.util.List	getSystemSettings(java.lang.String settingSection) Gets a section from the system system configuration file
java.util.List	getSystemSettings(java.lang.String path, java.lang.String settingSection) Gets a section from the specified settings document
org.dom4j.Document	getSystemSettingsDocument(java.lang.String actionPath) Returns a Document object containing the settings document within the path specified by actionPath.
java.util.Properties	getSystemSettingsProperties(java.lang.String path) Gets a properties file from the solution.
void	resetSettingsCache() The SystemSettings object caches each settings document once it's read in.

Method Detail

getSystemCfgSourceName

java.lang.String getSystemCfgSourceName()

Gets the name of the source of the system configurations. For system configurations that are stored in a file, it should return the filename. Other implementations should return a name that is relevant to the implementation (possibly a URL, or a database sql query, etc.) Often this will be pentaho.xml

Returns:

String containing a name that identifies the source of the system configuration

getSystemSetting

java.lang.String getSystemSetting(java.lang.String path,
                                  java.lang.String settingName,
                                  java.lang.String defaultValue)

Gets a system setting from the system path

Parameters:

path - relative to the "system" directory, go to this document

settingName - the setting name to get

defaultValue - the value to use if the setting isn't specified in the setting document

Returns:

the setting requested, or the default value if not found

getSystemSetting

java.lang.String getSystemSetting(java.lang.String settingName,
                                  java.lang.String defaultValue)

Gets a system setting from the system configuration file

Parameters:

settingName - the setting name to get

defaultValue - the value to use if the setting isn't specified in the setting document

Returns:

the setting requested, or the default value if not found

getSystemSettings

java.util.List getSystemSettings(java.lang.String path,
                                 java.lang.String settingSection)

Gets a section from the specified settings document

Parameters:

path - relative to the system directory, go to this document

settingSection - the section is the document to retrieve

Returns:

the list of settings in the specified section of the document

getSystemSettings

java.util.List getSystemSettings(java.lang.String settingSection)

Gets a section from the system system configuration file

Parameters:

settingSection - the section to retrieve

Returns:

the list of elements in the section of the document.

resetSettingsCache

void resetSettingsCache()

The SystemSettings object caches each settings document once it's read in. If the system gets a refresh event, this should be called to make sure that the system settings get refreshed.

getSystemSettingsDocument

org.dom4j.Document getSystemSettingsDocument(java.lang.String actionPath)

Returns a Document object containing the settings document within the path specified by actionPath.

Parameters:

actionPath - The XML document relative to the solution that contains the settings desired

Returns:

Document Parsed XML document.

getSystemSettingsProperties

java.util.Properties getSystemSettingsProperties(java.lang.String path)

Gets a properties file from the solution.

Parameters:

path - Relative path to the properties file within the solution

Returns:

Properties object containing the properties.