1 /**
2 * This file Copyright (c) 2011-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.renderer.registry;
35
36 import info.magnolia.cms.util.DeprecationUtil;
37 import info.magnolia.config.registry.AbstractRegistry;
38 import info.magnolia.config.registry.DefinitionMetadataBuilder;
39 import info.magnolia.config.registry.DefinitionProvider;
40 import info.magnolia.config.registry.DefinitionType;
41 import info.magnolia.registry.RegistrationException;
42 import info.magnolia.rendering.DefinitionTypes;
43 import info.magnolia.rendering.context.RenderingListener;
44 import info.magnolia.rendering.engine.DefaultRenderingEngine;
45 import info.magnolia.rendering.renderer.Renderer;
46
47 import java.util.List;
48
49 import javax.inject.Singleton;
50
51 /**
52 * Central registry of all renderers.
53 */
54 @Singleton
55 public class RendererRegistry extends AbstractRegistry<Renderer> {
56
57 @Override
58 public DefinitionType type() {
59 return DefinitionTypes.RENDERER;
60 }
61
62 @Override
63 public DefinitionMetadataBuilder newMetadataBuilder() {
64 return DefinitionMetadataBuilder.usingNameAsId();
65 }
66
67 public Renderer getRenderer(String type) throws RegistrationException {
68
69 DefinitionProvider<Renderer> provider;
70 provider = getProvider(type);
71
72 return provider.get();
73 }
74
75 /**
76 * This method is kept for compatibility reasons. It adapts the given provider to the new DefinitionProvider introduced in 5.4.
77 *
78 * @deprecated since 5.4
79 */
80 public void register(RendererProvider provider) {
81 throw new IllegalStateException("Not implemented yet/anymore - meant to be restored as a compatibility layer");
82 }
83
84 /**
85 * @deprecated since 5.4. Listeners are now instantiated under (/server/rendering/engine/listeners)
86 */
87 public void registerListener(final String listenerClassName) {
88 DeprecationUtil.isDeprecated(String.format("Was replaced by %s.setListeners()", DefaultRenderingEngine.class.getName()));
89 }
90
91 /**
92 * @deprecated since 5.4. Listeners are now instantiated under (/server/rendering/engine/listeners)
93 */
94 public List<Class<RenderingListener>> getListeners() {
95 DeprecationUtil.isDeprecated(String.format("Was replaced by %s.setListeners()", DefaultRenderingEngine.class.getName()));
96 return null;
97 }
98 }
99