HK2 Factory usage refactorings.

- Replaced injection of Factory with javax.inject.Provider where possible
- Introduced SupplierFactory for use cases where Factory.dispose implementation is NO OP
- Refactored all Factory implementations to extend SupplierFactory where possible
- Removed some stale and unused Factory related utility classes and methods

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

Author: Marek Potociar

containers/glassfish/jersey-gf-ejb/src/main/java/org/glassfish/jersey/gf/ejb/internal/EjbComponentProvider.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
@@ -40,11 +40,6 @@
 
 package org.glassfish.jersey.gf.ejb.internal;
 
-import com.sun.ejb.containers.BaseContainer;
-import com.sun.ejb.containers.EjbContainerUtil;
-import com.sun.ejb.containers.EjbContainerUtilImpl;
-import com.sun.enterprise.config.serverbeans.Application;
-import com.sun.enterprise.config.serverbeans.Applications;
 import java.lang.annotation.Annotation;
 import java.lang.reflect.InvocationHandler;
 import java.lang.reflect.InvocationTargetException;
@@ -64,27 +59,38 @@
 import java.util.concurrent.CopyOnWriteArrayList;
 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 javax.ws.rs.ext.ExceptionMapper;
-import org.glassfish.ejb.deployment.descriptor.EjbBundleDescriptorImpl;
-import org.glassfish.ejb.deployment.descriptor.EjbDescriptor;
+
+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.Factory;
 import org.glassfish.hk2.api.ServiceLocator;
 import org.glassfish.hk2.utilities.binding.ServiceBindingBuilder;
+
+import org.glassfish.ejb.deployment.descriptor.EjbBundleDescriptorImpl;
+import org.glassfish.ejb.deployment.descriptor.EjbDescriptor;
 import org.glassfish.internal.data.ApplicationInfo;
 import org.glassfish.internal.data.ApplicationRegistry;
 import org.glassfish.internal.data.ModuleInfo;
-import org.glassfish.jersey.internal.inject.Injections;
-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 com.sun.ejb.containers.BaseContainer;
+import com.sun.ejb.containers.EjbContainerUtil;
+import com.sun.ejb.containers.EjbContainerUtilImpl;
+import com.sun.enterprise.config.serverbeans.Application;
+import com.sun.enterprise.config.serverbeans.Applications;
 
 /**
  * EJB component provider.
@@ -106,7 +112,7 @@ public final class EjbComponentProvider implements ComponentProvider, ResourceMe
     /**
      * HK2 factory to provide EJB components obtained via JNDI lookup.
      */
-    private static class EjbFactory<T> implements Factory<T> {
+    private static class EjbFactory<T> extends SupplierFactory<T> {
 
         final InitialContext ctx;
         final Class<T> clazz;
@@ -123,11 +129,6 @@ public T provide() {
             }
         }
 
-        @Override
-        public void dispose(T instance) {
-            // do nothing
-        }
-
         public EjbFactory(Class<T> rawType, InitialContext ctx, EjbComponentProvider ejbProvider) {
             this.clazz = rawType;
             this.ctx = ctx;

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

@@ -1,7 +1,7 @@
 /*
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
  *
- * Copyright (c) 2012-2016 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
@@ -78,6 +78,7 @@
 import org.glassfish.jersey.internal.ServiceFinderBinder;
 import org.glassfish.jersey.internal.inject.Providers;
 import org.glassfish.jersey.internal.inject.ReferencingFactory;
+import org.glassfish.jersey.internal.inject.SupplierFactory;
 import org.glassfish.jersey.internal.util.ReflectionHelper;
 import org.glassfish.jersey.internal.util.collection.Ref;
 import org.glassfish.jersey.internal.util.collection.Value;
@@ -106,7 +107,6 @@
 import org.glassfish.jersey.servlet.spi.FilterUrlMappingsProvider;
 import org.glassfish.jersey.uri.UriComponent;
 
-import org.glassfish.hk2.api.Factory;
 import org.glassfish.hk2.api.ServiceLocator;
 import org.glassfish.hk2.api.TypeLiteral;
 import org.glassfish.hk2.utilities.binding.AbstractBinder;
@@ -235,30 +235,21 @@ protected void configure() {
                         .to(new TypeLiteral<Ref<HttpServletResponse>>() {}).in(RequestScoped.class);
             }
 
-            bindFactory(new Factory<ServletContext>() {
+            bindFactory(new SupplierFactory<ServletContext>() {
                 @Override
                 public ServletContext provide() {
                     return webConfig.getServletContext();
                 }
-
-                @Override
-                public void dispose(final ServletContext instance) {
-                    //not used
-                }
             }).to(ServletContext.class).in(Singleton.class);
 
             final ServletConfig servletConfig = webConfig.getServletConfig();
             if (webConfig.getConfigType() == WebConfig.ConfigType.ServletConfig) {
-                bindFactory(new Factory<ServletConfig>() {
+                bindFactory(new SupplierFactory<ServletConfig>() {
                     @Override
                     public ServletConfig provide() {
                         return servletConfig;
                     }
 
-                    @Override
-                    public void dispose(final ServletConfig instance) {
-                        //not used
-                    }
                 }).to(ServletConfig.class).in(Singleton.class);
 
                 // @PersistenceUnit
@@ -272,29 +263,21 @@ public void dispose(final ServletConfig instance) {
                     }
                 }
             } else {
-                bindFactory(new Factory<FilterConfig>() {
+                bindFactory(new SupplierFactory<FilterConfig>() {
                     @Override
                     public FilterConfig provide() {
                         return webConfig.getFilterConfig();
                     }
 
-                    @Override
-                    public void dispose(final FilterConfig instance) {
-                        //not used
-                    }
                 }).to(FilterConfig.class).in(Singleton.class);
             }
 
-            bindFactory(new Factory<WebConfig>() {
+            bindFactory(new SupplierFactory<WebConfig>() {
                 @Override
                 public WebConfig provide() {
                     return webConfig;
                 }
 
-                @Override
-                public void dispose(final WebConfig instance) {
-                    //not used
-                }
             }).to(WebConfig.class).in(Singleton.class);
 
             install(new ServiceFinderBinder<>(AsyncContextDelegateProvider.class, applicationProperties, RuntimeType.SERVER));

core-client/src/main/java/org/glassfish/jersey/client/ClientBinder.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
@@ -57,6 +57,7 @@
 import org.glassfish.jersey.internal.inject.ContextInjectionResolver;
 import org.glassfish.jersey.internal.inject.JerseyClassAnalyzer;
 import org.glassfish.jersey.internal.inject.ReferencingFactory;
+import org.glassfish.jersey.internal.inject.SupplierFactory;
 import org.glassfish.jersey.internal.spi.AutoDiscoverable;
 import org.glassfish.jersey.internal.util.collection.Ref;
 import org.glassfish.jersey.message.internal.MessageBodyFactory;
@@ -65,7 +66,6 @@
 import org.glassfish.jersey.process.internal.RequestScoped;
 import org.glassfish.jersey.spi.ExecutorServiceProvider;
 
-import org.glassfish.hk2.api.Factory;
 import org.glassfish.hk2.api.TypeLiteral;
 import org.glassfish.hk2.utilities.binding.AbstractBinder;
 
@@ -88,7 +88,7 @@ public RequestContextInjectionFactory(Provider<Ref<ClientRequest>> referenceFact
         }
     }
 
-    private static class PropertiesDelegateFactory implements Factory<PropertiesDelegate> {
+    private static class PropertiesDelegateFactory extends SupplierFactory<PropertiesDelegate> {
 
         private final Provider<ClientRequest> requestProvider;
 
@@ -101,11 +101,6 @@ private PropertiesDelegateFactory(Provider<ClientRequest> requestProvider) {
         public PropertiesDelegate provide() {
             return requestProvider.get().getPropertiesDelegate();
         }
-
-        @Override
-        public void dispose(PropertiesDelegate instance) {
-            // do nothing
-        }
     }
 
     /**

core-common/src/main/java/org/glassfish/jersey/internal/inject/ContextInjectionResolver.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
@@ -45,9 +45,10 @@
 import java.util.List;
 import java.util.Set;
 
+import javax.ws.rs.core.Context;
+
 import javax.inject.Inject;
 import javax.inject.Singleton;
-import javax.ws.rs.core.Context;
 
 import org.glassfish.jersey.internal.util.ReflectionHelper;
 import org.glassfish.jersey.internal.util.collection.LazyValue;
@@ -130,16 +131,11 @@ public Object resolve(Injectee injectee, ServiceHandle<?> root) {
     }
 
     private Factory asFactory(final ServiceHandle handle) {
-        return new Factory() {
+        return new SupplierFactory() {
             @Override
             public Object provide() {
                 return handle.getService();
             }
-
-            @Override
-            public void dispose(Object instance) {
-                //not used
-            }
         };
     }
 

core-common/src/main/java/org/glassfish/jersey/internal/inject/Injections.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
@@ -39,8 +39,6 @@
  */
 package org.glassfish.jersey.internal.inject;
 
-import java.lang.annotation.Annotation;
-
 import javax.ws.rs.WebApplicationException;
 
 import org.glassfish.hk2.api.DynamicConfiguration;
@@ -213,32 +211,6 @@ public static void addBinding(final BindingBuilder<?> builder,
         BindingBuilderFactory.addBinding(builder, configuration, defaultLoader);
     }
 
-    /**
-     * Get a new factory class-based service binding builder.
-     *
-     * @param <T>          service type.
-     * @param factoryType  service factory class.
-     * @param factoryScope factory scope.
-     * @return initialized binding builder.
-     */
-    public static <T> ServiceBindingBuilder<T> newFactoryBinder(
-            final Class<? extends Factory<T>> factoryType, final Class<? extends Annotation> factoryScope) {
-        return BindingBuilderFactory.newFactoryBinder(factoryType, factoryScope);
-    }
-
-    /**
-     * Get a new factory class-based service binding builder.
-     *
-     * The factory itself is bound in a {@link org.glassfish.hk2.api.PerLookup per-lookup} scope.
-     *
-     * @param <T>         service type.
-     * @param factoryType service factory class.
-     * @return initialized binding builder.
-     */
-    public static <T> ServiceBindingBuilder<T> newFactoryBinder(final Class<? extends Factory<T>> factoryType) {
-        return BindingBuilderFactory.newFactoryBinder(factoryType);
-    }
-
     /**
      * Get a new factory instance-based service binding builder.
      *