View Javadoc
1   /**
2    * This file Copyright (c) 2020 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.view;
35  
36  import info.magnolia.objectfactory.Components;
37  import info.magnolia.rendering.renderer.ContextAttributeConfiguration;
38  import info.magnolia.rendering.renderer.Renderer;
39  
40  import java.util.HashMap;
41  import java.util.Map;
42  
43  import org.springframework.beans.factory.config.AbstractFactoryBean;
44  
45  /**
46   * Factory bean for creating instances of {@link FreemarkerTemplateViewRenderer},
47   * delegating instantiate to the {@link info.magnolia.objectfactory.ComponentProvider ComponentProvider}
48   * so we don't need to expose its dependencies to Spring context.
49   *
50   * @see FreemarkerTemplateViewRenderer
51   */
52  public class FreemarkerTemplateViewRendererFactoryBean extends AbstractFactoryBean<Renderer> {
53      private Map<String, ContextAttributeConfiguration> contextAttributes = new HashMap<String, ContextAttributeConfiguration>();
54      private boolean exposeModelAsRequestAttributes = true;
55      private boolean exposeSpringMacroHelpers = true;
56  
57      public Map<String, ContextAttributeConfiguration> getContextAttributes() {
58          return contextAttributes;
59      }
60  
61      public void setContextAttributes(Map<String, ContextAttributeConfiguration> contextAttributes) {
62          this.contextAttributes = contextAttributes;
63      }
64  
65      public void addContextAttribute(String name, ContextAttributeConfiguration contextAttributeConfiguration) {
66          this.contextAttributes.put(name, contextAttributeConfiguration);
67      }
68  
69      public void addContextAttribute(String name, Class<?> componentClass) {
70          ContextAttributeConfiguration attributeConfiguration = new ContextAttributeConfiguration();
71          attributeConfiguration.setName(name);
72          attributeConfiguration.setComponentClass(componentClass);
73          addContextAttribute(name, attributeConfiguration);
74      }
75  
76      public boolean isExposeModelAsRequestAttributes() {
77          return exposeModelAsRequestAttributes;
78      }
79  
80      public void setExposeModelAsRequestAttributes(boolean exposeModelAsRequestAttributes) {
81          this.exposeModelAsRequestAttributes = exposeModelAsRequestAttributes;
82      }
83  
84      public boolean isExposeSpringMacroHelpers() {
85          return exposeSpringMacroHelpers;
86      }
87  
88      public void setExposeSpringMacroHelpers(boolean exposeSpringMacroHelpers) {
89          this.exposeSpringMacroHelpers = exposeSpringMacroHelpers;
90      }
91  
92      @Override
93      public Class<?> getObjectType() {
94          return FreemarkerTemplateViewRenderer.class;
95      }
96  
97      @Override
98      protected Renderer createInstance() throws Exception {
99          FreemarkerTemplateViewRenderer renderer = Components.newInstance(FreemarkerTemplateViewRenderer.class);
100         renderer.setExposeModelAsRequestAttributes(exposeModelAsRequestAttributes);
101         renderer.setExposeSpringMacroHelpers(exposeSpringMacroHelpers);
102         renderer.setContextAttributes(contextAttributes);
103         return renderer;
104     }
105 }