|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IConfigurationManagerService
The Configuration Manager Service provides an API for software components to request and store configuration data as well as request that configurations be archived within the Configuration Manager. Copyright © 2009 Eurotech Inc. All rights reserved.
Field Summary | |
---|---|
static java.lang.String |
NEW_CONFIGURATION_TOPIC_BASE
A static string representing the base topic that is published when a bundle accepts a new configuration by not throwing an EsfConfigurationException. |
static java.lang.String |
SERVICE_NAME
Reports the class name representing this interface. |
Method Summary | |
---|---|
boolean |
configChangePending(java.lang.String name)
This method is used to find out if the configuration manager has sent a new configuration to a component and is waiting for a response. |
java.lang.Object |
getConfiguration(java.lang.String name)
This method returns a configuration @Object. |
java.lang.Object |
rejectConfiguration(java.lang.String name)
Deprecated. As of ESF 1.1.0 replaced by This method is used to inform that Configuration Manager that a component has rejected a configuration. A component must specify a String representing its symbolic name. The Configuration Manager will then issue a configuration error corresponding to the specified component and return a Configuration Object representing the most recent stored configuration in the archive. If no stored or default configuration exists in the archive, the method will return null |
void |
requestConfigurationUpdate(java.lang.String name)
This method is used to request an update of a configuration from the configuration source/back-end. |
void |
storeConfiguration(java.lang.String name)
Deprecated. As of ESF 1.1.0 replaced by This method is used to inform that Configuration Manager that the last supplied configuration @Object was accepted and should be stored in the archive. The Configuration Manager will then store the configuration @Object as in the archive as the current configuration. |
void |
storeConfiguration(java.lang.String name,
IConfigurableComponentService configurableComponent,
long bundleId,
java.lang.Object config)
This is used to store a configuration from a given configurable component. |
Field Detail |
---|
static final java.lang.String SERVICE_NAME
static final java.lang.String NEW_CONFIGURATION_TOPIC_BASE
Method Detail |
---|
java.lang.Object getConfiguration(java.lang.String name)
name
- A @String representing the symbolic name of the requesting component.
void requestConfigurationUpdate(java.lang.String name)
name
- A @String representing the symbolic name of the requesting component.java.lang.Object rejectConfiguration(java.lang.String name)
name
- A @String representing the symbolic name of the rejecting component.
void storeConfiguration(java.lang.String name)
name
- A @String representing the symbolic name of the requesting component.void storeConfiguration(java.lang.String name, IConfigurableComponentService configurableComponent, long bundleId, java.lang.Object config) throws java.lang.Exception
name
- the symbolic name of the bundle to be configuredconfigurableComponent
- the instance of the configurable componentbundleId
- the bundle id of the bundle being configuredconfig
- the configuration to be stored
java.lang.Exception
- if the configuration can not be storedboolean configChangePending(java.lang.String name)
name
- A @String representing the symbolic name of the requesting component.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |