Introducing Injection SPI.

 - new InstanceManager SPI
 - HK2 implementation of Instance SPI and set up as default
 - all ServiceLocator invocations routed through InstanceManager
 - Marek’s partial feedback incorporated (along with TODOs)

Change-Id: Ied029d19aaba9f22efc0b7965594e4eac96690fd
Signed-off-by: Marek Potociar <[email protected]>

Author: Petr Bouda

containers/glassfish/jersey-gf-ejb/src/main/java/org/glassfish/jersey/gf/ejb/internal/EjbComponentInterceptor.java

@@ -1,7 +1,7 @@
 /*
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
  *
- * Copyright (c) 2012-2015 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2012-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
@@ -43,8 +43,7 @@
 import javax.interceptor.InvocationContext;
 
 import org.glassfish.jersey.ext.cdi1x.internal.CdiComponentProvider;
-
-import org.glassfish.hk2.api.ServiceLocator;
+import org.glassfish.jersey.spi.inject.InstanceManager;
 
 /**
  * EJB interceptor to inject Jersey specific stuff into EJB beans.
@@ -53,22 +52,22 @@
  */
 public final class EjbComponentInterceptor {
 
-    private final ServiceLocator locator;
+    private final InstanceManager instanceManager;
 
     /**
-     * Create new EJB component locator.
+     * Create new EJB component instance manager.
      *
-     * @param locator HK2 service locator.
+     * @param instanceManager instance manager.
      */
-    public EjbComponentInterceptor(final ServiceLocator locator) {
-        this.locator = locator;
+    public EjbComponentInterceptor(final InstanceManager instanceManager) {
+        this.instanceManager = instanceManager;
     }
 
     @PostConstruct
     private void inject(final InvocationContext context) throws Exception {
 
         final Object beanInstance = context.getTarget();
-        locator.inject(beanInstance, CdiComponentProvider.CDI_CLASS_ANALYZER);
+        instanceManager.inject(beanInstance, CdiComponentProvider.CDI_CLASS_ANALYZER);
 
         // Invoke next interceptor in chain
         context.proceed();

containers/glassfish/jersey-gf-ejb/src/main/java/org/glassfish/jersey/gf/ejb/internal/EjbComponentProvider.java

@@ -60,25 +60,23 @@
 import java.util.logging.Level;
 import java.util.logging.Logger;
 
-import javax.ws.rs.ext.ExceptionMapper;
-
 import javax.annotation.Priority;
 import javax.ejb.Local;
 import javax.ejb.Remote;
 import javax.inject.Singleton;
 import javax.naming.InitialContext;
 import javax.naming.NamingException;
 
-import org.glassfish.jersey.internal.inject.Injections;
 import org.glassfish.jersey.internal.inject.SupplierFactory;
 import org.glassfish.jersey.server.ApplicationHandler;
 import org.glassfish.jersey.server.model.Invocable;
 import org.glassfish.jersey.server.spi.ComponentProvider;
 import org.glassfish.jersey.server.spi.internal.ResourceMethodInvocationHandlerProvider;
-
-import org.glassfish.hk2.api.DynamicConfiguration;
-import org.glassfish.hk2.api.ServiceLocator;
-import org.glassfish.hk2.utilities.binding.ServiceBindingBuilder;
+import org.glassfish.jersey.spi.inject.ClassBeanDescriptor;
+import org.glassfish.jersey.spi.inject.Descriptor;
+import org.glassfish.jersey.spi.inject.Descriptors;
+import org.glassfish.jersey.spi.inject.InstanceBeanDescriptor;
+import org.glassfish.jersey.spi.inject.InstanceManager;
 
 import org.glassfish.ejb.deployment.descriptor.EjbBundleDescriptorImpl;
 import org.glassfish.ejb.deployment.descriptor.EjbDescriptor;
@@ -145,15 +143,16 @@ public EjbFactory(Class<T> rawType, InitialContext ctx, EjbComponentProvider ejb
         add("javax.ejb.Singleton");
     }});
 
-    private ServiceLocator locator = null;
+    private InstanceManager instanceManager = null;
 
     // ComponentProvider
     @Override
-    public void initialize(final ServiceLocator locator) {
-        this.locator = locator;
-        final DynamicConfiguration configuration = Injections.getConfiguration(locator);
-        Injections.addBinding(Injections.newBinder(this).to(ResourceMethodInvocationHandlerProvider.class), configuration);
-        configuration.commit();
+    public void initialize(final InstanceManager instanceManager) {
+        this.instanceManager = instanceManager;
+
+        InstanceBeanDescriptor<EjbComponentProvider> descriptor = Descriptors.service(EjbComponentProvider.this)
+                .to(ResourceMethodInvocationHandlerProvider.class);
+        this.instanceManager.register(descriptor);
     }
 
     private ApplicationInfo getApplicationInfo(EjbContainerUtil ejbUtil) throws NamingException {
@@ -191,7 +190,7 @@ private ApplicationInfo getApplicationInfo(EjbContainerUtil ejbUtil) throws Nami
 
     private void registerEjbInterceptor() {
         try {
-            final Object interceptor = new EjbComponentInterceptor(locator);
+            final Object interceptor = new EjbComponentInterceptor(instanceManager);
             initialContext = getInitialContext();
             final EjbContainerUtil ejbUtil = EjbContainerUtilImpl.getInstance();
             final ApplicationInfo appInfo = getApplicationInfo(ejbUtil);
@@ -271,7 +270,7 @@ public boolean bind(Class<?> component, Set<Class<?>> providerContracts) {
             LOGGER.fine(LocalizationMessages.EJB_CLASS_BEING_CHECKED(component));
         }
 
-        if (locator == null) {
+        if (instanceManager == null) {
             throw new IllegalStateException(LocalizationMessages.EJB_COMPONENT_PROVIDER_NOT_INITIALIZED_PROPERLY());
         }
 
@@ -283,18 +282,10 @@ public boolean bind(Class<?> component, Set<Class<?>> providerContracts) {
             registerEjbInterceptor();
         }
 
-        DynamicConfiguration dc = Injections.getConfiguration(locator);
-
-        final ServiceBindingBuilder bindingBuilder = Injections.newFactoryBinder(new EjbFactory(component, initialContext, this));
-
-        bindingBuilder.to(component);
-        for (Class contract : providerContracts) {
-            bindingBuilder.to(contract);
-        }
-
-        Injections.addBinding(bindingBuilder, dc);
-
-        dc.commit();
+        Descriptor descriptor = Descriptors.factory(new EjbFactory(component, initialContext, EjbComponentProvider.this))
+                .to(component)
+                .to(providerContracts);
+        instanceManager.register(descriptor);
 
         if (LOGGER.isLoggable(Level.CONFIG)) {
             LOGGER.config(LocalizationMessages.EJB_CLASS_BOUND_WITH_CDI(component));
@@ -309,9 +300,11 @@ public void done() {
     }
 
     private void registerEjbExceptionMapper() {
-        final DynamicConfiguration dc = Injections.getConfiguration(locator);
-        Injections.addBinding(Injections.newBinder(EjbExceptionMapper.class).to(ExceptionMapper.class).in(Singleton.class), dc);
-        dc.commit();
+        ClassBeanDescriptor<EjbExceptionMapper> descriptor =
+                Descriptors.serviceAsContract(EjbExceptionMapper.class)
+                    .in(Singleton.class);
+
+        instanceManager.register(descriptor);
     }
 
     private boolean isEjbComponent(Class<?> component) {

containers/grizzly2-http/src/main/java/org/glassfish/jersey/grizzly2/httpserver/GrizzlyHttpContainer.java

@@ -1,7 +1,7 @@
 /*
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
  *
- * Copyright (c) 2010-2015 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2010-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
@@ -37,6 +37,7 @@
  * only if the new code is made subject to such option by the copyright
  * holder.
  */
+
 package org.glassfish.jersey.grizzly2.httpserver;
 
 import java.io.IOException;
@@ -53,6 +54,7 @@
 import java.util.logging.Logger;
 
 import javax.ws.rs.core.Application;
+import javax.ws.rs.core.GenericType;
 import javax.ws.rs.core.SecurityContext;
 
 import javax.inject.Inject;
@@ -72,11 +74,9 @@
 import org.glassfish.jersey.server.internal.ContainerUtils;
 import org.glassfish.jersey.server.spi.Container;
 import org.glassfish.jersey.server.spi.ContainerResponseWriter;
-import org.glassfish.jersey.server.spi.RequestScopedInitializer;
+import org.glassfish.jersey.spi.inject.AbstractBinder;
 
 import org.glassfish.hk2.api.ServiceLocator;
-import org.glassfish.hk2.api.TypeLiteral;
-import org.glassfish.hk2.utilities.binding.AbstractBinder;
 
 import org.glassfish.grizzly.CompletionHandler;
 import org.glassfish.grizzly.http.server.HttpHandler;
@@ -95,10 +95,9 @@ public final class GrizzlyHttpContainer extends HttpHandler implements Container
     private static final ExtendedLogger logger =
             new ExtendedLogger(Logger.getLogger(GrizzlyHttpContainer.class.getName()), Level.FINEST);
 
-    private final Type RequestTYPE = (new TypeLiteral<Ref<Request>>() {
-    }).getType();
-    private final Type ResponseTYPE = (new TypeLiteral<Ref<Response>>() {
-    }).getType();
+    private final Type RequestTYPE = (new GenericType<Ref<Request>>() { }).getType();
+    private final Type ResponseTYPE = (new GenericType<Ref<Response>>() { }).getType();
+
     /**
      * Cached value of configuration property
      * {@link org.glassfish.jersey.server.ServerProperties#RESPONSE_SET_STATUS_OVER_SEND_ERROR}.
@@ -151,12 +150,12 @@ static class GrizzlyBinder extends AbstractBinder {
         protected void configure() {
             bindFactory(GrizzlyRequestReferencingFactory.class).to(Request.class)
                     .proxy(false).in(RequestScoped.class);
-            bindFactory(ReferencingFactory.<Request>referenceFactory()).to(new TypeLiteral<Ref<Request>>() {})
+            bindFactory(ReferencingFactory.<Request>referenceFactory()).to(new GenericType<Ref<Request>>() {})
                     .in(RequestScoped.class);
 
             bindFactory(GrizzlyResponseReferencingFactory.class).to(Response.class)
                     .proxy(true).proxyForSameScope(false).in(RequestScoped.class);
-            bindFactory(ReferencingFactory.<Response>referenceFactory()).to(new TypeLiteral<Ref<Response>>() {})
+            bindFactory(ReferencingFactory.<Response>referenceFactory()).to(new GenericType<Ref<Response>>() {})
                     .in(RequestScoped.class);
         }
     }
@@ -343,7 +342,7 @@ private void rethrow(final Throwable error) {
      * Create a new Grizzly HTTP container.
      *
      * @param application   JAX-RS / Jersey application to be deployed on Grizzly HTTP container.
-     * @param parentLocator parent HK2 service locator.
+     * @param parentLocator parent instance manager.
      */
     /* package */ GrizzlyHttpContainer(final Application application, final ServiceLocator parentLocator) {
         this.appHandler = new ApplicationHandler(application, new GrizzlyBinder(), parentLocator);
@@ -373,13 +372,9 @@ public void service(final Request request, final Response response) {
             }
             requestContext.setWriter(responseWriter);
 
-            requestContext.setRequestScopedInitializer(new RequestScopedInitializer() {
-
-                @Override
-                public void initialize(final ServiceLocator locator) {
-                    locator.<Ref<Request>>getService(RequestTYPE).set(request);
-                    locator.<Ref<Response>>getService(ResponseTYPE).set(response);
-                }
+            requestContext.setRequestScopedInitializer(instanceManager -> {
+                instanceManager.<Ref<Request>>getInstance(RequestTYPE).set(request);
+                instanceManager.<Ref<Response>>getInstance(ResponseTYPE).set(response);
             });
             appHandler.handle(requestContext);
         } finally {

containers/jersey-servlet-core/src/main/java/org/glassfish/jersey/servlet/ServletContainer.java

@@ -1,7 +1,7 @@
 /*
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
  *
- * Copyright (c) 2012-2015 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2012-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
@@ -37,6 +37,7 @@
  * only if the new code is made subject to such option by the copyright
  * holder.
  */
+
 package org.glassfish.jersey.servlet;
 
 import java.io.IOException;
@@ -644,7 +645,7 @@ private String pickUrlMapping(final String requestUri, final List<String> filter
     private FilterUrlMappingsProvider getFilterUrlMappingsProvider() {
         FilterUrlMappingsProvider filterUrlMappingsProvider = null;
         final Iterator<FilterUrlMappingsProvider> providers = Providers.getAllProviders(
-                getApplicationHandler().getServiceLocator(), FilterUrlMappingsProvider.class).iterator();
+                getApplicationHandler().getInstanceManager(), FilterUrlMappingsProvider.class).iterator();
         if (providers.hasNext()) {
              filterUrlMappingsProvider = providers.next();
         }

containers/jersey-servlet-core/src/main/java/org/glassfish/jersey/servlet/WebComponent.java

@@ -37,6 +37,7 @@
  * only if the new code is made subject to such option by the copyright
  * holder.
  */
+
 package org.glassfish.jersey.servlet;
 
 import java.io.IOException;
@@ -60,6 +61,7 @@
 
 import javax.ws.rs.RuntimeType;
 import javax.ws.rs.core.Form;
+import javax.ws.rs.core.GenericType;
 import javax.ws.rs.core.MediaType;
 import javax.ws.rs.core.MultivaluedMap;
 import javax.ws.rs.core.Response;
@@ -105,11 +107,11 @@
 import org.glassfish.jersey.servlet.spi.AsyncContextDelegate;
 import org.glassfish.jersey.servlet.spi.AsyncContextDelegateProvider;
 import org.glassfish.jersey.servlet.spi.FilterUrlMappingsProvider;
+import org.glassfish.jersey.spi.inject.AbstractBinder;
+import org.glassfish.jersey.spi.inject.InstanceManager;
 import org.glassfish.jersey.uri.UriComponent;
 
 import org.glassfish.hk2.api.ServiceLocator;
-import org.glassfish.hk2.api.TypeLiteral;
-import org.glassfish.hk2.utilities.binding.AbstractBinder;
 
 import jersey.repackaged.com.google.common.base.Predicate;
 import jersey.repackaged.com.google.common.collect.Collections2;
@@ -128,8 +130,8 @@ public class WebComponent {
 
     private static final Logger LOGGER = Logger.getLogger(WebComponent.class.getName());
 
-    private static final Type REQUEST_TYPE = (new TypeLiteral<Ref<HttpServletRequest>>() {}).getType();
-    private static final Type RESPONSE_TYPE = (new TypeLiteral<Ref<HttpServletResponse>>() {}).getType();
+    private static final Type REQUEST_TYPE = (new GenericType<Ref<HttpServletRequest>>() {}).getType();
+    private static final Type RESPONSE_TYPE = (new GenericType<Ref<HttpServletResponse>>() {}).getType();
 
     private static final AsyncContextDelegate DEFAULT_ASYNC_DELEGATE = new AsyncContextDelegate() {
 
@@ -147,28 +149,20 @@ public void complete() {
     private final boolean requestResponseBindingExternalized;
 
     private static final RequestScopedInitializerProvider DEFAULT_REQUEST_SCOPE_INITIALIZER_PROVIDER =
-            new RequestScopedInitializerProvider() {
-                @Override
-                public RequestScopedInitializer get(final RequestContextProvider context) {
-                    return new RequestScopedInitializer() {
-                        @Override
-                        public void initialize(final ServiceLocator locator) {
-                            locator.<Ref<HttpServletRequest>>getService(REQUEST_TYPE).set(context.getHttpServletRequest());
-                            locator.<Ref<HttpServletResponse>>getService(RESPONSE_TYPE).set(context.getHttpServletResponse());
-                        }
-                    };
-                }
+            context -> (RequestScopedInitializer) instanceManager -> {
+                instanceManager.<Ref<HttpServletRequest>>getInstance(REQUEST_TYPE).set(context.getHttpServletRequest());
+                instanceManager.<Ref<HttpServletResponse>>getInstance(RESPONSE_TYPE).set(context.getHttpServletResponse());
             };
 
     /**
      * Return the first found {@link AsyncContextDelegateProvider}
-     * (via {@link Providers#getAllProviders(org.glassfish.hk2.api.ServiceLocator, Class)}) or {@code #DEFAULT_ASYNC_DELEGATE} if
+     * (via {@link Providers#getAllProviders(InstanceManager, Class)}) or {@code #DEFAULT_ASYNC_DELEGATE} if
      * other delegate cannot be found.
      *
      * @return a non-null AsyncContextDelegateProvider.
      */
     private AsyncContextDelegateProvider getAsyncExtensionDelegate() {
-        final Iterator<AsyncContextDelegateProvider> providers = Providers.getAllProviders(appHandler.getServiceLocator(),
+        final Iterator<AsyncContextDelegateProvider> providers = Providers.getAllProviders(appHandler.getInstanceManager(),
                 AsyncContextDelegateProvider.class).iterator();
         if (providers.hasNext()) {
             return providers.next();
@@ -226,13 +220,13 @@ protected void configure() {
                         .proxy(true).proxyForSameScope(false).in(RequestScoped.class);
 
                 bindFactory(ReferencingFactory.<HttpServletRequest>referenceFactory())
-                        .to(new TypeLiteral<Ref<HttpServletRequest>>() {}).in(RequestScoped.class);
+                        .to(new GenericType<Ref<HttpServletRequest>>() {}).in(RequestScoped.class);
 
                 // response
                 bindFactory(HttpServletResponseReferencingFactory.class).to(HttpServletResponse.class)
                         .proxy(true).proxyForSameScope(false).in(RequestScoped.class);
                 bindFactory(ReferencingFactory.<HttpServletResponse>referenceFactory())
-                        .to(new TypeLiteral<Ref<HttpServletResponse>>() {}).in(RequestScoped.class);
+                        .to(new GenericType<Ref<HttpServletResponse>>() {}).in(RequestScoped.class);
             }
 
             bindFactory(new SupplierFactory<ServletContext>() {
@@ -380,8 +374,8 @@ public WebComponent(final WebConfig webConfig, ResourceConfig resourceConfig) th
         this.queryParamsAsFormParams = !resourceConfig.isProperty(ServletProperties.QUERY_PARAMS_AS_FORM_PARAMS_DISABLED);
         this.configSetStatusOverSendError = ServerProperties.getValue(resourceConfig.getProperties(),
                 ServerProperties.RESPONSE_SET_STATUS_OVER_SEND_ERROR, false, Boolean.class);
-        this.backgroundTaskScheduler = appHandler.getServiceLocator()
-                .getService(ScheduledExecutorService.class, BackgroundSchedulerLiteral.INSTANCE);
+        this.backgroundTaskScheduler = appHandler.getInstanceManager()
+                .getInstance(ScheduledExecutorService.class, BackgroundSchedulerLiteral.INSTANCE);
     }
 
     /**