org.pentaho.platform.api.engine
Interface IConfiguredPojo

All Known Subinterfaces:

IConfiguredPojo

public interface IConfiguredPojo

The interface for a POJO component that wants access to system settings. This is an optional interface.

Author:

jamesdixon

Method Summary

boolean	configure(java.util.Map<java.lang.String,java.lang.String> props) Sets the configuration settings that were requested via a call to getConfigSettingsPaths().
java.util.Set<java.lang.String>	getConfigSettingsPaths() Returns a list of Strings that define system settings that a POJO component would like read for it.

Method Detail

getConfigSettingsPaths

java.util.Set<java.lang.String> getConfigSettingsPaths()

Returns a list of Strings that define system settings that a POJO component would like read for it. The strings are expected to be in the format of : folder/file{setting path} e.g. "smtp-email/email_config.xml{email-smtp/properties/mail.smtp.host}"

Returns:

List of configuration settings paths

configure

boolean configure(java.util.Map<java.lang.String,java.lang.String> props)

Sets the configuration settings that were requested via a call to getConfigSettingsPaths(). The keys of the map will be the Strings that were returned by the call to getConfigSettingsPaths. e.g. "smtp-email/email_config.xml{email-smtp/properties/mail.smtp.host}" -> "myhost.com"

Parameters:

props -

Returns: