View Javadoc
1   /**
2    * This file Copyright (c) 2012-2018 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.template;
35  
36  import info.magnolia.config.registry.DefinitionMetadata;
37  import info.magnolia.config.registry.DefinitionMetadataBuilder;
38  import info.magnolia.config.registry.DefinitionProvider;
39  import info.magnolia.config.registry.DefinitionRawView;
40  import info.magnolia.config.registry.Registry;
41  import info.magnolia.config.registry.decoration.DefinitionDecorator;
42  import info.magnolia.config.source.ConfigurationSourceTypes;
43  import info.magnolia.module.blossom.support.ExplicitIdDefinitionMetadataBuilder;
44  import info.magnolia.rendering.DefinitionTypes;
45  import info.magnolia.rendering.template.TemplateDefinition;
46  
47  import java.util.Collections;
48  import java.util.List;
49  
50  /**
51   * Provider used to export Blossom templates to {@link info.magnolia.rendering.template.registry.TemplateDefinitionRegistry}.
52   *
53   * @since 2.0
54   */
55  public class BlossomTemplateDefinitionProvider implements DefinitionProvider<TemplateDefinition> {
56  
57      private BlossomTemplateDefinition definition;
58  
59      public BlossomTemplateDefinitionProvider(BlossomTemplateDefinition definition) {
60          this.definition = definition;
61      }
62  
63      @Override
64      public List<DefinitionDecorator<TemplateDefinition>> getDecorators() {
65          return Collections.EMPTY_LIST;
66      }
67  
68      @Override
69      public DefinitionMetadata getMetadata() {
70          DefinitionMetadataBuilder builder = new ExplicitIdDefinitionMetadataBuilder(definition.getId())
71                  .type(DefinitionTypes.TEMPLATE)
72                  .name(definition.getName())
73                  .configurationSourceType(ConfigurationSourceTypes.code);
74          if (definition.getHandler() != null) {
75              builder.location(definition.getHandler().getClass().getName());
76          }
77          return builder.build();
78      }
79  
80      @Override
81      public TemplateDefinition get() throws Registry.InvalidDefinitionException {
82          return definition;
83      }
84  
85      @Override
86      public DefinitionRawView getRaw() {
87          return DefinitionRawView.EMPTY;
88      }
89  
90      @Override
91      public boolean isValid() {
92          return true;
93      }
94  
95      @Override
96      public List<String> getErrorMessages() {
97          return Collections.emptyList();
98      }
99  
100     @Override
101     public long getLastModified() {
102         return System.currentTimeMillis();
103     }
104 }