jpa-container-eclipselink-adapter/src/main/java/org/apache/aries/jpa/eclipselink/adapter/Activator.java

/*
// * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIESOR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.aries.jpa.eclipselink.adapter;

import java.lang.reflect.Constructor;
import java.util.Dictionary;
import java.util.HashSet;
import java.util.Hashtable;
import java.util.List;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;

import javax.persistence.EntityManagerFactory;
import javax.persistence.spi.PersistenceProvider;

import org.osgi.framework.Bundle;
import org.osgi.framework.BundleActivator;
import org.osgi.framework.BundleContext;
import org.osgi.framework.BundleEvent;
import org.osgi.framework.BundleListener;
import org.osgi.framework.Constants;
import org.osgi.framework.ServiceRegistration;
import org.osgi.framework.wiring.BundleRevision;
import org.osgi.framework.wiring.BundleWire;
import org.osgi.framework.wiring.BundleWiring;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Eclipselink adapter main class.
 * 
 * The purpose of this class is to:
 * <ul>
 * <li>publish an OSGi-compatible Eclipselink {@link PersistenceProvider} service in the service registry</li>
 * <li>intercept {@link EntityManagerFactory} creation to ensure that the Eclipselink target server (if not specified otherwise)
 *     is OSGi compatible</li>
 * </ul>
 */
public class Activator implements BundleActivator, BundleListener {
    public static final String ECLIPSELINK_JPA_PROVIDER_BUNDLE_SYMBOLIC_NAME = "org.eclipse.persistence.jpa";
    public static final String ECLIPSELINK_JPA_PROVIDER_CLASS_NAME = "org.eclipse.persistence.jpa.PersistenceProvider";
    private static final Logger LOG = LoggerFactory.getLogger(Activator.class);
    private final ConcurrentMap<Bundle, ServiceRegistration<?>> registeredProviders = new ConcurrentHashMap<Bundle, ServiceRegistration<?>>();
    
    private BundleContext context;
    
    @Override
    public void start(BundleContext ctx) {
        LOG.debug("Starting EclipseLink adapter");
        context = ctx;
        ctx.addBundleListener(this);
        
        for (Bundle b : ctx.getBundles()) {
            if ((b.getState() & (Bundle.ACTIVE | Bundle.STARTING | Bundle.RESOLVED | Bundle.STOPPING)) != 0) 
                handlePotentialEclipseLink(b);
        }
    }
    
    @Override
    public void stop(BundleContext ctx) {
        LOG.debug("Stopping EclipseLink adapter");

        for (ServiceRegistration<?> reg : registeredProviders.values()) {
          reg.unregister();
        }
      }
    
    @Override
    public void bundleChanged(BundleEvent event) {
        if ((event.getType() & (BundleEvent.RESOLVED)) != 0) {
            handlePotentialEclipseLink(event.getBundle());
        } else if (event.getType() == BundleEvent.UNRESOLVED || event.getType() == BundleEvent.UNINSTALLED) {
            ServiceRegistration<?> reg = registeredProviders.remove(event.getBundle());
            if (reg != null) {
                reg.unregister();
            }
        }
    }
    
    private void handlePotentialEclipseLink(Bundle b) {
        if (!ECLIPSELINK_JPA_PROVIDER_BUNDLE_SYMBOLIC_NAME.equals(b.getSymbolicName())) {
            return;
        }
        if (registeredProviders.containsKey(b)) {
            return;
        }
        
        PersistenceProvider provider = createEclipselinkProvider(b);
        if (provider == null) {
            return;
        }

        LOG.debug("Adding new EclipseLink provider for bundle {}", b);
        PersistenceProvider proxiedProvider = new EclipseLinkPersistenceProvider(provider, b);
        
        Dictionary<String, Object> props = new Hashtable<String, Object>(); // NOSONAR
        props.put("org.apache.aries.jpa.container.weaving.packages", getJPAPackages(b));
        props.put("javax.persistence.provider", ECLIPSELINK_JPA_PROVIDER_CLASS_NAME);
        ServiceRegistration<?> reg = context.registerService(PersistenceProvider.class, proxiedProvider, props);
        
        ServiceRegistration<?> old = registeredProviders.putIfAbsent(b, reg);
        if (old != null) {
            reg.unregister();
        }
    }

    @SuppressWarnings("unchecked")
    private static PersistenceProvider createEclipselinkProvider(Bundle b) {
        try {
            Class<? extends PersistenceProvider> providerClass = (Class<? extends PersistenceProvider>)b.loadClass(Activator.ECLIPSELINK_JPA_PROVIDER_CLASS_NAME);
            Constructor<? extends PersistenceProvider> con = providerClass.getConstructor();
            return con.newInstance();
        } catch (Exception e) {
            LOG.debug("Unable to load EclipseLink provider class. Ignoring bundle " + b.getSymbolicName(), e);
            return null;
        }
    }
    
    /**
     * Get all the relevant packages that the EclipseLink JPA provider exports or persistence packages it uses itself. These are needed
     * so that the woven proxy (for runtime enhancement) can be used later on :)
     * 
     * Note that differently to OpenJPA the relevant classes are actually in more than just one bundle (org.eclipse.persistence.jpa and org.eclipse.persistence.core
     * at the time of this writing). Hence, we have to take more than just the packages of the JPA provider bundle into account ...
     * 
     * @param jpaBundle
     * @return
     */
    private String[] getJPAPackages(Bundle jpaBundle) {
        Set<String> result = new HashSet<String>();

        for (Bundle b : context.getBundles()) {
            BundleWiring bw = b.adapt(BundleWiring.class);
            if (bw == null) {
                continue;
            }
            boolean isJpaBundle = b.equals(jpaBundle);
            List<BundleWire> wires = bw.getProvidedWires(BundleRevision.PACKAGE_NAMESPACE);
            for (BundleWire w : wires) {
                String pkgName = (String)w.getCapability().getAttributes().get(BundleRevision.PACKAGE_NAMESPACE);
                boolean add = isJpaBundle || pkgName.startsWith("org.eclipse.persistence");
                if (add) {
                    result.add(getPkg(b, pkgName));
                }
            }
        }
        
        result.add(getPkg(context.getBundle(), "org.apache.aries.jpa.eclipselink.adapter.platform"));
        LOG.debug("Found JPA packages {}", result);
        return result.toArray(new String[0]);
    }

    private static String getPkg(Bundle b, String pkgName) {
        return String.format("%s;%s=%s; %s=%s", pkgName, Constants.BUNDLE_SYMBOLICNAME_ATTRIBUTE, b.getSymbolicName(), Constants.BUNDLE_VERSION_ATTRIBUTE, b.getVersion());
    }
}