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 java.lang.String	FACTORY_ID

Method Summary

Methods

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

Field Detail

FACTORY_ID

static final java.lang.String FACTORY_ID

See Also:

Constant Field Values

Method Detail

createConfiguration

 createConfiguration(UserInformation userInformation,
                        java.lang.String factoryId,
                        java.lang.String configurationId,
                        java.util.Map<java.lang.String,java.lang.String> initialProperties)

updateConfiguration

 updateConfiguration(UserInformation userInformation,
                        java.lang.String factoryId,
                        java.lang.String configurationId,
                        java.util.Map<java.lang.String,java.lang.String> newProperties,
                        boolean fullSet)

deleteConfiguration

 deleteConfiguration(UserInformation userInformation,
                        java.lang.String factoryId,
                        java.lang.String configurationId)

purgeFactory

 purgeFactory(UserInformation userInformation,
                 java.lang.String factoryId)

applyDiff

 applyDiff(UserInformation userInformation,
              java.util.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(java.lang.String factoryId)

getKnownFactories

Factory[] getKnownFactories()

getConfigurations

Configuration[] getConfigurations(java.lang.String factoryId)

getConfiguration

Configuration getConfiguration(java.lang.String factoryId,
                             java.lang.String configurationId)