From 08462f2c1574af29a434f448bb5ceabd1dbcd7f0 Mon Sep 17 00:00:00 2001 From: Lukasz Lenart Date: Mon, 19 Sep 2011 05:49:16 +0000 Subject: [PATCH] Move CDI plugin into trunk git-svn-id: https://svn.apache.org/repos/asf/struts/struts2/trunk@1172467 13f79535-47bb-0310-9956-ffa450edef68 --- plugins/cdi/pom.xml | 59 ++++++ .../apache/struts2/cdi/CdiObjectFactory.java | 142 ++++++++++++++ plugins/cdi/src/main/resources/LICENSE.txt | 174 ++++++++++++++++++ plugins/cdi/src/main/resources/NOTICE.txt | 5 + .../cdi/src/main/resources/struts-plugin.xml | 35 ++++ .../struts2/cdi/CdiObjectFactoryTest.java | 48 +++++ .../org/apache/struts2/cdi/FooConsumer.java | 16 ++ .../org/apache/struts2/cdi/FooService.java | 12 ++ .../cdi/src/test/resources/META-INF/beans.xml | 1 + .../cdi/src/test/resources/log4j.properties | 11 ++ 10 files changed, 503 insertions(+) create mode 100644 plugins/cdi/pom.xml create mode 100644 plugins/cdi/src/main/java/org/apache/struts2/cdi/CdiObjectFactory.java create mode 100644 plugins/cdi/src/main/resources/LICENSE.txt create mode 100644 plugins/cdi/src/main/resources/NOTICE.txt create mode 100644 plugins/cdi/src/main/resources/struts-plugin.xml create mode 100644 plugins/cdi/src/test/java/org/apache/struts2/cdi/CdiObjectFactoryTest.java create mode 100644 plugins/cdi/src/test/java/org/apache/struts2/cdi/FooConsumer.java create mode 100644 plugins/cdi/src/test/java/org/apache/struts2/cdi/FooService.java create mode 100644 plugins/cdi/src/test/resources/META-INF/beans.xml create mode 100644 plugins/cdi/src/test/resources/log4j.properties diff --git a/plugins/cdi/pom.xml b/plugins/cdi/pom.xml new file mode 100644 index 000000000..25caa8597 --- /dev/null +++ b/plugins/cdi/pom.xml @@ -0,0 +1,59 @@ + + + 4.0.0 + + + org.apache.struts + struts2-plugins + 2.3-SNAPSHOT + + + org.apache.struts + struts2-cdi-plugin + 2.3-SNAPSHOT + + + + + javax.enterprise + cdi-api + 1.0-SP1 + provided + + + + org.jboss.weld + weld-core + 1.0.1-Final + provided + + + + org.jboss.weld + weld-se + 1.0.1-Final + test + + + + org.springframework + spring-test + test + + + + junit + junit + test + + + + log4j + log4j + test + + + + + \ No newline at end of file diff --git a/plugins/cdi/src/main/java/org/apache/struts2/cdi/CdiObjectFactory.java b/plugins/cdi/src/main/java/org/apache/struts2/cdi/CdiObjectFactory.java new file mode 100644 index 000000000..af86f1395 --- /dev/null +++ b/plugins/cdi/src/main/java/org/apache/struts2/cdi/CdiObjectFactory.java @@ -0,0 +1,142 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +package org.apache.struts2.cdi; + +import com.opensymphony.xwork2.ObjectFactory; +import com.opensymphony.xwork2.util.logging.Logger; +import com.opensymphony.xwork2.util.logging.LoggerFactory; + +import javax.enterprise.context.spi.CreationalContext; +import javax.enterprise.inject.spi.BeanManager; +import javax.enterprise.inject.spi.InjectionTarget; +import javax.naming.Context; +import javax.naming.InitialContext; +import javax.naming.NamingException; +import java.util.Map; +import java.util.concurrent.ConcurrentHashMap; + +/** + * CdiObjectFactory allows Struts 2 managed objects, like Actions, Interceptors or Results, to be injected by a Contexts + * and Dependency Injection container (JSR299 / WebBeans). + */ +public class CdiObjectFactory extends ObjectFactory { + + private static final Logger LOG = LoggerFactory.getLogger(CdiObjectFactory.class); + + /** + * The key under which the BeanManager can be found according to CDI API docs + */ + public static final String CDI_JNDIKEY_BEANMANAGER_COMP = "java:comp/BeanManager"; + /** + * The key under which the BeanManager can be found according to JBoss Weld docs + */ + public static final String CDI_JNDIKEY_BEANMANAGER_APP = "java:app/BeanManager"; + + protected BeanManager beanManager; + protected CreationalContext ctx; + + Map, InjectionTarget> injectionTargetCache = new ConcurrentHashMap, InjectionTarget>(); + + public CdiObjectFactory() { + super(); + LOG.info("Initializing Struts2 CDI integration..."); + this.beanManager = findBeanManager(); + if (beanManager != null) { + this.ctx = buildNonContextualCreationalContext(beanManager); + LOG.info("Struts2 CDI integration initialized."); + } else { + LOG.error("Struts2 CDI integration could not be initialized."); + } + } + + /** + * Try to find the CDI BeanManager from JNDI context. First the key {@link #CDI_JNDIKEY_BEANMANAGER_COMP} will be + * tested. If nothing is found there, the key {@link #CDI_JNDIKEY_BEANMANAGER_APP} will be checked. + * + * @return the BeanManager, if found. null otherwise. + */ + protected BeanManager findBeanManager() { + BeanManager bm; + try { + Context initialContext = new InitialContext(); + LOG.info("[findBeanManager]: Checking for BeanManager under JNDI key " + CDI_JNDIKEY_BEANMANAGER_COMP); + try { + bm = (BeanManager) initialContext.lookup(CdiObjectFactory.CDI_JNDIKEY_BEANMANAGER_COMP); + } catch (NamingException e) { + LOG.warn("[findBeanManager]: Lookup failed.", e); + LOG.info("[findBeanManager]: Checking for BeanManager under JNDI key " + CDI_JNDIKEY_BEANMANAGER_APP); + bm = (BeanManager) initialContext.lookup(CdiObjectFactory.CDI_JNDIKEY_BEANMANAGER_APP); + } + LOG.info("[findBeanManager]: BeanManager found."); + return bm; + } catch (NamingException e) { + LOG.error("Could not get BeanManager from JNDI context", e); + } + return null; + } + + @Override + @SuppressWarnings("unchecked") + public Object buildBean(String className, Map extraContext, boolean injectInternal) + throws Exception { + + Class clazz = getClassInstance(className); + InjectionTarget injectionTarget = getInjectionTarget(clazz); + + Object o = injectionTarget.produce(ctx); + injectionTarget.inject(o, ctx); + injectionTarget.postConstruct(o); + + if (injectInternal) { + injectInternalBeans(o); + } + + return o; + } + + /** + * Get a InjectionTarget instance for a given class. If the appropriate target is not found in cache, a nw instance + * will be created. + * + * @param clazz The class to get a InjectionTarget instance for. + * @return if found in cache, an existing instance. A new instance otherwise. + */ + protected InjectionTarget getInjectionTarget(Class clazz) { + InjectionTarget result; + result = injectionTargetCache.get(clazz); + if (result == null) { + result = beanManager.createInjectionTarget(beanManager.createAnnotatedType(clazz)); + injectionTargetCache.put(clazz, result); + } + + return result; + } + + /** + * Simple wrapper for CreationalContext creation. + * + * @param beanManager the BeanManager to use for creating the context. + * @return the context to use, if given BeanManager was not null. null otherwise. + */ + @SuppressWarnings("unchecked") + protected CreationalContext buildNonContextualCreationalContext(BeanManager beanManager) { + return beanManager != null ? beanManager.createCreationalContext(null) : null; + } +} diff --git a/plugins/cdi/src/main/resources/LICENSE.txt b/plugins/cdi/src/main/resources/LICENSE.txt new file mode 100644 index 000000000..dd5b3a58a --- /dev/null +++ b/plugins/cdi/src/main/resources/LICENSE.txt @@ -0,0 +1,174 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. diff --git a/plugins/cdi/src/main/resources/NOTICE.txt b/plugins/cdi/src/main/resources/NOTICE.txt new file mode 100644 index 000000000..fc8b72f01 --- /dev/null +++ b/plugins/cdi/src/main/resources/NOTICE.txt @@ -0,0 +1,5 @@ +Apache Struts +Copyright 2000-2009 The Apache Software Foundation + +This product includes software developed by +The Apache Software Foundation (http://www.apache.org/). diff --git a/plugins/cdi/src/main/resources/struts-plugin.xml b/plugins/cdi/src/main/resources/struts-plugin.xml new file mode 100644 index 000000000..381c5cc8d --- /dev/null +++ b/plugins/cdi/src/main/resources/struts-plugin.xml @@ -0,0 +1,35 @@ + + + + + + + + + + + + + + diff --git a/plugins/cdi/src/test/java/org/apache/struts2/cdi/CdiObjectFactoryTest.java b/plugins/cdi/src/test/java/org/apache/struts2/cdi/CdiObjectFactoryTest.java new file mode 100644 index 000000000..f35ac5563 --- /dev/null +++ b/plugins/cdi/src/test/java/org/apache/struts2/cdi/CdiObjectFactoryTest.java @@ -0,0 +1,48 @@ +package org.apache.struts2.cdi; + +import org.jboss.weld.environment.se.StartMain; +import static org.junit.Assert.*; + +import org.jboss.weld.environment.se.WeldContainer; +import org.junit.Before; +import org.junit.Test; +import org.springframework.mock.jndi.SimpleNamingContextBuilder; + +import javax.enterprise.inject.spi.InjectionTarget; + +/** + * CdiObjectFactoryTest. + */ +public class CdiObjectFactoryTest { + + @Before + public void setUp() throws Exception { + SimpleNamingContextBuilder builder = new SimpleNamingContextBuilder(); + builder.activate(); + + StartMain sm = new StartMain(new String[0]); + WeldContainer weldContainer = sm.go(); + builder.bind(CdiObjectFactory.CDI_JNDIKEY_BEANMANAGER_COMP, weldContainer.getBeanManager()); + } + + @Test + public void testFindBeanManager() throws Exception { + assertNotNull(new CdiObjectFactory().findBeanManager()); + } + + @Test + public void testGetBean() throws Exception { + final CdiObjectFactory cdiObjectFactory = new CdiObjectFactory(); + FooConsumer fooConsumer = (FooConsumer) cdiObjectFactory.buildBean(FooConsumer.class.getCanonicalName(), null, false); + assertNotNull(fooConsumer); + assertNotNull(fooConsumer.fooService); + } + + @Test public void testGetInjectionTarget() throws Exception { + final CdiObjectFactory cdiObjectFactory = new CdiObjectFactory(); + final InjectionTarget injectionTarget = cdiObjectFactory.getInjectionTarget(FooConsumer.class); + assertNotNull(injectionTarget); + assertTrue(cdiObjectFactory.injectionTargetCache.containsKey(FooConsumer.class)); + assertSame(cdiObjectFactory.getInjectionTarget(FooConsumer.class), injectionTarget); + } +} diff --git a/plugins/cdi/src/test/java/org/apache/struts2/cdi/FooConsumer.java b/plugins/cdi/src/test/java/org/apache/struts2/cdi/FooConsumer.java new file mode 100644 index 000000000..9f133f740 --- /dev/null +++ b/plugins/cdi/src/test/java/org/apache/struts2/cdi/FooConsumer.java @@ -0,0 +1,16 @@ +package org.apache.struts2.cdi; + +import javax.inject.Inject; + +/** + * FooConsumer. + */ +public class FooConsumer { + + @Inject + FooService fooService; + + public void foo() { + System.out.println(fooService.getHello()); + } +} diff --git a/plugins/cdi/src/test/java/org/apache/struts2/cdi/FooService.java b/plugins/cdi/src/test/java/org/apache/struts2/cdi/FooService.java new file mode 100644 index 000000000..afc6bf07c --- /dev/null +++ b/plugins/cdi/src/test/java/org/apache/struts2/cdi/FooService.java @@ -0,0 +1,12 @@ +package org.apache.struts2.cdi; + +/** + * FooService. + */ +public class FooService { + + public String getHello() { + return "Hello"; + } + +} diff --git a/plugins/cdi/src/test/resources/META-INF/beans.xml b/plugins/cdi/src/test/resources/META-INF/beans.xml new file mode 100644 index 000000000..e71e48076 --- /dev/null +++ b/plugins/cdi/src/test/resources/META-INF/beans.xml @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/plugins/cdi/src/test/resources/log4j.properties b/plugins/cdi/src/test/resources/log4j.properties new file mode 100644 index 000000000..77d993906 --- /dev/null +++ b/plugins/cdi/src/test/resources/log4j.properties @@ -0,0 +1,11 @@ +# Set root logger level to WARN and append to stdout +log4j.rootLogger=INFO, stdout + +log4j.appender.stdout=org.apache.log4j.ConsoleAppender +log4j.appender.stdout.layout=org.apache.log4j.PatternLayout + +# Pattern to output the caller's file name and line number. +log4j.appender.stdout.layout.ConversionPattern=%d %5p (%c:%L) - %m%n + +# Print only messages of level ERROR or above in the package noModule. +log4j.logger.noModule=FATAL