org.eclipse.gemini.blueprint.service.importer.support

Class AbstractServiceImporterProxyFactoryBean

java.lang.Object

org.eclipse.gemini.blueprint.service.importer.support.AbstractOsgiServiceImportFactoryBean

org.eclipse.gemini.blueprint.service.importer.support.AbstractServiceImporterProxyFactoryBean

All Implemented Interfaces:

BundleContextAware, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanClassLoaderAware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.FactoryBean<java.lang.Object>, org.springframework.beans.factory.InitializingBean, org.springframework.beans.factory.SmartFactoryBean<java.lang.Object>

Direct Known Subclasses:

OsgiServiceCollectionProxyFactoryBean, OsgiServiceProxyFactoryBean

abstract class AbstractServiceImporterProxyFactoryBean
extends AbstractOsgiServiceImportFactoryBean
implements org.springframework.beans.factory.SmartFactoryBean<java.lang.Object>

Package protected class that provides the common aop infrastructure functionality for OSGi service importers. Provides most of the constructs required for assembling the service proxies, leaving subclasses to decide on the service cardinality (one service or multiple) and proxy weaving.

Field Summary

Fields

Modifier and Type	Field and Description
private ChainedClassLoader	aopClassLoader aop classloader
private boolean	blueprintCompliant
private boolean	initialized
private boolean	lazyProxy
protected java.lang.Object	proxy
private boolean	useBlueprintException

Constructor Summary

Constructors

Constructor and Description
AbstractServiceImporterProxyFactoryBean()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
(package private) abstract java.lang.Object	createProxy(boolean lazy) Creates the proxy tracking the matching OSGi services.
void	destroy()
(package private) java.lang.ClassLoader	getAopClassLoader() Returns the class loader used for AOP weaving
java.lang.Object	getObject() Returns a managed object for accessing OSGi service(s).
java.lang.Class<?>	getObjectType() Returns the managed proxy type.
(package private) abstract java.lang.Runnable	getProxyDestructionCallback() Returns the destruction callback associated with the proxy created by this object.
(package private) abstract java.lang.Runnable	getProxyInitializer() Returns a callback to the proxy which gets called when the proxy is called for the first time, if a lazy creation was used.
(package private) boolean	isBlueprintCompliant()
boolean	isEagerInit() The object created by this factory bean is eagerly initialized.
boolean	isPrototype() The object returned by this FactoryBean is a not a prototype.
boolean	isSingleton() The object managed by this factory is a singleton.
(package private) boolean	isUseBlueprintExceptions()
void	setBeanClassLoader(java.lang.ClassLoader classLoader) This method is called automatically by the container.
void	setBlueprintCompliant(boolean compliant) Indicates whether the importer should use (strict) blueprint spec compliance or not.
void	setUseBlueprintExceptions(boolean useBlueprintExceptions) Indicates whether Blueprint exceptions are preferred over Spring DM ones.

Methods inherited from class org.eclipse.gemini.blueprint.service.importer.support.AbstractOsgiServiceImportFactoryBean

getAvailability, getBeanClassLoader, getBeanName, getBundleContext, getCardinality, getContextClassLoader, getFilter, getImportContextClassLoader, getInterfaces, getInternalCardinality, getListeners, getUnifiedFilter, setAvailability, setBeanName, setBundleContext, setCardinality, setContextClassLoader, setFilter, setImportContextClassLoader, setInterfaces, setListeners, setServiceBeanName

Methods inherited from class java.lang.Object

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

Field Detail

initialized

private volatile boolean initialized

proxy

protected java.lang.Object proxy

useBlueprintException

private boolean useBlueprintException

lazyProxy

private volatile boolean lazyProxy

aopClassLoader

private ChainedClassLoader aopClassLoader

aop classloader

blueprintCompliant

private boolean blueprintCompliant

Constructor Detail

AbstractServiceImporterProxyFactoryBean

AbstractServiceImporterProxyFactoryBean()

Method Detail

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

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

Overrides:

afterPropertiesSet in class AbstractOsgiServiceImportFactoryBean

destroy

public void destroy()
             throws java.lang.Exception

Specified by:

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

Throws:

java.lang.Exception

getObject

public java.lang.Object getObject()

Returns a managed object for accessing OSGi service(s).

Specified by:

getObject in interface org.springframework.beans.factory.FactoryBean<java.lang.Object>

Returns:

managed OSGi service(s)

getObjectType

public java.lang.Class<?> getObjectType()

Returns the managed proxy type. Note that calling this method will cause the creation of the proxy but not its initialization.

Specified by:

getObjectType in interface org.springframework.beans.factory.FactoryBean<java.lang.Object>

isSingleton

public boolean isSingleton()

The object managed by this factory is a singleton.

Specified by:

isSingleton in interface org.springframework.beans.factory.FactoryBean<java.lang.Object>

Returns:

true (i.e. the FactoryBean returns singletons)

isEagerInit

public boolean isEagerInit()

The object created by this factory bean is eagerly initialized.

Specified by:

isEagerInit in interface org.springframework.beans.factory.SmartFactoryBean<java.lang.Object>

Returns:

true (this factory bean should be eagerly initialized)

isPrototype

public boolean isPrototype()

The object returned by this FactoryBean is a not a prototype.

Specified by:

isPrototype in interface org.springframework.beans.factory.SmartFactoryBean<java.lang.Object>

Returns:

false (the managed object is not a prototype)

createProxy

abstract java.lang.Object createProxy(boolean lazy)

Creates the proxy tracking the matching OSGi services. This method is guaranteed to be called only once, normally during initialization.

Parameters:

lazy - indicates whether the proxy is lazy (no code is executed in the proxy) or not

Returns:

OSGi service tracking proxy.

See Also:

getProxyDestructionCallback()

getProxyInitializer

abstract java.lang.Runnable getProxyInitializer()

Returns a callback to the proxy which gets called when the proxy is called for the first time, if a lazy creation was used. For eager initialization, a null object should be returned.

Returns:

proxy initialization callback

getProxyDestructionCallback

abstract java.lang.Runnable getProxyDestructionCallback()

Returns the destruction callback associated with the proxy created by this object. The callback is called once, during the destruction process of the FactoryBean.

Returns:

destruction callback for the service proxy.

See Also:

#createProxy()

getAopClassLoader

java.lang.ClassLoader getAopClassLoader()

Returns the class loader used for AOP weaving

Returns:

the classloader used for weaving

setBeanClassLoader

public void setBeanClassLoader(java.lang.ClassLoader classLoader)

This method is called automatically by the container. The class will automatically chain this classloader with the AOP infrastructure classes (even if these are not visible to the user) so that the proxy creation can be completed successfully.

Specified by:

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

Overrides:

setBeanClassLoader in class AbstractOsgiServiceImportFactoryBean

setUseBlueprintExceptions

public void setUseBlueprintExceptions(boolean useBlueprintExceptions)

Indicates whether Blueprint exceptions are preferred over Spring DM ones.

Parameters:

useBlueprintExceptions -

isUseBlueprintExceptions

boolean isUseBlueprintExceptions()

setBlueprintCompliant

public void setBlueprintCompliant(boolean compliant)

Indicates whether the importer should use (strict) blueprint spec compliance or not. Strict compliance means that only interfaces are supported and that Blueprint exceptions are thrown by default.

Parameters:

compliant -

isBlueprintCompliant

boolean isBlueprintCompliant()