View Javadoc
1   /**
2    * This file Copyright (c) 2010-2015 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.rendering.template.registry;
35  
36  import info.magnolia.jcr.node2bean.Node2BeanException;
37  import info.magnolia.jcr.node2bean.Node2BeanProcessor;
38  import info.magnolia.objectfactory.Components;
39  import info.magnolia.registry.RegistrationException;
40  import info.magnolia.rendering.template.TemplateDefinition;
41  
42  import javax.jcr.Node;
43  import javax.jcr.RepositoryException;
44  
45  /**
46   * TemplateDefinitionProvider that instantiates a template from a configuration node.
47   *
48   * @deprecated since 5.4 use DefinitionProvider<Renderer> and configuration sources.
49   */
50  public class ConfiguredTemplateDefinitionProvider implements TemplateDefinitionProvider {
51  
52      private final String id;
53      private final TemplateDefinition templateDefinition;
54  
55      public ConfiguredTemplateDefinitionProvider(String id, Node configNode) throws Node2BeanException, RepositoryException {
56          this.id = id;
57          this.templateDefinition = fromNode(configNode);
58          if (templateDefinition != null) {
59              templateDefinition.setId(id);
60          }
61      }
62  
63      @Override
64      public String getId() {
65          return id;
66      }
67  
68      @Override
69      public TemplateDefinition getTemplateDefinition() throws RegistrationException {
70          return templateDefinition;
71      }
72  
73      @Override
74      public String toString() {
75          return "ConfiguredTemplateDefinitionProvider [id=" + id + ", templateDefinition=" + templateDefinition + "]";
76      }
77  
78      protected TemplateDefinition fromNode(Node configNode) throws Node2BeanException, RepositoryException {
79          return (TemplateDefinition) Components.getComponent(Node2BeanProcessor.class).toBean(configNode, TemplateDefinition.class);
80      }
81  
82      // Copied to Manager for now
83  //    protected DefinitionId<TemplateDefinition> createMetadata(TemplateDefinition templateDefinition, Node templateDefinitionNode) throws RepositoryException {
84  //        final String path = templateDefinitionNode.getPath();
85  //        final String[] pathElements = path.split("/");
86  //        final String moduleName = pathElements[2];
87  //        // return moduleName + ":" + StringUtils.removeStart(path, "/modules/" + moduleName + "/templates/");
88  //        return new DefinitionId<TemplateDefinition>(DefinitionTypes.TEMPLATE, templateDefinition.getName(), moduleName, null/*TODO pass the source obj around*/, path) {
89  //            @Override
90  //            public String asReferenceString() {
91  //                return getModule() + ":" + StringUtils.removeStart(getLocation(), "/modules/" + getModule() + "/templates/");
92  //            }
93  //        };
94  //    }
95  }