JERSEY-2855: introduced foreign request scope bridge to enable direct injection of factory provided request scoped JAX-RS stuff into factory provided external managed components

Change-Id: Id8074c94692fe6803d6299d16e6cb70d3e7b9fd7
Signed-off-by: Jakub Podlesak <[email protected]>

Author: japod

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-2014 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2012-2015 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,14 +39,21 @@
  */
 package org.glassfish.jersey.internal.inject;
 
+import java.lang.reflect.Field;
 import java.lang.reflect.Type;
-
-import javax.ws.rs.core.Context;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Set;
 
 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;
+import org.glassfish.jersey.internal.util.collection.Value;
+import org.glassfish.jersey.internal.util.collection.Values;
+import org.glassfish.jersey.process.internal.RequestScoped;
 
 import org.glassfish.hk2.api.ActiveDescriptor;
 import org.glassfish.hk2.api.Factory;
@@ -55,6 +62,8 @@
 import org.glassfish.hk2.api.ServiceHandle;
 import org.glassfish.hk2.api.ServiceLocator;
 import org.glassfish.hk2.api.TypeLiteral;
+import org.glassfish.hk2.utilities.AbstractActiveDescriptor;
+import org.glassfish.hk2.utilities.BuilderHelper;
 import org.glassfish.hk2.utilities.InjecteeImpl;
 import org.glassfish.hk2.utilities.binding.AbstractBinder;
 import org.glassfish.hk2.utilities.cache.Cache;
@@ -64,6 +73,7 @@
  * Injection resolver for {@link Context @Context} injection annotation.
  *
  * @author Marek Potociar (marek.potociar at oracle.com)
+ * @author Jakub Podlesak (jakub.podlesak at oracle.com)
  */
 @Singleton
 public class ContextInjectionResolver implements InjectionResolver<Context> {
@@ -100,9 +110,9 @@ public Object resolve(Injectee injectee, ServiceHandle<?> root) {
         Injectee newInjectee;
 
         if (isHk2Factory) {
-            newInjectee = getInjectee(injectee, ReflectionHelper.getTypeArgument(requiredType, 0));
+            newInjectee = getFactoryInjectee(injectee, ReflectionHelper.getTypeArgument(requiredType, 0));
         } else {
-            newInjectee = injectee;
+            newInjectee = foreignRequestScopedInjecteeCache.compute(injectee);
         }
 
         ActiveDescriptor<?> ad = descriptorCache.compute(newInjectee);
@@ -133,7 +143,7 @@ public void dispose(Object instance) {
         };
     }
 
-    private Injectee getInjectee(final Injectee injectee, final Type requiredType) {
+    private Injectee getFactoryInjectee(final Injectee injectee, final Type requiredType) {
         return new RequiredTypeOverridingInjectee(injectee, requiredType);
     }
 
@@ -147,6 +157,16 @@ private RequiredTypeOverridingInjectee(final Injectee injectee, final Type requi
         }
     }
 
+    private static class DescriptorOverridingInjectee extends InjecteeImpl {
+
+        private static final long serialVersionUID = -3740895548611880189L;
+
+        private DescriptorOverridingInjectee(final Injectee injectee, final ActiveDescriptor descriptor) {
+            super(injectee);
+            setInjecteeDescriptor(descriptor);
+        }
+    }
+
     @Override
     public boolean isConstructorParameterIndicator() {
         return true;
@@ -156,4 +176,49 @@ public boolean isConstructorParameterIndicator() {
     public boolean isMethodParameterIndicator() {
         return false;
     }
+
+
+    private final Cache<Injectee, Injectee> foreignRequestScopedInjecteeCache =
+            new Cache<Injectee, Injectee>(new Computable<Injectee, Injectee>() {
+        @Override
+        public Injectee compute(Injectee injectee) {
+            if (injectee.getParent() != null) {
+                if (Field.class.isAssignableFrom(injectee.getParent().getClass())) {
+                    Field f = (Field) injectee.getParent();
+                    if (foreignRequestScopedComponents.get().contains(f.getDeclaringClass())) {
+                        final Class<?> clazz = f.getType();
+                        if (serviceLocator.getServiceHandle(clazz).getActiveDescriptor().getScopeAnnotation()
+                                                                                            == RequestScoped.class) {
+                            final AbstractActiveDescriptor<Object> descriptor =
+                                    BuilderHelper.activeLink(clazz)
+                                            .to(clazz)
+                                            .in(RequestScoped.class)
+                                            .build();
+                            return new DescriptorOverridingInjectee(injectee, descriptor);
+                        }
+                    }
+                }
+            }
+            return injectee;
+        }
+    });
+
+    LazyValue<Set<Class<?>>> foreignRequestScopedComponents = Values.lazy(new Value<Set<Class<?>>>() {
+        @Override
+        public Set<Class<?>> get() {
+            return getForeignRequestScopedComponents();
+        }
+    });
+
+    private Set<Class<?>> getForeignRequestScopedComponents() {
+        final List<ForeignRequestScopeBridge> scopeBridges = serviceLocator.getAllServices(ForeignRequestScopeBridge.class);
+        final Set<Class<?>> result = new HashSet<Class<?>>();
+        for (ForeignRequestScopeBridge bridge : scopeBridges) {
+            final Set<Class<?>> requestScopedComponents = bridge.getRequestScopedComponents();
+            if (requestScopedComponents != null) {
+                result.addAll(requestScopedComponents);
+            }
+        }
+        return result;
+    }
 }

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

@@ -0,0 +1,63 @@
+/*
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
+ *
+ * Copyright (c) 2015 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.internal.inject;
+
+import java.util.Set;
+
+/**
+ * Internal service to help determine
+ * which HK2 factory provided components should be treated
+ * as request scoped. This is to help avoid having
+ * dynamic proxies of request scoped components injected into
+ * factory created components managed by 3rd party component
+ * providers
+ *
+ * Jakub Podlesak (jakub.podlesak at oracle.com).
+ */
+public interface ForeignRequestScopeBridge {
+
+    /**
+     * Get me a set of classes that are managed outside of HK2
+     * and should be treated as if HK2 request scoped.
+     *
+     * @return set of classes representing foreign request scoped components.
+     */
+    Set<Class<?>> getRequestScopedComponents();
+}

examples/cdi-webapp/src/main/java/org/glassfish/jersey/examples/cdi/resources/MyApplication.java

@@ -61,6 +61,8 @@ public Set<Class<?>> getClasses() {
         classes.add(EchoParamResource.class);
         classes.add(EchoParamFieldResource.class);
         classes.add(EchoParamConstructorResource.class);
+        classes.add(ProxyInjectedAppScopedResource.class);
+        classes.add(RequestScopedResource.class);
         return classes;
     }
 }

examples/cdi-webapp/src/main/java/org/glassfish/jersey/examples/cdi/resources/ProxyInjectedAppScopedResource.java

@@ -0,0 +1,68 @@
+/*
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
+ *
+ * Copyright (c) 2015 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.examples.cdi.resources;
+
+import javax.enterprise.context.ApplicationScoped;
+import javax.ws.rs.GET;
+import javax.ws.rs.Path;
+import javax.ws.rs.core.Context;
+import javax.ws.rs.core.UriInfo;
+
+/**
+ * Application scoped CDI bean to demonstrate a dynamic proxy is being injected
+ * for URI info so that actual request information is available.
+ *
+ * @author Jakub Podlesak (jakub.podlesak at oralcle.com)
+ */
+@ApplicationScoped
+@Path("ui-app")
+public class ProxyInjectedAppScopedResource {
+
+    @Context UriInfo uiField;
+
+    @Path("{p}")
+    @GET
+    public String getUri(@Context UriInfo uiParam) {
+        if (uiParam == uiField) {
+            throw new IllegalStateException("Dynamic proxy expected in the uiField");
+        }
+        return uiField.getRequestUri().getPath();
+    }
+}

examples/cdi-webapp/src/main/java/org/glassfish/jersey/examples/cdi/resources/RequestScopedResource.java

@@ -0,0 +1,69 @@
+/*
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
+ *
+ * Copyright (c) 2015 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.examples.cdi.resources;
+
+import javax.enterprise.context.ApplicationScoped;
+import javax.enterprise.context.RequestScoped;
+import javax.ws.rs.GET;
+import javax.ws.rs.Path;
+import javax.ws.rs.core.Context;
+import javax.ws.rs.core.UriInfo;
+
+/**
+ * Request scoped CDI bean to demonstrate no dynamic proxy is being injected
+ * for JAX-RS request scoped URI info.
+ *
+ * @author Jakub Podlesak (jakub.podlesak at oralcle.com)
+ */
+@RequestScoped
+@Path("ui-req")
+public class RequestScopedResource {
+
+    @Context UriInfo uiField;
+
+    @Path("{p}")
+    @GET
+    public String getUri(@Context UriInfo uiParam) {
+        if (uiParam != uiField) {
+            throw new IllegalStateException("No dynamic proxy expected in the uiField");
+        }
+        return uiField.getRequestUri().getPath();
+    }
+}