1 /**
2 * This file Copyright (c) 2013 Magnolia International
3 * Ltd. (http://www.magnolia-cms.com). All rights reserved.
4 *
5 *
6 * This file is dual-licensed under both the Magnolia
7 * Network Agreement and the GNU General Public License.
8 * You may elect to use one or the other of these licenses.
9 *
10 * This file is distributed in the hope that it will be
11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12 * implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14 * Redistribution, except as permitted by whichever of the GPL
15 * or MNA you select, is prohibited.
16 *
17 * 1. For the GPL license (GPL), you can redistribute and/or
18 * modify this file under the terms of the GNU General
19 * Public License, Version 3, as published by the Free Software
20 * Foundation. You should have received a copy of the GNU
21 * General Public License, Version 3 along with this program;
22 * if not, write to the Free Software Foundation, Inc., 51
23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24 *
25 * 2. For the Magnolia Network Agreement (MNA), this file
26 * and the accompanying materials are made available under the
27 * terms of the MNA which accompanies this distribution, and
28 * is available at http://www.magnolia-cms.com/mna.html
29 *
30 * Any modifications to this file must keep this entire header
31 * intact.
32 *
33 */
34 package info.magnolia.module.blossom.rendering;
35
36 import info.magnolia.rendering.model.RenderingModel;
37 import info.magnolia.rendering.model.RenderingModelImpl;
38 import info.magnolia.rendering.template.RenderableDefinition;
39
40 import javax.jcr.Node;
41 import javax.servlet.ServletContext;
42
43 import org.springframework.beans.factory.config.AutowireCapableBeanFactory;
44 import org.springframework.web.context.support.WebApplicationContextUtils;
45
46 /**
47 * Support base class for rendering models that needs autowiring using an application context.
48 * <p/>
49 * Injection is by default performed with the root web application context and only beans managed there are injectable,
50 * typically those defined in or loaded into it using the <code>applicationContext.xml</code> file.
51 * <p/>
52 * Note that rendering models are created by Magnolia using Google Guice. Arguments to the constructor are resolved by
53 * taking them from Guice. Since Guice supports the @Inject annotation on fields and methods you should prefer the
54 * @Autowired annotation for dependencies you need from Spring and you should not try to acquire those as
55 * constructor arguments.
56 *
57 * @param <RD> type of RenderableDefinition
58 * @see RenderingModel
59 * @see org.springframework.beans.factory.annotation.Autowired
60 * @see org.springframework.beans.factory.config.AutowireCapableBeanFactory#autowireBean(Object)
61 * @since 3.0
62 */
63 public abstract class AbstractAutowiredRenderingModel<RD extends RenderableDefinition> extends RenderingModelImpl<RD> {
64
65 private ServletContext servletContext;
66
67 protected AbstractAutowiredRenderingModel(Node content, RD definition, RenderingModel<?> parent, ServletContext servletContext) {
68 super(content, definition, parent);
69 this.servletContext = servletContext;
70 findBeanFactory().autowireBean(this);
71 }
72
73 /**
74 * Finds the bean factory to use for autowiring. By default finds the root web application context
75 */
76 protected AutowireCapableBeanFactory findBeanFactory() {
77 return WebApplicationContextUtils.getWebApplicationContext(servletContext).getAutowireCapableBeanFactory();
78 }
79 }