View Javadoc
1   /**
2    * This file Copyright (c) 2014-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.config.source;
35  
36  import info.magnolia.config.source.jcr.JcrConfigurationSourceBuilder;
37  import info.magnolia.config.source.yaml.YamlConfigurationSourceBuilder;
38  import info.magnolia.config.source.yaml.YamlReader;
39  import info.magnolia.init.MagnoliaConfigurationProperties;
40  import info.magnolia.jcr.node2bean.Node2BeanProcessor;
41  import info.magnolia.map2bean.Map2BeanTransformer;
42  import info.magnolia.module.ModuleRegistry;
43  import info.magnolia.objectfactory.Components;
44  import info.magnolia.resourceloader.ResourceOrigin;
45  
46  import javax.inject.Inject;
47  import javax.inject.Singleton;
48  
49  /**
50   * This factory provides builders for the default {@link info.magnolia.config.source.ConfigurationSource} implementations.
51   * If you implement your own {@link info.magnolia.config.source.ConfigurationSource}, you don't necessarily need
52   * to implement such a factory or even a {@link info.magnolia.config.source.ConfigurationSourceBuilder};
53   * the main goal of this class is to allow relatively fluent code to register sources and "hide" their dependencies
54   * (they're injected in this factory).
55   */
56  @Singleton
57  public class ConfigurationSourceFactory {
58  
59      private final ResourceOrigin origin;
60      private final YamlReader yamlReader;
61      private final Map2BeanTransformer map2BeanTransformer;
62      private final Node2BeanProcessor node2BeanProcessor;
63      private final ModuleRegistry moduleRegistry;
64      private final MagnoliaConfigurationProperties magnoliaConfigurationProperties;
65  
66      /**
67       * @deprecated since 5.5 - use {@link #ConfigurationSourceFactory(ResourceOrigin, YamlReader, Map2BeanTransformer, Node2BeanProcessor, ModuleRegistry, MagnoliaConfigurationProperties)} instead.
68       */
69      @Deprecated
70      public ConfigurationSourceFactory(ResourceOrigin origin, YamlReader yamlReader, info.magnolia.config.map2bean.Map2BeanTransformer map2BeanTransformer, Node2BeanProcessor node2BeanProcessor, ModuleRegistry moduleRegistry) {
71          this(origin, yamlReader, map2BeanTransformer, node2BeanProcessor, moduleRegistry, Components.getComponent(MagnoliaConfigurationProperties.class));
72      }
73  
74      @Inject
75      public ConfigurationSourceFactory(ResourceOrigin origin, YamlReader yamlReader, Map2BeanTransformer map2BeanTransformer, Node2BeanProcessor node2BeanProcessor, ModuleRegistry moduleRegistry, MagnoliaConfigurationProperties magnoliaConfigurationProperties) {
76          this.origin = origin;
77          this.yamlReader = yamlReader;
78          this.map2BeanTransformer = map2BeanTransformer;
79          this.node2BeanProcessor = node2BeanProcessor;
80          this.moduleRegistry = moduleRegistry;
81          this.magnoliaConfigurationProperties = magnoliaConfigurationProperties;
82      }
83  
84      public YamlConfigurationSourceBuilder yaml() {
85          return new YamlConfigurationSourceBuilder(origin, map2BeanTransformer, yamlReader, magnoliaConfigurationProperties);
86      }
87  
88      public JcrConfigurationSourceBuilder jcr() {
89          return new JcrConfigurationSourceBuilder(node2BeanProcessor, moduleRegistry);
90      }
91  
92      public ConfigurationSourceBuilder code() {
93          throw new IllegalStateException("not yet");
94      }
95  }