1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17 package org.apache.commons.configuration2.builder.combined;
18
19 import java.net.URL;
20 import java.util.ArrayList;
21 import java.util.Collection;
22 import java.util.Collections;
23 import java.util.HashMap;
24 import java.util.Iterator;
25 import java.util.LinkedList;
26 import java.util.List;
27 import java.util.Map;
28 import java.util.Set;
29 import java.util.stream.Collectors;
30
31 import org.apache.commons.configuration2.CombinedConfiguration;
32 import org.apache.commons.configuration2.Configuration;
33 import org.apache.commons.configuration2.ConfigurationLookup;
34 import org.apache.commons.configuration2.HierarchicalConfiguration;
35 import org.apache.commons.configuration2.SystemConfiguration;
36 import org.apache.commons.configuration2.XMLConfiguration;
37 import org.apache.commons.configuration2.beanutils.BeanDeclaration;
38 import org.apache.commons.configuration2.beanutils.BeanHelper;
39 import org.apache.commons.configuration2.beanutils.CombinedBeanDeclaration;
40 import org.apache.commons.configuration2.beanutils.XMLBeanDeclaration;
41 import org.apache.commons.configuration2.builder.BasicBuilderParameters;
42 import org.apache.commons.configuration2.builder.BasicConfigurationBuilder;
43 import org.apache.commons.configuration2.builder.BuilderParameters;
44 import org.apache.commons.configuration2.builder.ConfigurationBuilder;
45 import org.apache.commons.configuration2.builder.ConfigurationBuilderEvent;
46 import org.apache.commons.configuration2.builder.FileBasedBuilderParametersImpl;
47 import org.apache.commons.configuration2.builder.FileBasedBuilderProperties;
48 import org.apache.commons.configuration2.builder.FileBasedConfigurationBuilder;
49 import org.apache.commons.configuration2.builder.XMLBuilderParametersImpl;
50 import org.apache.commons.configuration2.builder.XMLBuilderProperties;
51 import org.apache.commons.configuration2.event.EventListener;
52 import org.apache.commons.configuration2.ex.ConfigurationException;
53 import org.apache.commons.configuration2.interpol.ConfigurationInterpolator;
54 import org.apache.commons.configuration2.interpol.Lookup;
55 import org.apache.commons.configuration2.io.FileSystem;
56 import org.apache.commons.configuration2.resolver.CatalogResolver;
57 import org.apache.commons.configuration2.tree.DefaultExpressionEngineSymbols;
58 import org.apache.commons.configuration2.tree.OverrideCombiner;
59 import org.apache.commons.configuration2.tree.UnionCombiner;
60 import org.xml.sax.EntityResolver;
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209 public class CombinedConfigurationBuilder extends BasicConfigurationBuilder<CombinedConfiguration> {
210
211
212
213 private final class ConfigurationSourceData {
214
215 private final List<ConfigurationDeclaration> overrideDeclarations;
216
217
218 private final List<ConfigurationDeclaration> unionDeclarations;
219
220
221 private final List<ConfigurationBuilder<? extends Configuration>> overrideBuilders;
222
223
224 private final List<ConfigurationBuilder<? extends Configuration>> unionBuilders;
225
226
227 private final Map<String, ConfigurationBuilder<? extends Configuration>> namedBuilders;
228
229
230 private final Collection<ConfigurationBuilder<? extends Configuration>> allBuilders;
231
232
233 private final EventListener<ConfigurationBuilderEvent> changeListener;
234
235
236
237
238 public ConfigurationSourceData() {
239 overrideDeclarations = new ArrayList<>();
240 unionDeclarations = new ArrayList<>();
241 overrideBuilders = new ArrayList<>();
242 unionBuilders = new ArrayList<>();
243 namedBuilders = new HashMap<>();
244 allBuilders = new LinkedList<>();
245 changeListener = createBuilderChangeListener();
246 }
247
248
249
250
251
252
253
254
255
256 private void addChildConfiguration(final CombinedConfiguration ccResult, final ConfigurationDeclaration decl,
257 final ConfigurationBuilder<? extends Configuration> builder) throws ConfigurationException {
258 try {
259 ccResult.addConfiguration(builder.getConfiguration(), decl.getName(), decl.getAt());
260 } catch (final ConfigurationException cex) {
261
262 if (!decl.isOptional()) {
263 throw cex;
264 }
265 }
266 }
267
268
269
270
271
272
273 public Set<String> builderNames() {
274 return namedBuilders.keySet();
275 }
276
277
278
279
280 public void cleanUp() {
281 getChildBuilders().forEach(b -> b.removeEventListener(ConfigurationBuilderEvent.RESET, changeListener));
282 namedBuilders.clear();
283 }
284
285
286
287
288
289
290
291
292
293
294
295 public List<ConfigurationBuilder<? extends Configuration>> createAndAddConfigurations(final CombinedConfiguration ccResult,
296 final List<ConfigurationDeclaration> srcDecl, final List<ConfigurationBuilder<? extends Configuration>> builders) throws ConfigurationException {
297 final boolean createBuilders = builders.isEmpty();
298 final List<ConfigurationBuilder<? extends Configuration>> newBuilders;
299 if (createBuilders) {
300 newBuilders = new ArrayList<>(srcDecl.size());
301 } else {
302 newBuilders = builders;
303 }
304
305 for (int i = 0; i < srcDecl.size(); i++) {
306 final ConfigurationBuilder<? extends Configuration> b;
307 if (createBuilders) {
308 b = createConfigurationBuilder(srcDecl.get(i));
309 newBuilders.add(b);
310 } else {
311 b = builders.get(i);
312 }
313 addChildConfiguration(ccResult, srcDecl.get(i), b);
314 }
315
316 return newBuilders;
317 }
318
319
320
321
322 private EventListener<ConfigurationBuilderEvent> createBuilderChangeListener() {
323 return event -> resetResult();
324 }
325
326
327
328
329
330
331
332
333 private ConfigurationBuilder<? extends Configuration> createConfigurationBuilder(final ConfigurationDeclaration decl) throws ConfigurationException {
334 final ConfigurationBuilderProvider provider = providerForTag(decl.getConfiguration().getRootElementName());
335 if (provider == null) {
336 throw new ConfigurationException("Unsupported configuration source: " + decl.getConfiguration().getRootElementName());
337 }
338
339 final ConfigurationBuilder<? extends Configuration> builder = provider.getConfigurationBuilder(decl);
340 if (decl.getName() != null) {
341 namedBuilders.put(decl.getName(), builder);
342 }
343 allBuilders.add(builder);
344 builder.addEventListener(ConfigurationBuilderEvent.RESET, changeListener);
345 return builder;
346 }
347
348
349
350
351
352
353
354
355
356 private List<? extends HierarchicalConfiguration<?>> fetchTopLevelOverrideConfigs(final HierarchicalConfiguration<?> config) {
357
358 final List<? extends HierarchicalConfiguration<?>> configs = config.childConfigurationsAt(null);
359 for (final Iterator<? extends HierarchicalConfiguration<?>> it = configs.iterator(); it.hasNext();) {
360 final String nodeName = it.next().getRootElementName();
361 for (final String element : CONFIG_SECTIONS) {
362 if (element.equals(nodeName)) {
363 it.remove();
364 break;
365 }
366 }
367 }
368 return configs;
369 }
370
371
372
373
374
375
376 public Collection<ConfigurationBuilder<? extends Configuration>> getChildBuilders() {
377 return allBuilders;
378 }
379
380
381
382
383
384
385
386
387 public ConfigurationBuilder<? extends Configuration> getNamedBuilder(final String name) {
388 return namedBuilders.get(name);
389 }
390
391
392
393
394
395
396 public List<ConfigurationDeclaration> getOverrideSources() {
397 return overrideDeclarations;
398 }
399
400
401
402
403
404
405 public List<ConfigurationDeclaration> getUnionSources() {
406 return unionDeclarations;
407 }
408
409
410
411
412
413
414
415 public void initFromDefinitionConfiguration(final HierarchicalConfiguration<?> config) throws ConfigurationException {
416 overrideDeclarations.addAll(createDeclarations(fetchTopLevelOverrideConfigs(config)));
417 overrideDeclarations.addAll(createDeclarations(config.childConfigurationsAt(KEY_OVERRIDE)));
418 unionDeclarations.addAll(createDeclarations(config.childConfigurationsAt(KEY_UNION)));
419 }
420 }
421
422
423
424
425
426
427 public static final String ADDITIONAL_NAME = CombinedConfigurationBuilder.class.getName() + "/ADDITIONAL_CONFIG";
428
429
430 static final String CONFIG_BEAN_FACTORY_NAME = CombinedConfigurationBuilder.class.getName() + ".CONFIG_BEAN_FACTORY_NAME";
431
432
433 static final String ATTR_NAME = DefaultExpressionEngineSymbols.DEFAULT_ATTRIBUTE_START + XMLBeanDeclaration.RESERVED_PREFIX + "name"
434 + DefaultExpressionEngineSymbols.DEFAULT_ATTRIBUTE_END;
435
436
437 static final String ATTR_ATNAME = "at";
438
439
440 static final String ATTR_AT_RES = DefaultExpressionEngineSymbols.DEFAULT_ATTRIBUTE_START + XMLBeanDeclaration.RESERVED_PREFIX + ATTR_ATNAME
441 + DefaultExpressionEngineSymbols.DEFAULT_ATTRIBUTE_END;
442
443
444 static final String ATTR_AT = DefaultExpressionEngineSymbols.DEFAULT_ATTRIBUTE_START + ATTR_ATNAME + DefaultExpressionEngineSymbols.DEFAULT_ATTRIBUTE_END;
445
446
447 static final String ATTR_OPTIONALNAME = "optional";
448
449
450 static final String ATTR_OPTIONAL_RES = DefaultExpressionEngineSymbols.DEFAULT_ATTRIBUTE_START + XMLBeanDeclaration.RESERVED_PREFIX + ATTR_OPTIONALNAME
451 + DefaultExpressionEngineSymbols.DEFAULT_ATTRIBUTE_END;
452
453
454 static final String ATTR_OPTIONAL = DefaultExpressionEngineSymbols.DEFAULT_ATTRIBUTE_START + ATTR_OPTIONALNAME
455 + DefaultExpressionEngineSymbols.DEFAULT_ATTRIBUTE_END;
456
457
458 static final String ATTR_FORCECREATE = DefaultExpressionEngineSymbols.DEFAULT_ATTRIBUTE_START + XMLBeanDeclaration.RESERVED_PREFIX + "forceCreate"
459 + DefaultExpressionEngineSymbols.DEFAULT_ATTRIBUTE_END;
460
461
462 static final String ATTR_RELOAD = DefaultExpressionEngineSymbols.DEFAULT_ATTRIBUTE_START + XMLBeanDeclaration.RESERVED_PREFIX + "reload"
463 + DefaultExpressionEngineSymbols.DEFAULT_ATTRIBUTE_END;
464
465
466
467
468 static final String KEY_SYSTEM_PROPS = "[@systemProperties]";
469
470
471 static final String SEC_HEADER = "header";
472
473
474 static final String KEY_UNION = "additional";
475
476
477 static final String[] CONFIG_SECTIONS = {"additional", "override", SEC_HEADER};
478
479
480
481
482 static final String KEY_OVERRIDE = "override";
483
484
485
486
487 static final String KEY_OVERRIDE_LIST = SEC_HEADER + ".combiner.override.list-nodes.node";
488
489
490
491
492 static final String KEY_ADDITIONAL_LIST = SEC_HEADER + ".combiner.additional.list-nodes.node";
493
494
495
496
497 static final String KEY_CONFIGURATION_PROVIDERS = SEC_HEADER + ".providers.provider";
498
499
500
501
502 static final String KEY_PROVIDER_KEY = XMLBeanDeclaration.ATTR_PREFIX + "tag]";
503
504
505
506
507 static final String KEY_CONFIGURATION_LOOKUPS = SEC_HEADER + ".lookups.lookup";
508
509
510
511
512 static final String KEY_ENTITY_RESOLVER = SEC_HEADER + ".entity-resolver";
513
514
515
516
517 static final String KEY_LOOKUP_KEY = XMLBeanDeclaration.ATTR_PREFIX + "prefix]";
518
519
520
521
522 static final String FILE_SYSTEM = SEC_HEADER + ".fileSystem";
523
524
525
526
527
528 static final String KEY_RESULT = SEC_HEADER + ".result";
529
530
531 static final String KEY_COMBINER = KEY_RESULT + ".nodeCombiner";
532
533
534 static final String EXT_XML = "xml";
535
536
537 private static final String BASIC_BUILDER = "org.apache.commons.configuration2.builder.BasicConfigurationBuilder";
538
539
540 private static final String FILE_BUILDER = "org.apache.commons.configuration2.builder.FileBasedConfigurationBuilder";
541
542
543 private static final String RELOADING_BUILDER = "org.apache.commons.configuration2.builder.ReloadingFileBasedConfigurationBuilder";
544
545
546 private static final String FILE_PARAMS = "org.apache.commons.configuration2.builder.FileBasedBuilderParametersImpl";
547
548
549 private static final ConfigurationBuilderProvider PROPERTIES_PROVIDER = new FileExtensionConfigurationBuilderProvider(FILE_BUILDER, RELOADING_BUILDER,
550 "org.apache.commons.configuration2.XMLPropertiesConfiguration", "org.apache.commons.configuration2.PropertiesConfiguration", EXT_XML,
551 Collections.singletonList(FILE_PARAMS));
552
553
554 private static final ConfigurationBuilderProvider XML_PROVIDER = new BaseConfigurationBuilderProvider(FILE_BUILDER, RELOADING_BUILDER,
555 "org.apache.commons.configuration2.XMLConfiguration", Collections.singletonList("org.apache.commons.configuration2.builder.XMLBuilderParametersImpl"));
556
557
558 private static final BaseConfigurationBuilderProvider JNDI_PROVIDER = new BaseConfigurationBuilderProvider(BASIC_BUILDER, null,
559 "org.apache.commons.configuration2.JNDIConfiguration",
560 Collections.singletonList("org.apache.commons.configuration2.builder.JndiBuilderParametersImpl"));
561
562
563 private static final BaseConfigurationBuilderProvider SYSTEM_PROVIDER = new BaseConfigurationBuilderProvider(BASIC_BUILDER, null,
564 "org.apache.commons.configuration2.SystemConfiguration", Collections.singletonList("org.apache.commons.configuration2.builder.BasicBuilderParameters"));
565
566
567 private static final BaseConfigurationBuilderProvider INI_PROVIDER = new BaseConfigurationBuilderProvider(FILE_BUILDER, RELOADING_BUILDER,
568 "org.apache.commons.configuration2.INIConfiguration", Collections.singletonList(FILE_PARAMS));
569
570
571 private static final BaseConfigurationBuilderProvider ENV_PROVIDER = new BaseConfigurationBuilderProvider(BASIC_BUILDER, null,
572 "org.apache.commons.configuration2.EnvironmentConfiguration",
573 Collections.singletonList("org.apache.commons.configuration2.builder.BasicBuilderParameters"));
574
575
576 private static final BaseConfigurationBuilderProvider PLIST_PROVIDER = new FileExtensionConfigurationBuilderProvider(FILE_BUILDER, RELOADING_BUILDER,
577 "org.apache.commons.configuration2.plist.XMLPropertyListConfiguration", "org.apache.commons.configuration2.plist.PropertyListConfiguration", EXT_XML,
578 Collections.singletonList(FILE_PARAMS));
579
580
581 private static final BaseConfigurationBuilderProvider COMBINED_PROVIDER = new CombinedConfigurationBuilderProvider();
582
583
584 private static final MultiFileConfigurationBuilderProvider MULTI_XML_PROVIDER = new MultiFileConfigurationBuilderProvider(
585 "org.apache.commons.configuration2.XMLConfiguration", "org.apache.commons.configuration2.builder.XMLBuilderParametersImpl");
586
587
588 private static final String[] DEFAULT_TAGS = {"properties", "xml", "hierarchicalXml", "plist", "ini", "system", "env", "jndi", "configuration",
589 "multiFile"};
590
591
592 private static final ConfigurationBuilderProvider[] DEFAULT_PROVIDERS = {PROPERTIES_PROVIDER, XML_PROVIDER, XML_PROVIDER, PLIST_PROVIDER, INI_PROVIDER,
593 SYSTEM_PROVIDER, ENV_PROVIDER, JNDI_PROVIDER, COMBINED_PROVIDER, MULTI_XML_PROVIDER};
594
595
596 private static final Map<String, ConfigurationBuilderProvider> DEFAULT_PROVIDERS_MAP;
597
598 static {
599 DEFAULT_PROVIDERS_MAP = createDefaultProviders();
600 }
601
602
603
604
605
606
607 private static Map<String, ConfigurationBuilderProvider> createDefaultProviders() {
608 final Map<String, ConfigurationBuilderProvider> providers = new HashMap<>();
609 for (int i = 0; i < DEFAULT_TAGS.length; i++) {
610 providers.put(DEFAULT_TAGS[i], DEFAULT_PROVIDERS[i]);
611 }
612 return providers;
613 }
614
615
616
617
618
619
620
621
622
623 private static void initNodeCombinerListNodes(final CombinedConfiguration cc, final HierarchicalConfiguration<?> defConfig, final String key) {
624 defConfig.getList(key).forEach(listNode -> cc.getNodeCombiner().addListNode((String) listNode));
625 }
626
627
628 private ConfigurationBuilder<? extends HierarchicalConfiguration<?>> definitionBuilder;
629
630
631 private HierarchicalConfiguration<?> definitionConfiguration;
632
633
634 private ConfigurationSourceData sourceData;
635
636
637 private CombinedBuilderParametersImpl currentParameters;
638
639
640 private XMLBuilderParametersImpl currentXMLParameters;
641
642
643 private CombinedConfiguration currentConfiguration;
644
645
646
647
648
649 private ConfigurationInterpolator parentInterpolator;
650
651
652
653
654 public CombinedConfigurationBuilder() {
655 super(CombinedConfiguration.class);
656 }
657
658
659
660
661
662
663
664 public CombinedConfigurationBuilder(final Map<String, Object> params) {
665 super(CombinedConfiguration.class, params);
666 }
667
668
669
670
671
672
673
674
675
676 public CombinedConfigurationBuilder(final Map<String, Object> params, final boolean allowFailOnInit) {
677 super(CombinedConfiguration.class, params, allowFailOnInit);
678 }
679
680
681
682
683
684
685
686
687 private void addDefinitionBuilderChangeListener(final ConfigurationBuilder<? extends HierarchicalConfiguration<?>> defBuilder) {
688 defBuilder.addEventListener(ConfigurationBuilderEvent.RESET, event -> {
689 synchronized (this) {
690 reset();
691 definitionBuilder = defBuilder;
692 }
693 });
694 }
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710 public synchronized Set<String> builderNames() {
711 if (sourceData == null) {
712 return Collections.emptySet();
713 }
714 return Collections.unmodifiableSet(sourceData.builderNames());
715 }
716
717
718
719
720 @Override
721 public CombinedConfigurationBuilder configure(final BuilderParameters... params) {
722 super.configure(params);
723 return this;
724 }
725
726
727
728
729
730
731
732
733
734 protected void configureEntityResolver(final HierarchicalConfiguration<?> config, final XMLBuilderParametersImpl xmlParams) throws ConfigurationException {
735 if (config.getMaxIndex(KEY_ENTITY_RESOLVER) == 0) {
736 final XMLBeanDeclaration decl = new XMLBeanDeclaration(config, KEY_ENTITY_RESOLVER, true);
737 final EntityResolver resolver = (EntityResolver) fetchBeanHelper().createBean(decl, CatalogResolver.class);
738 final FileSystem fileSystem = xmlParams.getFileHandler().getFileSystem();
739 if (fileSystem != null) {
740 BeanHelper.setProperty(resolver, "fileSystem", fileSystem);
741 }
742 final String basePath = xmlParams.getFileHandler().getBasePath();
743 if (basePath != null) {
744 BeanHelper.setProperty(resolver, "baseDir", basePath);
745 }
746 final ConfigurationInterpolator ci = new ConfigurationInterpolator();
747 ci.registerLookups(fetchPrefixLookups());
748 BeanHelper.setProperty(resolver, "interpolator", ci);
749
750 xmlParams.setEntityResolver(resolver);
751 }
752 }
753
754
755
756
757
758
759
760
761
762
763 protected CombinedConfiguration createAdditionalsConfiguration(final CombinedConfiguration resultConfig) {
764 final CombinedConfiguration addConfig = new CombinedConfiguration(new UnionCombiner());
765 addConfig.setListDelimiterHandler(resultConfig.getListDelimiterHandler());
766 return addConfig;
767 }
768
769
770
771
772
773
774
775 private Collection<ConfigurationDeclaration> createDeclarations(final Collection<? extends HierarchicalConfiguration<?>> configs) {
776 return configs.stream().map(c -> new ConfigurationDeclaration(this, c)).collect(Collectors.toList());
777 }
778
779
780
781
782
783
784 @Override
785 protected BeanDeclaration createResultDeclaration(final Map<String, Object> params) throws ConfigurationException {
786 final BeanDeclaration paramsDecl = super.createResultDeclaration(params);
787 final XMLBeanDeclaration resultDecl = new XMLBeanDeclaration(getDefinitionConfiguration(), KEY_RESULT, true, CombinedConfiguration.class.getName());
788 return new CombinedBeanDeclaration(resultDecl, paramsDecl);
789 }
790
791
792
793
794
795
796
797 private ConfigurationSourceData createSourceData() throws ConfigurationException {
798 final ConfigurationSourceData result = new ConfigurationSourceData();
799 result.initFromDefinitionConfiguration(getDefinitionConfiguration());
800 return result;
801 }
802
803
804
805
806
807
808
809
810
811
812 protected ConfigurationBuilder<? extends HierarchicalConfiguration<?>> createXMLDefinitionBuilder(final BuilderParameters builderParams) {
813 return new FileBasedConfigurationBuilder<>(XMLConfiguration.class).configure(builderParams);
814 }
815
816
817
818
819
820
821
822 private Map<String, ? extends Lookup> fetchPrefixLookups() {
823 final CombinedConfiguration cc = getConfigurationUnderConstruction();
824 return cc != null ? cc.getInterpolator().getLookups() : null;
825 }
826
827
828
829
830
831
832
833 private String getBasePath() {
834 return currentXMLParameters.getFileHandler().getBasePath();
835 }
836
837
838
839
840
841
842
843
844 protected synchronized Collection<ConfigurationBuilder<? extends Configuration>> getChildBuilders() {
845 return sourceData.getChildBuilders();
846 }
847
848
849
850
851
852
853
854
855 CombinedConfiguration getConfigurationUnderConstruction() {
856 return currentConfiguration;
857 }
858
859
860
861
862
863
864
865 public synchronized ConfigurationBuilder<? extends HierarchicalConfiguration<?>> getDefinitionBuilder() throws ConfigurationException {
866 if (definitionBuilder == null) {
867 definitionBuilder = setupDefinitionBuilder(getParameters());
868 addDefinitionBuilderChangeListener(definitionBuilder);
869 }
870 return definitionBuilder;
871 }
872
873
874
875
876
877
878
879
880
881
882
883 protected HierarchicalConfiguration<?> getDefinitionConfiguration() throws ConfigurationException {
884 if (definitionConfiguration == null) {
885 definitionConfiguration = getDefinitionBuilder().getConfiguration();
886 }
887 return definitionConfiguration;
888 }
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905 public synchronized ConfigurationBuilder<? extends Configuration> getNamedBuilder(final String name) throws ConfigurationException {
906 if (sourceData == null) {
907 throw new ConfigurationException("Information about child builders" + " has not been setup yet! Call getConfiguration() first.");
908 }
909 final ConfigurationBuilder<? extends Configuration> builder = sourceData.getNamedBuilder(name);
910 if (builder == null) {
911 throw new ConfigurationException("Builder cannot be resolved: " + name);
912 }
913 return builder;
914 }
915
916
917
918
919
920
921
922
923 private ConfigurationSourceData getSourceData() throws ConfigurationException {
924 if (sourceData == null) {
925 if (currentParameters == null) {
926 setUpCurrentParameters();
927 setUpCurrentXMLParameters();
928 }
929 sourceData = createSourceData();
930 }
931 return sourceData;
932 }
933
934
935
936
937
938
939
940
941 void initBean(final Object bean, final BeanDeclaration decl) {
942 fetchBeanHelper().initBean(bean, decl);
943 }
944
945
946
947
948
949
950
951
952 private void initChildBasicParameters(final BasicBuilderParameters params) {
953 params.setPrefixLookups(fetchPrefixLookups());
954 params.setParentInterpolator(parentInterpolator);
955 if (currentParameters.isInheritSettings()) {
956 params.inheritFrom(getParameters());
957 }
958 }
959
960
961
962
963
964
965
966
967
968 protected void initChildBuilderParameters(final BuilderParameters params) {
969 initDefaultChildParameters(params);
970
971 if (params instanceof BasicBuilderParameters) {
972 initChildBasicParameters((BasicBuilderParameters) params);
973 }
974 if (params instanceof XMLBuilderProperties<?>) {
975 initChildXMLParameters((XMLBuilderProperties<?>) params);
976 }
977 if (params instanceof FileBasedBuilderProperties<?>) {
978 initChildFileBasedParameters((FileBasedBuilderProperties<?>) params);
979 }
980 if (params instanceof CombinedBuilderParametersImpl) {
981 initChildCombinedParameters((CombinedBuilderParametersImpl) params);
982 }
983 }
984
985
986
987
988
989
990
991
992 private void initChildCombinedParameters(final CombinedBuilderParametersImpl params) {
993 params.registerMissingProviders(currentParameters);
994 params.setBasePath(getBasePath());
995 }
996
997
998
999
1000
1001
1002
1003 void initChildEventListeners(final BasicConfigurationBuilder<? extends Configuration> dest) {
1004 copyEventListeners(dest);
1005 }
1006
1007
1008
1009
1010
1011
1012
1013 private void initChildFileBasedParameters(final FileBasedBuilderProperties<?> params) {
1014 params.setBasePath(getBasePath());
1015 params.setFileSystem(currentXMLParameters.getFileHandler().getFileSystem());
1016 }
1017
1018
1019
1020
1021
1022
1023 private void initChildXMLParameters(final XMLBuilderProperties<?> params) {
1024 params.setEntityResolver(currentXMLParameters.getEntityResolver());
1025 }
1026
1027
1028
1029
1030
1031
1032
1033
1034 private void initDefaultBasePath() throws ConfigurationException {
1035 assert currentParameters != null : "Current parameters undefined!";
1036 if (currentParameters.getBasePath() != null) {
1037 currentXMLParameters.setBasePath(currentParameters.getBasePath());
1038 } else {
1039 final ConfigurationBuilder<? extends HierarchicalConfiguration<?>> defBuilder = getDefinitionBuilder();
1040 if (defBuilder instanceof FileBasedConfigurationBuilder) {
1041 @SuppressWarnings("rawtypes")
1042 final FileBasedConfigurationBuilder fileBuilder = (FileBasedConfigurationBuilder) defBuilder;
1043 final URL url = fileBuilder.getFileHandler().getURL();
1044 currentXMLParameters.setBasePath(url != null ? url.toExternalForm() : fileBuilder.getFileHandler().getBasePath());
1045 }
1046 }
1047 }
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059 private void initDefaultChildParameters(final BuilderParameters params) {
1060 currentParameters.getChildDefaultParametersManager().initializeParameters(params);
1061 }
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072 protected FileSystem initFileSystem(final HierarchicalConfiguration<?> config) throws ConfigurationException {
1073 if (config.getMaxIndex(FILE_SYSTEM) == 0) {
1074 final XMLBeanDeclaration decl = new XMLBeanDeclaration(config, FILE_SYSTEM);
1075 return (FileSystem) fetchBeanHelper().createBean(decl);
1076 }
1077 return null;
1078 }
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088 @Override
1089 protected void initResultInstance(final CombinedConfiguration result) throws ConfigurationException {
1090 super.initResultInstance(result);
1091
1092 currentConfiguration = result;
1093 final HierarchicalConfiguration<?> config = getDefinitionConfiguration();
1094 if (config.getMaxIndex(KEY_COMBINER) < 0) {
1095
1096 result.setNodeCombiner(new OverrideCombiner());
1097 }
1098
1099 setUpCurrentParameters();
1100 initNodeCombinerListNodes(result, config, KEY_OVERRIDE_LIST);
1101 registerConfiguredProviders(config);
1102 setUpCurrentXMLParameters();
1103 currentXMLParameters.setFileSystem(initFileSystem(config));
1104 initSystemProperties(config, getBasePath());
1105 registerConfiguredLookups(config, result);
1106 configureEntityResolver(config, currentXMLParameters);
1107 setUpParentInterpolator(currentConfiguration, config);
1108
1109 final ConfigurationSourceData data = getSourceData();
1110 final boolean createBuilders = data.getChildBuilders().isEmpty();
1111 final List<ConfigurationBuilder<? extends Configuration>> overrideBuilders = data.createAndAddConfigurations(result, data.getOverrideSources(),
1112 data.overrideBuilders);
1113 if (createBuilders) {
1114 data.overrideBuilders.addAll(overrideBuilders);
1115 }
1116 if (!data.getUnionSources().isEmpty()) {
1117 final CombinedConfiguration addConfig = createAdditionalsConfiguration(result);
1118 result.addConfiguration(addConfig, ADDITIONAL_NAME);
1119 initNodeCombinerListNodes(addConfig, config, KEY_ADDITIONAL_LIST);
1120 final List<ConfigurationBuilder<? extends Configuration>> unionBuilders = data.createAndAddConfigurations(addConfig, data.unionDeclarations,
1121 data.unionBuilders);
1122 if (createBuilders) {
1123 data.unionBuilders.addAll(unionBuilders);
1124 }
1125 }
1126
1127 result.isEmpty();
1128 currentConfiguration = null;
1129 }
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139 protected void initSystemProperties(final HierarchicalConfiguration<?> config, final String basePath) throws ConfigurationException {
1140 final String fileName = config.getString(KEY_SYSTEM_PROPS);
1141 if (fileName != null) {
1142 try {
1143 SystemConfiguration.setSystemProperties(basePath, fileName);
1144 } catch (final Exception ex) {
1145 throw new ConfigurationException("Error setting system properties from " + fileName, ex);
1146 }
1147 }
1148 }
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158 protected ConfigurationBuilderProvider providerForTag(final String tagName) {
1159 return currentParameters.providerForTag(tagName);
1160 }
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171 protected void registerConfiguredLookups(final HierarchicalConfiguration<?> defConfig, final Configuration resultConfig) throws ConfigurationException {
1172 final Map<String, Lookup> lookups = defConfig.configurationsAt(KEY_CONFIGURATION_LOOKUPS).stream().collect(
1173 Collectors.toMap(config -> config.getString(KEY_LOOKUP_KEY), config -> (Lookup) fetchBeanHelper().createBean(new XMLBeanDeclaration(config))));
1174
1175 if (!lookups.isEmpty()) {
1176 final ConfigurationInterpolator defCI = defConfig.getInterpolator();
1177 if (defCI != null) {
1178 defCI.registerLookups(lookups);
1179 }
1180 resultConfig.getInterpolator().registerLookups(lookups);
1181 }
1182 }
1183
1184
1185
1186
1187
1188
1189 private void registerConfiguredProviders(final HierarchicalConfiguration<?> defConfig) {
1190 defConfig.configurationsAt(KEY_CONFIGURATION_PROVIDERS).forEach(config -> {
1191 final XMLBeanDeclaration decl = new XMLBeanDeclaration(config);
1192 final String key = config.getString(KEY_PROVIDER_KEY);
1193 currentParameters.registerProvider(key, (ConfigurationBuilderProvider) fetchBeanHelper().createBean(decl));
1194 });
1195 }
1196
1197
1198
1199
1200 @Override
1201 public synchronized void resetParameters() {
1202 super.resetParameters();
1203 definitionBuilder = null;
1204 definitionConfiguration = null;
1205 currentParameters = null;
1206 currentXMLParameters = null;
1207
1208 if (sourceData != null) {
1209 sourceData.cleanUp();
1210 sourceData = null;
1211 }
1212 }
1213
1214
1215
1216
1217
1218 private void setUpCurrentParameters() {
1219 currentParameters = CombinedBuilderParametersImpl.fromParameters(getParameters(), true);
1220 currentParameters.registerMissingProviders(DEFAULT_PROVIDERS_MAP);
1221 }
1222
1223
1224
1225
1226
1227
1228
1229
1230 private void setUpCurrentXMLParameters() throws ConfigurationException {
1231 currentXMLParameters = new XMLBuilderParametersImpl();
1232 initDefaultBasePath();
1233 }
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247 protected ConfigurationBuilder<? extends HierarchicalConfiguration<?>> setupDefinitionBuilder(final Map<String, Object> params)
1248 throws ConfigurationException {
1249 final CombinedBuilderParametersImpl cbParams = CombinedBuilderParametersImpl.fromParameters(params);
1250 if (cbParams != null) {
1251 final ConfigurationBuilder<? extends HierarchicalConfiguration<?>> defBuilder = cbParams.getDefinitionBuilder();
1252 if (defBuilder != null) {
1253 return defBuilder;
1254 }
1255
1256 if (cbParams.getDefinitionBuilderParameters() != null) {
1257 return createXMLDefinitionBuilder(cbParams.getDefinitionBuilderParameters());
1258 }
1259 }
1260
1261 final BuilderParameters fileParams = FileBasedBuilderParametersImpl.fromParameters(params);
1262 if (fileParams != null) {
1263 return createXMLDefinitionBuilder(fileParams);
1264 }
1265
1266 throw new ConfigurationException("No builder for configuration definition specified!");
1267 }
1268
1269
1270
1271
1272
1273
1274
1275
1276 private void setUpParentInterpolator(final Configuration resultConfig, final Configuration defConfig) {
1277 parentInterpolator = new ConfigurationInterpolator();
1278 parentInterpolator.addDefaultLookup(new ConfigurationLookup(resultConfig));
1279 final ConfigurationInterpolator defInterpolator = defConfig.getInterpolator();
1280 if (defInterpolator != null) {
1281 defInterpolator.setParentInterpolator(parentInterpolator);
1282 }
1283 }
1284 }