View Javadoc
1   /**
2    * This file Copyright (c) 2014-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.config.source.jcr;
35  
36  import info.magnolia.config.registry.Registry;
37  import info.magnolia.config.source.AbstractConfigurationSourceBuilder;
38  import info.magnolia.jcr.node2bean.Node2BeanProcessor;
39  import info.magnolia.module.ModuleRegistry;
40  
41  import java.io.IOException;
42  
43  import org.apache.jackrabbit.commons.predicate.Predicate;
44  
45  /**
46   * Builder for {@link info.magnolia.config.source.jcr.JcrConfigurationSource} instances.
47   */
48  public class JcrConfigurationSourceBuilder extends AbstractConfigurationSourceBuilder {
49      private final Node2BeanProcessor node2BeanProcessor;
50      private final ModuleRegistry moduleRegistry;
51      private String pathInModule;
52      private Predicate nodeFilter = Predicate.TRUE;
53  
54      public JcrConfigurationSourceBuilder(Node2BeanProcessor node2BeanProcessor, ModuleRegistry moduleRegistry) {
55          this.node2BeanProcessor = node2BeanProcessor;
56          this.moduleRegistry = moduleRegistry;
57      }
58  
59      public JcrConfigurationSourceBuilder withModulePath(String pathInModule) {
60          this.pathInModule = pathInModule;
61          return this;
62      }
63  
64      /**
65       * Provides a {@link org.apache.jackrabbit.commons.predicate.Predicate} which will be used
66       * to determine if a given need can indeed be registered with this registry. Defaults to an
67       * "always true" implementation.
68       */
69      public JcrConfigurationSourceBuilder withFilter(Predicate nodeFilter) {
70          this.nodeFilter = nodeFilter;
71          return this;
72      }
73  
74      @Override
75      public void bindTo(Registry<?> registry) {
76          if (pathInModule == null) {
77              throw new IllegalStateException(this + " is incomplete.");
78          }
79          if (registry == null) {
80              throw new NullPointerException("Must pass a registry instance");
81          }
82  
83          try {
84              final JcrConfigurationSource<?> configurationSource = new JcrConfigurationSource<>(registry, pathInModule, nodeFilter, node2BeanProcessor, moduleRegistry);
85              configurationSource.start();
86          } catch (IOException e) {
87              throw new RuntimeException(e);
88          }
89      }
90  
91      public void bindWithDefaults(Registry registry) {
92          withModulePath(pluralTypeNameOf(registry)).bindTo(registry);
93      }
94  
95  }