org.eclipse.gemini.blueprint.compendium.internal.cm

Class ManagedServiceFactoryFactoryBean

java.lang.Object

org.eclipse.gemini.blueprint.compendium.internal.cm.ManagedServiceFactoryFactoryBean

All Implemented Interfaces:

BundleContextAware, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanClassLoaderAware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.FactoryBean<java.util.Collection>, org.springframework.beans.factory.InitializingBean

public class ManagedServiceFactoryFactoryBean
extends java.lang.Object
implements org.springframework.beans.factory.InitializingBean, org.springframework.beans.factory.BeanClassLoaderAware, org.springframework.beans.factory.BeanFactoryAware, BundleContextAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.FactoryBean<java.util.Collection>

Factory class that automatically manages instances based on the configuration available inside a ManagedServiceFactory. The factory returns a list of ServiceRegistration of all published instances.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	ManagedServiceFactoryFactoryBean.ConfigurationWatcher Configuration Admin whiteboard 'listener'.
private class	ManagedServiceFactoryFactoryBean.DestructionInvokerCache Simple associating cache between types and disposable invoker.
private class	ManagedServiceFactoryFactoryBean.InitialInjectionProcessor Simple processor that applies the ConfigurationAdmin configuration before the bean is initialized.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	autowireOnUpdate
private org.springframework.beans.factory.support.DefaultListableBeanFactory	beanFactory embedded bean factory for instance management
private org.osgi.framework.BundleContext	bundleContext bundle context
private ExportContextClassLoaderEnum	ccl ccl
private java.lang.ClassLoader	classLoader class loader
private org.osgi.framework.ServiceRegistration	configurationWatcher configuration watcher registration
private boolean	destroyed destroyed flag - used since some CM implementations still call the service even though it was unregistered
private ManagedServiceFactoryFactoryBean.DestructionInvokerCache	destructionInvokerFactory special destruction invoker for managed-components/template beans
private InterfaceDetector	detector auto export
private java.lang.String	factoryPid Configuration Admin fpid
java.util.Map	initialInjectionProperties
private java.lang.Class<?>[]	interfaces interfaces
private OsgiServiceRegistrationListener[]	listeners listeners
private static org.apache.commons.logging.Log	log logger
private java.lang.Object	monitor visibility monitor
private org.springframework.beans.factory.BeanFactory	owningBeanFactory owning bean factory - can be null
private java.util.Map<java.lang.String,OsgiServiceFactoryBean>	serviceExporters lookup map between exporters and associated pids
private java.util.Map	serviceProperties service properties
private DynamicCollection	serviceRegistrations inner bean service registrations
private org.springframework.beans.factory.support.RootBeanDefinition	templateDefinition bean definition template
private UpdateCallback	updateCallback update callback
private java.lang.String	updateMethod
private java.util.Collection<org.osgi.framework.ServiceRegistration>	userReturnedCollection read-only view of the registration

Constructor Summary

Constructors

Constructor and Description
ManagedServiceFactoryFactoryBean()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
private void	createEmbeddedBeanFactory()
private OsgiServiceFactoryBean	createExporter(java.lang.String beanName, java.lang.Object bean)
private void	createInstance(java.lang.String pid, java.util.Map props)
private void	createOrUpdate(java.lang.String pid, java.util.Map props)
void	destroy()
private void	destroyFactory()
private void	destroyInstance(java.lang.String pid)
java.util.Collection	getObject()
java.lang.Class<java.util.Collection>	getObjectType()
boolean	isSingleton()
private void	processTemplateDefinition()
private void	registerService()
private void	registerService(java.lang.String pid, java.lang.Object bean)
void	setAutowireOnUpdate(boolean autowireOnUpdate) Sets whether autowire on update should be performed automatically or not.
void	setBeanClassLoader(java.lang.ClassLoader classLoader)
void	setBeanFactory(org.springframework.beans.factory.BeanFactory beanFactory)
void	setBundleContext(org.osgi.framework.BundleContext bundleContext) Set the BundleContext that this bean runs in.
void	setExportContextClassLoader(ExportContextClassLoaderEnum ccl)
void	setFactoryPid(java.lang.String factoryPid)
void	setInterfaceDetector(InterfaceDetector detector)
void	setInterfaces(java.lang.Class<?>[] interfaces)
void	setListeners(OsgiServiceRegistrationListener[] listeners) Sets the listeners interested in registration and unregistration events.
void	setServiceProperties(java.util.Map serviceProperties) Sets the properties used when exposing the target as an OSGi service.
void	setTemplateDefinition(org.springframework.beans.factory.config.BeanDefinition[] templateDefinition)
void	setUpdateMethod(java.lang.String updateMethod)
private void	unregisterService(java.lang.String pid)
private void	updateInstance(java.lang.String pid, java.util.Map props)

Methods inherited from class java.lang.Object

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

Field Detail

log

private static final org.apache.commons.logging.Log log

logger

monitor

private final java.lang.Object monitor

visibility monitor

factoryPid

private java.lang.String factoryPid

Configuration Admin fpid

bundleContext

private org.osgi.framework.BundleContext bundleContext

bundle context

beanFactory

private org.springframework.beans.factory.support.DefaultListableBeanFactory beanFactory

embedded bean factory for instance management

templateDefinition

private org.springframework.beans.factory.support.RootBeanDefinition templateDefinition

bean definition template

owningBeanFactory

private org.springframework.beans.factory.BeanFactory owningBeanFactory

owning bean factory - can be null

configurationWatcher

private org.osgi.framework.ServiceRegistration configurationWatcher

configuration watcher registration

serviceRegistrations

private final DynamicCollection serviceRegistrations

inner bean service registrations

userReturnedCollection

private final java.util.Collection<org.osgi.framework.ServiceRegistration> userReturnedCollection

read-only view of the registration

serviceExporters

private final java.util.Map<java.lang.String,OsgiServiceFactoryBean> serviceExporters

lookup map between exporters and associated pids

listeners

private OsgiServiceRegistrationListener[] listeners

listeners

detector

private InterfaceDetector detector

auto export

ccl

private ExportContextClassLoaderEnum ccl

ccl

interfaces

private java.lang.Class<?>[] interfaces

interfaces

classLoader

private java.lang.ClassLoader classLoader

class loader

autowireOnUpdate

private boolean autowireOnUpdate

updateMethod

private java.lang.String updateMethod

updateCallback

private UpdateCallback updateCallback

update callback

initialInjectionProperties

public java.util.Map initialInjectionProperties

destroyed

private boolean destroyed

destroyed flag - used since some CM implementations still call the service even though it was unregistered

serviceProperties

private volatile java.util.Map serviceProperties

service properties

destructionInvokerFactory

private volatile ManagedServiceFactoryFactoryBean.DestructionInvokerCache destructionInvokerFactory

special destruction invoker for managed-components/template beans

Constructor Detail

ManagedServiceFactoryFactoryBean

public ManagedServiceFactoryFactoryBean()

Method Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws java.lang.Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

java.lang.Exception

processTemplateDefinition

private void processTemplateDefinition()

destroy

public void destroy()
             throws java.lang.Exception

Specified by:

destroy in interface org.springframework.beans.factory.DisposableBean

Throws:

java.lang.Exception

createEmbeddedBeanFactory

private void createEmbeddedBeanFactory()

registerService

private void registerService()

destroyFactory

private void destroyFactory()

createOrUpdate

private void createOrUpdate(java.lang.String pid,
                            java.util.Map props)

createInstance

private void createInstance(java.lang.String pid,
                            java.util.Map props)

registerService

private void registerService(java.lang.String pid,
                             java.lang.Object bean)

createExporter

private OsgiServiceFactoryBean createExporter(java.lang.String beanName,
                                              java.lang.Object bean)

updateInstance

private void updateInstance(java.lang.String pid,
                            java.util.Map props)

destroyInstance

private void destroyInstance(java.lang.String pid)

unregisterService

private void unregisterService(java.lang.String pid)

setBeanFactory

public void setBeanFactory(org.springframework.beans.factory.BeanFactory beanFactory)
                    throws org.springframework.beans.BeansException

Specified by:

setBeanFactory in interface org.springframework.beans.factory.BeanFactoryAware

Throws:

org.springframework.beans.BeansException

setBundleContext

public void setBundleContext(org.osgi.framework.BundleContext bundleContext)

Description copied from interface: BundleContextAware

Set the BundleContext that this bean runs in. Normally this can be used to initialize an object.

Specified by:

setBundleContext in interface BundleContextAware

Parameters:

bundleContext - the BundleContext object to be used by this object

getObject

public java.util.Collection getObject()
                               throws java.lang.Exception

Specified by:

getObject in interface org.springframework.beans.factory.FactoryBean<java.util.Collection>

Throws:

java.lang.Exception

getObjectType

public java.lang.Class<java.util.Collection> getObjectType()

Specified by:

getObjectType in interface org.springframework.beans.factory.FactoryBean<java.util.Collection>

isSingleton

public boolean isSingleton()

Specified by:

isSingleton in interface org.springframework.beans.factory.FactoryBean<java.util.Collection>

setListeners

public void setListeners(OsgiServiceRegistrationListener[] listeners)

Sets the listeners interested in registration and unregistration events.

Parameters:

listeners - registration/unregistration listeners.

setFactoryPid

public void setFactoryPid(java.lang.String factoryPid)

Parameters:

factoryPid - The factoryPid to set.

setTemplateDefinition

public void setTemplateDefinition(org.springframework.beans.factory.config.BeanDefinition[] templateDefinition)

Parameters:

templateDefinition - The templateDefinition to set.

setBeanClassLoader

public void setBeanClassLoader(java.lang.ClassLoader classLoader)

Specified by:

setBeanClassLoader in interface org.springframework.beans.factory.BeanClassLoaderAware

setInterfaceDetector

public void setInterfaceDetector(InterfaceDetector detector)

setExportContextClassLoader

public void setExportContextClassLoader(ExportContextClassLoaderEnum ccl)

Parameters:

ccl - The ccl to set.

setInterfaces

public void setInterfaces(java.lang.Class<?>[] interfaces)

Parameters:

interfaces - The interfaces to set.

setAutowireOnUpdate

public void setAutowireOnUpdate(boolean autowireOnUpdate)

Sets whether autowire on update should be performed automatically or not.

Parameters:

autowireOnUpdate -

setUpdateMethod

public void setUpdateMethod(java.lang.String updateMethod)

Parameters:

updateMethod - The updateMethod to set.

setServiceProperties

public void setServiceProperties(java.util.Map serviceProperties)

Sets the properties used when exposing the target as an OSGi service. If the given argument implements ( ServicePropertiesChangeListener), any updates to the properties will be reflected by the service registration.

Parameters:

serviceProperties - properties used for exporting the target as an OSGi service