View Javadoc

1   /**
2    * This file Copyright (c) 2011-2013 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.objectfactory.Classes;
37  import info.magnolia.registry.RegistrationException;
38  import info.magnolia.registry.RegistryMap;
39  import info.magnolia.rendering.context.RenderingListener;
40  import info.magnolia.rendering.renderer.Renderer;
41  
42  import java.util.ArrayList;
43  import java.util.List;
44  import java.util.Set;
45  
46  import javax.inject.Singleton;
47  
48  import org.slf4j.Logger;
49  import org.slf4j.LoggerFactory;
50  
51  /**
52   * Central registry of all renderers.
53   */
54  @Singleton
55  public class RendererRegistry {
56  
57      private static final Logger log = LoggerFactory.getLogger(RendererRegistry.class);
58  
59      private final List<Class<RenderingListener>> listeners = new ArrayList<Class<RenderingListener>>();
60  
61      private final RegistryMap<String, RendererProvider> registry = new RegistryMap<String, RendererProvider>() {
62  
63          @Override
64          protected String keyFromValue(RendererProvider provider) {
65              return provider.getType();
66          }
67      };
68  
69      public Renderer getRenderer(String type) throws RegistrationException {
70  
71          RendererProvider provider;
72          try {
73              provider = registry.getRequired(type);
74          } catch (RegistrationException e) {
75              throw new RegistrationException("No renderer registered for type: " + type, e);
76          }
77  
78          return provider.getRenderer();
79      }
80  
81      public void register(RendererProvider rendererProvider) {
82          registry.put(rendererProvider.getType(), rendererProvider);
83      }
84  
85      public void unregister(String type) {
86          registry.remove(type);
87      }
88  
89      public Set<String> unregisterAndRegister(Set<String> registeredTypes, List<RendererProvider> providers) {
90          return registry.removeAndPutAll(registeredTypes, providers);
91      }
92  
93      public void registerListener(final String listenerClassName) {
94          Class<RenderingListener> listenerClass;
95          try {
96              listenerClass = Classes.getClassFactory().forName(listenerClassName);
97              if (!listeners.contains(listenerClassName)) {
98                  getListeners().add(listenerClass);
99              }
100         } catch (ClassNotFoundException e) {
101             log.error("{} was not found.", listenerClassName);
102         }
103     }
104 
105     public List<Class<RenderingListener>> getListeners() {
106         return listeners;
107     }
108 }