Merge "JERSEY-2320: EJB singleton bean registered as an exception mapper causes deployment failure. - added test case and fixed the original issue - added EJB stateless bean as exception mapper - made sure both EJB beans get properly injected"

Author: Michal Gajdoš

core-common/src/main/java/org/glassfish/jersey/internal/ExceptionMapperFactory.java

@@ -41,30 +41,37 @@
 package org.glassfish.jersey.internal;
 
 import java.lang.reflect.ParameterizedType;
+import java.lang.reflect.Proxy;
 import java.lang.reflect.Type;
 import java.lang.reflect.TypeVariable;
+import java.util.Collection;
+import java.util.Comparator;
+import java.util.LinkedHashMap;
 import java.util.LinkedHashSet;
+import java.util.List;
 import java.util.Map;
+import java.util.Map.Entry;
 import java.util.Set;
+import java.util.SortedSet;
 import java.util.TreeMap;
+import java.util.TreeSet;
 import java.util.logging.Level;
 import java.util.logging.Logger;
-
-import javax.ws.rs.ProcessingException;
-import javax.ws.rs.ext.ExceptionMapper;
-
 import javax.inject.Inject;
 import javax.inject.Singleton;
-
+import javax.ws.rs.ProcessingException;
+import javax.ws.rs.ext.ExceptionMapper;
+import org.glassfish.hk2.api.ActiveDescriptor;
+import org.glassfish.hk2.api.ServiceHandle;
+import org.glassfish.hk2.api.ServiceLocator;
+import org.glassfish.hk2.utilities.binding.AbstractBinder;
+import org.glassfish.jersey.internal.inject.CustomAnnotationImpl;
 import org.glassfish.jersey.internal.inject.Providers;
 import org.glassfish.jersey.internal.util.ReflectionHelper;
 import org.glassfish.jersey.internal.util.collection.ClassTypePair;
 import org.glassfish.jersey.spi.ExceptionMappers;
 import org.glassfish.jersey.spi.ExtendedExceptionMapper;
 
-import org.glassfish.hk2.api.ServiceLocator;
-import org.glassfish.hk2.utilities.binding.AbstractBinder;
-
 /**
  * {@link ExceptionMappers Exception mappers} implementation that aggregates
  * exception mappers and server as the main entry point for exception mapper
@@ -73,6 +80,7 @@
  * @author Paul Sandoz
  * @author Santiago Pericas-Geertsen (Santiago.PericasGeertsen at oracle.com)
  * @author Marek Potociar (marek.potociar at oracle.com)
+ * @author Jakub Podlesak (jakub.podlesak at oracle.com)
  */
 public class ExceptionMapperFactory implements ExceptionMappers {
     private static final Logger LOGGER = Logger.getLogger(ExceptionMapperFactory.class.getName());
@@ -90,10 +98,10 @@ protected void configure() {
 
     private static class ExceptionMapperType {
 
-        ExceptionMapper mapper;
+        ServiceHandle<ExceptionMapper> mapper;
         Class<? extends Throwable> exceptionType;
 
-        public ExceptionMapperType(final ExceptionMapper mapper, final Class<? extends Throwable> exceptionType) {
+        public ExceptionMapperType(final ServiceHandle<ExceptionMapper> mapper, final Class<? extends Throwable> exceptionType) {
             this.mapper = mapper;
             this.exceptionType = exceptionType;
         }
@@ -121,7 +129,7 @@ private <T extends Throwable> ExceptionMapper<T> find(final Class<T> type, final
         for (final ExceptionMapperType mapperType : exceptionMapperTypes) {
             final int d = distance(type, mapperType.exceptionType);
             if (d >= 0) {
-                orderedMappers.put(d, mapperType.mapper);
+                orderedMappers.put(d, mapperType.mapper.getService());
             }
         }
 
@@ -156,10 +164,44 @@ private <T extends Throwable> ExceptionMapper<T> find(final Class<T> type, final
      */
     @Inject
     public ExceptionMapperFactory(final ServiceLocator locator) {
-        for (final ExceptionMapper<?> mapper : Providers.getAllProviders(locator, ExceptionMapper.class)) {
-            final Class<? extends Throwable> c = getExceptionType(mapper.getClass());
-            if (c != null) {
-                exceptionMapperTypes.add(new ExceptionMapperType(mapper, c));
+
+        final Collection<ServiceHandle<ExceptionMapper>> mapperHandles =
+                Providers.getAllServiceHandles(locator, ExceptionMapper.class);
+
+        for (ServiceHandle<ExceptionMapper> mapperHandle : mapperHandles) {
+
+            final ExceptionMapper mapper = mapperHandle.getService();
+
+            if (Proxy.isProxyClass(mapper.getClass())) {
+
+                SortedSet<Class<? extends ExceptionMapper>> mapperTypes
+                        = new TreeSet<Class<? extends ExceptionMapper>>(new Comparator<Class<? extends ExceptionMapper>>() {
+
+                            @Override
+                            public int compare(Class<? extends ExceptionMapper> o1, Class<? extends ExceptionMapper> o2) {
+                                return o1.isAssignableFrom(o2) ? -1 : 1;
+                            }
+                        });
+
+                final Set<Type> contracts = mapperHandle.getActiveDescriptor().getContractTypes();
+                for (Type contract : contracts) {
+                    if (contract instanceof Class &&
+                            ExceptionMapper.class.isAssignableFrom((Class<?>)contract) && contract != ExceptionMapper.class) {
+                        mapperTypes.add((Class<? extends ExceptionMapper>) contract);
+                    }
+                }
+
+                if (!mapperTypes.isEmpty()) {
+                    final Class<? extends Throwable> c = getExceptionType(mapperTypes.first());
+                    if (c != null) {
+                        exceptionMapperTypes.add(new ExceptionMapperType(mapperHandle, c));
+                    }
+                }
+            } else {
+                final Class<? extends Throwable> c = getExceptionType(mapper.getClass());
+                if (c != null) {
+                    exceptionMapperTypes.add(new ExceptionMapperType(mapperHandle, c));
+                }
             }
         }
     }
@@ -258,4 +300,4 @@ private Class getResolvedType(final Type t, final Class c, final Class dc) {
             return null;
         }
     }
-}
+}

core-common/src/main/java/org/glassfish/jersey/internal/inject/Providers.java

@@ -182,7 +182,7 @@ public void dispose(final T instance) {
      * @return set of all available default service provider instances for the contract.
      */
     public static <T> Set<T> getProviders(final ServiceLocator locator, final Class<T> contract) {
-        final Collection<ServiceHandle<T>> hk2Providers = getAllServiceHandles(locator, contract);
+        final Collection<ServiceHandle<T>> hk2Providers = getServiceHandles(locator, contract);
         return getClasses(hk2Providers);
     }
 
@@ -196,7 +196,7 @@ public static <T> Set<T> getProviders(final ServiceLocator locator, final Class<
      * @return set of all available service provider instances for the contract.
      */
     public static <T> Set<T> getCustomProviders(final ServiceLocator locator, final Class<T> contract) {
-        final Collection<ServiceHandle<T>> hk2Providers = getAllServiceHandles(locator, contract, new CustomAnnotationImpl());
+        final Collection<ServiceHandle<T>> hk2Providers = getServiceHandles(locator, contract, new CustomAnnotationImpl());
         return getClasses(hk2Providers);
     }
 
@@ -223,8 +223,8 @@ public static <T> Iterable<T> getAllProviders(final ServiceLocator locator, fina
      * @return iterable of all available ranked service providers for the contract. Return value is never null.
      */
     public static <T> Iterable<RankedProvider<T>> getAllRankedProviders(final ServiceLocator locator, final Class<T> contract) {
-        final List<ServiceHandle<T>> providers = getAllServiceHandles(locator, contract, new CustomAnnotationImpl());
-        providers.addAll(getAllServiceHandles(locator, contract));
+        final List<ServiceHandle<T>> providers = getServiceHandles(locator, contract, new CustomAnnotationImpl());
+        providers.addAll(getServiceHandles(locator, contract));
 
         final LinkedHashMap<ActiveDescriptor<T>, RankedProvider<T>> providerMap =
                 new LinkedHashMap<ActiveDescriptor<T>, RankedProvider<T>>();
@@ -308,7 +308,33 @@ public static <T> Iterable<T> getAllProviders(final ServiceLocator locator,
         return sortRankedProviders(comparator, getAllRankedProviders(locator, contract));
     }
 
-    private static <T> List<ServiceHandle<T>> getAllServiceHandles(final ServiceLocator locator, final Class<T> contract,
+    /**
+     * Get collection of all {@link ServiceHandle}s bound for providers (custom and default) registered for the given service provider contract
+     * in the underlying {@link ServiceLocator HK2 service locator} container.
+     *
+     * @param <T>        service provider contract Java type.
+     * @param locator    underlying HK2 service locator.
+     * @param contract   service provider contract.
+     * @return set of all available service provider instances for the contract
+     */
+    public static <T> Collection<ServiceHandle<T>> getAllServiceHandles(final ServiceLocator locator, final Class<T> contract) {
+        final List<ServiceHandle<T>> providers = getServiceHandles(locator, contract, new CustomAnnotationImpl());
+        providers.addAll(getServiceHandles(locator, contract));
+
+        final LinkedHashMap<ActiveDescriptor, ServiceHandle<T>> providerMap =
+                new LinkedHashMap<ActiveDescriptor, ServiceHandle<T>>();
+
+        for (final ServiceHandle<T> provider : providers) {
+            final ActiveDescriptor key = provider.getActiveDescriptor();
+            if (!providerMap.containsKey(key)) {
+                providerMap.put(key, provider);
+            }
+        }
+
+        return providerMap.values();
+    }
+
+    private static <T> List<ServiceHandle<T>> getServiceHandles(final ServiceLocator locator, final Class<T> contract,
                                                                    final Annotation... qualifiers) {
 
         final List<ServiceHandle<T>> allServiceHandles = qualifiers == null ?
@@ -335,20 +361,8 @@ private static <T> List<ServiceHandle<T>> getAllServiceHandles(final ServiceLoca
      * {@link Comparator comparator}.
      */
     public static <T> Iterable<T> getAllProviders(final ServiceLocator locator, final Class<T> contract, final Comparator<T> comparator) {
-        final List<ServiceHandle<T>> providers = getAllServiceHandles(locator, contract, new CustomAnnotationImpl());
-        providers.addAll(getAllServiceHandles(locator, contract));
-
-        final LinkedHashMap<ActiveDescriptor, ServiceHandle<T>> providerMap =
-                new LinkedHashMap<ActiveDescriptor, ServiceHandle<T>>();
-
-        for (final ServiceHandle<T> provider : providers) {
-            final ActiveDescriptor key = provider.getActiveDescriptor();
-            if (!providerMap.containsKey(key)) {
-                providerMap.put(key, provider);
-            }
-        }
 
-        final List<T> providerList = new ArrayList<T>(getClasses(providerMap.values()));
+        final List<T> providerList = new ArrayList<T>(getClasses(getAllServiceHandles(locator, contract)));
 
         if (comparator != null) {
             Collections.sort(providerList, comparator);
@@ -377,7 +391,7 @@ private static <T> Set<T> getClasses(final Collection<ServiceHandle<T>> hk2Provi
      * @return set of all available service provider instances for the contract.
      */
     public static <T> SortedSet<T> getProviders(final ServiceLocator locator, final Class<T> contract, final Comparator<T> comparator) {
-        final Collection<ServiceHandle<T>> hk2Providers = getAllServiceHandles(locator, contract);
+        final Collection<ServiceHandle<T>> hk2Providers = getServiceHandles(locator, contract);
         if (hk2Providers.isEmpty()) {
             return Sets.newTreeSet(comparator);
         } else {

tests/integration/ejb-test-webapp/src/main/java/org/glassfish/jersey/tests/ejb/resources/CustomBaseException.java

@@ -0,0 +1,51 @@
+/*
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
+ *
+ * Copyright (c) 2014 Oracle and/or its affiliates. All rights reserved.
+ *
+ * The contents of this file are subject to the terms of either the GNU
+ * General Public License Version 2 only ("GPL") or the Common Development
+ * and Distribution License("CDDL") (collectively, the "License").  You
+ * may not use this file except in compliance with the License.  You can
+ * obtain a copy of the License at
+ * http://glassfish.java.net/public/CDDL+GPL_1_1.html
+ * or packager/legal/LICENSE.txt.  See the License for the specific
+ * language governing permissions and limitations under the License.
+ *
+ * When distributing the software, include this License Header Notice in each
+ * file and include the License file at packager/legal/LICENSE.txt.
+ *
+ * GPL Classpath Exception:
+ * Oracle designates this particular file as subject to the "Classpath"
+ * exception as provided by Oracle in the GPL Version 2 section of the License
+ * file that accompanied this code.
+ *
+ * Modifications:
+ * If applicable, add the following below the License Header, with the fields
+ * enclosed by brackets [] replaced by your own identifying information:
+ * "Portions Copyright [year] [name of copyright owner]"
+ *
+ * Contributor(s):
+ * If you wish your version of this file to be governed by only the CDDL or
+ * only the GPL Version 2, indicate your decision by adding "[Contributor]
+ * elects to include this software in this distribution under the [CDDL or GPL
+ * Version 2] license."  If you don't indicate a single choice of license, a
+ * recipient has the option to distribute your version of this file under
+ * either the CDDL, the GPL Version 2 or to extend the choice of license to
+ * its licensees as provided above.  However, if you add GPL Version 2 code
+ * and therefore, elected the GPL Version 2 license, then the option applies
+ * only if the new code is made subject to such option by the copyright
+ * holder.
+ */
+
+package org.glassfish.jersey.tests.ejb.resources;
+
+/**
+ * Custom exception. Part of JERSEY-2320 reproducer.
+ * This one serves as a base for other exceptions
+ * mapped by {@link EjbExceptionMapperOne} and {@link EjbExceptionMapperTwo}.
+ *
+ * @author Jakub Podlesak (jakub.podlesak at oracle.com)
+ */
+public class CustomBaseException extends Exception {
+}

tests/integration/ejb-test-webapp/src/main/java/org/glassfish/jersey/tests/ejb/resources/CustomExceptionOne.java

@@ -0,0 +1,50 @@
+/*
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
+ *
+ * Copyright (c) 2014 Oracle and/or its affiliates. All rights reserved.
+ *
+ * The contents of this file are subject to the terms of either the GNU
+ * General Public License Version 2 only ("GPL") or the Common Development
+ * and Distribution License("CDDL") (collectively, the "License").  You
+ * may not use this file except in compliance with the License.  You can
+ * obtain a copy of the License at
+ * http://glassfish.java.net/public/CDDL+GPL_1_1.html
+ * or packager/legal/LICENSE.txt.  See the License for the specific
+ * language governing permissions and limitations under the License.
+ *
+ * When distributing the software, include this License Header Notice in each
+ * file and include the License file at packager/legal/LICENSE.txt.
+ *
+ * GPL Classpath Exception:
+ * Oracle designates this particular file as subject to the "Classpath"
+ * exception as provided by Oracle in the GPL Version 2 section of the License
+ * file that accompanied this code.
+ *
+ * Modifications:
+ * If applicable, add the following below the License Header, with the fields
+ * enclosed by brackets [] replaced by your own identifying information:
+ * "Portions Copyright [year] [name of copyright owner]"
+ *
+ * Contributor(s):
+ * If you wish your version of this file to be governed by only the CDDL or
+ * only the GPL Version 2, indicate your decision by adding "[Contributor]
+ * elects to include this software in this distribution under the [CDDL or GPL
+ * Version 2] license."  If you don't indicate a single choice of license, a
+ * recipient has the option to distribute your version of this file under
+ * either the CDDL, the GPL Version 2 or to extend the choice of license to
+ * its licensees as provided above.  However, if you add GPL Version 2 code
+ * and therefore, elected the GPL Version 2 license, then the option applies
+ * only if the new code is made subject to such option by the copyright
+ * holder.
+ */
+
+package org.glassfish.jersey.tests.ejb.resources;
+
+/**
+ * Custom exception. Part of JERSEY-2320 reproducer.
+ * This one gets mapped by {@link EjbExceptionMapperOne}.
+ *
+ * @author Jakub Podlesak (jakub.podlesak at oracle.com)
+ */
+public class CustomExceptionOne extends CustomBaseException {
+}

tests/integration/ejb-test-webapp/src/main/java/org/glassfish/jersey/tests/ejb/resources/CustomExceptionTwo.java

@@ -0,0 +1,50 @@
+/*
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
+ *
+ * Copyright (c) 2014 Oracle and/or its affiliates. All rights reserved.
+ *
+ * The contents of this file are subject to the terms of either the GNU
+ * General Public License Version 2 only ("GPL") or the Common Development
+ * and Distribution License("CDDL") (collectively, the "License").  You
+ * may not use this file except in compliance with the License.  You can
+ * obtain a copy of the License at
+ * http://glassfish.java.net/public/CDDL+GPL_1_1.html
+ * or packager/legal/LICENSE.txt.  See the License for the specific
+ * language governing permissions and limitations under the License.
+ *
+ * When distributing the software, include this License Header Notice in each
+ * file and include the License file at packager/legal/LICENSE.txt.
+ *
+ * GPL Classpath Exception:
+ * Oracle designates this particular file as subject to the "Classpath"
+ * exception as provided by Oracle in the GPL Version 2 section of the License
+ * file that accompanied this code.
+ *
+ * Modifications:
+ * If applicable, add the following below the License Header, with the fields
+ * enclosed by brackets [] replaced by your own identifying information:
+ * "Portions Copyright [year] [name of copyright owner]"
+ *
+ * Contributor(s):
+ * If you wish your version of this file to be governed by only the CDDL or
+ * only the GPL Version 2, indicate your decision by adding "[Contributor]
+ * elects to include this software in this distribution under the [CDDL or GPL
+ * Version 2] license."  If you don't indicate a single choice of license, a
+ * recipient has the option to distribute your version of this file under
+ * either the CDDL, the GPL Version 2 or to extend the choice of license to
+ * its licensees as provided above.  However, if you add GPL Version 2 code
+ * and therefore, elected the GPL Version 2 license, then the option applies
+ * only if the new code is made subject to such option by the copyright
+ * holder.
+ */
+
+package org.glassfish.jersey.tests.ejb.resources;
+
+/**
+ * Custom exception. Part of JERSEY-2320 reproducer.
+ * This one gets mapped by {@link EjbExceptionMapperTwo}.
+ *
+ * @author Jakub Podlesak (jakub.podlesak at oracle.com)
+ */
+public class CustomExceptionTwo extends CustomBaseException {
+}