com.esf.core.configuration.service

Interface IConfigurableComponentService

All Known Subinterfaces:

IEncryptedConfigurableComponentService

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

Fields

Modifier and Type	Field and Description
static java.lang.String	SERVICE_NAME Reports the class name representing this interface.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	receiveConfig(java.lang.Object config) Receives a configuration from the configuration manager.

Field Detail

SERVICE_NAME

static final java.lang.String SERVICE_NAME

Reports the class name representing this interface.

Method Detail

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 valid, but the application does not wish to have it archived, null should be returned. If the configuration is deemed to be invalid by the bundle implementing the IConfigurableComponentService an EsfConfigurationException should be thrown which and no previously archived configuration will be affected. It is also important to note that upon receipt of a valid configuration the Configuration Manager will publish a message on EventAdmin with the topic com/esf/core/configuration/service/new/ and the payload will be the bundle ID of the bundle that accepted its configuration. Note this will occur even if the bundle implementing the IConfigurableComponentService returns a null configuration. The only reason this will not occur is if the bundle throws an EsfConfigurationException.

Parameters:

config - The new configuration to be validated and put into effect

Returns:

An Object representing the valid new configuration to archive or null

Throws:

{@link - EsfConfigurationException}

EsfConfigurationException