Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/scalecube/scalecube-config
ScaleCube Config is a configuration access management library for JVM based distributed applications
https://github.com/scalecube/scalecube-config
configuration configuration-registry distributed java jvm
Last synced: 3 months ago
JSON representation
ScaleCube Config is a configuration access management library for JVM based distributed applications
- Host: GitHub
- URL: https://github.com/scalecube/scalecube-config
- Owner: scalecube
- License: apache-2.0
- Created: 2017-08-15T16:01:53.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-10-08T18:42:45.000Z (4 months ago)
- Last Synced: 2024-10-16T03:41:11.950Z (4 months ago)
- Topics: configuration, configuration-registry, distributed, java, jvm
- Language: Java
- Homepage: http://scalecube.io
- Size: 861 KB
- Stars: 16
- Watchers: 16
- Forks: 4
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# ScaleCube Config
[](https://maven-badges.herokuapp.com/maven-central/io.scalecube/config)
ScaleCube Config is a configuration management library for JVM based distributed applications.
It provides the following functionality:
* Dynamic typed properties
* Register callbacks on property changes
* Object binding for grouping properties
* Extensible range of supported property sources (environment variables, program arguments, classpath, property files, mongodb, git repository, zookeeper etc.)
* Support centralized hierarchical property sources
* Control over order of applying different property sources
* Audit log of property changes
* Expose properties and settings via JMX and/or HTTP
## Usage
Configure and create configuration registry instance:
``` java
Predicate predicate = path -> path.toString().endsWith(".props"); // match by .props extension
ConfigRegistrySettings settings = ConfigRegistrySettings.builder()
.addLastSource("classpath", new ClassPathConfigSource(predicate))
.addLastSource("configDirectory", new DirectoryConfigSource("conf" /* base path */, predicate))
.addListener(new Slf4JConfigEventListener()) // print all property changes to log
.build();
ConfigRegistry configRegistry = ConfigRegistry.create(settings);
```
Get dynamic typed configuration property:
``` java
LongConfigProperty timeoutProperty = configRegistry.longProperty("http.request-timeout");
long timeout = timeoutProperty.get(30 /* default value */);
```
Register callbacks on property modifications:
``` java
timeoutProperty.addCallback((oldValue, newValue) ->
System.out.println("Timeout value changed to " + newValue));
```
Register validators on property values (only values which passed all validators will be applied):
``` java
timeoutProperty.addValidator(val -> val >= 0); // timeout can't be negative
```
Utilize object binding:
``` java
// Define configuration class
public interface MyConfig {
private boolean meaning;
private int answer;
private double realAnswer;
...
}
// myapp.config.meaning=true
// myapp.config.answer=42
// myapp.config.realAnswer=42.000000000000001
ObjectConfigProperty config = configRegistry.objectProperty("myapp.config", MyConfig.class);
// Get current config values
MyConfig currentConfig = config.value(MyConfig.defaultValue() /* or default */);
// Register callback (called only once per config reload even when several properties changed)
config.addCallback((oldConfig, newConfig) ->
System.out.println("MyConfig updated from " + oldConfig + " to " + newConfig));
// Register validator
// If meaning is present, an answer should be at least as big as the answer
config.addValidator(val -> val.meaning && val.answer >= 42);
```
Start embedded HTTP server which exposes configuration endpoints:
``` java
ConfigRegistryHttpServer.create(configRegistry, 5050); // starts http server on port 5050
```
After HTTP server is started explore configuration registry by browsing following endpoints:
* [http://localhost:5050/_config/properties](http://localhost:5050/_config/properties)
* [http://localhost:5050/_config/sources](http://localhost:5050/_config/sources)
* [http://localhost:5050/_config/events](http://localhost:5050/_config/events)
* [http://localhost:5050/_config/settings](http://localhost:5050/_config/settings)
See more examples at [config-examples](https://github.com/scalecube/scalecube-config/tree/master/config-examples/src/main/java/io/scalecube/config/examples) module.
## Maven
Binaries and dependency information for Maven can be found at
[http://search.maven.org](http://search.maven.org/#search%7Cga%7C1%7Cio.scalecube.config).
Change history and [version numbers](http://semver.org/) can be found at [CHANGES.md](https://github.com/scalecube/scalecube-config/blob/master/CHANGES.md).
Maven dependency:
``` xml
io.scalecube
config
x.y.z
io.scalecube
config-http-server
x.y.z
io.scalecube
config-mongo
x.y.z
```
## Bugs and Feedback
For bugs, questions and discussions please use the [GitHub Issues](https://github.com/scalecube/scalecube-config/issues).
## License
[Apache License, Version 2.0](https://github.com/scalecube/scalecube-config/blob/master/LICENSE.txt)