Merge "Remove HK2 classes: MultiException, JerseyErrorService, Singleton Immediate annotation, Unqualified annotation." into 2.x

Author: Petr Bouda

core-client/src/main/java/org/glassfish/jersey/client/ClientBinder.java

@@ -54,7 +54,6 @@
 
 import org.glassfish.jersey.internal.ContextResolverFactory;
 import org.glassfish.jersey.internal.JaxrsProviders;
-import org.glassfish.jersey.internal.JerseyErrorService;
 import org.glassfish.jersey.internal.PropertiesDelegate;
 import org.glassfish.jersey.internal.ServiceFinderBinder;
 import org.glassfish.jersey.internal.inject.AbstractBinder;
@@ -113,7 +112,6 @@ public PropertiesDelegate get() {
     @Override
     protected void configure() {
         install(new RequestScope.Binder(), // must go first as it registers the request scope instance.
-                new JerseyErrorService.Binder(),
                 new MessagingBinders.MessageBodyProviders(clientRuntimeProperties, RuntimeType.CLIENT),
                 new MessagingBinders.HeaderDelegateProviders(),
                 new MessageBodyFactory.Binder(),

core-common/src/main/java/org/glassfish/jersey/hk2/HK2InjectionManager.java

@@ -50,7 +50,6 @@
 import org.glassfish.jersey.internal.LocalizationMessages;
 import org.glassfish.jersey.internal.inject.Binder;
 import org.glassfish.jersey.internal.inject.Binding;
-import org.glassfish.jersey.internal.inject.Bindings;
 import org.glassfish.jersey.internal.inject.ClassBinding;
 import org.glassfish.jersey.internal.inject.CompositeBinder;
 import org.glassfish.jersey.internal.inject.ForeignDescriptor;
@@ -143,16 +142,9 @@ public ServiceLocator getServiceLocator() {
     @Override
     public void initialize(String name, InjectionManager parent, Binder... binders) {
         this.locator = createLocator(name, parent);
-        ServiceLocatorUtilities.bind(locator, new JerseyClassAnalyzer.Binder(locator));
 
-        // First service the current BeanManager to be able to inject itself into other services.
-        Hk2Helper.bind(locator, Bindings.service(this).to(InjectionManager.class));
-
-        // Add support for Context annotation.
-        Hk2Helper.bind(locator, new ContextInjectionResolverImpl.Binder());
-
-        // Compose together the initialization binders and bind them as a whole.
-        Hk2Helper.bind(locator, CompositeBinder.wrap(binders));
+        // Register all components needed for proper HK2 locator bootstrap
+        Hk2Helper.bind(locator, new Hk2BootstrapBinder(this, CompositeBinder.wrap(binders)));
 
         this.locator.setDefaultClassAnalyzerName(JerseyClassAnalyzer.NAME);
 

core-common/src/main/java/org/glassfish/jersey/hk2/Hk2BootstrapBinder.java

@@ -0,0 +1,104 @@
+/*
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
+ *
+ * Copyright (c) 2017 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.hk2;
+
+import org.glassfish.jersey.internal.inject.AbstractBinder;
+import org.glassfish.jersey.internal.inject.InjectionManager;
+
+/**
+ * {@link AbstractBinder} that registers all components needed for a proper bootstrap of Jersey based on HK2 framework.
+ *
+ * @author Petr Bouda (petr.bouda at oracle.com)
+ */
+public class Hk2BootstrapBinder extends AbstractBinder {
+
+    private final AbstractBinder externalBinder;
+
+    private final InjectionManager injectionManager;
+
+    /**
+     * Create a bootstrap which is specific for HK2 module and automatically install {@code externalBinder}.
+     *
+     * @param injectionManager HK2 service locator.
+     * @param externalBinder   externally provided binder (particularly Jersey specific services).
+     */
+    public Hk2BootstrapBinder(InjectionManager injectionManager, AbstractBinder externalBinder) {
+        this.injectionManager = injectionManager;
+        this.externalBinder = externalBinder;
+    }
+
+    @Override
+    protected void configure() {
+        install(
+                // First service the current injection manager to be able to inject itself into other services.
+                new HK2InjectionManagerBinder(injectionManager),
+                // Jersey-like class analyzer that is able to choose the right services' construtor.
+                new JerseyClassAnalyzer.Binder(injectionManager),
+                // Add support for Context annotation.
+                new ContextInjectionResolverImpl.Binder(),
+                // Compose together the initialization binders and bind them as a whole.
+                externalBinder,
+                // Improved HK2 Error reporting.
+                new JerseyErrorService.Binder());
+    }
+
+    /**
+     * Binder that registers a provided injection manager.
+     */
+    private static class HK2InjectionManagerBinder extends AbstractBinder {
+
+        private final InjectionManager injectionManager;
+
+        /**
+         * Constructor for a creation injection manager binder.
+         *
+         * @param injectionManager current injection manager.
+         */
+        private HK2InjectionManagerBinder(InjectionManager injectionManager) {
+            this.injectionManager = injectionManager;
+        }
+
+        @Override
+        protected void configure() {
+            bind(injectionManager).to(InjectionManager.class);
+        }
+    }
+}

core-common/src/main/java/org/glassfish/jersey/hk2/JerseyClassAnalyzer.java

@@ -57,6 +57,8 @@
 
 import org.glassfish.jersey.internal.Errors;
 import org.glassfish.jersey.internal.LocalizationMessages;
+import org.glassfish.jersey.internal.inject.AbstractBinder;
+import org.glassfish.jersey.internal.inject.InjectionManager;
 import org.glassfish.jersey.internal.inject.InjectionResolver;
 import org.glassfish.jersey.internal.util.collection.ImmutableCollectors;
 import org.glassfish.jersey.internal.util.collection.LazyValue;
@@ -65,8 +67,6 @@
 
 import org.glassfish.hk2.api.ClassAnalyzer;
 import org.glassfish.hk2.api.MultiException;
-import org.glassfish.hk2.api.ServiceLocator;
-import org.glassfish.hk2.utilities.binding.AbstractBinder;
 
 /**
  * Implementation of the {@link ClassAnalyzer} that supports selection
@@ -90,18 +90,23 @@ public final class JerseyClassAnalyzer implements ClassAnalyzer {
      */
     public static final class Binder extends AbstractBinder {
 
-        private final ServiceLocator serviceLocator;
+        private final InjectionManager injectionManager;
 
-        public Binder(ServiceLocator serviceLocator) {
-            this.serviceLocator = serviceLocator;
+        /**
+         * Constructor for {@code JerseyClassAnalyzer}.
+         *
+         * @param injectionManager current injection manager.
+         */
+        public Binder(InjectionManager injectionManager) {
+            this.injectionManager = injectionManager;
         }
 
         @Override
         protected void configure() {
             ClassAnalyzer defaultAnalyzer =
-                    serviceLocator.getService(ClassAnalyzer.class, ClassAnalyzer.DEFAULT_IMPLEMENTATION_NAME);
+                    injectionManager.getInstance(ClassAnalyzer.class, ClassAnalyzer.DEFAULT_IMPLEMENTATION_NAME);
 
-            Supplier<List<InjectionResolver>> resolvers = () -> serviceLocator.getAllServices(InjectionResolver.class);
+            Supplier<List<InjectionResolver>> resolvers = () -> injectionManager.getAllInstances(InjectionResolver.class);
 
             bind(new JerseyClassAnalyzer(defaultAnalyzer, resolvers))
                     .analyzeWith(ClassAnalyzer.DEFAULT_IMPLEMENTATION_NAME)

core-common/src/main/java/org/glassfish/jersey/internal/JerseyErrorService.java renamed to core-common/src/main/java/org/glassfish/jersey/hk2/JerseyErrorService.java

@@ -1,7 +1,7 @@
 /*
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
  *
- * Copyright (c) 2013-2017 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2017 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
@@ -38,13 +38,15 @@
  * holder.
  */
 
-package org.glassfish.jersey.internal;
+package org.glassfish.jersey.hk2;
 
 import java.io.PrintWriter;
 import java.io.StringWriter;
 
 import javax.inject.Singleton;
 
+import org.glassfish.jersey.internal.Errors;
+import org.glassfish.jersey.internal.LocalizationMessages;
 import org.glassfish.jersey.internal.inject.AbstractBinder;
 
 import org.glassfish.hk2.api.ErrorInformation;

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

@@ -70,7 +70,7 @@ private CompositeBinder(Collection<Binder> installed) {
      * @param binders provided binder to install as a collection.
      * @return composite binder.
      */
-    public static Binder wrap(Collection<Binder> binders) {
+    public static AbstractBinder wrap(Collection<Binder> binders) {
         return new CompositeBinder(binders);
     }
 
@@ -80,7 +80,7 @@ public static Binder wrap(Collection<Binder> binders) {
      * @param binders provided binder to install as an array.
      * @return composite binder.
      */
-    public static Binder wrap(Binder... binders) {
+    public static AbstractBinder wrap(Binder... binders) {
         return new CompositeBinder(Arrays.asList(binders));
     }
 

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

@@ -49,8 +49,6 @@
 
 import org.glassfish.jersey.hk2.HK2InjectionManager;
 
-import org.glassfish.hk2.api.MultiException;
-
 /**
  * Injection binding utility methods.
  *
@@ -132,28 +130,25 @@ private static InjectionManager _injectionManager(String name, InjectionManager
     /**
      * Get the class by contract or create and inject a new instance.
      *
-     * @param <T>             instance type.
+     * @param <T>              instance type.
      * @param injectionManager DI injection manager.
-     * @param clazz           class of the instance to be provider.
+     * @param clazz            class of the instance to be provider.
      * @return instance of the class either provided as a service or created and injected  by HK2.
      */
     public static <T> T getOrCreate(InjectionManager injectionManager, final Class<T> clazz) {
         try {
             final T component = injectionManager.getInstance(clazz);
             return component == null ? injectionManager.createAndInitialize(clazz) : component;
-            // TODO: not really MultiException.
-        } catch (final MultiException e) {
-
+        } catch (final RuntimeException e) {
             // Look for WebApplicationException and return it if found. MultiException is thrown when *Param field is
             // annotated and value cannot be provided (for example fromString(String) method can throw unchecked
             // exception.
             //
             // see InvalidParamTest
             // see JERSEY-1117
-            for (final Throwable t : e.getErrors()) {
-                if (WebApplicationException.class.isAssignableFrom(t.getClass())) {
-                    throw (WebApplicationException) t;
-                }
+            Throwable throwable = e.getCause();
+            if (throwable != null && WebApplicationException.class.isAssignableFrom(throwable.getClass())) {
+                throw (WebApplicationException) throwable;
             }
 
             throw e;

core-common/src/test/java/org/glassfish/jersey/internal/TestBinder.java

@@ -82,7 +82,6 @@ public static void initProviders(final InjectionManager injectionManager,
     protected void configure() {
         install(
                 new RequestScope.Binder(),
-                new JerseyErrorService.Binder(),
                 new MessagingBinders.MessageBodyProviders(null, RuntimeType.SERVER),
                 new MessageBodyFactory.Binder(),
                 new ExceptionMapperFactory.Binder(),