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.template.registry;
35  
36  import java.util.ArrayList;
37  import java.util.Collection;
38  import java.util.Set;
39  import javax.inject.Singleton;
40  
41  import org.slf4j.Logger;
42  import org.slf4j.LoggerFactory;
43  
44  import info.magnolia.registry.RegistrationException;
45  import info.magnolia.registry.RegistryMap;
46  import info.magnolia.rendering.template.TemplateDefinition;
47  
48  
49  /**
50   * The central registry of all {@link TemplateDefinition}s.
51   *
52   * @version $Id$
53   */
54  @Singleton
55  public class TemplateDefinitionRegistry {
56  
57      private static final Logger log = LoggerFactory.getLogger(TemplateDefinitionRegistry.class);
58  
59      private final RegistryMap<String, TemplateDefinitionProvider> registry = new RegistryMap<String, TemplateDefinitionProvider>() {
60  
61          @Override
62          protected String keyFromValue(TemplateDefinitionProvider provider) {
63              return provider.getId();
64          }
65      };
66  
67      public TemplateDefinition getTemplateDefinition(String id) throws RegistrationException {
68  
69          TemplateDefinitionProvider templateDefinitionProvider;
70          try {
71              templateDefinitionProvider = registry.getRequired(id);
72          } catch (RegistrationException e) {
73              throw new RegistrationException("No template definition registered for id: " + id, e);
74          }
75  
76          return templateDefinitionProvider.getTemplateDefinition();
77      }
78  
79      /**
80       * @return all TemplateDefinitions - in case of errors it'll just deliver the ones that are properly registered and logs error's for the others.
81       */
82      public Collection<TemplateDefinition> getTemplateDefinitions() {
83          final Collection<TemplateDefinition> templateDefinitions = new ArrayList<TemplateDefinition>();
84          for (TemplateDefinitionProvider provider : registry.values()) {
85              try {
86                  final TemplateDefinition templateDefinition = provider.getTemplateDefinition();
87                  if (templateDefinition == null) {
88                      log.error("Provider's TemplateDefinition is null: " + provider);
89                  } else {
90                      templateDefinitions.add(templateDefinition);
91                  }
92              } catch (RegistrationException e) {
93                  log.error("Failed to read template definition from " + provider + ".", e);
94              }
95          }
96          return templateDefinitions;
97      }
98  
99      public void register(TemplateDefinitionProvider provider) {
100         registry.put(provider);
101     }
102 
103     public void unregister(String id) {
104         registry.remove(id);
105     }
106 
107     public Set<String> unregisterAndRegister(Collection<String> registeredIds, Collection<TemplateDefinitionProvider> providers) {
108         return registry.removeAndPutAll(registeredIds, providers);
109     }
110 }