Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/spotify/dns-java
DNS wrapper library that provides SRV lookup functionality
https://github.com/spotify/dns-java
dns dnsjava srv
Last synced: 6 days ago
JSON representation
DNS wrapper library that provides SRV lookup functionality
- Host: GitHub
- URL: https://github.com/spotify/dns-java
- Owner: spotify
- License: apache-2.0
- Created: 2014-03-11T13:16:54.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2023-07-03T08:46:30.000Z (over 1 year ago)
- Last Synced: 2024-04-14T20:17:05.830Z (7 months ago)
- Topics: dns, dnsjava, srv
- Language: Java
- Size: 239 KB
- Stars: 203
- Watchers: 108
- Forks: 45
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# DEPRECATION NOTICE
This repo is no longer actively maintained. While it should continue to work and there are no major known bugs, we will not be improving dns-java or releasing new versions.
[](https://circleci.com/gh/spotify/dns-java)
[](https://coveralls.io/github/spotify/dns-java?branch=master)
[](https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.spotify%22%20dns*)
[](LICENSE)
spotify-dns-java
================
This small DNS wrapper library provides some useful pieces of functionality related to SRV lookups.
## Resilience
Sometimes it is useful to default to previously returned, retained values, if a dns lookup should
fail or return an empty result. This behavior is controlled by the ```retainingDataOnFailures()```
and ```retentionDurationMillis(long)``` methods in
[DnsSrvResolvers.DnsSrvResolverBuilder](src/main/java/com/spotify/dns/DnsSrvResolvers.java).
## Watching for Changes
It's often useful to update where you try to connect based on changes in lookup results, and this library
provides functionality that allows you to get notified when things change by implementing this interface (defined in the [ChangeNotifier](src/main/java/com/spotify/dns/ChangeNotifier.java) interface):
```java
interface Listener {
/**
* Signal that set of records changed.
*
* @param changeNotification An object containing details about the change
*/
void onChange(ChangeNotification changeNotification);
}
/**
* A change event containing the current and previous set of records.
*/
interface ChangeNotification {
Set current();
Set previous();
}
```
Take a look at the [PollingUsage example](src/test/java/com/spotify/dns/examples/PollingUsage.java) for an example.
## Metrics
If you have a statistics system that can be integrated with using the munin protocol, the method
metered() in DnsSrvResolvers.DnsSrvResolverBuilder enables this in conjunction with the spotify
munin forwarder. Have a look at the
[BasicUsage example](src/test/java/com/spotify/dns/examples/BasicUsage.java) for details on how to
set that up.
## Usage
The entry point to lookups is through an instance of
[DnsSrvResolver](src/main/java/com/spotify/dns/DnsSrvResolver.java) obtained via the
[DnsSrvResolvers](src/main/java/com/spotify/dns/DnsSrvResolvers.java) factory class.
To periodically check a set of records and react to changes, use the
[DnsSrvWatcher](src/main/java/com/spotify/dns/DnsSrvWatcher.java) interface obtained via the
[DnsSrvWatchers](src/main/java/com/spotify/dns/DnsSrvWatchers.java) factory class.
For example code, have a look at
[BasicUsage example](src/test/java/com/spotify/dns/examples/BasicUsage.java) and
[PollingUsage example](src/test/java/com/spotify/dns/examples/PollingUsage.java)
To include the latest released version in your maven project, do:
```xml
com.spotify
dns
3.2.2
```
NOTE: version 3.1.0 is broken; you cannot use the retention feature in that version.
## License
This software is released under the Apache License 2.0. More information in the file LICENSE
distributed with this project.