Class | Line # | Actions | |||||
---|---|---|---|---|---|---|---|
AllConfigurationSource | 47 | 3 | 0% | 1 | 0 |
1 | /* | |
2 | * See the NOTICE file distributed with this work for additional | |
3 | * information regarding copyright ownership. | |
4 | * | |
5 | * This is free software; you can redistribute it and/or modify it | |
6 | * under the terms of the GNU Lesser General Public License as | |
7 | * published by the Free Software Foundation; either version 2.1 of | |
8 | * the License, or (at your option) any later version. | |
9 | * | |
10 | * This software is distributed in the hope that it will be useful, | |
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
13 | * Lesser General Public License for more details. | |
14 | * | |
15 | * You should have received a copy of the GNU Lesser General Public | |
16 | * License along with this software; if not, write to the Free | |
17 | * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA | |
18 | * 02110-1301 USA, or see the FSF site: http://www.fsf.org. | |
19 | */ | |
20 | package org.xwiki.configuration.internal; | |
21 | ||
22 | import javax.inject.Inject; | |
23 | import javax.inject.Named; | |
24 | import javax.inject.Singleton; | |
25 | ||
26 | import org.xwiki.component.annotation.Component; | |
27 | import org.xwiki.component.phase.Initializable; | |
28 | import org.xwiki.component.phase.InitializationException; | |
29 | import org.xwiki.configuration.ConfigurationSource; | |
30 | ||
31 | /** | |
32 | * Composite Configuration Source that looks in the following sources in that order: | |
33 | * <ul> | |
34 | * <li>user preferences wiki page</li> | |
35 | * <li>space preferences wiki page</li> | |
36 | * <li>wiki preferences wiki page</li> | |
37 | * <li>xwiki properties file (xwiki.properties)</li> | |
38 | * </ul> | |
39 | * Should be used when a configuration can be overridden by the user in his/her profile. | |
40 | * | |
41 | * @version $Id: 45be1733f18071be3440f6be8fd1aff59ec5b632 $ | |
42 | * @since 2.0M2 | |
43 | */ | |
44 | @Component | |
45 | @Named("all") | |
46 | @Singleton | |
47 | public class AllConfigurationSource extends CompositeConfigurationSource implements Initializable | |
48 | { | |
49 | @Inject | |
50 | @Named("xwikiproperties") | |
51 | private ConfigurationSource xwikiPropertiesSource; | |
52 | ||
53 | @Inject | |
54 | @Named("documents") | |
55 | private ConfigurationSource documentsPreferencesSource; | |
56 | ||
57 | @Inject | |
58 | @Named("user") | |
59 | private ConfigurationSource userPreferencesSource; | |
60 | ||
61 | 60 | @Override |
62 | public void initialize() throws InitializationException | |
63 | { | |
64 | // First source is searched first when a property value is requested. | |
65 | 60 | addConfigurationSource(this.userPreferencesSource); |
66 | 60 | addConfigurationSource(this.documentsPreferencesSource); |
67 | 60 | addConfigurationSource(this.xwikiPropertiesSource); |
68 | } | |
69 | } |