com.esf.core.configuration.service
Interface IConfigurableComponentService
public interface IConfigurableComponentService
An interface to allows bundles which may need to be configured access to the @IConfigurationManagerService.
This allows implementers of this bundle to be configured via the @IConfigurationManagerService
Copyright (c) 2009 Eurotech Inc. All rights reserved.
Field Summary |
static java.lang.String |
SERVICE_NAME
Reports the class name representing this interface. |
Method Summary |
java.lang.Object |
receiveConfig(java.lang.Object config)
Receives a configuration from the configuration manager. |
SERVICE_NAME
static final java.lang.String SERVICE_NAME
- Reports the class name representing this interface.
receiveConfig
java.lang.Object receiveConfig(java.lang.Object config)
throws EsfConfigurationException
- Receives a configuration from the configuration manager. Upon receiving it, implementors
of this method should return an @Object representing the complete new valid configuration.
If the configuration is deemed invalid by the implementor of this service null should
be returned.
When the configuration is deemed valid and returned as an @Object representing the
configuration the Configuration Manager will store it in the archive. This is the
configuration that will be passed back at ESF startup time.
If the configuration is deemed to be invalid by the bundle implementing the
- Parameters:
config
- The new configuration to be validated and put into effect
- Returns:
- An @Object representing the complete new configuration if it is valid,
otherwise null should be returned
- Throws:
EsfConfigurationException