1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34 package info.magnolia.config.source.yaml;
35
36 import info.magnolia.config.registry.Registry;
37 import info.magnolia.config.source.AbstractConfigurationSourceBuilder;
38 import info.magnolia.init.MagnoliaConfigurationProperties;
39 import info.magnolia.map2bean.Map2BeanTransformer;
40 import info.magnolia.module.ModuleRegistry;
41 import info.magnolia.objectfactory.Components;
42 import info.magnolia.resourceloader.ResourceOrigin;
43
44 import java.util.regex.Pattern;
45 import java.util.regex.PatternSyntaxException;
46
47 import org.slf4j.Logger;
48 import org.slf4j.LoggerFactory;
49
50
51
52
53 public class YamlConfigurationSourceBuilder extends AbstractConfigurationSourceBuilder {
54
55 private static final Logger log = LoggerFactory.getLogger(YamlConfigurationSourceBuilder.class);
56
57
58
59
60
61
62 private static final String MODULE_CONVENTIONS_FORMAT = "^/(?<module>[a-zA-Z0-9-_]+)/(?<deftype>%s)/(?<relPath>.*/)?(?<name>[a-zA-Z0-9-_\\.]+)\\.yaml$";
63
64 private final ResourceOrigin origin;
65 private final YamlReader yamlReader;
66 private final MagnoliaConfigurationProperties magnoliaConfigurationProperties;
67 private final Map2BeanTransformer map2BeanTransformer;
68 private final ModuleRegistry moduleRegistry;
69 private String pathPattern;
70
71
72
73
74 @Deprecated
75 public YamlConfigurationSourceBuilder(ResourceOrigin origin, info.magnolia.config.map2bean.Map2BeanTransformer map2BeanTransformer, YamlReader yamlReader) {
76 this(origin, map2BeanTransformer, yamlReader, Components.getComponent(MagnoliaConfigurationProperties.class), Components.getComponent(ModuleRegistry.class));
77 }
78
79
80
81
82 @Deprecated
83 public YamlConfigurationSourceBuilder(ResourceOrigin origin, Map2BeanTransformer map2BeanTransformer, YamlReader yamlReader, MagnoliaConfigurationProperties magnoliaConfigurationProperties) {
84 this(origin, map2BeanTransformer, yamlReader, magnoliaConfigurationProperties, Components.getComponent(ModuleRegistry.class));
85 }
86
87 public YamlConfigurationSourceBuilder(ResourceOrigin origin, Map2BeanTransformer map2BeanTransformer, YamlReader yamlReader, MagnoliaConfigurationProperties magnoliaConfigurationProperties, ModuleRegistry moduleRegistry) {
88 this.origin = origin;
89 this.map2BeanTransformer = map2BeanTransformer;
90 this.yamlReader = yamlReader;
91 this.magnoliaConfigurationProperties = magnoliaConfigurationProperties;
92 this.moduleRegistry = moduleRegistry;
93 }
94
95 public YamlConfigurationSourceBuilder withPattern(String pathPattern) {
96 this.pathPattern = pathPattern;
97 return this;
98 }
99
100 @Override
101 public void bindTo(Registry<?> registry) {
102 final Pattern pathPattern = validatePathPattern(this.pathPattern);
103 if (registry == null) {
104 throw new NullPointerException("Must pass a registry instance");
105 }
106
107 new YamlConfigurationSource<>(origin, map2BeanTransformer, registry, pathPattern, yamlReader, magnoliaConfigurationProperties, moduleRegistry).start();
108 }
109
110 public void bindWithDefaults(Registry registry) {
111 if (pathPattern != null) {
112 throw new IllegalStateException(this + " is already partially configured, don't use bindWithDefaults().");
113 }
114 withPattern(moduleConventionsFormatFor(registry)).bindTo(registry);
115 }
116
117 protected Pattern validatePathPattern(String regex) {
118 if (pathPattern == null) {
119 throw new IllegalStateException(this + " is incomplete.");
120 }
121 try {
122
123 return Pattern.compile(regex);
124 } catch (PatternSyntaxException e) {
125 log.warn("Pattern {} is invalid: {}", regex, e.getMessage());
126 return Pattern.compile("$^");
127 }
128 }
129
130
131 protected String moduleConventionsFormatFor(Registry registry) {
132 return String.format(MODULE_CONVENTIONS_FORMAT, registry.type().getPluralName());
133 }
134
135 }