├── .gitignore ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── git-bind ├── src │ └── main │ │ ├── java │ │ └── org │ │ │ └── cfg4j │ │ │ └── sample │ │ │ ├── ReksioConfig.java │ │ │ ├── MainController.java │ │ │ └── ConfigBeans.java │ │ └── resources │ │ └── application.properties ├── build.gradle └── README.md ├── metrics ├── src │ └── main │ │ └── java │ │ └── org │ │ └── cfg4j │ │ └── sample │ │ ├── ReksioConfig.java │ │ ├── MonitoringBeans.java │ │ ├── MainController.java │ │ └── ConfigBeans.java ├── application.yaml ├── build.gradle └── README.md ├── consul-bind ├── src │ └── main │ │ ├── java │ │ └── org │ │ │ └── cfg4j │ │ │ └── sample │ │ │ ├── ReksioConfig.java │ │ │ ├── ConfigBeans.java │ │ │ └── MainController.java │ │ └── resources │ │ └── application.properties ├── build.gradle └── README.md ├── files-bind ├── src │ └── main │ │ └── java │ │ └── org │ │ └── cfg4j │ │ └── sample │ │ ├── ReksioConfig.java │ │ ├── MainController.java │ │ └── ConfigBeans.java ├── otherConfig.properties ├── application.yaml ├── build.gradle └── README.md ├── classpath-bind ├── src │ └── main │ │ ├── java │ │ └── org │ │ │ └── cfg4j │ │ │ └── sample │ │ │ ├── ReksioConfig.java │ │ │ ├── ConfigBeans.java │ │ │ └── MainController.java │ │ └── resources │ │ ├── otherConfig.properties │ │ └── application.yaml ├── README.md └── build.gradle ├── git-multi-file ├── src │ └── main │ │ ├── java │ │ └── org │ │ │ └── cfg4j │ │ │ └── sample │ │ │ ├── ReksioConfig.java │ │ │ ├── MainController.java │ │ │ └── ConfigBeans.java │ │ └── resources │ │ └── application.properties ├── build.gradle └── README.md ├── git-simple ├── src │ └── main │ │ ├── resources │ │ └── application.properties │ │ └── java │ │ └── org │ │ └── cfg4j │ │ └── sample │ │ ├── MainController.java │ │ └── ConfigBeans.java ├── build.gradle └── README.md ├── settings.gradle ├── README.md ├── gradlew.bat ├── gradlew └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | .idea/ 2 | .gradle/ 3 | build/ 4 | *.iml 5 | *.log.* 6 | gradle.properties -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/cfg4j/cfg4j-sample-apps/HEAD/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /git-bind/src/main/java/org/cfg4j/sample/ReksioConfig.java: -------------------------------------------------------------------------------- 1 | package org.cfg4j.sample; 2 | 3 | import java.net.URL; 4 | import java.util.List; 5 | import java.util.Map; 6 | 7 | public interface ReksioConfig { 8 | 9 | Boolean awake(); 10 | 11 | String bornIn(); 12 | 13 | Integer birthYear(); 14 | 15 | List friends(); 16 | 17 | URL homepage(); 18 | 19 | Map grades(); 20 | 21 | } 22 | -------------------------------------------------------------------------------- /metrics/src/main/java/org/cfg4j/sample/ReksioConfig.java: -------------------------------------------------------------------------------- 1 | package org.cfg4j.sample; 2 | 3 | import java.net.URL; 4 | import java.util.List; 5 | import java.util.Map; 6 | 7 | public interface ReksioConfig { 8 | 9 | Boolean awake(); 10 | 11 | String bornIn(); 12 | 13 | Integer birthYear(); 14 | 15 | List friends(); 16 | 17 | URL homepage(); 18 | 19 | Map grades(); 20 | 21 | } 22 | -------------------------------------------------------------------------------- /consul-bind/src/main/java/org/cfg4j/sample/ReksioConfig.java: -------------------------------------------------------------------------------- 1 | package org.cfg4j.sample; 2 | 3 | import java.net.URL; 4 | import java.util.List; 5 | import java.util.Map; 6 | 7 | public interface ReksioConfig { 8 | 9 | Boolean awake(); 10 | 11 | String bornIn(); 12 | 13 | Integer birthYear(); 14 | 15 | List friends(); 16 | 17 | URL homepage(); 18 | 19 | Map grades(); 20 | 21 | } 22 | -------------------------------------------------------------------------------- /files-bind/src/main/java/org/cfg4j/sample/ReksioConfig.java: -------------------------------------------------------------------------------- 1 | package org.cfg4j.sample; 2 | 3 | import java.net.URL; 4 | import java.util.List; 5 | import java.util.Map; 6 | 7 | public interface ReksioConfig { 8 | 9 | Boolean awake(); 10 | 11 | String bornIn(); 12 | 13 | Integer birthYear(); 14 | 15 | List friends(); 16 | 17 | URL homepage(); 18 | 19 | Map grades(); 20 | 21 | } 22 | -------------------------------------------------------------------------------- /classpath-bind/src/main/java/org/cfg4j/sample/ReksioConfig.java: -------------------------------------------------------------------------------- 1 | package org.cfg4j.sample; 2 | 3 | import java.net.URL; 4 | import java.util.List; 5 | import java.util.Map; 6 | 7 | public interface ReksioConfig { 8 | 9 | Boolean awake(); 10 | 11 | String bornIn(); 12 | 13 | Integer birthYear(); 14 | 15 | List friends(); 16 | 17 | URL homepage(); 18 | 19 | Map grades(); 20 | 21 | } 22 | -------------------------------------------------------------------------------- /git-multi-file/src/main/java/org/cfg4j/sample/ReksioConfig.java: -------------------------------------------------------------------------------- 1 | package org.cfg4j.sample; 2 | 3 | import java.net.URL; 4 | import java.util.List; 5 | import java.util.Map; 6 | 7 | public interface ReksioConfig { 8 | 9 | Boolean awake(); 10 | 11 | String bornIn(); 12 | 13 | Integer birthYear(); 14 | 15 | List friends(); 16 | 17 | URL homepage(); 18 | 19 | Map grades(); 20 | 21 | } 22 | -------------------------------------------------------------------------------- /consul-bind/src/main/resources/application.properties: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright 2015 Norbert Potocki (norbert.potocki@nort.pl) 3 | # 4 | # Licensed under the Apache License, Version 2.0 (the "License"); 5 | # you may not use this file except in compliance with the License. 6 | # You may obtain a copy of the License at 7 | # 8 | # http://www.apache.org/licenses/LICENSE-2.0 9 | # 10 | # Unless required by applicable law or agreed to in writing, software 11 | # distributed under the License is distributed on an "AS IS" BASIS, 12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | # See the License for the specific language governing permissions and 14 | # limitations under the License. 15 | # 16 | spring.main.show_banner=false -------------------------------------------------------------------------------- /files-bind/otherConfig.properties: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright 2015 Norbert Potocki (norbert.potocki@nort.pl) 3 | # 4 | # Licensed under the Apache License, Version 2.0 (the "License"); 5 | # you may not use this file except in compliance with the License. 6 | # You may obtain a copy of the License at 7 | # 8 | # http://www.apache.org/licenses/LICENSE-2.0 9 | # 10 | # Unless required by applicable law or agreed to in writing, software 11 | # distributed under the License is distributed on an "AS IS" BASIS, 12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | # See the License for the specific language governing permissions and 14 | # limitations under the License. 15 | # 16 | yet.another.setting=guess,what,this,is,a,list -------------------------------------------------------------------------------- /git-bind/src/main/resources/application.properties: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright 2015 Norbert Potocki (norbert.potocki@nort.pl) 3 | # 4 | # Licensed under the Apache License, Version 2.0 (the "License"); 5 | # you may not use this file except in compliance with the License. 6 | # You may obtain a copy of the License at 7 | # 8 | # http://www.apache.org/licenses/LICENSE-2.0 9 | # 10 | # Unless required by applicable law or agreed to in writing, software 11 | # distributed under the License is distributed on an "AS IS" BASIS, 12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | # See the License for the specific language governing permissions and 14 | # limitations under the License. 15 | # 16 | spring.main.show_banner=false -------------------------------------------------------------------------------- /git-simple/src/main/resources/application.properties: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright 2015 Norbert Potocki (norbert.potocki@nort.pl) 3 | # 4 | # Licensed under the Apache License, Version 2.0 (the "License"); 5 | # you may not use this file except in compliance with the License. 6 | # You may obtain a copy of the License at 7 | # 8 | # http://www.apache.org/licenses/LICENSE-2.0 9 | # 10 | # Unless required by applicable law or agreed to in writing, software 11 | # distributed under the License is distributed on an "AS IS" BASIS, 12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | # See the License for the specific language governing permissions and 14 | # limitations under the License. 15 | # 16 | spring.main.show_banner=false -------------------------------------------------------------------------------- /git-multi-file/src/main/resources/application.properties: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright 2015 Norbert Potocki (norbert.potocki@nort.pl) 3 | # 4 | # Licensed under the Apache License, Version 2.0 (the "License"); 5 | # you may not use this file except in compliance with the License. 6 | # You may obtain a copy of the License at 7 | # 8 | # http://www.apache.org/licenses/LICENSE-2.0 9 | # 10 | # Unless required by applicable law or agreed to in writing, software 11 | # distributed under the License is distributed on an "AS IS" BASIS, 12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | # See the License for the specific language governing permissions and 14 | # limitations under the License. 15 | # 16 | spring.main.show_banner=false -------------------------------------------------------------------------------- /classpath-bind/src/main/resources/otherConfig.properties: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright 2015 Norbert Potocki (norbert.potocki@nort.pl) 3 | # 4 | # Licensed under the Apache License, Version 2.0 (the "License"); 5 | # you may not use this file except in compliance with the License. 6 | # You may obtain a copy of the License at 7 | # 8 | # http://www.apache.org/licenses/LICENSE-2.0 9 | # 10 | # Unless required by applicable law or agreed to in writing, software 11 | # distributed under the License is distributed on an "AS IS" BASIS, 12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | # See the License for the specific language governing permissions and 14 | # limitations under the License. 15 | # 16 | yet.another.setting=guess,what,this,is,a,list -------------------------------------------------------------------------------- /metrics/src/main/java/org/cfg4j/sample/MonitoringBeans.java: -------------------------------------------------------------------------------- 1 | package org.cfg4j.sample; 2 | 3 | import com.codahale.metrics.JmxReporter; 4 | import com.codahale.metrics.MetricRegistry; 5 | import com.ryantenney.metrics.spring.config.annotation.MetricsConfigurerAdapter; 6 | import org.springframework.context.annotation.Configuration; 7 | 8 | import java.util.concurrent.TimeUnit; 9 | 10 | @Configuration 11 | public class MonitoringBeans extends MetricsConfigurerAdapter { 12 | 13 | @Override 14 | public void configureReporters(MetricRegistry metricRegistry) { 15 | JmxReporter.forRegistry(metricRegistry) 16 | .convertRatesTo(TimeUnit.SECONDS) 17 | .convertDurationsTo(TimeUnit.MILLISECONDS) 18 | .build() 19 | .start(); 20 | } 21 | } 22 | -------------------------------------------------------------------------------- /settings.gradle: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2015 Norbert Potocki (norbert.potocki@nort.pl) 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | include 'classpath-bind', 'consul-bind', 'files-bind', 'git-bind', 'git-simple', 'git-multi-file', 'metrics' -------------------------------------------------------------------------------- /metrics/application.yaml: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright 2015 Norbert Potocki (norbert.potocki@nort.pl) 3 | # 4 | # Licensed under the Apache License, Version 2.0 (the "License"); 5 | # you may not use this file except in compliance with the License. 6 | # You may obtain a copy of the License at 7 | # 8 | # http://www.apache.org/licenses/LICENSE-2.0 9 | # 10 | # Unless required by applicable law or agreed to in writing, software 11 | # distributed under the License is distributed on an "AS IS" BASIS, 12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | # See the License for the specific language governing permissions and 14 | # limitations under the License. 15 | # 16 | reksio: 17 | awake: true 18 | bornIn: Poland 19 | birthYear: 1967 20 | friends: 21 | - Bolek 22 | - Lolek 23 | 24 | homepage: https://en.wikipedia.org/wiki/Reksio 25 | grades: Math=A,PE=A,Polish=A -------------------------------------------------------------------------------- /files-bind/application.yaml: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright 2015 Norbert Potocki (norbert.potocki@nort.pl) 3 | # 4 | # Licensed under the Apache License, Version 2.0 (the "License"); 5 | # you may not use this file except in compliance with the License. 6 | # You may obtain a copy of the License at 7 | # 8 | # http://www.apache.org/licenses/LICENSE-2.0 9 | # 10 | # Unless required by applicable law or agreed to in writing, software 11 | # distributed under the License is distributed on an "AS IS" BASIS, 12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | # See the License for the specific language governing permissions and 14 | # limitations under the License. 15 | # 16 | reksio: 17 | awake: true 18 | bornIn: Poland 19 | birthYear: 1967 20 | friends: 21 | - Bolek 22 | - Lolek 23 | 24 | homepage: https://en.wikipedia.org/wiki/Reksio 25 | grades: Math=A,PE=A,Polish=A -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright 2015 Norbert Potocki (norbert.potocki@nort.pl) 3 | # 4 | # Licensed under the Apache License, Version 2.0 (the "License"); 5 | # you may not use this file except in compliance with the License. 6 | # You may obtain a copy of the License at 7 | # 8 | # http://www.apache.org/licenses/LICENSE-2.0 9 | # 10 | # Unless required by applicable law or agreed to in writing, software 11 | # distributed under the License is distributed on an "AS IS" BASIS, 12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | # See the License for the specific language governing permissions and 14 | # limitations under the License. 15 | # 16 | 17 | #Tue May 05 14:02:24 PDT 2015 18 | distributionBase=GRADLE_USER_HOME 19 | distributionPath=wrapper/dists 20 | zipStoreBase=GRADLE_USER_HOME 21 | zipStorePath=wrapper/dists 22 | distributionUrl=https\://services.gradle.org/distributions/gradle-2.4-bin.zip 23 | -------------------------------------------------------------------------------- /classpath-bind/src/main/resources/application.yaml: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright 2015 Norbert Potocki (norbert.potocki@nort.pl) 3 | # 4 | # Licensed under the Apache License, Version 2.0 (the "License"); 5 | # you may not use this file except in compliance with the License. 6 | # You may obtain a copy of the License at 7 | # 8 | # http://www.apache.org/licenses/LICENSE-2.0 9 | # 10 | # Unless required by applicable law or agreed to in writing, software 11 | # distributed under the License is distributed on an "AS IS" BASIS, 12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | # See the License for the specific language governing permissions and 14 | # limitations under the License. 15 | # 16 | spring: 17 | main: 18 | show_banner: false 19 | 20 | reksio: 21 | awake: true 22 | bornIn: Poland 23 | birthYear: 1967 24 | friends: 25 | - Bolek 26 | - Lolek 27 | 28 | homepage: https://en.wikipedia.org/wiki/Reksio 29 | grades: Math=A,PE=A,Polish=A 30 | 31 | some: 32 | setting: some setting string value 33 | other: 34 | setting: what do you know? :p -------------------------------------------------------------------------------- /classpath-bind/README.md: -------------------------------------------------------------------------------- 1 | # [cfg4j](http://cfg4j.org) sample app (uses **classpath** as configuration store) 2 | App demonstrating how to access configuration stored in a classpath files using cfg4j library. **Uses multiple configuration files.** 3 | 4 | ## Usage 5 | ``` 6 | > cd cfg4j-sample-apps/ 7 | > ./gradlew build 8 | > java -jar classpath-bind/build/libs/classpath-bind-1.0.0-SNAPSHOT.jar 9 | ``` 10 | 11 | ## Code snippets 12 | 13 | ### Configuration beans - see ConfigBeans.java 14 | ```java 15 | // Specify which files to load. Configuration from both files will be merged. 16 | ConfigFilesProvider configFilesProvider = () -> Arrays.asList(new File("application.yaml"), new File("otherConfig.properties")); 17 | 18 | // Use classpath repository as configuration store 19 | ConfigurationSource source = new ClasspathConfigurationSource(configFilesProvider); 20 | 21 | // Create provider 22 | return new ConfigurationProviderBuilder() 23 | .withConfigurationSource(source) 24 | .build(); 25 | } 26 | ``` 27 | 28 | ### Obtain configuration - see MainController.java 29 | ```java 30 | // Define configuration interface 31 | public interface ReksioConfig { 32 | URL homepage(); 33 | ... 34 | } 35 | 36 | ReksioConfig reksioConfig = configurationProvider.bind("reksio", ReksioConfig.class); 37 | URL url = reksioConfig.homepage(); 38 | ``` -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ## Sample applications using [cfg4j](http://cfg4j.org) library 2 | 3 | ## Apps 4 | * [classpath-bind](classpath-bind/) - reads configuration from a **classpath files** and outputs values 5 | to the stdout. 6 | * [consul-bind](consul-bind/) - reads configuration from a local **[Consul](http://consul.io) agent** and outputs values 7 | to the stdout. Automatically reloads configuration after change. 8 | * [files-bind](files-bind/) - reads configuration from a local files and outputs values 9 | to the stdout. Automatically **reloads configuration after change**. 10 | * [git-simple](git-simple/) - reads configuration from a given **git repository** (using *getProperty* methods) and outputs values 11 | to the stdout. Automatically reloads configuration after change. 12 | * [git-bind](git-bind/) - reads configuration from a given git repository (using **object binding**) and outputs values 13 | to the stdout. Automatically reloads configuration after change. 14 | * [git-multi-file](git-multi-file/) - reads configuration from a given git repository (from **multiple files**) and outputs values 15 | to the stdout. Automatically reloads configuration after change. 16 | * [metrics](metrics/) - reads configuration from a a local file and outputs values 17 | to the stdout. Automatically reloads configuration after change. **Exposes metrics**. 18 | 19 | ## Usage 20 | * Build all apps 21 | 22 | ``` 23 | > cd cfg4j-sample-apps/ 24 | > ./gradlew build 25 | ``` 26 | 27 | * Run app (in this example: "git-bind") - **read README.md file in the corresponding app root directory** for more information. 28 | 29 | ``` 30 | > java -jar git-bind/build/libs/git-bind-1.0.0-SNAPSHOT.jar 31 | ``` -------------------------------------------------------------------------------- /classpath-bind/build.gradle: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2015 Norbert Potocki (norbert.potocki@nort.pl) 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | // ----------- Build script configuration ----------- 17 | 18 | buildscript { 19 | 20 | ext { 21 | artifactName = "classpath-bind" 22 | } 23 | 24 | repositories { 25 | mavenLocal() 26 | mavenCentral() 27 | } 28 | 29 | dependencies { 30 | classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}") 31 | } 32 | } 33 | 34 | // ----------- Plugins ----------- 35 | 36 | apply plugin: "spring-boot" 37 | 38 | // ----------- Repositories ----------- 39 | 40 | repositories { 41 | mavenLocal() 42 | mavenCentral() 43 | } 44 | 45 | // ----------- External module dependencies ----------- 46 | 47 | dependencies { 48 | compile group: "org.springframework.boot", name: "spring-boot-starter", version: "${springBootVersion}" 49 | 50 | compile group: "org.cfg4j", name: "cfg4j-core", version: "${cfg4jVersion}" 51 | } 52 | 53 | // ----------- Task configurations ----------- 54 | jar { 55 | baseName = "${artifactName}" 56 | version = "${artifactVersion}" 57 | } -------------------------------------------------------------------------------- /git-bind/build.gradle: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2015 Norbert Potocki (norbert.potocki@nort.pl) 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | // ----------- Build script configuration ----------- 17 | 18 | buildscript { 19 | 20 | ext { 21 | artifactName = "git-bind" 22 | } 23 | 24 | repositories { 25 | mavenLocal() 26 | mavenCentral() 27 | } 28 | 29 | dependencies { 30 | classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}") 31 | } 32 | } 33 | 34 | // ----------- Plugins ----------- 35 | 36 | apply plugin: "spring-boot" 37 | 38 | // ----------- Repositories ----------- 39 | 40 | repositories { 41 | mavenLocal() 42 | mavenCentral() 43 | } 44 | 45 | // ----------- External module dependencies ----------- 46 | 47 | dependencies { 48 | compile group: "org.springframework.boot", name: "spring-boot-starter", version: "${springBootVersion}" 49 | 50 | compile group: "org.cfg4j", name: "cfg4j-core", version: "${cfg4jVersion}" 51 | compile group: "org.cfg4j", name: "cfg4j-git", version: "${cfg4jVersion}" 52 | } 53 | 54 | // ----------- Task configurations ----------- 55 | jar { 56 | baseName = "${artifactName}" 57 | version = "${artifactVersion}" 58 | } -------------------------------------------------------------------------------- /consul-bind/build.gradle: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2015 Norbert Potocki (norbert.potocki@nort.pl) 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | // ----------- Build script configuration ----------- 17 | 18 | buildscript { 19 | 20 | ext { 21 | artifactName = "consul-bind" 22 | } 23 | 24 | repositories { 25 | mavenLocal() 26 | mavenCentral() 27 | } 28 | 29 | dependencies { 30 | classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}") 31 | } 32 | } 33 | 34 | // ----------- Plugins ----------- 35 | 36 | apply plugin: "spring-boot" 37 | 38 | // ----------- Repositories ----------- 39 | 40 | repositories { 41 | mavenLocal() 42 | mavenCentral() 43 | } 44 | 45 | // ----------- External module dependencies ----------- 46 | 47 | dependencies { 48 | compile group: "org.springframework.boot", name: "spring-boot-starter", version: "${springBootVersion}" 49 | 50 | compile group: "org.cfg4j", name: "cfg4j-core", version: "${cfg4jVersion}" 51 | compile group: "org.cfg4j", name: "cfg4j-consul", version: "${cfg4jVersion}" 52 | } 53 | 54 | // ----------- Task configurations ----------- 55 | jar { 56 | baseName = "${artifactName}" 57 | version = "${artifactVersion}" 58 | } -------------------------------------------------------------------------------- /git-simple/build.gradle: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2015 Norbert Potocki (norbert.potocki@nort.pl) 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | // ----------- Build script configuration ----------- 17 | 18 | buildscript { 19 | 20 | ext { 21 | artifactName = "git-simple" 22 | 23 | springBootVersion = "1.2.4.RELEASE" 24 | } 25 | 26 | repositories { 27 | mavenLocal() 28 | mavenCentral() 29 | } 30 | 31 | dependencies { 32 | classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}") 33 | } 34 | } 35 | 36 | // ----------- Plugins ----------- 37 | 38 | apply plugin: "spring-boot" 39 | 40 | // ----------- Repositories ----------- 41 | 42 | repositories { 43 | mavenLocal() 44 | mavenCentral() 45 | } 46 | 47 | // ----------- External module dependencies ----------- 48 | 49 | dependencies { 50 | compile group: "org.springframework.boot", name: "spring-boot-starter", version: "${springBootVersion}" 51 | 52 | compile group: "org.cfg4j", name: "cfg4j-core", version: "${cfg4jVersion}" 53 | compile group: "org.cfg4j", name: "cfg4j-git", version: "${cfg4jVersion}" 54 | } 55 | 56 | // ----------- Task configurations ----------- 57 | jar { 58 | baseName = "${artifactName}" 59 | version = "${artifactVersion}" 60 | } -------------------------------------------------------------------------------- /git-multi-file/build.gradle: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2015 Norbert Potocki (norbert.potocki@nort.pl) 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | // ----------- Build script configuration ----------- 17 | 18 | buildscript { 19 | 20 | ext { 21 | artifactName = "git-multi-file" 22 | 23 | springBootVersion = "1.2.4.RELEASE" 24 | } 25 | 26 | repositories { 27 | mavenLocal() 28 | mavenCentral() 29 | } 30 | 31 | dependencies { 32 | classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}") 33 | } 34 | } 35 | 36 | // ----------- Plugins ----------- 37 | 38 | apply plugin: "spring-boot" 39 | 40 | // ----------- Repositories ----------- 41 | 42 | repositories { 43 | mavenLocal() 44 | mavenCentral() 45 | } 46 | 47 | // ----------- External module dependencies ----------- 48 | 49 | dependencies { 50 | compile group: "org.springframework.boot", name: "spring-boot-starter", version: "${springBootVersion}" 51 | 52 | compile group: "org.cfg4j", name: "cfg4j-core", version: "${cfg4jVersion}" 53 | compile group: "org.cfg4j", name: "cfg4j-git", version: "${cfg4jVersion}" 54 | } 55 | 56 | // ----------- Task configurations ----------- 57 | jar { 58 | baseName = "${artifactName}" 59 | version = "${artifactVersion}" 60 | } -------------------------------------------------------------------------------- /consul-bind/src/main/java/org/cfg4j/sample/ConfigBeans.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2015 Norbert Potocki (norbert.potocki@nort.pl) 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package org.cfg4j.sample; 17 | 18 | import org.cfg4j.provider.ConfigurationProvider; 19 | import org.cfg4j.provider.ConfigurationProviderBuilder; 20 | import org.cfg4j.source.ConfigurationSource; 21 | import org.cfg4j.source.consul.ConsulConfigurationSourceBuilder; 22 | import org.cfg4j.source.reload.ReloadStrategy; 23 | import org.cfg4j.source.reload.strategy.PeriodicalReloadStrategy; 24 | import org.springframework.context.annotation.Bean; 25 | import org.springframework.context.annotation.Configuration; 26 | 27 | import java.util.concurrent.TimeUnit; 28 | 29 | @Configuration 30 | public class ConfigBeans { 31 | 32 | @Bean 33 | public ConfigurationProvider configurationProvider() { 34 | // Use Consul service as configuration store 35 | ConfigurationSource source = new ConsulConfigurationSourceBuilder().build(); 36 | 37 | // Reload configuration every 5 seconds 38 | ReloadStrategy reloadStrategy = new PeriodicalReloadStrategy(5, TimeUnit.SECONDS); 39 | 40 | // Create provider 41 | return new ConfigurationProviderBuilder() 42 | .withConfigurationSource(source) 43 | .withReloadStrategy(reloadStrategy) 44 | .build(); 45 | } 46 | } 47 | -------------------------------------------------------------------------------- /files-bind/build.gradle: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2015 Norbert Potocki (norbert.potocki@nort.pl) 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | // ----------- Build script configuration ----------- 17 | 18 | buildscript { 19 | 20 | ext { 21 | artifactName = "files-bind" 22 | } 23 | 24 | repositories { 25 | mavenLocal() 26 | mavenCentral() 27 | } 28 | 29 | dependencies { 30 | classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}") 31 | } 32 | } 33 | 34 | // ----------- Plugins ----------- 35 | 36 | apply plugin: "spring-boot" 37 | 38 | // ----------- Repositories ----------- 39 | 40 | repositories { 41 | mavenLocal() 42 | mavenCentral() 43 | } 44 | 45 | // ----------- External module dependencies ----------- 46 | 47 | dependencies { 48 | compile group: "org.springframework.boot", name: "spring-boot-starter", version: "${springBootVersion}" 49 | 50 | compile group: "org.cfg4j", name: "cfg4j-core", version: "${cfg4jVersion}" 51 | } 52 | 53 | // ----------- Task configurations ----------- 54 | jar { 55 | baseName = "${artifactName}" 56 | version = "${artifactVersion}" 57 | } 58 | 59 | task copyProperties(type: Copy) { 60 | from '.' 61 | include '*.properties' 62 | include '*.yaml' 63 | into 'build/libs' 64 | } 65 | 66 | build.dependsOn copyProperties -------------------------------------------------------------------------------- /classpath-bind/src/main/java/org/cfg4j/sample/ConfigBeans.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2015 Norbert Potocki (norbert.potocki@nort.pl) 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package org.cfg4j.sample; 17 | 18 | import org.cfg4j.provider.ConfigurationProvider; 19 | import org.cfg4j.provider.ConfigurationProviderBuilder; 20 | import org.cfg4j.source.ConfigurationSource; 21 | import org.cfg4j.source.classpath.ClasspathConfigurationSource; 22 | import org.cfg4j.source.context.filesprovider.ConfigFilesProvider; 23 | import org.springframework.context.annotation.Bean; 24 | import org.springframework.context.annotation.Configuration; 25 | 26 | import java.nio.file.Paths; 27 | import java.util.Arrays; 28 | 29 | @Configuration 30 | public class ConfigBeans { 31 | 32 | @Bean 33 | public ConfigurationProvider configurationProvider() { 34 | // Specify which files to load. Configuration from both files will be merged. 35 | ConfigFilesProvider configFilesProvider = () -> Arrays.asList(Paths.get("application.yaml"), Paths.get("otherConfig.properties")); 36 | 37 | // Use classpath repository as configuration store 38 | ConfigurationSource source = new ClasspathConfigurationSource(configFilesProvider); 39 | 40 | // Create provider 41 | return new ConfigurationProviderBuilder() 42 | .withConfigurationSource(source) 43 | .build(); 44 | } 45 | } 46 | -------------------------------------------------------------------------------- /git-multi-file/src/main/java/org/cfg4j/sample/MainController.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2015 Norbert Potocki (norbert.potocki@nort.pl) 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package org.cfg4j.sample; 17 | 18 | import org.cfg4j.provider.ConfigurationProvider; 19 | import org.springframework.beans.factory.annotation.Autowired; 20 | import org.springframework.boot.CommandLineRunner; 21 | import org.springframework.boot.SpringApplication; 22 | import org.springframework.boot.autoconfigure.EnableAutoConfiguration; 23 | import org.springframework.context.annotation.ComponentScan; 24 | import org.springframework.stereotype.Controller; 25 | 26 | @Controller 27 | @EnableAutoConfiguration 28 | @ComponentScan 29 | public class MainController implements CommandLineRunner { 30 | 31 | public static void main(String[] args) throws Exception { 32 | SpringApplication.run(MainController.class, args); 33 | } 34 | 35 | @Autowired 36 | private ConfigurationProvider configurationProvider; 37 | 38 | public void run(String... args) throws Exception { 39 | Boolean wasAwake = false; 40 | 41 | ReksioConfig reksioConfig = configurationProvider.bind("reksio", ReksioConfig.class); 42 | 43 | while (true) { 44 | if (wasAwake != reksioConfig.awake()) { 45 | System.out.println("Reksio is now " + (reksioConfig.awake() ? "awake" : "asleep")); 46 | 47 | wasAwake = reksioConfig.awake(); 48 | } 49 | 50 | Thread.sleep(3000); 51 | } 52 | } 53 | } 54 | -------------------------------------------------------------------------------- /consul-bind/src/main/java/org/cfg4j/sample/MainController.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2015 Norbert Potocki (norbert.potocki@nort.pl) 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package org.cfg4j.sample; 17 | 18 | import org.cfg4j.provider.ConfigurationProvider; 19 | import org.springframework.beans.factory.annotation.Autowired; 20 | import org.springframework.boot.CommandLineRunner; 21 | import org.springframework.boot.SpringApplication; 22 | import org.springframework.boot.autoconfigure.EnableAutoConfiguration; 23 | import org.springframework.context.annotation.ComponentScan; 24 | import org.springframework.stereotype.Controller; 25 | 26 | @Controller 27 | @EnableAutoConfiguration 28 | @ComponentScan 29 | public class MainController implements CommandLineRunner { 30 | 31 | @Autowired 32 | private ConfigurationProvider configurationProvider; 33 | 34 | public void run(String... args) throws Exception { 35 | Boolean wasAwake = false; 36 | 37 | ReksioConfig reksioConfig = configurationProvider.bind("reksio", ReksioConfig.class); 38 | 39 | while (true) { 40 | if (wasAwake != reksioConfig.awake()) { 41 | System.out.println("Reksio is now " + (reksioConfig.awake() ? "awake" : "asleep")); 42 | 43 | wasAwake = reksioConfig.awake(); 44 | } 45 | 46 | Thread.sleep(3000); 47 | } 48 | } 49 | 50 | // For Spring Boot 51 | public static void main(String[] args) throws Exception { 52 | SpringApplication.run(MainController.class, args); 53 | } 54 | 55 | } 56 | -------------------------------------------------------------------------------- /files-bind/src/main/java/org/cfg4j/sample/MainController.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2015 Norbert Potocki (norbert.potocki@nort.pl) 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package org.cfg4j.sample; 17 | 18 | import org.cfg4j.provider.ConfigurationProvider; 19 | import org.springframework.beans.factory.annotation.Autowired; 20 | import org.springframework.boot.CommandLineRunner; 21 | import org.springframework.boot.SpringApplication; 22 | import org.springframework.boot.autoconfigure.EnableAutoConfiguration; 23 | import org.springframework.context.annotation.ComponentScan; 24 | import org.springframework.stereotype.Controller; 25 | 26 | @Controller 27 | @EnableAutoConfiguration 28 | @ComponentScan 29 | public class MainController implements CommandLineRunner { 30 | 31 | @Autowired 32 | private ConfigurationProvider configurationProvider; 33 | 34 | public void run(String... args) throws Exception { 35 | Boolean wasAwake = false; 36 | 37 | ReksioConfig reksioConfig = configurationProvider.bind("reksio", ReksioConfig.class); 38 | 39 | while (true) { 40 | if (wasAwake != reksioConfig.awake()) { 41 | System.out.println("Reksio is now " + (reksioConfig.awake() ? "awake" : "asleep")); 42 | 43 | wasAwake = reksioConfig.awake(); 44 | } 45 | 46 | Thread.sleep(3000); 47 | } 48 | } 49 | 50 | // For Spring Boot 51 | public static void main(String[] args) throws Exception { 52 | SpringApplication.run(MainController.class, args); 53 | } 54 | 55 | } 56 | -------------------------------------------------------------------------------- /git-bind/src/main/java/org/cfg4j/sample/MainController.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2015 Norbert Potocki (norbert.potocki@nort.pl) 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package org.cfg4j.sample; 17 | 18 | import org.cfg4j.provider.ConfigurationProvider; 19 | import org.springframework.beans.factory.annotation.Autowired; 20 | import org.springframework.boot.CommandLineRunner; 21 | import org.springframework.boot.SpringApplication; 22 | import org.springframework.boot.autoconfigure.EnableAutoConfiguration; 23 | import org.springframework.context.annotation.ComponentScan; 24 | import org.springframework.stereotype.Controller; 25 | 26 | @Controller 27 | @EnableAutoConfiguration 28 | @ComponentScan 29 | public class MainController implements CommandLineRunner { 30 | 31 | @Autowired 32 | private ConfigurationProvider configurationProvider; 33 | 34 | public void run(String... args) throws Exception { 35 | Boolean wasAwake = false; 36 | 37 | ReksioConfig reksioConfig = configurationProvider.bind("reksio", ReksioConfig.class); 38 | 39 | while (true) { 40 | if (wasAwake != reksioConfig.awake()) { 41 | System.out.println("Reksio is now " + (reksioConfig.awake() ? "awake" : "asleep")); 42 | 43 | wasAwake = reksioConfig.awake(); 44 | } 45 | 46 | Thread.sleep(3000); 47 | } 48 | } 49 | 50 | // For Spring Boot 51 | public static void main(String[] args) throws Exception { 52 | SpringApplication.run(MainController.class, args); 53 | } 54 | 55 | } 56 | -------------------------------------------------------------------------------- /classpath-bind/src/main/java/org/cfg4j/sample/MainController.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2015 Norbert Potocki (norbert.potocki@nort.pl) 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package org.cfg4j.sample; 17 | 18 | import org.cfg4j.provider.ConfigurationProvider; 19 | import org.springframework.beans.factory.annotation.Autowired; 20 | import org.springframework.boot.CommandLineRunner; 21 | import org.springframework.boot.SpringApplication; 22 | import org.springframework.boot.autoconfigure.EnableAutoConfiguration; 23 | import org.springframework.context.annotation.ComponentScan; 24 | import org.springframework.stereotype.Controller; 25 | 26 | @Controller 27 | @EnableAutoConfiguration 28 | @ComponentScan 29 | public class MainController implements CommandLineRunner { 30 | 31 | @Autowired 32 | private ConfigurationProvider configurationProvider; 33 | 34 | public void run(String... args) throws Exception { 35 | Boolean wasAwake = false; 36 | 37 | ReksioConfig reksioConfig = configurationProvider.bind("reksio", ReksioConfig.class); 38 | 39 | while (true) { 40 | if (wasAwake != reksioConfig.awake()) { 41 | System.out.println("Reksio is now " + (reksioConfig.awake() ? "awake" : "asleep")); 42 | 43 | wasAwake = reksioConfig.awake(); 44 | } 45 | 46 | Thread.sleep(3000); 47 | } 48 | } 49 | 50 | // For Spring Boot 51 | public static void main(String[] args) throws Exception { 52 | SpringApplication.run(MainController.class, args); 53 | } 54 | 55 | } 56 | -------------------------------------------------------------------------------- /git-simple/src/main/java/org/cfg4j/sample/MainController.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2015 Norbert Potocki (norbert.potocki@nort.pl) 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package org.cfg4j.sample; 17 | 18 | import org.cfg4j.provider.ConfigurationProvider; 19 | import org.springframework.beans.factory.annotation.Autowired; 20 | import org.springframework.boot.CommandLineRunner; 21 | import org.springframework.boot.SpringApplication; 22 | import org.springframework.boot.autoconfigure.EnableAutoConfiguration; 23 | import org.springframework.context.annotation.ComponentScan; 24 | import org.springframework.stereotype.Controller; 25 | 26 | @Controller 27 | @EnableAutoConfiguration 28 | @ComponentScan 29 | public class MainController implements CommandLineRunner { 30 | 31 | @Autowired 32 | private ConfigurationProvider configurationProvider; 33 | 34 | public void run(String... args) throws Exception { 35 | String previousSettingValue = null; 36 | 37 | while (true) { 38 | String newSettingValue = configurationProvider.getProperty("some.setting", String.class); 39 | 40 | if (!newSettingValue.equals(previousSettingValue)) { 41 | System.out.println("new value: some.setting = " + newSettingValue); 42 | previousSettingValue = newSettingValue; 43 | } 44 | 45 | Thread.sleep(1000); 46 | } 47 | } 48 | 49 | // For Spring Boot 50 | public static void main(String[] args) throws Exception { 51 | SpringApplication.run(MainController.class, args); 52 | } 53 | } 54 | -------------------------------------------------------------------------------- /metrics/build.gradle: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2015 Norbert Potocki (norbert.potocki@nort.pl) 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | // ----------- Build script configuration ----------- 17 | 18 | buildscript { 19 | 20 | ext { 21 | artifactName = "metrics" 22 | } 23 | 24 | repositories { 25 | mavenLocal() 26 | mavenCentral() 27 | } 28 | 29 | dependencies { 30 | classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}") 31 | } 32 | } 33 | 34 | // ----------- Plugins ----------- 35 | 36 | apply plugin: "spring-boot" 37 | 38 | // ----------- Repositories ----------- 39 | 40 | repositories { 41 | mavenLocal() 42 | mavenCentral() 43 | } 44 | 45 | // ----------- External module dependencies ----------- 46 | 47 | dependencies { 48 | compile group: "org.springframework.boot", name: "spring-boot-starter", version: "${springBootVersion}" 49 | 50 | compile group: "org.cfg4j", name: "cfg4j-core", version: "${cfg4jVersion}" 51 | 52 | // Metrics 53 | compile group: "io.dropwizard.metrics", name: "metrics-core", version: "3.1.2" 54 | compile group: "com.ryantenney.metrics", name: "metrics-spring", version: "3.1.2" 55 | } 56 | 57 | // ----------- Task configurations ----------- 58 | jar { 59 | baseName = "${artifactName}" 60 | version = "${artifactVersion}" 61 | } 62 | 63 | task copyProperties(type: Copy) { 64 | from '.' 65 | include '*.yaml' 66 | into 'build/libs' 67 | } 68 | 69 | build.dependsOn copyProperties -------------------------------------------------------------------------------- /git-simple/README.md: -------------------------------------------------------------------------------- 1 | # [cfg4j](http://cfg4j.org) sample app (uses **git** as configuration store) 2 | App demonstrating how to access configuration stored in a Git repository using cfg4j library. Uses simple method access. 3 | 4 | ## Usage 5 | ``` 6 | > cd cfg4j-sample-apps/ 7 | > ./gradlew build 8 | > java -jar git-simple/build/libs/git-simple-1.0.0-SNAPSHOT.jar 9 | ``` 10 | 11 | You can: 12 | * use any git repository: **-DconfigRepoPath=\** parameter. Both local and remote repos are supported. 13 | * use non-default branch: **-DconfigBranch=\** 14 | 15 | ``` 16 | > java -DconfigRepoPath=/tmp/myRepo.git -DconfigBranch=myBranch -jar git-simple/build/libs/git-simple-1.0.0-SNAPSHOT.jar 17 | ``` 18 | 19 | ## Code snippets 20 | 21 | ### Configuration beans - see ConfigBeans.java 22 | ```java 23 | @Value("${configRepoPath:https://github.com/cfg4j/cfg4j-git-sample-config.git}") 24 | private String configRepoPath; // Run with -DconfigRepoPath= parameter to override 25 | 26 | @Value("${configBranch:master}") 27 | private String branch; // Run with -DconfigBranch= parameter to override 28 | 29 | @Bean 30 | public ConfigurationProvider configurationProvider() { 31 | // Use Git repository as configuration store 32 | ConfigurationSource source = new GitConfigurationSourceBuilder() 33 | .withRepositoryURI(configRepoPath) 34 | .build(); 35 | 36 | // Select branch to use (use new DefaultEnvironment()) for master 37 | Environment environment = new ImmutableEnvironment(branch); 38 | 39 | // Reload configuration every 5 seconds 40 | ReloadStrategy reloadStrategy = new PeriodicalReloadStrategy(5, TimeUnit.SECONDS); 41 | 42 | // Create provider 43 | return new ConfigurationProviderBuilder() 44 | .withConfigurationSource(source) 45 | .withEnvironment(environment) 46 | .withReloadStrategy(reloadStrategy) 47 | .build(); 48 | } 49 | ``` 50 | 51 | ### Obtain configuration - see MainController.java 52 | ```java 53 | String newSettingValue = configurationProvider.getProperty("some.setting", String.class); 54 | ``` -------------------------------------------------------------------------------- /consul-bind/README.md: -------------------------------------------------------------------------------- 1 | # [cfg4j](http://cfg4j.org) sample app (uses **[Consul](http://consul.io)** as configuration store) 2 | App demonstrating how to access configuration stored in a Consul service using cfg4j library. Uses configuration object binding. 3 | 4 | ## Usage 5 | 1. Make sure local consul agent is running and listening on **localhost:8500**. You can run a single-node consul instance by invoking: 6 | ``` 7 | > consul agent -data-dir=/tmp/consul -server -bootstrap 8 | ``` 9 | 10 | 2. Put sample config values to Consul's key-value store 11 | ``` 12 | > curl -X PUT localhost:8500/v1/kv/reksio.awake -d true 13 | > curl -X PUT localhost:8500/v1/kv/reksio.bornIn -d Poland 14 | > curl -X PUT localhost:8500/v1/kv/reksio.birthYear -d 1967 15 | > curl -X PUT localhost:8500/v1/kv/reksio.friends -d Bolek,Lolek 16 | > curl -X PUT localhost:8500/v1/kv/reksio.homepage -d https://en.wikipedia.org/wiki/Reksio 17 | > curl -X PUT localhost:8500/v1/kv/reksio.grades -d Math=A,PE=A,Polish=A 18 | ``` 19 | 20 | 3. Run sample app 21 | ``` 22 | > cd cfg4j-sample-apps/ 23 | > ./gradlew build 24 | > java -jar consul-bind/build/libs/consul-bind-1.0.0-SNAPSHOT.jar 25 | ``` 26 | 27 | ## Code snippets 28 | 29 | ### Configuration beans - see ConfigBeans.java 30 | ```java 31 | @Bean 32 | public ConfigurationProvider configurationProvider() { 33 | // Use Consul service as configuration store 34 | ConfigurationSource source = new ConsulConfigurationSourceBuilder().build(); 35 | 36 | // Reload configuration every 5 seconds 37 | ReloadStrategy reloadStrategy = new PeriodicalReloadStrategy(5, TimeUnit.SECONDS); 38 | 39 | // Create provider 40 | return new ConfigurationProviderBuilder() 41 | .withConfigurationSource(source) 42 | .withReloadStrategy(reloadStrategy) 43 | .build(); 44 | } 45 | ``` 46 | 47 | ### Obtain configuration - see MainController.java 48 | ```java 49 | // Define configuration interface 50 | public interface ReksioConfig { 51 | URL homepage(); 52 | ... 53 | } 54 | 55 | ReksioConfig reksioConfig = configurationProvider.bind("reksio", ReksioConfig.class); 56 | URL url = reksioConfig.homepage(); 57 | ``` 58 | -------------------------------------------------------------------------------- /files-bind/README.md: -------------------------------------------------------------------------------- 1 | # [cfg4j](http://cfg4j.org) sample app (uses **local files** as configuration store) 2 | App demonstrating how to access configuration stored in a local files using cfg4j library. **Uses multiple configuration files.** 3 | 4 | ## Usage 5 | ``` 6 | > cd cfg4j-sample-apps/ 7 | > ./gradlew build 8 | > java -jar files-bind/build/libs/files-bind-1.0.0-SNAPSHOT.jar 9 | ``` 10 | 11 | You can: 12 | * use any path to config files: **-DconfigFilesPath=\** parameter. Both absolute and relative paths are supported. 13 | 14 | ``` 15 | > java -DconfigFilesPath=./files-bind/build/libs/ -jar files-bind/build/libs/files-bind-1.0.0-SNAPSHOT.jar 16 | ``` 17 | 18 | 19 | ## Code snippets 20 | 21 | ### Configuration beans - see ConfigBeans.java 22 | ```java 23 | @Value("${configFilesPath:./files-bind/build/libs/}") 24 | private String filesPath; // Run with -DconfigFilesPath= parameter to override 25 | 26 | @Bean 27 | public ConfigurationProvider configurationProvider() { 28 | // Specify which files to load. Configuration from both files will be merged. 29 | ConfigFilesProvider configFilesProvider = () -> Arrays.asList(new File("application.yaml"), new File("otherConfig.properties")); 30 | 31 | // Use local files as configuration store 32 | ConfigurationSource source = new FilesConfigurationSource(configFilesProvider); 33 | 34 | // Use relative paths 35 | Environment environment = new ImmutableEnvironment(filesPath); 36 | 37 | // Reload configuration every 5 seconds 38 | ReloadStrategy reloadStrategy = new PeriodicalReloadStrategy(5, TimeUnit.SECONDS); 39 | 40 | // Create provider 41 | return new ConfigurationProviderBuilder() 42 | .withConfigurationSource(source) 43 | .withReloadStrategy(reloadStrategy) 44 | .withEnvironment(environment) 45 | .build(); 46 | } 47 | ``` 48 | 49 | ### Obtain configuration - see MainController.java 50 | ```java 51 | // Define configuration interface 52 | public interface ReksioConfig { 53 | URL homepage(); 54 | ... 55 | } 56 | 57 | ReksioConfig reksioConfig = configurationProvider.bind("reksio", ReksioConfig.class); 58 | URL url = reksioConfig.homepage(); 59 | ``` -------------------------------------------------------------------------------- /metrics/src/main/java/org/cfg4j/sample/MainController.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2015 Norbert Potocki (norbert.potocki@nort.pl) 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package org.cfg4j.sample; 17 | 18 | import com.codahale.metrics.annotation.Metered; 19 | import com.ryantenney.metrics.spring.config.annotation.EnableMetrics; 20 | import org.cfg4j.provider.ConfigurationProvider; 21 | import org.springframework.beans.factory.annotation.Autowired; 22 | import org.springframework.boot.CommandLineRunner; 23 | import org.springframework.boot.SpringApplication; 24 | import org.springframework.boot.autoconfigure.EnableAutoConfiguration; 25 | import org.springframework.context.annotation.ComponentScan; 26 | import org.springframework.stereotype.Controller; 27 | 28 | @Controller 29 | @EnableAutoConfiguration 30 | @ComponentScan 31 | @EnableMetrics 32 | public class MainController implements CommandLineRunner { 33 | 34 | @Autowired 35 | private ConfigurationProvider configurationProvider; 36 | 37 | @Metered(name = "hello.run") 38 | public void run(String... args) throws Exception { 39 | Boolean wasAwake = false; 40 | 41 | ReksioConfig reksioConfig = configurationProvider.bind("reksio", ReksioConfig.class); 42 | 43 | while (true) { 44 | if (wasAwake != reksioConfig.awake()) { 45 | System.out.println("Reksio is now " + (reksioConfig.awake() ? "awake" : "asleep")); 46 | 47 | wasAwake = reksioConfig.awake(); 48 | } 49 | 50 | Thread.sleep(500); 51 | } 52 | } 53 | 54 | // For Spring Boot 55 | public static void main(String[] args) throws Exception { 56 | SpringApplication.run(MainController.class, args); 57 | } 58 | 59 | } 60 | -------------------------------------------------------------------------------- /git-bind/README.md: -------------------------------------------------------------------------------- 1 | # [cfg4j](http://cfg4j.org) sample app (uses **git** as configuration store) 2 | App demonstrating how to access configuration stored in a Git repository using cfg4j library. Uses configuration object binding. 3 | 4 | ## Usage 5 | ``` 6 | > cd cfg4j-sample-apps/ 7 | > ./gradlew build 8 | > java -jar git-bind/build/libs/git-bind-1.0.0-SNAPSHOT.jar 9 | ``` 10 | 11 | You can: 12 | * use any git repository: **-DconfigRepoPath=\** parameter. Both local and remote repos are supported. 13 | * use non-default branch: **-DconfigBranch=\** 14 | 15 | ``` 16 | > java -DconfigRepoPath=/tmp/myRepo.git -DconfigBranch=master -jar git-bind/build/libs/git-bind-1.0.0-SNAPSHOT.jar 17 | ``` 18 | 19 | ## Code snippets 20 | 21 | ### Configuration beans - see ConfigBeans.java 22 | ```java 23 | @Value("${configRepoPath:https://github.com/cfg4j/cfg4j-git-sample-config.git}") 24 | private String configRepoPath; // Run with -DconfigRepoPath= parameter to override 25 | 26 | @Value("${configBranch:production-env}") 27 | private String branch; // Run with -DconfigBranch= parameter to override 28 | 29 | @Bean 30 | public ConfigurationProvider configurationProvider() { 31 | // Use Git repository as configuration store 32 | ConfigurationSource source = new GitConfigurationSourceBuilder() 33 | .withRepositoryURI(configRepoPath) 34 | .build(); 35 | 36 | // Select branch to use (use new DefaultEnvironment()) for master 37 | Environment environment = new ImmutableEnvironment(branch); 38 | 39 | // Reload configuration every 5 seconds 40 | ReloadStrategy reloadStrategy = new PeriodicalReloadStrategy(5, TimeUnit.SECONDS); 41 | 42 | // Create provider 43 | return new ConfigurationProviderBuilder() 44 | .withConfigurationSource(source) 45 | .withEnvironment(environment) 46 | .withReloadStrategy(reloadStrategy) 47 | .build(); 48 | } 49 | ``` 50 | 51 | ### Obtain configuration - see MainController.java 52 | ```java 53 | // Define configuration interface 54 | public interface ReksioConfig { 55 | URL homepage(); 56 | ... 57 | } 58 | 59 | ReksioConfig reksioConfig = configurationProvider.bind("reksio", ReksioConfig.class); 60 | URL url = reksioConfig.homepage(); 61 | ``` -------------------------------------------------------------------------------- /metrics/README.md: -------------------------------------------------------------------------------- 1 | # [cfg4j](http://cfg4j.org) sample app demonstrating publishing metrics 2 | App demonstrating how to publish metrics for configuration source and provider. **Uses single, local configuration file.** 3 | 4 | ## Usage 5 | ``` 6 | > cd cfg4j-sample-apps/ 7 | > ./gradlew build 8 | > java -jar metrics/build/libs/metrics-1.0.0-SNAPSHOT.jar 9 | ``` 10 | 11 | You can: 12 | * use any path to config files: **-DconfigFilesPath=\** parameter. Both absolute and relative paths are supported. 13 | 14 | ``` 15 | > java -DconfigFilesPath=./metrics/build/libs/ -jar metrics/build/libs/metrics-1.0.0-SNAPSHOT.jar 16 | ``` 17 | 18 | 19 | ## Code snippets 20 | 21 | ### Configuration beans - see ConfigBeans.java 22 | ```java 23 | @Value("${configFilesPath:./metrics/build/libs/}") 24 | private String filesPath; // Run with -DconfigFilesPath= parameter to override 25 | 26 | @Autowired 27 | private MetricRegistry metricRegistry; 28 | 29 | @Bean 30 | public ConfigurationProvider configurationProvider() { 31 | // Specify which files to load. Configuration from both files will be merged. 32 | ConfigFilesProvider configFilesProvider = () -> Arrays.asList(new File("application.yaml"), new File("otherConfig.properties")); 33 | 34 | // Use local files as configuration store 35 | ConfigurationSource source = new FilesConfigurationSource(configFilesProvider); 36 | 37 | // Use relative paths 38 | Environment environment = new ImmutableEnvironment(filesPath); 39 | 40 | // Reload configuration every 5 seconds 41 | ReloadStrategy reloadStrategy = new PeriodicalReloadStrategy(5, TimeUnit.SECONDS); 42 | 43 | // Create provider 44 | return new ConfigurationProviderBuilder() 45 | .withConfigurationSource(source) 46 | .withReloadStrategy(reloadStrategy) 47 | .withEnvironment(environment) 48 | .withMetrics(metricRegistry, "firstProvider.") // Enable metrics 49 | .build(); 50 | } 51 | ``` 52 | 53 | ### Metric publisher beans - see MonitoringBeans.java 54 | ```java 55 | @Configuration 56 | public class MonitoringBeans extends MetricsConfigurerAdapter { 57 | 58 | @Override 59 | public void configureReporters(MetricRegistry metricRegistry) { 60 | JmxReporter.forRegistry(metricRegistry) 61 | .convertRatesTo(TimeUnit.SECONDS) 62 | .convertDurationsTo(TimeUnit.MILLISECONDS) 63 | .build() 64 | .start(); 65 | } 66 | } 67 | ``` 68 | -------------------------------------------------------------------------------- /git-multi-file/README.md: -------------------------------------------------------------------------------- 1 | # [cfg4j](http://cfg4j.org) sample app (uses **git** as configuration store) 2 | App demonstrating how to access configuration stored in a Git repository using cfg4j library. **Uses multiple configuration files.** 3 | 4 | ## Usage 5 | ``` 6 | > cd cfg4j-sample-apps/ 7 | > ./gradlew build 8 | > java -jar git-multi-file/build/libs/git-multi-file-1.0.0-SNAPSHOT.jar 9 | ``` 10 | 11 | You can: 12 | * use any git repository: **-DconfigRepoPath=\** parameter. Both local and remote repos are supported. 13 | * use non-default branch: **-DconfigBranch=\** 14 | 15 | ``` 16 | > java -DconfigRepoPath=/tmp/myRepo.git -DconfigBranch=master -jar git-multi-file/build/libs/git-multi-file-1.0.0-SNAPSHOT.jar 17 | ``` 18 | 19 | ## Code snippets 20 | 21 | ### Configuration beans - see ConfigBeans.java 22 | ```java 23 | @Value("${configRepoPath:https://github.com/cfg4j/cfg4j-git-sample-config.git}") 24 | private String configRepoPath; // Run with -DconfigRepoPath= parameter to override 25 | 26 | @Value("${configBranch:production-env}") 27 | private String branch; // Run with -DconfigBranch= parameter to override 28 | 29 | @Bean 30 | public ConfigurationProvider configurationProvider() { 31 | // Specify which files to load. Configuration from both files will be merged. 32 | ConfigFilesProvider configFilesProvider = () -> Arrays.asList(Paths.get("application.properties"), Paths.get("otherConfig.properties")); 33 | 34 | // Use Git repository as configuration store 35 | ConfigurationSource source = new GitConfigurationSourceBuilder() 36 | .withRepositoryURI(configRepoPath) 37 | .withConfigFilesProvider(configFilesProvider) 38 | .build(); 39 | 40 | // Select branch to use (use new DefaultEnvironment()) for master 41 | Environment environment = new ImmutableEnvironment(branch); 42 | 43 | // Reload configuration every 5 seconds 44 | ReloadStrategy reloadStrategy = new PeriodicalReloadStrategy(5, TimeUnit.SECONDS); 45 | 46 | // Create provider 47 | return new ConfigurationProviderBuilder() 48 | .withConfigurationSource(source) 49 | .withEnvironment(environment) 50 | .withReloadStrategy(reloadStrategy) 51 | .build(); 52 | } 53 | ``` 54 | 55 | ### Obtain configuration - see MainController.java 56 | ```java 57 | // Define configuration interface 58 | public interface ReksioConfig { 59 | URL homepage(); 60 | ... 61 | } 62 | 63 | ReksioConfig reksioConfig = configurationProvider.bind("reksio", ReksioConfig.class); 64 | URL url = reksioConfig.homepage(); 65 | ``` 66 | -------------------------------------------------------------------------------- /git-simple/src/main/java/org/cfg4j/sample/ConfigBeans.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2015 Norbert Potocki (norbert.potocki@nort.pl) 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package org.cfg4j.sample; 17 | 18 | import org.cfg4j.provider.ConfigurationProvider; 19 | import org.cfg4j.provider.ConfigurationProviderBuilder; 20 | import org.cfg4j.source.ConfigurationSource; 21 | import org.cfg4j.source.context.environment.Environment; 22 | import org.cfg4j.source.context.environment.ImmutableEnvironment; 23 | import org.cfg4j.source.git.GitConfigurationSourceBuilder; 24 | import org.cfg4j.source.reload.ReloadStrategy; 25 | import org.cfg4j.source.reload.strategy.PeriodicalReloadStrategy; 26 | import org.springframework.beans.factory.annotation.Value; 27 | import org.springframework.context.annotation.Bean; 28 | import org.springframework.context.annotation.Configuration; 29 | 30 | import java.util.concurrent.TimeUnit; 31 | 32 | @Configuration 33 | public class ConfigBeans { 34 | 35 | @Value("${configRepoPath:https://github.com/cfg4j/cfg4j-git-sample-config.git}") 36 | private String configRepoPath; // Run with -DconfigRepoPath= parameter to override 37 | 38 | @Value("${configBranch:master}") 39 | private String branch; // Run with -DconfigBranch= parameter to override 40 | 41 | @Bean 42 | public ConfigurationProvider configurationProvider() { 43 | // Use Git repository as configuration store 44 | ConfigurationSource source = new GitConfigurationSourceBuilder() 45 | .withRepositoryURI(configRepoPath) 46 | .build(); 47 | 48 | // Select branch to use (use new DefaultEnvironment()) for master 49 | Environment environment = new ImmutableEnvironment(branch); 50 | 51 | // Reload configuration every 5 seconds 52 | ReloadStrategy reloadStrategy = new PeriodicalReloadStrategy(5, TimeUnit.SECONDS); 53 | 54 | // Create provider 55 | return new ConfigurationProviderBuilder() 56 | .withConfigurationSource(source) 57 | .withEnvironment(environment) 58 | .withReloadStrategy(reloadStrategy) 59 | .build(); 60 | } 61 | } 62 | -------------------------------------------------------------------------------- /git-bind/src/main/java/org/cfg4j/sample/ConfigBeans.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2015 Norbert Potocki (norbert.potocki@nort.pl) 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package org.cfg4j.sample; 17 | 18 | import org.cfg4j.provider.ConfigurationProvider; 19 | import org.cfg4j.provider.ConfigurationProviderBuilder; 20 | import org.cfg4j.source.ConfigurationSource; 21 | import org.cfg4j.source.context.environment.Environment; 22 | import org.cfg4j.source.context.environment.ImmutableEnvironment; 23 | import org.cfg4j.source.git.GitConfigurationSourceBuilder; 24 | import org.cfg4j.source.reload.ReloadStrategy; 25 | import org.cfg4j.source.reload.strategy.PeriodicalReloadStrategy; 26 | import org.springframework.beans.factory.annotation.Value; 27 | import org.springframework.context.annotation.Bean; 28 | import org.springframework.context.annotation.Configuration; 29 | 30 | import java.util.concurrent.TimeUnit; 31 | 32 | @Configuration 33 | public class ConfigBeans { 34 | 35 | @Value("${configRepoPath:https://github.com/cfg4j/cfg4j-git-sample-config.git}") 36 | private String configRepoPath; // Run with -DconfigRepoPath= parameter to override 37 | 38 | @Value("${configBranch:production-env}") 39 | private String branch; // Run with -DconfigBranch= parameter to override 40 | 41 | @Bean 42 | public ConfigurationProvider configurationProvider() { 43 | // Use Git repository as configuration store 44 | ConfigurationSource source = new GitConfigurationSourceBuilder() 45 | .withRepositoryURI(configRepoPath) 46 | .build(); 47 | 48 | // Select branch to use (use new DefaultEnvironment()) for master 49 | Environment environment = new ImmutableEnvironment(branch); 50 | 51 | // Reload configuration every 5 seconds 52 | ReloadStrategy reloadStrategy = new PeriodicalReloadStrategy(5, TimeUnit.SECONDS); 53 | 54 | // Create provider 55 | return new ConfigurationProviderBuilder() 56 | .withConfigurationSource(source) 57 | .withEnvironment(environment) 58 | .withReloadStrategy(reloadStrategy) 59 | .build(); 60 | } 61 | } 62 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @if "%DEBUG%" == "" @echo off 2 | @rem ########################################################################## 3 | @rem 4 | @rem Gradle startup script for Windows 5 | @rem 6 | @rem ########################################################################## 7 | 8 | @rem Set local scope for the variables with windows NT shell 9 | if "%OS%"=="Windows_NT" setlocal 10 | 11 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 12 | set DEFAULT_JVM_OPTS= 13 | 14 | set DIRNAME=%~dp0 15 | if "%DIRNAME%" == "" set DIRNAME=. 16 | set APP_BASE_NAME=%~n0 17 | set APP_HOME=%DIRNAME% 18 | 19 | @rem Find java.exe 20 | if defined JAVA_HOME goto findJavaFromJavaHome 21 | 22 | set JAVA_EXE=java.exe 23 | %JAVA_EXE% -version >NUL 2>&1 24 | if "%ERRORLEVEL%" == "0" goto init 25 | 26 | echo. 27 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 28 | echo. 29 | echo Please set the JAVA_HOME variable in your environment to match the 30 | echo location of your Java installation. 31 | 32 | goto fail 33 | 34 | :findJavaFromJavaHome 35 | set JAVA_HOME=%JAVA_HOME:"=% 36 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 37 | 38 | if exist "%JAVA_EXE%" goto init 39 | 40 | echo. 41 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 42 | echo. 43 | echo Please set the JAVA_HOME variable in your environment to match the 44 | echo location of your Java installation. 45 | 46 | goto fail 47 | 48 | :init 49 | @rem Get command-line arguments, handling Windowz variants 50 | 51 | if not "%OS%" == "Windows_NT" goto win9xME_args 52 | if "%@eval[2+2]" == "4" goto 4NT_args 53 | 54 | :win9xME_args 55 | @rem Slurp the command line arguments. 56 | set CMD_LINE_ARGS= 57 | set _SKIP=2 58 | 59 | :win9xME_args_slurp 60 | if "x%~1" == "x" goto execute 61 | 62 | set CMD_LINE_ARGS=%* 63 | goto execute 64 | 65 | :4NT_args 66 | @rem Get arguments from the 4NT Shell from JP Software 67 | set CMD_LINE_ARGS=%$ 68 | 69 | :execute 70 | @rem Setup the command line 71 | 72 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 73 | 74 | @rem Execute Gradle 75 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% 76 | 77 | :end 78 | @rem End local scope for the variables with windows NT shell 79 | if "%ERRORLEVEL%"=="0" goto mainEnd 80 | 81 | :fail 82 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 83 | rem the _cmd.exe /c_ return code! 84 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 85 | exit /b 1 86 | 87 | :mainEnd 88 | if "%OS%"=="Windows_NT" endlocal 89 | 90 | :omega 91 | -------------------------------------------------------------------------------- /files-bind/src/main/java/org/cfg4j/sample/ConfigBeans.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2015 Norbert Potocki (norbert.potocki@nort.pl) 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package org.cfg4j.sample; 17 | 18 | import org.cfg4j.provider.ConfigurationProvider; 19 | import org.cfg4j.provider.ConfigurationProviderBuilder; 20 | import org.cfg4j.source.ConfigurationSource; 21 | import org.cfg4j.source.context.environment.Environment; 22 | import org.cfg4j.source.context.environment.ImmutableEnvironment; 23 | import org.cfg4j.source.context.filesprovider.ConfigFilesProvider; 24 | import org.cfg4j.source.files.FilesConfigurationSource; 25 | import org.cfg4j.source.reload.ReloadStrategy; 26 | import org.cfg4j.source.reload.strategy.PeriodicalReloadStrategy; 27 | import org.springframework.beans.factory.annotation.Value; 28 | import org.springframework.context.annotation.Bean; 29 | import org.springframework.context.annotation.Configuration; 30 | 31 | import java.nio.file.Paths; 32 | import java.util.Arrays; 33 | import java.util.concurrent.TimeUnit; 34 | 35 | @Configuration 36 | public class ConfigBeans { 37 | 38 | @Value("${configFilesPath:./files-bind/build/libs/}") 39 | private String filesPath; // Run with -DconfigFilesPath= parameter to override 40 | 41 | @Bean 42 | public ConfigurationProvider configurationProvider() { 43 | // Specify which files to load. Configuration from both files will be merged. 44 | ConfigFilesProvider configFilesProvider = () -> Arrays.asList(Paths.get("application.yaml"), Paths.get("otherConfig.properties")); 45 | 46 | // Use local files as configuration store 47 | ConfigurationSource source = new FilesConfigurationSource(configFilesProvider); 48 | 49 | // Use relative paths 50 | Environment environment = new ImmutableEnvironment(filesPath); 51 | 52 | // Reload configuration every 5 seconds 53 | ReloadStrategy reloadStrategy = new PeriodicalReloadStrategy(5, TimeUnit.SECONDS); 54 | 55 | // Create provider 56 | return new ConfigurationProviderBuilder() 57 | .withConfigurationSource(source) 58 | .withReloadStrategy(reloadStrategy) 59 | .withEnvironment(environment) 60 | .build(); 61 | } 62 | } 63 | -------------------------------------------------------------------------------- /metrics/src/main/java/org/cfg4j/sample/ConfigBeans.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2015 Norbert Potocki (norbert.potocki@nort.pl) 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package org.cfg4j.sample; 17 | 18 | import com.codahale.metrics.MetricRegistry; 19 | import org.cfg4j.provider.ConfigurationProvider; 20 | import org.cfg4j.provider.ConfigurationProviderBuilder; 21 | import org.cfg4j.source.ConfigurationSource; 22 | import org.cfg4j.source.context.environment.Environment; 23 | import org.cfg4j.source.context.environment.ImmutableEnvironment; 24 | import org.cfg4j.source.context.filesprovider.ConfigFilesProvider; 25 | import org.cfg4j.source.files.FilesConfigurationSource; 26 | import org.cfg4j.source.reload.ReloadStrategy; 27 | import org.cfg4j.source.reload.strategy.PeriodicalReloadStrategy; 28 | import org.springframework.beans.factory.annotation.Autowired; 29 | import org.springframework.beans.factory.annotation.Value; 30 | import org.springframework.context.annotation.Bean; 31 | import org.springframework.context.annotation.Configuration; 32 | 33 | import java.nio.file.Paths; 34 | import java.util.Arrays; 35 | import java.util.Collections; 36 | import java.util.concurrent.TimeUnit; 37 | 38 | @Configuration 39 | public class ConfigBeans { 40 | 41 | @Value("${configFilesPath:./metrics/build/libs/}") 42 | private String filesPath; // Run with -DconfigFilesPath= parameter to override 43 | 44 | @Autowired 45 | private MetricRegistry metricRegistry; 46 | 47 | @Bean 48 | public ConfigurationProvider configurationProvider() { 49 | // Specify which files to load. Configuration from both files will be merged. 50 | ConfigFilesProvider configFilesProvider = () -> Collections.singletonList(Paths.get("application.yaml")); 51 | 52 | // Use local files as configuration store 53 | ConfigurationSource source = new FilesConfigurationSource(configFilesProvider); 54 | 55 | // Use relative paths 56 | Environment environment = new ImmutableEnvironment(filesPath); 57 | 58 | // Reload configuration every 500 milliseconds 59 | ReloadStrategy reloadStrategy = new PeriodicalReloadStrategy(500, TimeUnit.MILLISECONDS); 60 | 61 | // Create provider 62 | return new ConfigurationProviderBuilder() 63 | .withConfigurationSource(source) 64 | .withReloadStrategy(reloadStrategy) 65 | .withEnvironment(environment) 66 | .withMetrics(metricRegistry, "firstProvider.") 67 | .build(); 68 | } 69 | } 70 | -------------------------------------------------------------------------------- /git-multi-file/src/main/java/org/cfg4j/sample/ConfigBeans.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2015 Norbert Potocki (norbert.potocki@nort.pl) 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package org.cfg4j.sample; 17 | 18 | import org.cfg4j.provider.ConfigurationProvider; 19 | import org.cfg4j.provider.ConfigurationProviderBuilder; 20 | import org.cfg4j.source.ConfigurationSource; 21 | import org.cfg4j.source.context.environment.Environment; 22 | import org.cfg4j.source.context.environment.ImmutableEnvironment; 23 | import org.cfg4j.source.context.filesprovider.ConfigFilesProvider; 24 | import org.cfg4j.source.git.GitConfigurationSourceBuilder; 25 | import org.cfg4j.source.reload.ReloadStrategy; 26 | import org.cfg4j.source.reload.strategy.PeriodicalReloadStrategy; 27 | import org.springframework.beans.factory.annotation.Value; 28 | import org.springframework.context.annotation.Bean; 29 | import org.springframework.context.annotation.Configuration; 30 | 31 | import java.nio.file.Paths; 32 | import java.util.Arrays; 33 | import java.util.concurrent.TimeUnit; 34 | 35 | @Configuration 36 | public class ConfigBeans { 37 | 38 | @Value("${configRepoPath:https://github.com/cfg4j/cfg4j-git-sample-config.git}") 39 | private String configRepoPath; // Run with -DconfigRepoPath= parameter to override 40 | 41 | @Value("${configBranch:production-env}") 42 | private String branch; // Run with -DconfigBranch= parameter to override 43 | 44 | @Bean 45 | public ConfigurationProvider configurationProvider() { 46 | // Specify which files to load. Configuration from both files will be merged. 47 | ConfigFilesProvider configFilesProvider = () -> Arrays.asList(Paths.get("application.properties"), Paths.get("otherConfig.properties")); 48 | 49 | // Use Git repository as configuration store 50 | ConfigurationSource source = new GitConfigurationSourceBuilder() 51 | .withRepositoryURI(configRepoPath) 52 | .withConfigFilesProvider(configFilesProvider) 53 | .build(); 54 | 55 | // Select branch to use (use new DefaultEnvironment()) for master 56 | Environment environment = new ImmutableEnvironment(branch); 57 | 58 | // Reload configuration every 5 seconds 59 | ReloadStrategy reloadStrategy = new PeriodicalReloadStrategy(5, TimeUnit.SECONDS); 60 | 61 | // Create provider 62 | return new ConfigurationProviderBuilder() 63 | .withConfigurationSource(source) 64 | .withEnvironment(environment) 65 | .withReloadStrategy(reloadStrategy) 66 | .build(); 67 | } 68 | } 69 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | ############################################################################## 4 | ## 5 | ## Gradle start up script for UN*X 6 | ## 7 | ############################################################################## 8 | 9 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 10 | DEFAULT_JVM_OPTS="" 11 | 12 | APP_NAME="Gradle" 13 | APP_BASE_NAME=`basename "$0"` 14 | 15 | # Use the maximum available, or set MAX_FD != -1 to use that value. 16 | MAX_FD="maximum" 17 | 18 | warn ( ) { 19 | echo "$*" 20 | } 21 | 22 | die ( ) { 23 | echo 24 | echo "$*" 25 | echo 26 | exit 1 27 | } 28 | 29 | # OS specific support (must be 'true' or 'false'). 30 | cygwin=false 31 | msys=false 32 | darwin=false 33 | case "`uname`" in 34 | CYGWIN* ) 35 | cygwin=true 36 | ;; 37 | Darwin* ) 38 | darwin=true 39 | ;; 40 | MINGW* ) 41 | msys=true 42 | ;; 43 | esac 44 | 45 | # For Cygwin, ensure paths are in UNIX format before anything is touched. 46 | if $cygwin ; then 47 | [ -n "$JAVA_HOME" ] && JAVA_HOME=`cygpath --unix "$JAVA_HOME"` 48 | fi 49 | 50 | # Attempt to set APP_HOME 51 | # Resolve links: $0 may be a link 52 | PRG="$0" 53 | # Need this for relative symlinks. 54 | while [ -h "$PRG" ] ; do 55 | ls=`ls -ld "$PRG"` 56 | link=`expr "$ls" : '.*-> \(.*\)$'` 57 | if expr "$link" : '/.*' > /dev/null; then 58 | PRG="$link" 59 | else 60 | PRG=`dirname "$PRG"`"/$link" 61 | fi 62 | done 63 | SAVED="`pwd`" 64 | cd "`dirname \"$PRG\"`/" >&- 65 | APP_HOME="`pwd -P`" 66 | cd "$SAVED" >&- 67 | 68 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 69 | 70 | # Determine the Java command to use to start the JVM. 71 | if [ -n "$JAVA_HOME" ] ; then 72 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 73 | # IBM's JDK on AIX uses strange locations for the executables 74 | JAVACMD="$JAVA_HOME/jre/sh/java" 75 | else 76 | JAVACMD="$JAVA_HOME/bin/java" 77 | fi 78 | if [ ! -x "$JAVACMD" ] ; then 79 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 80 | 81 | Please set the JAVA_HOME variable in your environment to match the 82 | location of your Java installation." 83 | fi 84 | else 85 | JAVACMD="java" 86 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 87 | 88 | Please set the JAVA_HOME variable in your environment to match the 89 | location of your Java installation." 90 | fi 91 | 92 | # Increase the maximum file descriptors if we can. 93 | if [ "$cygwin" = "false" -a "$darwin" = "false" ] ; then 94 | MAX_FD_LIMIT=`ulimit -H -n` 95 | if [ $? -eq 0 ] ; then 96 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then 97 | MAX_FD="$MAX_FD_LIMIT" 98 | fi 99 | ulimit -n $MAX_FD 100 | if [ $? -ne 0 ] ; then 101 | warn "Could not set maximum file descriptor limit: $MAX_FD" 102 | fi 103 | else 104 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" 105 | fi 106 | fi 107 | 108 | # For Darwin, add options to specify how the application appears in the dock 109 | if $darwin; then 110 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" 111 | fi 112 | 113 | # For Cygwin, switch paths to Windows format before running java 114 | if $cygwin ; then 115 | APP_HOME=`cygpath --path --mixed "$APP_HOME"` 116 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` 117 | 118 | # We build the pattern for arguments to be converted via cygpath 119 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` 120 | SEP="" 121 | for dir in $ROOTDIRSRAW ; do 122 | ROOTDIRS="$ROOTDIRS$SEP$dir" 123 | SEP="|" 124 | done 125 | OURCYGPATTERN="(^($ROOTDIRS))" 126 | # Add a user-defined pattern to the cygpath arguments 127 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then 128 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" 129 | fi 130 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 131 | i=0 132 | for arg in "$@" ; do 133 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` 134 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option 135 | 136 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition 137 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` 138 | else 139 | eval `echo args$i`="\"$arg\"" 140 | fi 141 | i=$((i+1)) 142 | done 143 | case $i in 144 | (0) set -- ;; 145 | (1) set -- "$args0" ;; 146 | (2) set -- "$args0" "$args1" ;; 147 | (3) set -- "$args0" "$args1" "$args2" ;; 148 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;; 149 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; 150 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; 151 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; 152 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; 153 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; 154 | esac 155 | fi 156 | 157 | # Split up the JVM_OPTS And GRADLE_OPTS values into an array, following the shell quoting and substitution rules 158 | function splitJvmOpts() { 159 | JVM_OPTS=("$@") 160 | } 161 | eval splitJvmOpts $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS 162 | JVM_OPTS[${#JVM_OPTS[*]}]="-Dorg.gradle.appname=$APP_BASE_NAME" 163 | 164 | exec "$JAVACMD" "${JVM_OPTS[@]}" -classpath "$CLASSPATH" org.gradle.wrapper.GradleWrapperMain "$@" 165 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | --------------------------------------------------------------------------------