org.eclipse.scada.ca

Interface ConfigurationAdministrator

All Known Subinterfaces:

FreezableConfigurationAdministrator

All Known Implementing Classes:

AbstractConfigurationAdministrator, ConfigurationAdminImpl, ConfigurationAdministratorImpl

public interface ConfigurationAdministrator

Field Summary

Fields

Modifier and Type	Field and Description
static String	FACTORY_ID

Method Summary

Methods

Modifier and Type	Method and Description
NotifyFuture<Void>	applyDiff(UserInformation userInformation, Collection<DiffEntry> changeSet) Applies a change set to an existing configuration manager.
NotifyFuture<Configuration>	createConfiguration(UserInformation userInformation, String factoryId, String configurationId, Map<String,String> initialProperties)
NotifyFuture<Configuration>	deleteConfiguration(UserInformation userInformation, String factoryId, String configurationId)
Configuration	getConfiguration(String factoryId, String configurationId)
Configuration[]	getConfigurations(String factoryId)
Factory	getFactory(String factoryId)
Factory[]	getKnownFactories()
NotifyFuture<Void>	purgeFactory(UserInformation userInformation, String factoryId)
NotifyFuture<Configuration>	updateConfiguration(UserInformation userInformation, String factoryId, String configurationId, Map<String,String> newProperties, boolean fullSet)

Field Detail

FACTORY_ID

static final String FACTORY_ID

See Also:

Constant Field Values

Method Detail

createConfiguration

NotifyFuture<Configuration> createConfiguration(UserInformation userInformation,
                                              String factoryId,
                                              String configurationId,
                                              Map<String,String> initialProperties)

updateConfiguration

NotifyFuture<Configuration> updateConfiguration(UserInformation userInformation,
                                              String factoryId,
                                              String configurationId,
                                              Map<String,String> newProperties,
                                              boolean fullSet)

deleteConfiguration

NotifyFuture<Configuration> deleteConfiguration(UserInformation userInformation,
                                              String factoryId,
                                              String configurationId)

purgeFactory

NotifyFuture<Void> purgeFactory(UserInformation userInformation,
                              String factoryId)

applyDiff

NotifyFuture<Void> applyDiff(UserInformation userInformation,
                           Collection<DiffEntry> changeSet)

Applies a change set to an existing configuration manager.

The operation must be atomic to the configuration system.

Note that there are two or more entries for one factory/configuration combination it is unspecified which entry will be applied.

Parameters:

changeSet - the change set to apply

Returns:

a future which notifies the end of the operation

getFactory

Factory getFactory(String factoryId)

getKnownFactories

Factory[] getKnownFactories()

getConfigurations

Configuration[] getConfigurations(String factoryId)

getConfiguration

Configuration getConfiguration(String factoryId,
                             String configurationId)