https://github.com/samply/common-config
The library for all samply config files
https://github.com/samply/common-config
Last synced: 3 months ago
JSON representation
The library for all samply config files
- Host: GitHub
- URL: https://github.com/samply/common-config
- Owner: samply
- License: apache-2.0
- Created: 2020-10-05T12:05:46.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-03-17T09:35:21.000Z (about 3 years ago)
- Last Synced: 2024-12-30T07:14:07.768Z (5 months ago)
- Language: Java
- Size: 125 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Samply Common Config
This library offers utilities to find and deserialize configuration files
depending on the operating system. It also offers configuration objects that
have been created from XSD files with `xjc`.
## Usage
The application must use a `prefix`, which defines the properties and
environment variables that are used to find the requested file.
Use the FileFinderUtil to find a configuration file, e.g.
```
File file = FileFinderUtil.findFile("config.xml", "samply");
```
The FileFinderUtil will now search for the `config.xml` file
in the following locations:
- location defined by the Java property `samply.confdir` (defined at runtime with the `-Dsamply.confdir` argument)
- location defined by the environment variable `SAMPLY_CONFDIR` (defined at runtime with `SAMPLY_CONFDIR=`)
- user home directory (`~/.config/samply/`, e.g. `home/paul/.config/samply` on Linux, `C:\Users\paul\.config\samply` on Windows)
- OS Specific location (e.g. `/etc/samply/` for Linux, uses the location
defined in the Registry `HKEY_LOCAL_MACHINE/SOFTWARE/SAMPLY/ConfDir` for
Windows Systems) for files that are likely to be changed by the user/administrator
- OS Specific location (e.g. `/usr/local/share/` for Linux, uses the location
defined in the Registry `HKEY_LOCAL_MACHINE/SOFTWARE/SAMPLY/ConfDistDir` for
Windows Systems) for files that remain untouched
- the location defined by the `fallback` parameter, if there is one
You can also use the JAXBUtil to deserialize an XML file into an object. If possible you
should use the ObjectFactory in the JAXBContext, e.g.
```
Postgresql sql = JAXBUtil.unmarshall(file, JAXBContext.newInstance(ObjectFactory.class), Postgresql.class);
```
This method will unmarshall the given file into a Postgresql instance.
## Build
Use maven to build the jar:
```
mvn clean package
```
Use it as a dependency:
```xml
de.samply
common-config
VERSION
```
## License
Copyright 2020 The Samply Development Community
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.