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

Class OsgiServiceProxyFactoryBean

java.lang.Object

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

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

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

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>, org.springframework.context.ApplicationEventPublisherAware

public final class OsgiServiceProxyFactoryBean
extends AbstractServiceImporterProxyFactoryBean
implements org.springframework.context.ApplicationEventPublisherAware

OSGi (single) service importer. This implementation creates a managed OSGi service proxy that handles the OSGi service dynamics. The returned proxy will select only the best matching OSGi service for the configuration criteria. If the select service goes away (at any point in time), the proxy will automatically search for a replacement without the user intervention.

Note that the proxy instance remains the same and only the backing OSGi service changes. Due to the dynamic nature of OSGi, the backing object can change during method invocations.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	OsgiServiceProxyFactoryBean.Executor Wrapper around internal commands.

Field Summary

Fields

Modifier and Type	Field and Description
private org.springframework.context.ApplicationEventPublisher	applicationEventPublisher application publisher
private ImporterInternalActions	controller
private java.lang.Runnable	destructionCallback proxy infrastructure hook exposed to allow clean up
private java.lang.Runnable	initializationCallback
private static org.apache.commons.logging.Log	log
private boolean	mandatory convenience field *
private java.lang.Object	monitor
private ImportedOsgiServiceProxy	proxy proxy cast to a specific interface to allow specific method calls
private RetryTemplate	retryTemplate
private long	retryTimeout
private java.util.List<ImporterStateListener>	stateListeners internal listeners
private boolean	sticky

Constructor Summary

Constructors

Constructor and Description
OsgiServiceProxyFactoryBean()

Method Summary

Modifier and Type	Method and Description
private OsgiServiceLifecycleListener[]	addListener(OsgiServiceLifecycleListener[] listeners, OsgiServiceLifecycleListener listener) Add the given listener to the array but in the first position.
void	afterPropertiesSet()
(package private) java.lang.Object	createProxy(boolean lazyProxy) Creates the proxy tracking the matching OSGi services.
(package private) Cardinality	getInternalCardinality()
java.lang.Object	getObject() Returns a managed object for accessing OSGi service(s).
(package private) java.lang.Runnable	getProxyDestructionCallback() Returns the destruction callback associated with the proxy created by this object.
(package private) 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.
long	getTimeout() Returns the timeout (in milliseconds) this importer waits while trying to find a backing service.
void	setApplicationEventPublisher(org.springframework.context.ApplicationEventPublisher applicationEventPublisher)
void	setSticky(boolean sticky) Sets the stickiness of this proxy.
void	setTimeout(long timeoutInMillis) Sets how long (in milliseconds) should this importer wait between failed attempts at rebinding to a service that has been unregistered.

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

destroy, getAopClassLoader, getObjectType, isBlueprintCompliant, isEagerInit, isPrototype, isSingleton, isUseBlueprintExceptions, setBeanClassLoader, setBlueprintCompliant, setUseBlueprintExceptions

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

getAvailability, getBeanClassLoader, getBeanName, getBundleContext, getCardinality, getContextClassLoader, getFilter, getImportContextClassLoader, getInterfaces, 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

log

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

retryTimeout

private long retryTimeout

retryTemplate

private RetryTemplate retryTemplate

proxy

private ImportedOsgiServiceProxy proxy

proxy cast to a specific interface to allow specific method calls

destructionCallback

private java.lang.Runnable destructionCallback

proxy infrastructure hook exposed to allow clean up

initializationCallback

private java.lang.Runnable initializationCallback

applicationEventPublisher

private org.springframework.context.ApplicationEventPublisher applicationEventPublisher

application publisher

stateListeners

private final java.util.List<ImporterStateListener> stateListeners

internal listeners

controller

private final ImporterInternalActions controller

mandatory

private volatile boolean mandatory

convenience field *

sticky

private volatile boolean sticky

monitor

private final java.lang.Object monitor

Constructor Detail

OsgiServiceProxyFactoryBean

public OsgiServiceProxyFactoryBean()

Method Detail

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

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

Overrides:

afterPropertiesSet in class AbstractServiceImporterProxyFactoryBean

getObject

public java.lang.Object getObject()

Returns a managed object for accessing OSGi service(s). Returns a managed proxy to the best matching OSGi service.

Specified by:

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

Overrides:

getObject in class AbstractServiceImporterProxyFactoryBean

Returns:

managed OSGi service(s)

createProxy

java.lang.Object createProxy(boolean lazyProxy)

Description copied from class: AbstractServiceImporterProxyFactoryBean

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

Specified by:

createProxy in class AbstractServiceImporterProxyFactoryBean

Parameters:

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

Returns:

OSGi service tracking proxy.

See Also:

AbstractServiceImporterProxyFactoryBean.getProxyDestructionCallback()

getProxyInitializer

java.lang.Runnable getProxyInitializer()

Description copied from class: AbstractServiceImporterProxyFactoryBean

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.

Specified by:

getProxyInitializer in class AbstractServiceImporterProxyFactoryBean

Returns:

proxy initialization callback

getProxyDestructionCallback

java.lang.Runnable getProxyDestructionCallback()

Description copied from class: AbstractServiceImporterProxyFactoryBean

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

Specified by:

getProxyDestructionCallback in class AbstractServiceImporterProxyFactoryBean

Returns:

destruction callback for the service proxy.

See Also:

#createProxy()

addListener

private OsgiServiceLifecycleListener[] addListener(OsgiServiceLifecycleListener[] listeners,
                                                   OsgiServiceLifecycleListener listener)

Add the given listener to the array but in the first position.

Parameters:

listeners -

listener -

Returns:

setTimeout

public void setTimeout(long timeoutInMillis)

Sets how long (in milliseconds) should this importer wait between failed attempts at rebinding to a service that has been unregistered.

It is possible to change this value after initialization (while the proxy is in place). The new values will be used immediately by the proxy. Any in-flight waiting will be restarted using the new values. Note that if both values are the same, no restart will be applied.

Parameters:

timeoutInMillis - Timeout to set, in milliseconds

getTimeout

public long getTimeout()

Returns the timeout (in milliseconds) this importer waits while trying to find a backing service.

Returns:

timeout in milliseconds

setSticky

public void setSticky(boolean sticky)

Sets the stickiness of this proxy. If 'true' (default), the proxy will rebind only if the backing service is no longer available. If 'false', the rebind will occur every time a 'better' candidate appears. A better service is defined by having either a higher ranking or the same ranking and a lower service id.

Parameters:

sticky - sticky flag

setApplicationEventPublisher

public void setApplicationEventPublisher(org.springframework.context.ApplicationEventPublisher applicationEventPublisher)

Specified by:

setApplicationEventPublisher in interface org.springframework.context.ApplicationEventPublisherAware

getInternalCardinality

Cardinality getInternalCardinality()

Specified by:

getInternalCardinality in class AbstractOsgiServiceImportFactoryBean