com.github.dynamicextensionsalfresco.blueprint.DynamicExtensionsApplicationContextCreatorBase Maven / Gradle / Ivy
Show all versions of blueprint-integration-spring-3 Show documentation
package com.github.dynamicextensionsalfresco.blueprint;
import java.util.LinkedHashSet;
import java.util.Set;
import org.alfresco.service.descriptor.DescriptorService;
import org.alfresco.util.VersionNumber;
import org.eclipse.gemini.blueprint.context.DelegatedExecutionOsgiBundleApplicationContext;
import org.eclipse.gemini.blueprint.context.support.DefaultContextClassLoaderProvider;
import org.eclipse.gemini.blueprint.extender.OsgiApplicationContextCreator;
import org.eclipse.gemini.blueprint.extender.support.ApplicationContextConfiguration;
import org.eclipse.gemini.blueprint.extender.support.DefaultOsgiApplicationContextCreator;
import org.osgi.framework.Bundle;
import org.osgi.framework.BundleContext;
import org.osgi.framework.BundleException;
import org.osgi.framework.InvalidSyntaxException;
import org.osgi.framework.ServiceReference;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.ApplicationContext;
/**
* {@link OsgiApplicationContextCreator} that creates a {@link DynamicExtensionsApplicationContextBase} if a bundle has been
* marked as an Alfresco Dynamic Extension. Otherwise the implementation delegates to
* {@link DefaultOsgiApplicationContextCreator} to support the creation of regular Spring DM bundles.
*
* This implementation automatically uninstalls Dynamic Extension bundles with a duplicate symbolic name, even if they
* are of a different version. While OSGi allows running parallel versions of a given bundle, this additional constraint
* prevents duplicate Web Script, Behaviour and Action bindings in the repository.
*
* Installing parallel versions of regular OSGi bundles - that is: bundles without the
* Alfresco-Dynamic-Extension header - is still allowed.
*
* @author Laurens Fridael
*
*/
public abstract class DynamicExtensionsApplicationContextCreatorBase implements OsgiApplicationContextCreator {
private static final String ALFRESCO_DYNAMIC_EXTENSION_HEADER = "Alfresco-Dynamic-Extension";
private static final String HOST_APPLICATION_CONTEXT_BEAN_NAME = "HostApplicationContext";
private static final String OSGI_SERVICE_BLUEPRINT_COMPNAME = "osgi.service.blueprint.compname";
private final Logger logger = LoggerFactory.getLogger(getClass());
/* Operations */
@Override
public DelegatedExecutionOsgiBundleApplicationContext createApplicationContext(final BundleContext bundleContext)
throws Exception {
final Bundle bundle = bundleContext.getBundle();
/*
* WARNING: Avoid creating an instance of
* org.eclipse.gemini.blueprint.extender.internal.blueprint.activator.support.BlueprintContainerConfig, since
* this package is not exported by the extender Bundle. You should use
* org.eclipse.gemini.blueprint.extender.support.ApplicationContextConfiguration instead.
*
* https://bugs.eclipse.org/bugs/show_bug.cgi?id=379384
*
* UPDATE: This issue still seems to occur with Blueprint 1.0.2.RELEASE. Since Dynamic Extensions de-emphasizes
* the direct use of OSGi anyway, Blueprint configuration will definitely not be supported.
*/
final ApplicationContextConfiguration config = new ApplicationContextConfiguration(bundle);
String[] configurationLocations = null;
if (config.isSpringPoweredBundle()) {
configurationLocations = config.getConfigurationLocations();
}
if ((configurationLocations == null || configurationLocations.length == 0)
&& isAlfrescoDynamicExtension(bundle) == false) {
return null;
}
if (isAlfrescoDynamicExtension(bundle)) {
uninstallBundlesWithDuplicateSymbolicName(bundleContext);
}
final DynamicExtensionsApplicationContextBase applicationContext = createNewInstance(
configurationLocations, getHostApplicationContext(bundleContext));
applicationContext.setBundleContext(bundleContext);
final DefaultContextClassLoaderProvider contextClassLoaderProvider = new DefaultContextClassLoaderProvider();
contextClassLoaderProvider.setBeanClassLoader(ApplicationContext.class.getClassLoader());
applicationContext.setContextClassLoaderProvider(contextClassLoaderProvider);
applicationContext.setPublishContextAsService(config.isPublishContextAsService());
return applicationContext;
}
protected abstract DynamicExtensionsApplicationContextBase createNewInstance(String[] configurationLocations, ApplicationContext hostApplicationContext);
protected boolean isAlfrescoDynamicExtension(final Bundle bundle) {
return Boolean.valueOf(bundle.getHeaders().get(ALFRESCO_DYNAMIC_EXTENSION_HEADER));
}
/**
* Uninstalls {@link Bundle}s with symbolic names equal to that of the {@link Bundle} represented by the given the
* {@link BundleContext}
*
* @param bundleContext
* @throws BundleException
*/
protected void uninstallBundlesWithDuplicateSymbolicName(final BundleContext bundleContext) throws BundleException {
final Bundle currentBundle = bundleContext.getBundle();
final Set duplicateInstalledBundles = new LinkedHashSet();
for (final Bundle installedBundle : bundleContext.getBundles()) {
if (currentBundle != installedBundle && currentBundle.getBundleId() != installedBundle.getBundleId()
&& currentBundle.getSymbolicName().equals(installedBundle.getSymbolicName())) {
duplicateInstalledBundles.add(installedBundle);
}
}
for (final Bundle installedBundle : duplicateInstalledBundles) {
try {
if (logger.isWarnEnabled()) {
logger.warn("Overwriting existing installation of Dynamic Extension '{}'. "
+ "It is recommended not to deploy multiple versions of the same Dynamic Extension.",
installedBundle.getSymbolicName());
}
installedBundle.uninstall();
} catch (final BundleException e) {
logger.error("Error uninstalling Bundle: {}", e.getMessage(), e);
}
}
}
protected ApplicationContext getHostApplicationContext(final BundleContext bundleContext) {
final ServiceReference serviceReference = getServiceReferenceWithBeanName(bundleContext,
ApplicationContext.class.getName(), HOST_APPLICATION_CONTEXT_BEAN_NAME);
if (serviceReference != null) {
VersionNumber version = BundleUtils.getService(bundleContext, DescriptorService.class).getServerDescriptor()
.getVersionNumber();
return getSpringSpecificHostApplicationContext(bundleContext, serviceReference);
} else {
return null;
}
}
protected abstract ApplicationContext getSpringSpecificHostApplicationContext(BundleContext bundleContext, ServiceReference serviceReference);
protected ServiceReference getServiceReferenceWithBeanName(final BundleContext bundleContext,
final String serviceName, final String beanName) {
try {
final String filter = String.format("(%s=%s)", OSGI_SERVICE_BLUEPRINT_COMPNAME, beanName);
final ServiceReference[] serviceReferences = bundleContext.getServiceReferences(serviceName, filter);
if (serviceReferences != null && serviceReferences.length > 0) {
return serviceReferences[0];
} else {
return null;
}
} catch (final InvalidSyntaxException e) {
throw new RuntimeException(e);
}
}
}