public interface IConfigurationManagerService
Modifier and Type | Field and Description |
---|---|
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.
|
Modifier and Type | Method and Description |
---|---|
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.util.zip.ZipFile |
getAllEsfConfig()
returns a zip file in the form of a TypedConfigurationData.TCD_FILE_ZIP_1 will be created and
returned to the called.
|
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
IConfigurableComponentService
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
IConfigurableComponentService
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.
|
static final java.lang.String SERVICE_NAME
static final java.lang.String NEW_CONFIGURATION_TOPIC_BASE
Object
representing its config to be archived, this event will be published along
with a payload that includes the bundle ID that has accepted its configuration. This
should be used by bundles that are interested in configuration change events.
The bundle ID is the number assigned to the component bundle when installed in OSGi.
A component can obtain it's bundle ID by methods supplied by the BundleContext class.java.lang.Object getConfiguration(java.lang.String name)
Object
. The component must specify a String
representing its symbolic name. The configuration Object
will contain the current
configuration data stored in the manager for the specified component. A component will
use this method to obtain a new configuration after receiving a new configuration
event.name
- A String
representing the symbolic name of the requesting component.Object
containing typed configuration data. null if no
configuration exists.void requestConfigurationUpdate(java.lang.String name)
Object
containing the updated configuration data.name
- A String
representing the symbolic name of the requesting component.java.lang.Object rejectConfiguration(java.lang.String name)
IConfigurableComponentService
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 nullname
- A String
representing the symbolic name of the rejecting component.Object
containing typed configuration data. Null if no
configuration exists.void storeConfiguration(java.lang.String name)
IConfigurableComponentService
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.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
IConfigurableComponentService
that is updating its configurationname
- 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 storedjava.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.java.util.zip.ZipFile getAllEsfConfig() throws java.lang.Exception
java.lang.Exception
- If the configuration can not be acquired.Copyright © 2009 Eurotech Inc. All rights reserved.