org.eclipse.scada.ca.common.factory

Class BeanConfigurationFactory

java.lang.Object

org.eclipse.scada.ca.common.factory.AbstractServiceConfigurationFactory<BeanConfigurationFactory.BeanServiceInstance>

org.eclipse.scada.ca.common.factory.BeanConfigurationFactory

All Implemented Interfaces:

ConfigurationFactory

public class BeanConfigurationFactory
extends AbstractServiceConfigurationFactory<BeanConfigurationFactory.BeanServiceInstance>

A configuration factory that creates simple beans and applies the configuration using setters.

If the created bean supports Disposable then the Disposable.dispose() method will be called when the object is being removed from the factory.

Since:

0.15.0

Author:

Jens Reimann

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	BeanConfigurationFactory.BeanServiceInstance

Nested classes/interfaces inherited from class org.eclipse.scada.ca.common.factory.AbstractServiceConfigurationFactory

AbstractServiceConfigurationFactory.Entry<T>

Field Summary

Fields inherited from class org.eclipse.scada.ca.common.factory.AbstractServiceConfigurationFactory

context

Constructor Summary

Constructors

Constructor and Description
BeanConfigurationFactory(org.osgi.framework.BundleContext context, Class<?> beanClazz)
BeanConfigurationFactory(org.osgi.framework.BundleContext context, Class<?> beanClazz, boolean mergeIdField) Create a new factory

Method Summary

Modifier and Type	Method and Description
protected AbstractServiceConfigurationFactory.Entry<BeanConfigurationFactory.BeanServiceInstance>	createService(UserInformation userInformation, String configurationId, org.osgi.framework.BundleContext context, Map<String,String> parameters) Create a new service instance
protected void	disposeService(UserInformation userInformation, String id, BeanConfigurationFactory.BeanServiceInstance service) Dispose a service
protected AbstractServiceConfigurationFactory.Entry<BeanConfigurationFactory.BeanServiceInstance>	updateService(UserInformation userInformation, String configurationId, AbstractServiceConfigurationFactory.Entry<BeanConfigurationFactory.BeanServiceInstance> entry, Map<String,String> parameters) Update a service configuration

Methods inherited from class org.eclipse.scada.ca.common.factory.AbstractServiceConfigurationFactory

delete, dispose, getService, unregisterService, update

Methods inherited from class java.lang.Object

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

Constructor Detail

BeanConfigurationFactory

public BeanConfigurationFactory(org.osgi.framework.BundleContext context,
                                Class<?> beanClazz,
                                boolean mergeIdField)

Create a new factory

Parameters:

context - the bundle context

beanClazz - the bean class to use

mergeIdField - apply the configuration id as id if set the true

BeanConfigurationFactory

public BeanConfigurationFactory(org.osgi.framework.BundleContext context,
                                Class<?> beanClazz)

Method Detail

createService

protected AbstractServiceConfigurationFactory.Entry<BeanConfigurationFactory.BeanServiceInstance> createService(UserInformation userInformation,
                                                                                                                String configurationId,
                                                                                                                org.osgi.framework.BundleContext context,
                                                                                                                Map<String,String> parameters)
                                                                                                         throws Exception

Description copied from class: AbstractServiceConfigurationFactory

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.

Specified by:

createService in class AbstractServiceConfigurationFactory<BeanConfigurationFactory.BeanServiceInstance>

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:

Exception - if anything goes wrong

disposeService

protected void disposeService(UserInformation userInformation,
                              String id,
                              BeanConfigurationFactory.BeanServiceInstance service)

Description copied from class: AbstractServiceConfigurationFactory

Dispose a service

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

Specified by:

disposeService in class AbstractServiceConfigurationFactory<BeanConfigurationFactory.BeanServiceInstance>

updateService

protected AbstractServiceConfigurationFactory.Entry<BeanConfigurationFactory.BeanServiceInstance> updateService(UserInformation userInformation,
                                                                                                                String configurationId,
                                                                                                                AbstractServiceConfigurationFactory.Entry<BeanConfigurationFactory.BeanServiceInstance> entry,
                                                                                                                Map<String,String> parameters)
                                                                                                         throws Exception

Description copied from class: AbstractServiceConfigurationFactory

Update a service configuration

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

Specified by:

updateService in class AbstractServiceConfigurationFactory<BeanConfigurationFactory.BeanServiceInstance>

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:

Exception - if anything goes wrong