1 /**
2 * This file Copyright (c) 2012-2016 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.module.blossom.support.ExplicitIdDefinitionMetadataBuilder;
42 import info.magnolia.rendering.DefinitionTypes;
43 import info.magnolia.rendering.template.TemplateDefinition;
44
45 import java.util.Collections;
46 import java.util.List;
47
48 /**
49 * Provider used to export Blossom templates to {@link info.magnolia.rendering.template.registry.TemplateDefinitionRegistry}.
50 *
51 * @since 2.0
52 */
53 public class BlossomTemplateDefinitionProvider implements DefinitionProvider<TemplateDefinition> {
54
55 private BlossomTemplateDefinition definition;
56
57 public BlossomTemplateDefinitionProvider(BlossomTemplateDefinition definition) {
58 this.definition = definition;
59 }
60
61 @Override
62 public DefinitionMetadata getMetadata() {
63 DefinitionMetadataBuilder builder = new ExplicitIdDefinitionMetadataBuilder(definition.getId())
64 .type(DefinitionTypes.TEMPLATE)
65 .name(definition.getName());
66 if (definition.getHandler() != null) {
67 builder.location(definition.getHandler().getClass().getName());
68 }
69 return builder.build();
70 }
71
72 @Override
73 public TemplateDefinition get() throws Registry.InvalidDefinitionException {
74 return definition;
75 }
76
77 @Override
78 public DefinitionRawView getRaw() {
79 return DefinitionRawView.EMPTY;
80 }
81
82 @Override
83 public boolean isValid() {
84 return true;
85 }
86
87 @Override
88 public List<String> getErrorMessages() {
89 return Collections.emptyList();
90 }
91 }