OsgiServiceFactoryBean

java.lang.Object
- org.eclipse.gemini.blueprint.service.exporter.support.AbstractOsgiServiceExporter
- - org.eclipse.gemini.blueprint.service.exporter.support.OsgiServiceFactoryBean

All Implemented Interfaces:

BundleContextAware, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanClassLoaderAware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.FactoryBean<org.osgi.framework.ServiceRegistration>, org.springframework.beans.factory.InitializingBean, org.springframework.core.Ordered
```
public class OsgiServiceFactoryBean
extends AbstractOsgiServiceExporter
implements org.springframework.beans.factory.BeanClassLoaderAware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.BeanNameAware, BundleContextAware, org.springframework.beans.factory.FactoryBean<org.osgi.framework.ServiceRegistration>, org.springframework.beans.factory.InitializingBean, org.springframework.core.Ordered
```
FactoryBean that transparently publishes other beans in the same application context as OSGi services returning the ServiceRegistration for the given object. Also known as an exporter this class handle the registration and unregistration of an OSGi service for the backing/target object.
The service properties used when publishing the service are determined by the OsgiServicePropertiesResolver. The default implementation uses
- BundleSymbolicName=<bundle symbolic name>
- BundleVersion=<bundle version>
- org.eclipse.gemini.blueprint.bean.name="<bean name>
Note:If thread context class loader management is used ( setContextClassLoader(ExportContextClassLoader), since proxying is required, the target class has to meet certain criterion described in the Spring AOP documentation. In short, final classes are not supported when class enhancement is used.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`private class`	`OsgiServiceFactoryBean.Executor` Wrapper around internal commands.
`private class`	`OsgiServiceFactoryBean.PropertiesMonitor` Callback that propagates the changes in the service properties to the registration object.

Field Summary

Fields
Modifier and Type	Field and Description
`private java.util.concurrent.atomic.AtomicBoolean`	`activated`
`private java.lang.ClassLoader`	`aopClassLoader` class loader used by the aop infrastructure
`private org.springframework.beans.factory.BeanFactory`	`beanFactory`
`private java.lang.String`	`beanName` exporter bean name
`private org.osgi.framework.BundleContext`	`bundleContext`
`private boolean`	`cacheTarget` should the service be cached or not
`private java.lang.ClassLoader`	`classLoader`
`private ExportContextClassLoaderEnum`	`contextClassLoader`
`private ExporterController`	`controller` internal behaviour controller
`private boolean`	`hasNamedBean`
`private InterfaceDetector`	`interfaceDetector`
`private java.lang.Class<?>[]`	`interfaces`
`private java.lang.Object`	`lock` synchronization lock
`private static org.apache.commons.logging.Log`	`log`
`private ListenerNotifier`	`notifier`
`private int`	`order` Default value is same as non-ordered
`private ServicePropertiesChangeListener`	`propertiesListener`
`private OsgiServicePropertiesResolver`	`propertiesResolver`
`private int`	`ranking`
`private boolean`	`registerAtStartup` register at startup by default
`private boolean`	`registerService` register the service by default
`private LazyTargetResolver`	`resolver`
`private ServiceRegistrationWrapper`	`safeServiceRegistration`
`private java.util.Map`	`serviceProperties`
`private boolean`	`serviceRegistered` registration sanity flag
`private ServiceRegistrationDecorator`	`serviceRegistration`
`private java.lang.Object`	`target`
`private java.lang.String`	`targetBeanName`
`private java.lang.Class<?>`	`targetClass`

Fields inherited from interface org.springframework.core.Ordered
HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors
Constructor and Description

OsgiServiceFactoryBean()

Constructors
Constructor and Description
`OsgiServiceFactoryBean()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`private void`	`addBeanFactoryDependency()`
`void`	`afterPropertiesSet()`
`void`	`destroy()`
`java.lang.String`	`getBeanName()` Returns the bean name of this class when configured inside a Spring container.
`java.lang.Class<?>[]`	`getInterfaces()` Returns the interfaces that will be considered when exporting the target as an OSGi service.
`org.osgi.framework.ServiceRegistration`	`getObject()` Returns a `ServiceRegistration` to the OSGi service for the target object.
`java.lang.Class<? extends org.osgi.framework.ServiceRegistration>`	`getObjectType()`
`int`	`getOrder()`
`int`	`getRanking()` Returns the OSGi ranking used when publishing the service.
`OsgiServicePropertiesResolver`	`getResolver()` Returns the property resolver used for publishing the service.
`java.util.Map`	`getServiceProperties()` Returns the properties used when exporting the target as an OSGi service.
`java.lang.Object`	`getTarget()` Returns the object exported as an OSGi service.
`java.lang.String`	`getTargetBeanName()` Returns the target bean name.
`private boolean`	`isBeanBundleScoped()`
`boolean`	`isSingleton()`
`private java.util.Dictionary`	`mergeServiceProperties(java.util.Map serviceProperties, java.lang.String beanName)`
`(package private) void`	`registerService()` Publishes the given object as an OSGi service.
`(package private) org.osgi.framework.ServiceRegistration`	`registerService(java.lang.Class<?>[] classes, java.util.Dictionary serviceProperties)` Registration method.
`void`	`setAutoExport(AutoExport classExporter)` Deprecated.
`void`	`setBeanClassLoader(java.lang.ClassLoader classLoader)`
`void`	`setBeanFactory(org.springframework.beans.factory.BeanFactory beanFactory)`
`void`	`setBeanName(java.lang.String name)`
`void`	`setBundleContext(org.osgi.framework.BundleContext context)` Set the `BundleContext` that this bean runs in.
`void`	`setCacheTarget(boolean cacheTarget)` Sets the caching of the exported target object.
`void`	`setContextClassLoader(ExportContextClassLoader ccl)` Deprecated. As of Spring DM 2.0, replaced by `setExportContextClassLoader(ExportContextClassLoaderEnum)`
`void`	`setExportContextClassLoader(ExportContextClassLoaderEnum ccl)` Sets the context class loader management strategy to use when invoking operations on the exposed target bean.
`void`	`setInterfaceDetector(InterfaceDetector detector)` Sets the strategy used for automatically publishing classes.
`void`	`setInterfaces(java.lang.Class<?>[] interfaces)` Sets the interfaces advertised by the service.These will be advertised in the OSGi space and are considered when looking for a service.
`void`	`setOrder(int order)` Set the ordering which will apply to this class's implementation of Ordered, used when applying multiple BeanPostProcessors.
`void`	`setRanking(int ranking)` Shortcut for setting the ranking property of the published service.
`void`	`setRegisterService(boolean register)` Controls whether the service actually gets published or not.
`void`	`setResolver(OsgiServicePropertiesResolver resolver)` Sets the property resolver used when publishing the bean as an OSGi service.
`void`	`setServiceProperties(java.util.Map serviceProperties)` Sets the properties used when exposing the target as an OSGi service.
`void`	`setTarget(java.lang.Object target)` Sets the given object to be export as an OSGi service.
`void`	`setTargetBeanName(java.lang.String name)` Sets the name of the bean managed by the Spring container, which will be exported as an OSGi service.
`(package private) void`	`unregisterService()` Unregisters/de-exports the OSGi service.
`(package private) void`	`unregisterService(org.osgi.framework.ServiceRegistration registration)` Unregisters (literally stops) a service.

Methods inherited from class org.eclipse.gemini.blueprint.service.exporter.support.AbstractOsgiServiceExporter
getLazyListeners, getNotifier, setLazyListeners, setListeners

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
```
  - bundleContext
```
private volatile org.osgi.framework.BundleContext bundleContext
```
  - propertiesResolver
```
private volatile OsgiServicePropertiesResolver propertiesResolver
```
  - beanFactory
```
private volatile org.springframework.beans.factory.BeanFactory beanFactory
```
  - serviceRegistration
```
private volatile ServiceRegistrationDecorator serviceRegistration
```
  - safeServiceRegistration
```
private final ServiceRegistrationWrapper safeServiceRegistration
```
  - serviceProperties
```
private volatile java.util.Map serviceProperties
```
  - propertiesListener
```
private volatile ServicePropertiesChangeListener propertiesListener
```
  - ranking
```
private volatile int ranking
```
  - targetBeanName
```
private volatile java.lang.String targetBeanName
```
  - hasNamedBean
```
private boolean hasNamedBean
```
  - interfaces
```
private volatile java.lang.Class<?>[] interfaces
```
  - interfaceDetector
```
private InterfaceDetector interfaceDetector
```
  - contextClassLoader
```
private volatile ExportContextClassLoaderEnum contextClassLoader
```
  - target
```
private volatile java.lang.Object target
```
  - targetClass
```
private volatile java.lang.Class<?> targetClass
```
  - order
```
private int order
```
    Default value is same as non-ordered
  - classLoader
```
private java.lang.ClassLoader classLoader
```
  - aopClassLoader
```
private java.lang.ClassLoader aopClassLoader
```
    class loader used by the aop infrastructure
  - beanName
```
private java.lang.String beanName
```
    exporter bean name
  - serviceRegistered
```
private boolean serviceRegistered
```
    registration sanity flag
  - registerAtStartup
```
private boolean registerAtStartup
```
    register at startup by default
  - registerService
```
private boolean registerService
```
    register the service by default
  - lock
```
private final java.lang.Object lock
```
    synchronization lock
  - controller
```
private final ExporterController controller
```
    internal behaviour controller
  - resolver
```
private volatile LazyTargetResolver resolver
```
  - notifier
```
private ListenerNotifier notifier
```
  - activated
```
private final java.util.concurrent.atomic.AtomicBoolean activated
```
  - cacheTarget
```
private boolean cacheTarget
```
    should the service be cached or not
- Constructor Detail
  - OsgiServiceFactoryBean
```
public OsgiServiceFactoryBean()
```
- Method Detail
  - afterPropertiesSet
```
public void afterPropertiesSet()
                        throws java.lang.Exception
```
    Specified by:
    
    afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean
    
    Throws:
    
    java.lang.Exception
  - destroy
```
public void destroy()
```
    Specified by:
    
    destroy in interface org.springframework.beans.factory.DisposableBean
    
    Overrides:
    
    destroy in class AbstractOsgiServiceExporter
  - addBeanFactoryDependency
```
private void addBeanFactoryDependency()
```
  - mergeServiceProperties
```
private java.util.Dictionary mergeServiceProperties(java.util.Map serviceProperties,
                                                    java.lang.String beanName)
```
  - registerService
```
void registerService()
```
    Publishes the given object as an OSGi service. It simply assembles the classes required for publishing and then delegates the actual registration to a dedicated method.
    
    Specified by:
    
    registerService in class AbstractOsgiServiceExporter
  - registerService
```
org.osgi.framework.ServiceRegistration registerService(java.lang.Class<?>[] classes,
                                                       java.util.Dictionary serviceProperties)
```
    Registration method.
    
    Parameters:
    
    classes -
    
    serviceProperties -
    
    Returns:
    
    the ServiceRegistration
  - isBeanBundleScoped
```
private boolean isBeanBundleScoped()
```
  - setBeanClassLoader
```
public void setBeanClassLoader(java.lang.ClassLoader classLoader)
```
    Specified by:
    
    setBeanClassLoader in interface org.springframework.beans.factory.BeanClassLoaderAware
  - getObject
```
public org.osgi.framework.ServiceRegistration getObject()
                                                 throws java.lang.Exception
```
    Returns a ServiceRegistration to the OSGi service for the target object.
    
    Specified by:
    
    getObject in interface org.springframework.beans.factory.FactoryBean<org.osgi.framework.ServiceRegistration>
    
    Throws:
    
    java.lang.Exception
  - getObjectType
```
public java.lang.Class<? extends org.osgi.framework.ServiceRegistration> getObjectType()
```
    Specified by:
    
    getObjectType in interface org.springframework.beans.factory.FactoryBean<org.osgi.framework.ServiceRegistration>
  - isSingleton
```
public boolean isSingleton()
```
    Specified by:
    
    isSingleton in interface org.springframework.beans.factory.FactoryBean<org.osgi.framework.ServiceRegistration>
  - unregisterService
```
void unregisterService()
```
    Description copied from class: AbstractOsgiServiceExporter
    
    Unregisters/de-exports the OSGi service.
    
    Specified by:
    
    unregisterService in class AbstractOsgiServiceExporter
  - unregisterService
```
void unregisterService(org.osgi.framework.ServiceRegistration registration)
```
    Unregisters (literally stops) a service.
    
    Parameters:
    
    registration -
  - setContextClassLoader
```
public void setContextClassLoader(ExportContextClassLoader ccl)
```
    Deprecated. As of Spring DM 2.0, replaced by setExportContextClassLoader(ExportContextClassLoaderEnum)
    
    Sets the context class loader management strategy to use when invoking operations on the exposed target bean. By default, ExportContextClassLoader.UNMANAGED is used.
    Note: Since proxying is required for context class loader manager, the target class has to meet certain criteria described in the Spring AOP documentation. In short, final classes are not supported when class enhancement is used.
    
    Parameters:
    
    ccl - context class loader strategy to use
    
    See Also:
    
    ExportContextClassLoader
  - setExportContextClassLoader
```
public void setExportContextClassLoader(ExportContextClassLoaderEnum ccl)
```
    Sets the context class loader management strategy to use when invoking operations on the exposed target bean. By default, ExportContextClassLoader.UNMANAGED is used.
    Note: Since proxying is required for context class loader manager, the target class has to meet certain criteria described in the Spring AOP documentation. In short, final classes are not supported when class enhancement is used.
    
    Parameters:
    
    ccl - context class loader strategy to use
    
    See Also:
    
    ExportContextClassLoader
  - getTarget
```
public java.lang.Object getTarget()
```
    Returns the object exported as an OSGi service.
    
    Returns:
    
    the object exported as an OSGi service
  - setTarget
```
public void setTarget(java.lang.Object target)
```
    Sets the given object to be export as an OSGi service. Normally used when the exported service is a nested bean or an object not managed by the Spring container. Note that the passed target instance is ignored if setTargetBeanName(String) is used.
    
    Parameters:
    
    target - the object to be exported as an OSGi service
  - getTargetBeanName
```
public java.lang.String getTargetBeanName()
```
    Returns the target bean name.
    
    Returns:
    
    the target object bean name
  - setTargetBeanName
```
public void setTargetBeanName(java.lang.String name)
```
    Sets the name of the bean managed by the Spring container, which will be exported as an OSGi service. This method is normally what most use-cases need, rather then setTarget(Object).
    
    Parameters:
    
    name - target bean name
  - setAutoExport
```
public void setAutoExport(AutoExport classExporter)
```
    Deprecated.
    
    Sets the strategy used for automatically publishing classes. This allows the exporter to use the target class hierarchy and/or interfaces for registering the OSGi service. By default, autoExport is disabled AutoExport.DISABLED.
    
    Parameters:
    
    classExporter - class exporter used for automatically publishing service classes.
    
    See Also:
    
    AutoExport
  - setInterfaceDetector
```
public void setInterfaceDetector(InterfaceDetector detector)
```
    Sets the strategy used for automatically publishing classes. This allows the exporter to use the target class hierarchy and/or interfaces for registering the OSGi service. By default, autoExport is disabled DefaultInterfaceDetector.DISABLED.
    
    Parameters:
    
    detector -
  - getServiceProperties
```
public java.util.Map getServiceProperties()
```
    Returns the properties used when exporting the target as an OSGi service.
    
    Returns:
    
    properties used for exporting the target
  - 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
  - getRanking
```
public int getRanking()
```
    Returns the OSGi ranking used when publishing the service.
    
    Returns:
    
    service ranking used when publishing the service
  - setRanking
```
public void setRanking(int ranking)
```
    Shortcut for setting the ranking property of the published service.
    
    Parameters:
    
    ranking - service ranking
    
    See Also:
    
    Constants.SERVICE_RANKING
  - setRegisterService
```
public void setRegisterService(boolean register)
```
    Controls whether the service actually gets published or not. This can be used by application context creators to control service creation without blocking the creation of the context
    
    Parameters:
    
    register - whether to register the service or not. The default is true.
  - 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 context)
```
    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:
    
    context - the BundleContext object to be used by this object
  - getResolver
```
public OsgiServicePropertiesResolver getResolver()
```
    Returns the property resolver used for publishing the service.
    
    Returns:
    
    service property resolver
  - setResolver
```
public void setResolver(OsgiServicePropertiesResolver resolver)
```
    Sets the property resolver used when publishing the bean as an OSGi service.
    
    Parameters:
    
    resolver - service property resolver
  - getInterfaces
```
public java.lang.Class<?>[] getInterfaces()
```
    Returns the interfaces that will be considered when exporting the target as an OSGi service.
    
    Returns:
    
    interfaces under which the target will be published as an OSGi service
  - setInterfaces
```
public void setInterfaces(java.lang.Class<?>[] interfaces)
```
    Sets the interfaces advertised by the service.These will be advertised in the OSGi space and are considered when looking for a service.
    
    Parameters:
    
    interfaces - array of classes to advertise
  - getOrder
```
public int getOrder()
```
    Specified by:
    
    getOrder in interface org.springframework.core.Ordered
  - setOrder
```
public void setOrder(int order)
```
    Set the ordering which will apply to this class's implementation of Ordered, used when applying multiple BeanPostProcessors.
    Default value is Integer.MAX_VALUE, meaning that it's non-ordered.
    
    Parameters:
    
    order - ordering value
  - getBeanName
```
public java.lang.String getBeanName()
```
    Returns the bean name of this class when configured inside a Spring container.
    
    Returns:
    
    the bean name for this class
  - setBeanName
```
public void setBeanName(java.lang.String name)
```
    Specified by:
    
    setBeanName in interface org.springframework.beans.factory.BeanNameAware
  - setCacheTarget
```
public void setCacheTarget(boolean cacheTarget)
```
    Sets the caching of the exported target object. When enabled, the exporter will ignore the scope of the target bean and use only the first resolved instance for registration. When disabled (default), the scope of the target bean is considered and each service request, will be directed to the container. Set this option to 'true' to obtain OSGi 4.2 blueprint behaviour.

Class OsgiServiceFactoryBean

Nested Class Summary

Field Summary

Fields inherited from interface org.springframework.core.Ordered

Constructor Summary

Method Summary

Methods inherited from class org.eclipse.gemini.blueprint.service.exporter.support.AbstractOsgiServiceExporter

Methods inherited from class java.lang.Object

Field Detail

log

bundleContext

propertiesResolver

beanFactory

serviceRegistration

safeServiceRegistration

serviceProperties

propertiesListener

ranking

targetBeanName

hasNamedBean

interfaces

interfaceDetector

contextClassLoader

target

targetClass

order

classLoader

aopClassLoader

beanName

serviceRegistered

registerAtStartup

registerService

lock

controller

resolver

notifier

activated

cacheTarget

Constructor Detail

OsgiServiceFactoryBean

Method Detail

afterPropertiesSet

destroy

addBeanFactoryDependency

mergeServiceProperties

registerService

registerService

isBeanBundleScoped

setBeanClassLoader

getObject

getObjectType

isSingleton

unregisterService

unregisterService

setContextClassLoader

setExportContextClassLoader

getTarget

setTarget

getTargetBeanName

setTargetBeanName

setAutoExport

setInterfaceDetector

getServiceProperties

setServiceProperties

getRanking

setRanking

setRegisterService

setBeanFactory

setBundleContext

getResolver

setResolver

getInterfaces

setInterfaces

getOrder

setOrder

getBeanName

setBeanName

setCacheTarget