org.eclipse.scada.ca.common.factory

Class AbstractServiceConfigurationFactory<T>

java.lang.Object

org.eclipse.scada.ca.common.factory.AbstractServiceConfigurationFactory<T>

All Implemented Interfaces:

ConfigurationFactory

Direct Known Subclasses:

AbstractMonitorFactory, AverageDataSourceFactory, BeanConfigurationFactory, BlockHandlerFactoryImpl, CommonSumHandlerFactoryImpl, ConfigurationFactoryImpl, ConfigurationFactoryImpl, ConfiguredValueMapperFactory, ConstantDataSourceFactory, DataItemSourceFactoryImpl, DataItemTargetFactoryImpl, DataSourceLoggerFactory, DataStoreSourceFactory, EventMonitorFactory, EventPoolConfigurationFactory, ExporterFactoryImpl, FactoryImpl, FormulaSourceFactory, InfoServiceFactory, JdbcAuthenticationServiceFactory, JdbcValueMapperFactory, ManualHandlerFactoryImpl, MapperHandlerFactoryImpl, MarkerHandlerFactoryImpl, MasterFactory, MasterFactory, MemorySourceFactory, MovingAverageDataSourceFactory, MqttBrokerFactory, MqttDataItemFactory, MqttExporterFactory, MqttItemToTopicFactory, NegateHandlerFactoryImpl, ProxyDataSourceFactory, ProxyEventQueryFactory, ProxyItemFactory, ProxyMonitorQueryFactory, QueryServiceFactory, RoundHandlerFactoryImpl, ScaleHandlerFactoryImpl, ScriptComponentFactory, ScriptMonitorFactory, ScriptSourceFactory, SlaveFactory, SumSourceFactory, TimeItemFactory

public abstract class AbstractServiceConfigurationFactory<T>
extends java.lang.Object
implements ConfigurationFactory

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractServiceConfigurationFactory.Entry<T>

Constructor Summary

Constructors

Constructor and Description
AbstractServiceConfigurationFactory(BundleContext context)
AbstractServiceConfigurationFactory(BundleContext context, boolean canOnlyRecreate)

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract AbstractServiceConfigurationFactory.Entry<T>	createService(UserInformation userInformation, java.lang.String configurationId, BundleContext context, java.util.Map<java.lang.String,java.lang.String> parameters) Create a new service instance
void	delete(UserInformation userInformation, java.lang.String configurationId) receive configuration delete request
void	dispose()
protected abstract void	disposeService(UserInformation userInformation, java.lang.String configurationId, T service) Dispose a service
protected AbstractServiceConfigurationFactory.Entry<T>	getService(java.lang.String configurationId)
protected void	unregisterService(AbstractServiceConfigurationFactory.Entry<T> entry) Unregister the service entry with OSGi
void	update(UserInformation userInformation, java.lang.String configurationId, java.util.Map<java.lang.String,java.lang.String> parameters) receive configuration update
protected abstract AbstractServiceConfigurationFactory.Entry<T>	updateService(UserInformation userInformation, java.lang.String configurationId, AbstractServiceConfigurationFactory.Entry<T> entry, java.util.Map<java.lang.String,java.lang.String> parameters) Update a service configuration

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractServiceConfigurationFactory

public AbstractServiceConfigurationFactory(BundleContext context)

AbstractServiceConfigurationFactory

public AbstractServiceConfigurationFactory(BundleContext context,
                                   boolean canOnlyRecreate)

Method Detail

dispose

public void dispose()

unregisterService

protected void unregisterService(AbstractServiceConfigurationFactory.Entry<T> entry)

Unregister the service entry with OSGi

Parameters:

entry - the entry to unregister

delete

public void delete(UserInformation userInformation,
          java.lang.String configurationId)
            throws java.lang.Exception

Description copied from interface: ConfigurationFactory

receive configuration delete request

Specified by:

delete in interface ConfigurationFactory

Parameters:

userInformation - the principal that performed the change, may be null

configurationId - the configuration object to change

Throws:

java.lang.Exception - can be thrown if anything goes wrong changing the configuration

update

public void update(UserInformation userInformation,
          java.lang.String configurationId,
          java.util.Map<java.lang.String,java.lang.String> parameters)
            throws java.lang.Exception

Description copied from interface: ConfigurationFactory

receive configuration update

Specified by:

update in interface ConfigurationFactory

Parameters:

userInformation - the principal that performed the change, may be null

configurationId - the configuration object to change

parameters - the new properties

Throws:

java.lang.Exception - can be thrown if anything goes wrong changing the configuration

createService

protected abstract AbstractServiceConfigurationFactory.Entry<T> createService(UserInformation userInformation,
                                                         java.lang.String configurationId,
                                                         BundleContext context,
                                                         java.util.Map<java.lang.String,java.lang.String> parameters)
                                                                       throws java.lang.Exception

Create a new service instance

The method must also register the service with the OSGi bundle context if needed. The service registration must then be placed into the result that is returned. This is an optional step. There is no need to register the created service.

Parameters:

principal -

configurationId - the configuration id for which the service should be created

context - the bundle context

parameters - the initial parameters

Returns:

a new entry instance which holds the service. This method must never return null

Throws:

java.lang.Exception - if anything goes wrong

disposeService

protected abstract void disposeService(UserInformation userInformation,
                  java.lang.String configurationId,
                  T service)

Dispose a service

If the service entry contains a service handle, the service is automatically unregistered.

Parameters:

userInformation -

configurationId -

service -

updateService

protected abstract AbstractServiceConfigurationFactory.Entry<T> updateService(UserInformation userInformation,
                                                         java.lang.String configurationId,
                                                         AbstractServiceConfigurationFactory.Entry<T> entry,
                                                         java.util.Map<java.lang.String,java.lang.String> parameters)
                                                                       throws java.lang.Exception

Update a service configuration

If a new service entry is returned the old one will get disposed after the call returns

Parameters:

principal -

configurationId - the configuration to update

entry - the original service entry

parameters - the new parameters

Returns:

the new service entry or null if the entry did not change

Throws:

java.lang.Exception - if anything goes wrong

getService

protected AbstractServiceConfigurationFactory.Entry<T> getService(java.lang.String configurationId)