Removed dependency injection from request-bound value suppliers.

Value suppliers that derive their supplied value from request
had to be injected before. This requirement has been removed
for these value suppliers and the need to access injectable
request-scoped ContainerRequest instance has been moved to a single
place in code in the AbstractRequestDerivedValueSupplier.

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

Author: Marek Potociar

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

@@ -41,6 +41,8 @@
 
 import javax.ws.rs.WebApplicationException;
 
+import javax.inject.Provider;
+
 import org.glassfish.hk2.api.DynamicConfiguration;
 import org.glassfish.hk2.api.DynamicConfigurationService;
 import org.glassfish.hk2.api.Factory;
@@ -187,6 +189,18 @@ public static <T> T getOrCreate(final ServiceLocator serviceLocator, final Class
         }
     }
 
+    /**
+     * Get a provider for a contract.
+     *
+     * @param <T>            instance type.
+     * @param serviceLocator HK2 service locator.
+     * @param clazz          class of the instance to be provider.
+     * @return provider of contract class.
+     */
+    public static <T> Provider<T> getProvider(final ServiceLocator serviceLocator, final Class<T> clazz) {
+        return () -> serviceLocator.getService(clazz);
+    }
+
     /**
      * Add a binding represented by the binding builder to the HK2 dynamic configuration.
      *

core-server/src/main/java/org/glassfish/jersey/server/internal/inject/AbstractContainerRequestValueSupplier.java renamed to core-server/src/main/java/org/glassfish/jersey/server/internal/inject/AbstractRequestDerivedValueSupplier.java

@@ -41,7 +41,6 @@
 
 import java.util.function.Supplier;
 
-import javax.inject.Inject;
 import javax.inject.Provider;
 
 import org.glassfish.jersey.server.ContainerRequest;
@@ -53,16 +52,19 @@
  * @author Paul Sandoz
  * @author Marek Potociar (marek.potociar at oracle.com)
  */
-public abstract class AbstractContainerRequestValueSupplier<T> implements Supplier<T> {
-    @Inject
-    private Provider<ContainerRequest> request;
+public abstract class AbstractRequestDerivedValueSupplier<T> implements Supplier<T> {
+    private final Provider<ContainerRequest> requestProvider;
+
+    protected AbstractRequestDerivedValueSupplier(Provider<ContainerRequest> requestProvider) {
+        this.requestProvider = requestProvider;
+    }
 
     /**
      * Get the container request.
      *
      * @return the container request.
      */
-    protected final ContainerRequest getContainerRequest() {
-        return request.get();
+    protected final ContainerRequest getRequest() {
+        return requestProvider.get();
     }
 }

core-server/src/main/java/org/glassfish/jersey/server/internal/inject/AbstractValueSupplierProvider.java

@@ -44,6 +44,10 @@
 import java.util.Set;
 import java.util.function.Supplier;
 
+import javax.inject.Provider;
+
+import org.glassfish.jersey.internal.inject.Injections;
+import org.glassfish.jersey.server.ContainerRequest;
 import org.glassfish.jersey.server.model.Parameter;
 import org.glassfish.jersey.server.spi.internal.ValueSupplierProvider;
 
@@ -63,6 +67,7 @@ public abstract class AbstractValueSupplierProvider implements ValueSupplierProv
     private final MultivaluedParameterExtractorProvider mpep;
     private final ServiceLocator locator;
     private final Set<Parameter.Source> compatibleSources;
+    private final Provider<ContainerRequest> requestProvider;
 
     /**
      * Initialize the provider.
@@ -76,31 +81,20 @@ protected AbstractValueSupplierProvider(MultivaluedParameterExtractorProvider mp
                                             Parameter.Source... compatibleSources) {
         this.mpep = mpep;
         this.locator = locator;
-        this.compatibleSources = new HashSet<Parameter.Source>(Arrays.asList(compatibleSources));
-    }
+        this.compatibleSources = new HashSet<>(Arrays.asList(compatibleSources));
 
-    /**
-     * Get a parameter extractor that ignores default value set on the parameter.
-     *
-     * @param parameter parameter supported by the returned extractor.
-     * @return extractor supporting the parameter. The returned instance ignores
-     *         any default values set on the parameter.
-     * @see #get(org.glassfish.jersey.server.model.Parameter)
-     */
-    protected final MultivaluedParameterExtractor<?> getWithoutDefaultValue(Parameter parameter) {
-        return mpep.getWithoutDefaultValue(parameter);
+        this.requestProvider = Injections.getProvider(locator, ContainerRequest.class);
     }
 
     /**
-     * Get a parameter extractor. Unlike the extractor returned by the
-     * {@link #getWithoutDefaultValue(org.glassfish.jersey.server.model.Parameter)}
-     * method, the extractor returned from this method will use the default value
+     * Get a parameter extractor.
+     * The extractor returned from this method will use the default value
      * set on the parameter, in case the parameter is not found in the supplied
      * {@link javax.ws.rs.core.MultivaluedMap multivalued parameter map}.
      *
      * @param parameter parameter supported by the returned extractor.
      * @return extractor supporting the parameter. The returned instance ignores
-     *         any default values set on the parameter.
+     * any default values set on the parameter.
      */
     protected final MultivaluedParameterExtractor<?> get(Parameter parameter) {
         return mpep.get(parameter);
@@ -110,27 +104,29 @@ protected final MultivaluedParameterExtractor<?> get(Parameter parameter) {
      * Create a value supplier for the parameter. May return {@code null} in case
      * the parameter is not supported by the value supplier provider.
      *
-     * @param parameter parameter requesting the value supplier instance.
+     * @param parameter       parameter requesting the value supplier instance.
+     * @param requestProvider container request provider that provides request context specific access to the
+     *                        {@link ContainerRequest} instance.
      * @return parameter value supplier. Returns {@code null} if parameter is not supported.
      */
-    protected abstract Supplier<?> createValueSupplier(Parameter parameter);
+    protected abstract AbstractRequestDerivedValueSupplier<?> createValueSupplier(
+            Parameter parameter, Provider<ContainerRequest> requestProvider);
 
     /**
      * Get an injected value supplier for the parameter. May return {@code null}
      * in case the parameter is not supported by the value supplier provider.
      *
      * @param parameter parameter requesting the value supplier instance.
      * @return injected parameter value supplier. Returns {@code null} if parameter
-     *         is not supported.
+     * is not supported.
      */
     @Override
     public final Supplier<?> getValueSupplier(Parameter parameter) {
         if (!compatibleSources.contains(parameter.getSource())) {
             // not compatible
             return null;
         }
-
-        final Supplier<?> valueSupplier = createValueSupplier(parameter);
+        final Supplier<?> valueSupplier = createValueSupplier(parameter, requestProvider);
         if (valueSupplier != null) {
             locator.inject(valueSupplier);
         }

core-server/src/main/java/org/glassfish/jersey/server/internal/inject/BeanParamValueSupplierProvider.java

@@ -43,9 +43,11 @@
 import javax.ws.rs.BeanParam;
 
 import javax.inject.Inject;
+import javax.inject.Provider;
 import javax.inject.Singleton;
 
 import org.glassfish.jersey.process.internal.RequestScoped;
+import org.glassfish.jersey.server.ContainerRequest;
 import org.glassfish.jersey.server.model.Parameter;
 
 import org.glassfish.hk2.api.ActiveDescriptor;
@@ -81,7 +83,7 @@ public InjectionResolver() {
         }
     }
 
-    private static final class BeanParamValueSupplier extends AbstractContainerRequestValueSupplier<Object> {
+    private static final class BeanParamValueSupplier extends AbstractRequestDerivedValueSupplier<Object> {
         private final Parameter parameter;
         private final ServiceLocator locator;
 
@@ -100,7 +102,9 @@ public ActiveDescriptor<?> compute(Class<?> key) {
                     }
                 });
 
-        private BeanParamValueSupplier(ServiceLocator locator, Parameter parameter) {
+        private BeanParamValueSupplier(ServiceLocator locator, Parameter parameter, Provider<ContainerRequest> requestProvider) {
+            super(requestProvider);
+
             this.locator = locator;
             this.parameter = parameter;
         }
@@ -131,7 +135,10 @@ public BeanParamValueSupplierProvider(MultivaluedParameterExtractorProvider mpep
     }
 
     @Override
-    public AbstractContainerRequestValueSupplier<?> createValueSupplier(Parameter parameter) {
-        return new BeanParamValueSupplier(locator, parameter);
+    public AbstractRequestDerivedValueSupplier<?> createValueSupplier(
+            Parameter parameter,
+            Provider<ContainerRequest> requestProvider) {
+
+        return new BeanParamValueSupplier(locator, parameter, requestProvider);
     }
 }

core-server/src/main/java/org/glassfish/jersey/server/internal/inject/CookieParamValueSupplierProvider.java

@@ -46,10 +46,12 @@
 import javax.ws.rs.core.MultivaluedMap;
 
 import javax.inject.Inject;
+import javax.inject.Provider;
 import javax.inject.Singleton;
 
 import org.glassfish.jersey.internal.inject.ExtractorException;
 import org.glassfish.jersey.internal.util.collection.MultivaluedStringMap;
+import org.glassfish.jersey.server.ContainerRequest;
 import org.glassfish.jersey.server.ParamException;
 import org.glassfish.jersey.server.model.Parameter;
 
@@ -64,6 +66,39 @@
 @Singleton
 final class CookieParamValueSupplierProvider extends AbstractValueSupplierProvider {
 
+    /**
+     * {@link CookieParam} annotation value factory provider injection constructor.
+     *
+     * @param mpep     multivalued parameter extractor provider.
+     * @param injector injector instance.
+     */
+    @Inject
+    public CookieParamValueSupplierProvider(MultivaluedParameterExtractorProvider mpep, ServiceLocator injector) {
+        super(mpep, injector, Parameter.Source.COOKIE);
+    }
+
+    @Override
+    public AbstractRequestDerivedValueSupplier<?> createValueSupplier(
+            Parameter parameter,
+            Provider<ContainerRequest> requestProvider) {
+
+        String parameterName = parameter.getSourceName();
+        if (parameterName == null || parameterName.length() == 0) {
+            // Invalid cookie parameter name
+            return null;
+        }
+
+        if (parameter.getRawType() == Cookie.class) {
+            return new CookieTypeParamValueSupplier(parameterName, requestProvider);
+        } else {
+            MultivaluedParameterExtractor e = get(parameter);
+            if (e == null) {
+                return null;
+            }
+            return new CookieParamValueSupplier(e, requestProvider);
+        }
+    }
+
     /**
      * Injection resolver for {@link CookieParam} annotation.
      */
@@ -78,11 +113,13 @@ public InjectionResolver() {
         }
     }
 
-    private static final class CookieParamValueSupplier extends AbstractContainerRequestValueSupplier<Object> {
+    private static final class CookieParamValueSupplier extends AbstractRequestDerivedValueSupplier<Object> {
 
         private final MultivaluedParameterExtractor<?> extractor;
 
-        CookieParamValueSupplier(MultivaluedParameterExtractor<?> extractor) {
+        CookieParamValueSupplier(MultivaluedParameterExtractor<?> extractor, Provider<ContainerRequest> requestProvider) {
+            super(requestProvider);
+
             this.extractor = extractor;
         }
 
@@ -91,7 +128,7 @@ public Object get() {
             // TODO: cache?
             MultivaluedMap<String, String> cookies = new MultivaluedStringMap();
 
-            for (Map.Entry<String, Cookie> e : getContainerRequest().getCookies().entrySet()) {
+            for (Map.Entry<String, Cookie> e : getRequest().getCookies().entrySet()) {
                 cookies.putSingle(e.getKey(), e.getValue().getValue());
             }
 
@@ -104,47 +141,19 @@ public Object get() {
         }
     }
 
-    private static final class CookieTypeParamValueSupplier extends AbstractContainerRequestValueSupplier<Cookie> {
+    private static final class CookieTypeParamValueSupplier extends AbstractRequestDerivedValueSupplier<Cookie> {
 
         private final String name;
 
-        CookieTypeParamValueSupplier(String name) {
+        CookieTypeParamValueSupplier(String name, Provider<ContainerRequest> requestProvider) {
+            super(requestProvider);
+
             this.name = name;
         }
 
         @Override
         public Cookie get() {
-            return getContainerRequest().getCookies().get(name);
-        }
-    }
-
-    /**
-     * {@link CookieParam} annotation value factory provider injection constructor.
-     *
-     * @param mpep     multivalued parameter extractor provider.
-     * @param injector injector instance.
-     */
-    @Inject
-    public CookieParamValueSupplierProvider(MultivaluedParameterExtractorProvider mpep, ServiceLocator injector) {
-        super(mpep, injector, Parameter.Source.COOKIE);
-    }
-
-    @Override
-    public AbstractContainerRequestValueSupplier<?> createValueSupplier(Parameter parameter) {
-        String parameterName = parameter.getSourceName();
-        if (parameterName == null || parameterName.length() == 0) {
-            // Invalid cookie parameter name
-            return null;
-        }
-
-        if (parameter.getRawType() == Cookie.class) {
-            return new CookieTypeParamValueSupplier(parameterName);
-        } else {
-            MultivaluedParameterExtractor e = get(parameter);
-            if (e == null) {
-                return null;
-            }
-            return new CookieParamValueSupplier(e);
+            return getRequest().getCookies().get(name);
         }
     }
 }

core-server/src/main/java/org/glassfish/jersey/server/internal/inject/EntityParamValueSupplierProvider.java

@@ -45,6 +45,7 @@
 import javax.ws.rs.core.Response;
 
 import javax.inject.Inject;
+import javax.inject.Provider;
 import javax.inject.Singleton;
 
 import org.glassfish.jersey.server.ContainerRequest;
@@ -73,17 +74,27 @@ class EntityParamValueSupplierProvider extends AbstractValueSupplierProvider {
         super(mpep, injector, Parameter.Source.ENTITY);
     }
 
-    private static class EntityValueSupplier extends AbstractContainerRequestValueSupplier<Object> {
+    @Override
+    protected AbstractRequestDerivedValueSupplier<?> createValueSupplier(
+            Parameter parameter,
+            Provider<ContainerRequest> requestProvider) {
+
+        return new EntityValueSupplier(parameter, requestProvider);
+    }
+
+    private static class EntityValueSupplier extends AbstractRequestDerivedValueSupplier<Object> {
 
         private final Parameter parameter;
 
-        public EntityValueSupplier(Parameter parameter) {
+        public EntityValueSupplier(Parameter parameter, Provider<ContainerRequest> requestProvider) {
+            super(requestProvider);
+
             this.parameter = parameter;
         }
 
         @Override
         public Object get() {
-            final ContainerRequest requestContext = getContainerRequest();
+            final ContainerRequest requestContext = getRequest();
 
             final Class<?> rawType = parameter.getRawType();
 
@@ -102,9 +113,4 @@ public Object get() {
 
         }
     }
-
-    @Override
-    protected AbstractContainerRequestValueSupplier<?> createValueSupplier(Parameter parameter) {
-        return new EntityValueSupplier(parameter);
-    }
 }