1 /**
2 * This file Copyright (c) 2014-2018 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.map2bean.Map2BeanTransformer;
40 import info.magnolia.module.ModuleRegistry;
41
42 import org.apache.jackrabbit.commons.predicate.Predicate;
43
44 /**
45 * Builder for {@link info.magnolia.config.source.jcr.JcrConfigurationSource} instances.
46 */
47 public class JcrConfigurationSourceBuilder extends AbstractConfigurationSourceBuilder {
48 private final Node2BeanProcessor node2BeanProcessor;
49 private final Map2BeanTransformer map2BeanTransformer;
50 private final ModuleRegistry moduleRegistry;
51 private String pathInModule;
52 private Predicate nodeFilter = Predicate.TRUE;
53
54 public JcrConfigurationSourceBuilder(Node2BeanProcessor node2BeanProcessor, Map2BeanTransformer map2BeanTransformer, ModuleRegistry moduleRegistry) {
55 this.node2BeanProcessor = node2BeanProcessor;
56 this.map2BeanTransformer = map2BeanTransformer;
57 this.moduleRegistry = moduleRegistry;
58 }
59
60 public JcrConfigurationSourceBuilder withModulePath(String pathInModule) {
61 this.pathInModule = pathInModule;
62 return this;
63 }
64
65 /**
66 * Provides a {@link org.apache.jackrabbit.commons.predicate.Predicate} which will be used
67 * to determine if a given need can indeed be registered with this registry. Defaults to an
68 * "always true" implementation.
69 */
70 public JcrConfigurationSourceBuilder withFilter(Predicate nodeFilter) {
71 this.nodeFilter = nodeFilter;
72 return this;
73 }
74
75 /**
76 * Must be called only once (preferably on system startup) to prevent memory leaks
77 * ({@link javax.jcr.observation.EventListener}s cannot be deregistered once new {@link JcrConfigurationSource} is instantiated).
78 */
79 @Override
80 public void bindTo(Registry<?> registry) {
81 if (pathInModule == null) {
82 throw new IllegalStateException(this + " is incomplete.");
83 }
84 if (registry == null) {
85 throw new NullPointerException("Must pass a registry instance");
86 }
87
88 final JcrConfigurationSource<?> configurationSource = new JcrConfigurationSource<>(registry, pathInModule, nodeFilter, moduleRegistry, map2BeanTransformer);
89 configurationSource.start();
90 }
91
92 /**
93 * Must be called only once (preferably on system startup) to prevent memory leaks
94 * ({@link javax.jcr.observation.EventListener}s cannot be deregistered once new {@link JcrConfigurationSource} is instantiated).
95 */
96 public void bindWithDefaults(Registry registry) {
97 withModulePath(registry.type().getPluralName()).bindTo(registry);
98 }
99
100 }