com.esf.core.configuration.webui.service
Interface IEsfConfigurationWebUiService


public interface IEsfConfigurationWebUiService


Field Summary
static java.lang.String SERVICE_NAME
          Reports the class name representing this interface.
 
Method Summary
 java.util.Hashtable convertConfig(java.util.Properties propsFromHtml)
          converts the configuration from a 'html properties object' to a 'configuration manager object'.
 java.lang.String provideHtml()
          provides the HTML code for this given component to the Felix Webconsole
 void updateLocalConfiguration()
          notifies the implementation of the IEsfConfigurationWebUiService that it should update any configurable parameters with the current values.
 

Field Detail

SERVICE_NAME

static final java.lang.String SERVICE_NAME
Reports the class name representing this interface.

Method Detail

provideHtml

java.lang.String provideHtml()
provides the HTML code for this given component to the Felix Webconsole

Returns:
HTML code that describes this components configuration

convertConfig

java.util.Hashtable convertConfig(java.util.Properties propsFromHtml)
converts the configuration from a 'html properties object' to a 'configuration manager object'. The argument propsFromHtml object contains the keys that are the HTML parameters as entered by the user. The object to be returned is a Hashtable where the keys represent the symbolic names of the components to be configured and the values are the Objects representing the configurations for their respective components.

Parameters:
propsFromHtml - the Properties object where the keys are the HTML parameters and the values are those entered in by the user at the webconsole
Returns:
a Hashtable representing the configurations to be stored by the configuration manager. The keys must be the symbolic names of the components to be configured and the values are their respective configurations.

updateLocalConfiguration

void updateLocalConfiguration()
notifies the implementation of the IEsfConfigurationWebUiService that it should update any configurable parameters with the current values. This is called by the Felix Web Console immediately after a bundle is updated. It calls this method to make sure that the new values displayed in the Web UI will be up to date with the proper ones. This only gets called if the configuration was successful.