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

Class ServiceDynamicInterceptor

java.lang.Object

org.eclipse.gemini.blueprint.service.importer.support.internal.aop.ServiceInvoker

org.eclipse.gemini.blueprint.service.importer.support.internal.aop.ServiceDynamicInterceptor

All Implemented Interfaces:

org.aopalliance.aop.Advice, org.aopalliance.intercept.Interceptor, org.aopalliance.intercept.MethodInterceptor, ServiceReferenceProvider, org.springframework.beans.factory.Aware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationEventPublisherAware

public class ServiceDynamicInterceptor
extends ServiceInvoker
implements org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationEventPublisherAware

Interceptor adding dynamic behaviour for unary service (..1 cardinality). It will look for a service using the given filter, retrying if the service is down or unavailable. Will dynamically rebound a new service, if one is available with a higher service ranking and the interceptor is non sticky.

In case no service is available, it will throw an exception.

Note: this is a stateful interceptor and should not be shared.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	ServiceDynamicInterceptor.EventSenderRetryTemplate Override the default implementation to plug in event notification.
private class	ServiceDynamicInterceptor.Listener Listener tracking the OSGi services which form the dynamic reference.
private class	ServiceDynamicInterceptor.ServiceLookUpCallback
private class	ServiceDynamicInterceptor.ServiceReferenceLookUpCallback

Field Summary

Fields

Modifier and Type	Field and Description
private org.springframework.context.ApplicationEventPublisher	applicationEventPublisher event publisher
private org.osgi.framework.BundleContext	bundleContext
private java.lang.ClassLoader	classLoader TCCL to set when calling listeners
private OsgiServiceDependency	dependency dependency object
private boolean	destroyed flag indicating whether the proxy is already destroyed or not
private java.lang.Object	eventSource dependable service importer
private org.osgi.framework.Filter	filter
private java.lang.String	filterClassName
private static int	hashCode
private ReferenceHolder	holder service reference/service holder
private boolean	isDuringDestruction flag indicating whether the destruction has started or not
private org.osgi.framework.ServiceListener	listener event listener
private OsgiServiceLifecycleListener[]	listeners listener that need to be informed of bind/rebind/unbind
private java.lang.Object	lock used for reading/setting property and sending notifications between the event listener and any threads waiting for an OSGi service to appear
private boolean	mandatoryService mandatory flag
private java.lang.Object	proxy reference to the created proxy passed to the listeners
private static org.apache.commons.logging.Log	PUBLIC_LOGGER public logger
private SwappingServiceReferenceProxy	referenceDelegate
private RetryCallback<java.lang.Object>	retryCallback retry callback
private RetryTemplate	retryTemplate retry template
private java.lang.String	sourceName event source (importer) name
private java.util.List<ImporterStateListener>	stateListeners internal state listeners
private boolean	sticky
private boolean	useBlueprintExceptions standard exception flag

Fields inherited from class org.eclipse.gemini.blueprint.service.importer.support.internal.aop.ServiceInvoker

log

Constructor Summary

Constructors

Constructor and Description
ServiceDynamicInterceptor(org.osgi.framework.BundleContext context, java.lang.String filterClassName, org.osgi.framework.Filter filter, java.lang.ClassLoader classLoader)

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
void	destroy()
boolean	equals(java.lang.Object other)
OsgiServiceLifecycleListener[]	getListeners()
RetryTemplate	getRetryTemplate()
org.osgi.framework.ServiceReference	getServiceReference() Convenience method exposing the target (OSGi service) reference so that subinterceptors can access it.
java.lang.Object	getTarget() Determine the target object to execute the invocation upon.
org.osgi.framework.ServiceReference	getTargetReference()
int	hashCode()
private java.lang.Object	lookupService() Looks the service by waiting the service to appear.
private org.osgi.framework.ServiceReference	lookupServiceReference() Looks for the service reference to appear.
private void	publishEvent(org.springframework.context.ApplicationEvent event)
void	setApplicationEventPublisher(org.springframework.context.ApplicationEventPublisher applicationEventPublisher)
void	setListeners(OsgiServiceLifecycleListener[] listeners)
void	setMandatoryService(boolean mandatoryService)
void	setProxy(java.lang.Object proxy)
void	setRetryTimeout(long timeout)
void	setServiceImporter(java.lang.Object importer)
void	setServiceImporterName(java.lang.String name)
void	setStateListeners(java.util.List stateListeners) Internal state listeners
void	setSticky(boolean sticky)
void	setUseBlueprintExceptions(boolean useBlueprintExceptions)

Methods inherited from class org.eclipse.gemini.blueprint.service.importer.support.internal.aop.ServiceInvoker

doInvoke, invoke

Methods inherited from class java.lang.Object

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

Field Detail

hashCode

private static final int hashCode

PUBLIC_LOGGER

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

public logger

bundleContext

private final org.osgi.framework.BundleContext bundleContext

filterClassName

private final java.lang.String filterClassName

filter

private final org.osgi.framework.Filter filter

classLoader

private final java.lang.ClassLoader classLoader

TCCL to set when calling listeners

referenceDelegate

private final SwappingServiceReferenceProxy referenceDelegate

listener

private final org.osgi.framework.ServiceListener listener

event listener

mandatoryService

private boolean mandatoryService

mandatory flag

isDuringDestruction

private boolean isDuringDestruction

flag indicating whether the destruction has started or not

destroyed

private volatile boolean destroyed

flag indicating whether the proxy is already destroyed or not

lock

private final java.lang.Object lock

used for reading/setting property and sending notifications between the event listener and any threads waiting for an OSGi service to appear

holder

private volatile ReferenceHolder holder

service reference/service holder

retryTemplate

private final RetryTemplate retryTemplate

retry template

retryCallback

private final RetryCallback<java.lang.Object> retryCallback

retry callback

eventSource

private java.lang.Object eventSource

dependable service importer

sourceName

private java.lang.String sourceName

event source (importer) name

listeners

private OsgiServiceLifecycleListener[] listeners

listener that need to be informed of bind/rebind/unbind

proxy

private java.lang.Object proxy

reference to the created proxy passed to the listeners

applicationEventPublisher

private org.springframework.context.ApplicationEventPublisher applicationEventPublisher

event publisher

dependency

private OsgiServiceDependency dependency

dependency object

stateListeners

private java.util.List<ImporterStateListener> stateListeners

internal state listeners

useBlueprintExceptions

private boolean useBlueprintExceptions

standard exception flag

sticky

private boolean sticky

Constructor Detail

ServiceDynamicInterceptor

public ServiceDynamicInterceptor(org.osgi.framework.BundleContext context,
                                 java.lang.String filterClassName,
                                 org.osgi.framework.Filter filter,
                                 java.lang.ClassLoader classLoader)

Method Detail

getTarget

public java.lang.Object getTarget()

Description copied from class: ServiceInvoker

Determine the target object to execute the invocation upon.

Specified by:

getTarget in class ServiceInvoker

Returns:

getTargetReference

public org.osgi.framework.ServiceReference getTargetReference()

lookupService

private java.lang.Object lookupService()

Looks the service by waiting the service to appear. Note this method should use the same lock as the listener handling the service reference.

lookupServiceReference

private org.osgi.framework.ServiceReference lookupServiceReference()

Looks for the service reference to appear.

Returns:

publishEvent

private void publishEvent(org.springframework.context.ApplicationEvent event)

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

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

destroy

public void destroy()

Specified by:

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

Specified by:

destroy in class ServiceInvoker

getServiceReference

public org.osgi.framework.ServiceReference getServiceReference()

Convenience method exposing the target (OSGi service) reference so that subinterceptors can access it. By default, returns null. This particular interceptor returns a delegated service reference so that callers can keep the reference even if the underlying target service reference changes in time.

Specified by:

getServiceReference in interface ServiceReferenceProvider

Overrides:

getServiceReference in class ServiceInvoker

setRetryTimeout

public void setRetryTimeout(long timeout)

getRetryTemplate

public RetryTemplate getRetryTemplate()

getListeners

public OsgiServiceLifecycleListener[] getListeners()

setListeners

public void setListeners(OsgiServiceLifecycleListener[] listeners)

setServiceImporter

public void setServiceImporter(java.lang.Object importer)

setServiceImporterName

public void setServiceImporterName(java.lang.String name)

setMandatoryService

public void setMandatoryService(boolean mandatoryService)

setProxy

public void setProxy(java.lang.Object proxy)

setApplicationEventPublisher

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

Specified by:

setApplicationEventPublisher in interface org.springframework.context.ApplicationEventPublisherAware

setStateListeners

public void setStateListeners(java.util.List stateListeners)

Internal state listeners

setUseBlueprintExceptions

public void setUseBlueprintExceptions(boolean useBlueprintExceptions)

setSticky

public void setSticky(boolean sticky)

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object