com.atlassian.activeobjects.osgi

Class ActiveObjectsServiceFactory

java.lang.Object

com.atlassian.activeobjects.osgi.ActiveObjectsServiceFactory

All Implemented Interfaces:

org.osgi.framework.ServiceFactory, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean

public class ActiveObjectsServiceFactory
extends Object
implements org.osgi.framework.ServiceFactory, org.springframework.beans.factory.InitializingBean, org.springframework.beans.factory.DisposableBean

This is the service factory that will create the ActiveObjects instance for each plugin using active objects.

The instance created by that factory is a delegating instance that works together with the ActiveObjectsServiceFactory to get a correctly configure instance according to the plugin configuration and the application configuration.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ActiveObjectsServiceFactory.BundleRef Provides a wrapper that gives explicit object identity hashing and reference equality (via identity hasing)of a Bundle, for use in maps etc.

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	INIT_TASK_TIMEOUT_MS

Constructor Summary

Constructors

Constructor and Description
ActiveObjectsServiceFactory(ActiveObjectsFactory factory, com.atlassian.event.api.EventPublisher eventPublisher, com.atlassian.tenancy.api.TenantContext tenantContext, com.atlassian.sal.api.executor.ThreadLocalDelegateExecutorFactory threadLocalDelegateExecutorFactory, InitExecutorServiceProvider initExecutorServiceProvider)

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
void	destroy()
Object	getService(org.osgi.framework.Bundle bundle, org.osgi.framework.ServiceRegistration serviceRegistration) Invoked when the Gemini Blueprints/Spring DM proxy first accesses the module.
void	onHotRestart(HotRestartEvent hotRestartEvent) Listens for HotRestartEvent and recreate all ActiveObjects instances within the delegates with the possibly different configuration and data source
void	onPluginDisabledEvent(com.atlassian.plugin.event.events.PluginDisabledEvent pluginDisabledEvent) Listens for PluginDisabledEvent.
void	onPluginEnabledEvent(com.atlassian.plugin.event.events.PluginEnabledEvent pluginEnabledEvent) Listens for PluginEnabledEvent.
void	onPluginModuleEnabledEvent(com.atlassian.plugin.event.events.PluginModuleEnabledEvent pluginModuleEnabledEvent) Listens for PluginModuleEnabledEvent for ActiveObjectModuleDescriptor.
void	onTenantArrived(com.atlassian.tenancy.api.event.TenantArrivedEvent event) Listens for TenantArrivedEvent and allows initialisation of any uninitialised instances
void	startCleaning()
void	stopCleaning()
void	ungetService(org.osgi.framework.Bundle bundle, org.osgi.framework.ServiceRegistration serviceRegistration, Object ao) Invoked when the Gemini Blueprints/Spring DM proxy releases the module.

Methods inherited from class java.lang.Object

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

Field Detail

INIT_TASK_TIMEOUT_MS

protected static final int INIT_TASK_TIMEOUT_MS

Constructor Detail

ActiveObjectsServiceFactory

public ActiveObjectsServiceFactory(@Nonnull
                                   ActiveObjectsFactory factory,
                                   @Nonnull
                                   com.atlassian.event.api.EventPublisher eventPublisher,
                                   @Nonnull
                                   com.atlassian.tenancy.api.TenantContext tenantContext,
                                   @Nonnull
                                   com.atlassian.sal.api.executor.ThreadLocalDelegateExecutorFactory threadLocalDelegateExecutorFactory,
                                   @Nonnull
                                   InitExecutorServiceProvider initExecutorServiceProvider)

Method Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

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

Throws:

Exception

destroy

public void destroy()
             throws Exception

Specified by:

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

Throws:

Exception

getService

public Object getService(org.osgi.framework.Bundle bundle,
                         org.osgi.framework.ServiceRegistration serviceRegistration)

Invoked when the Gemini Blueprints/Spring DM proxy first accesses the module. Note that Blueprints is lazy, so this may not be called. A "safety backup" is added in onPluginEnabledEvent(PluginEnabledEvent) to eagerly initialise the lazy proxies that are not invoked during plugin startup.

Specified by:

getService in interface org.osgi.framework.ServiceFactory

ungetService

public void ungetService(org.osgi.framework.Bundle bundle,
                         org.osgi.framework.ServiceRegistration serviceRegistration,
                         Object ao)

Invoked when the Gemini Blueprints/Spring DM proxy releases the module. Note that Blueprints is lazy, so the proxy may never have been realised, thus this may not be called. A "safety backup" is added in onPluginDisabledEvent(PluginDisabledEvent) to release those references, for plugins that never realise the module.

Specified by:

ungetService in interface org.osgi.framework.ServiceFactory

startCleaning

public void startCleaning()

stopCleaning

public void stopCleaning()

onTenantArrived

@EventListener
public void onTenantArrived(com.atlassian.tenancy.api.event.TenantArrivedEvent event)

Listens for TenantArrivedEvent and allows initialisation of any uninitialised instances

onHotRestart

@EventListener
public void onHotRestart(HotRestartEvent hotRestartEvent)

Listens for HotRestartEvent and recreate all ActiveObjects instances within the delegates with the possibly different configuration and data source

onPluginModuleEnabledEvent

@EventListener
public void onPluginModuleEnabledEvent(com.atlassian.plugin.event.events.PluginModuleEnabledEvent pluginModuleEnabledEvent)

Listens for PluginModuleEnabledEvent for ActiveObjectModuleDescriptor. Passes it to appropriate delegate i.e. the one for which the plugin/bundle key matches.

onPluginEnabledEvent

@EventListener
public void onPluginEnabledEvent(com.atlassian.plugin.event.events.PluginEnabledEvent pluginEnabledEvent)

Listens for PluginEnabledEvent. If the plugin is present in the unattached configurations, it will tickle aoDelegatesByBundle to ensure that the configuration has been attached to a service, whether it has been OSGi registered or not.

onPluginDisabledEvent

@EventListener
public void onPluginDisabledEvent(com.atlassian.plugin.event.events.PluginDisabledEvent pluginDisabledEvent)

Listens for PluginDisabledEvent. If the plugin is present in the unattached or attached configurations, it will be removed to ensure that we don't leak resources and, more importantly, don't retain it if the plugin is re-enabled.