Merge pull request #42 from ganeshs/master

Using provider instead of HttpServletRequest in ServletJaxRsContextFactoryProvider
pac4j · May 19, 2018 · 9e95196 · 9e95196
1 parent 7cfd91f
commit 9e95196
Show file tree

Hide file tree

Showing 8 changed files with 78 additions and 16 deletions.
diff --git a/README.md b/README.md
@@ -51,8 +51,8 @@ You need to add a dependency on:
 
 - jax-rs-pac4j
   1. for Jersey (<2.26) : the `jersey-pac4j` library (<em>groupId</em>: **org.pac4j**, *version*: **2.2.0**)
-  2. for Resteasy : the `resteasy-pac4j` library (<em>groupId</em>: **org.pac4j**, *version*: **2.2.0**)
-- the appropriate `pac4j` [submodules](http://www.pac4j.org/docs/clients.html) (<em>groupId</em>: **org.pac4j**, *version*: **2.3.0**): `pac4j-oauth` for OAuth support (Facebook, Twitter...), `pac4j-cas` for CAS support, `pac4j-ldap` for LDAP authentication, etc.
+  2. for Resteasy : the `resteasy-pac4j` library (<em>groupId</em>: **org.pac4j**, *version*: **2.2.0**) and `resteasy-cdi` for CDI support
+- the appropriate `pac4j` [submodules](http://www.pac4j.org/docs/clients.html) (<em>groupId</em>: **org.pac4j**, *version*: **2.1.0**): `pac4j-oauth` for OAuth support (Facebook, Twitter...), `pac4j-cas` for CAS support, `pac4j-ldap` for LDAP authentication, etc.
 
 All released artifacts are available in the [Maven central repository](http://search.maven.org/#search%7Cga%7C1%7Cpac4j).
 
@@ -120,7 +120,7 @@ resourceConfig
 For a Jersey-based and Servlet-based (e.g., Jetty or Grizzly Servlet) environment with session management, annotation support and method parameters injection:
 ```java
 resourceConfig
-    .register(new ServletJaxRsContextFactoryProvider(config))
+    .register(ServletJaxRsContextFactoryProvider.class)
     .register(new Pac4JSecurityFeature(config))
     .register(new Pac4JValueFactoryProvider.Binder());
 ```
@@ -142,13 +142,20 @@ For a Resteasy-based and Servlet-based (e.g., Undertow) environment with session
         public Set<Object> getSingletons() {
             Config config = getConfig();
             Set<Object> singletons = new HashSet<>();
-            singletons.add(new ServletJaxRsContextFactoryProvider(config));
             singletons.add(new Pac4JSecurityFeature(config));
-            singletons.add(new Pac4JProfileInjectorFactory());
             return singletons;
         }
+
+        @Override
+        public Set<Class<?>> getClasses() {
+            Set<Class<?>> classes = new HashSet<>();
+            classes.add(ServletJaxRsContextFactoryProvider.class);
+            classes.add(Pac4JProfileInjectorFactory.class);
+            return classes;
+        }
     }
 ```
+For RestEasy, you need to include `resteasy-cdi` support to your project to ensure that dependencies are injected at runtime. Refer to the tests in `resteasy-pac4j` module.
 
 Note that a default value for the `clients` parameter of the `@Pac4JSecurity`
 annotation can be passed to the constructor of `Pac4JSecurityFeature`.

diff --git a/core/pom.xml b/core/pom.xml
@@ -21,6 +21,11 @@
       <version>1.2</version>
       <scope>provided</scope>
     </dependency>
+    <dependency>
+      <groupId>javax.inject</groupId>
+      <artifactId>javax.inject</artifactId>
+      <version>1</version>
+    </dependency>
     <dependency>
       <groupId>org.pac4j</groupId>
       <artifactId>pac4j-core</artifactId>

diff --git a/core/src/main/java/org/pac4j/jax/rs/servlet/features/ServletJaxRsContextFactoryProvider.java b/core/src/main/java/org/pac4j/jax/rs/servlet/features/ServletJaxRsContextFactoryProvider.java
@@ -1,7 +1,8 @@
 package org.pac4j.jax.rs.servlet.features;
 
+import javax.inject.Inject;
+import javax.inject.Provider;
 import javax.servlet.http.HttpServletRequest;
-import javax.ws.rs.core.Context;
 
 import org.pac4j.jax.rs.features.JaxRsContextFactoryProvider;
 import org.pac4j.jax.rs.servlet.pac4j.ServletJaxRsContext;
@@ -17,11 +18,11 @@
  */
 public class ServletJaxRsContextFactoryProvider extends JaxRsContextFactoryProvider {
 
-    @Context
-    private HttpServletRequest request;
+    @Inject
+    private Provider<HttpServletRequest> requestProvider;
 
     @Override
     public JaxRsContextFactory getContext(Class<?> type) {
-        return context -> new ServletJaxRsContext(getProviders(), context, getConfig().getSessionStore(), request);
+        return context -> new ServletJaxRsContext(getProviders(), context, getConfig().getSessionStore(), requestProvider.get());
     }
 }
diff --git a/core/src/main/resources/META-INF/beans.xml b/core/src/main/resources/META-INF/beans.xml
@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- NOTE: This file is required primarily for resteasy CDI. "Bean classes
+	of enabled beans must be deployed in bean archives. A library jar, EJB jar,
+	application client jar or rar archive is a bean archive if it has a file
+	named beans.xml in the META-INF directory". https://docs.jboss.org/cdi/spec/1.0/html/packagingdeployment.html -->
+<beans
+        xmlns="http://xmlns.jcp.org/xml/ns/javaee"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/beans_1_1.xsd"
+        bean-discovery-mode="all"
+>
+
+</beans>
diff --git a/jersey/src/test/java/org/pac4j/jax/rs/rules/JerseyGrizzlyServletRule.java b/jersey/src/test/java/org/pac4j/jax/rs/rules/JerseyGrizzlyServletRule.java
@@ -34,7 +34,7 @@ protected DeploymentContext configureDeployment(ResourceConfig config) {
     protected ResourceConfig configureResourceConfig(ResourceConfig config) {
         return super
                 .configureResourceConfig(config)
-                .register(new ServletJaxRsContextFactoryProvider());
+                .register(ServletJaxRsContextFactoryProvider.class);
     }
 
 }
diff --git a/jersey226/src/test/java/org/pac4j/jax/rs/rules/JerseyGrizzlyServletRule.java b/jersey226/src/test/java/org/pac4j/jax/rs/rules/JerseyGrizzlyServletRule.java
@@ -34,7 +34,7 @@ protected DeploymentContext configureDeployment(ResourceConfig config) {
     protected ResourceConfig configureResourceConfig(ResourceConfig config) {
         return super
                 .configureResourceConfig(config)
-                .register(new ServletJaxRsContextFactoryProvider());
+                .register(ServletJaxRsContextFactoryProvider.class);
     }
 
 }
diff --git a/resteasy/pom.xml b/resteasy/pom.xml
@@ -9,12 +9,16 @@
   <groupId>org.pac4j</groupId>
   <artifactId>resteasy-pac4j</artifactId>
 
+  <properties>
+    <resteasy.version>3.1.4.Final</resteasy.version>
+  </properties>
+
   <dependencyManagement>
     <dependencies>
       <dependency>
         <groupId>org.jboss.resteasy</groupId>
         <artifactId>resteasy-bom</artifactId>
-        <version>3.1.4.Final</version>
+        <version>${resteasy.version}</version>
         <scope>import</scope>
         <type>pom</type>
       </dependency>
@@ -44,11 +48,29 @@
       <artifactId>resteasy-undertow</artifactId>
       <scope>test</scope>
     </dependency>
+    <dependency>
+      <groupId>org.jboss.resteasy</groupId>
+      <artifactId>resteasy-cdi</artifactId>
+      <scope>test</scope>
+      <version>${resteasy.version}</version>
+    </dependency>
+    <dependency>
+      <groupId>javax</groupId>
+      <artifactId>javaee-api</artifactId>
+      <version>8.0</version>
+      <scope>test</scope>
+    </dependency>
     <dependency>
       <groupId>io.undertow</groupId>
       <artifactId>undertow-servlet</artifactId>
       <scope>test</scope>
     </dependency>
+    <dependency>
+      <groupId>org.jboss.weld.servlet</groupId>
+      <artifactId>weld-servlet</artifactId>
+      <version>2.4.7.Final</version>
+      <scope>test</scope>
+    </dependency>
     <dependency>
       <groupId>org.glassfish.jersey.core</groupId>
       <artifactId>jersey-client</artifactId>

diff --git a/resteasy/src/test/java/org/pac4j/jax/rs/rules/RestEasyUndertowServletRule.java b/resteasy/src/test/java/org/pac4j/jax/rs/rules/RestEasyUndertowServletRule.java
@@ -13,8 +13,11 @@
 import org.awaitility.Awaitility;
 import org.awaitility.Duration;
 import org.glassfish.jersey.client.JerseyClientBuilder;
+import org.jboss.resteasy.cdi.CdiInjectorFactory;
 import org.jboss.resteasy.plugins.server.undertow.UndertowJaxrsServer;
+import org.jboss.resteasy.spi.ResteasyDeployment;
 import org.jboss.resteasy.test.TestPortProvider;
+import org.jboss.weld.environment.servlet.Listener;
 import org.junit.rules.ExternalResource;
 import org.pac4j.jax.rs.features.JaxRsConfigProvider;
 import org.pac4j.jax.rs.features.Pac4JSecurityFeature;
@@ -23,6 +26,8 @@
 import org.pac4j.jax.rs.servlet.features.ServletJaxRsContextFactoryProvider;
 
 import io.undertow.server.session.SessionCookieConfig;
+import io.undertow.servlet.Servlets;
+import io.undertow.servlet.api.DeploymentInfo;
 
 public class RestEasyUndertowServletRule extends ExternalResource implements SessionContainerRule {
 
@@ -34,15 +39,16 @@ public class MyApp extends Application {
 
         @Override
         public Set<Class<?>> getClasses() {
-            return getResources();
+            Set<Class<?>> classes = getResources();
+            classes.add(ServletJaxRsContextFactoryProvider.class);
+            classes.add(Pac4JProfileInjectorFactory.class);
+            return classes;
         }
 
         @Override
         public Set<Object> getSingletons() {
             return Sets.newLinkedHashSet(
                     new JaxRsConfigProvider(getConfig()),
-                    new ServletJaxRsContextFactoryProvider(),
-                    new Pac4JProfileInjectorFactory(),
                     new Pac4JSecurityFeature());
         }
     }
@@ -66,7 +72,15 @@ protected void before() throws Throwable {
         System.setProperty("org.jboss.resteasy.port", "24257");
         server = new UndertowJaxrsServer().start();
 
-        server.deploy(new MyApp());
+        ResteasyDeployment deployment = new ResteasyDeployment();
+        deployment.setInjectorFactoryClass(CdiInjectorFactory.class.getName());
+        deployment.setApplication(new MyApp());
+        DeploymentInfo di = server.undertowDeployment(deployment)
+                .setContextPath("/")
+                .setDeploymentName("DI")
+                .setClassLoader(getClass().getClassLoader())
+                .addListeners(Servlets.listener(Listener.class));
+        server.deploy(di);
     }
 
     @Override