org.eclipse.scada.ca.common

Class AbstractConfigurationAdministrator

java.lang.Object

org.eclipse.scada.ca.common.AbstractConfigurationAdministrator

All Implemented Interfaces:

ConfigurationAdministrator, FreezableConfigurationAdministrator

Direct Known Subclasses:

ConfigurationAdminImpl, ConfigurationAdministratorImpl

public abstract class AbstractConfigurationAdministrator
extends Object
implements FreezableConfigurationAdministrator

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractConfigurationAdministrator.CompositeFuture<T>
protected static class	AbstractConfigurationAdministrator.ConfigurationFuture
protected static class	AbstractConfigurationAdministrator.PatchFuture
protected static class	AbstractConfigurationAdministrator.PurgeFuture

Field Summary

Fields inherited from interface org.eclipse.scada.ca.ConfigurationAdministrator

FACTORY_ID

Constructor Summary

Constructors

Constructor and Description
AbstractConfigurationAdministrator(org.osgi.framework.BundleContext context)

Method Summary

Modifier and Type	Method and Description
protected void	addFactoryService(String factoryId, ConfigurationFactory service, String description)
protected ConfigurationFactory	addingService(org.osgi.framework.ServiceReference<ConfigurationFactory> reference)
protected void	addStoredFactory(String factoryId, ConfigurationImpl[] configurations)
protected void	applyConfiguration(UserInformation userInformation, AbstractConfigurationAdministrator.ConfigurationFuture future, ConfigurationFactory factoryService, FactoryImpl factory, ConfigurationImpl configuration) Apply the configuration to the assigned service
NotifyFuture<Void>	applyDiff(UserInformation userInformation, Collection<DiffEntry> changeSet) Applies a change set to an existing configuration manager.
protected void	changeConfiguration(UserInformation userInformation, String factoryId, String configurationId, Map<String,String> properties, AbstractConfigurationAdministrator.ConfigurationFuture future) Request a change of the configuration
NotifyFuture<Configuration>	createConfiguration(UserInformation userInformation, String factoryId, String configurationId, Map<String,String> properties)
NotifyFuture<Configuration>	deleteConfiguration(UserInformation userInformation, String factoryId, String configurationId)
void	dispose()
void	freeze()
Configuration	getConfiguration(String factoryId, String configurationId)
Configuration[]	getConfigurations(String factoryId)
FactoryImpl	getFactory(String factoryId)
FactoryImpl[]	getKnownFactories()
protected abstract void	performDeleteConfiguration(UserInformation userInformation, String factoryId, String configurationId, AbstractConfigurationAdministrator.ConfigurationFuture future)
protected abstract void	performPurge(UserInformation userInformation, String factoryId, AbstractConfigurationAdministrator.PurgeFuture future)
protected abstract void	performStoreConfiguration(UserInformation userInformation, String factoryId, String configurationId, Map<String,String> properties, boolean fullSet, AbstractConfigurationAdministrator.ConfigurationFuture future)
NotifyFuture<Void>	purgeFactory(UserInformation userInformation, String factoryId)
protected void	removedService(org.osgi.framework.ServiceReference<ConfigurationFactory> reference, ConfigurationFactory service)
protected void	removeFactoryService(String factoryId, ConfigurationFactory service)
protected void	setFactoryState(FactoryImpl factory, FactoryState state)
void	start()
void	stop()
void	thaw()
NotifyFuture<Configuration>	updateConfiguration(UserInformation userInformation, String factoryId, String configurationId, Map<String,String> properties, boolean fullSet)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractConfigurationAdministrator

public AbstractConfigurationAdministrator(org.osgi.framework.BundleContext context)

Method Detail

start

public void start()
           throws Exception

Throws:

Exception

stop

public void stop()
          throws Exception

Throws:

Exception

dispose

public void dispose()

freeze

public void freeze()
            throws Exception

Specified by:

freeze in interface FreezableConfigurationAdministrator

Throws:

Exception

thaw

public void thaw()
          throws Exception

Specified by:

thaw in interface FreezableConfigurationAdministrator

Throws:

Exception

addStoredFactory

protected void addStoredFactory(String factoryId,
                                ConfigurationImpl[] configurations)

setFactoryState

protected void setFactoryState(FactoryImpl factory,
                               FactoryState state)

addFactoryService

protected void addFactoryService(String factoryId,
                                 ConfigurationFactory service,
                                 String description)

removeFactoryService

protected void removeFactoryService(String factoryId,
                                    ConfigurationFactory service)

performPurge

protected abstract void performPurge(UserInformation userInformation,
                                     String factoryId,
                                     AbstractConfigurationAdministrator.PurgeFuture future)
                              throws Exception

Throws:

Exception

performStoreConfiguration

protected abstract void performStoreConfiguration(UserInformation userInformation,
                                                  String factoryId,
                                                  String configurationId,
                                                  Map<String,String> properties,
                                                  boolean fullSet,
                                                  AbstractConfigurationAdministrator.ConfigurationFuture future)
                                           throws Exception

Throws:

Exception

performDeleteConfiguration

protected abstract void performDeleteConfiguration(UserInformation userInformation,
                                                   String factoryId,
                                                   String configurationId,
                                                   AbstractConfigurationAdministrator.ConfigurationFuture future)
                                            throws Exception

Throws:

Exception

changeConfiguration

protected void changeConfiguration(UserInformation userInformation,
                                   String factoryId,
                                   String configurationId,
                                   Map<String,String> properties,
                                   AbstractConfigurationAdministrator.ConfigurationFuture future)

Request a change of the configuration

Parameters:

userInformation -

factoryId -

configurationId -

properties -

future -

applyConfiguration

protected void applyConfiguration(UserInformation userInformation,
                                  AbstractConfigurationAdministrator.ConfigurationFuture future,
                                  ConfigurationFactory factoryService,
                                  FactoryImpl factory,
                                  ConfigurationImpl configuration)

Apply the configuration to the assigned service

This method can block for some while

Parameters:

userInformation -

future -

factory -

factoryService -

configuration -

purgeFactory

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

Specified by:

purgeFactory in interface ConfigurationAdministrator

createConfiguration

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

Specified by:

createConfiguration in interface ConfigurationAdministrator

updateConfiguration

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

Specified by:

updateConfiguration in interface ConfigurationAdministrator

deleteConfiguration

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

Specified by:

deleteConfiguration in interface ConfigurationAdministrator

getConfiguration

public Configuration getConfiguration(String factoryId,
                                      String configurationId)

Specified by:

getConfiguration in interface ConfigurationAdministrator

getConfigurations

public Configuration[] getConfigurations(String factoryId)

Specified by:

getConfigurations in interface ConfigurationAdministrator

getFactory

public FactoryImpl getFactory(String factoryId)

Specified by:

getFactory in interface ConfigurationAdministrator

getKnownFactories

public FactoryImpl[] getKnownFactories()

Specified by:

getKnownFactories in interface ConfigurationAdministrator

addingService

protected ConfigurationFactory addingService(org.osgi.framework.ServiceReference<ConfigurationFactory> reference)

removedService

protected void removedService(org.osgi.framework.ServiceReference<ConfigurationFactory> reference,
                              ConfigurationFactory service)

applyDiff

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

Description copied from interface: ConfigurationAdministrator

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.

Specified by:

applyDiff in interface ConfigurationAdministrator

changeSet - the change set to apply

Returns:

a future which notifies the end of the operation