Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/florianmichael/checkhost4j
Java implementation of the check-host.net API
https://github.com/florianmichael/checkhost4j
check-host checkhost checkhostnet http ping tcp udp web
Last synced: 3 months ago
JSON representation
Java implementation of the check-host.net API
- Host: GitHub
- URL: https://github.com/florianmichael/checkhost4j
- Owner: FlorianMichael
- License: apache-2.0
- Created: 2023-05-16T19:14:54.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-15T07:52:56.000Z (5 months ago)
- Last Synced: 2024-09-15T10:49:01.703Z (5 months ago)
- Topics: check-host, checkhost, checkhostnet, http, ping, tcp, udp, web
- Language: Java
- Homepage:
- Size: 296 KB
- Stars: 7
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# CheckHost4J
Java implementation of the check-host.net API
## Contact
If you encounter any issues, please report them on the [issue tracker](https://github.com/FlorianMichael/CheckHost4J/issues).
If you just want to talk or need help with CheckHost4J feel free to join my [Discord](https://discord.gg/BwWhCHUKDf).
## How to add this to your project
### Gradle/Maven
To use CheckHost4J with Gradle/Maven you can use [Maven Central](https://mvnrepository.com/artifact/de.florianmichael/CheckHost4J), [Lenni0451's Maven](https://maven.lenni0451.net/#/releases/de/florianmichael/CheckHost4J) or [Jitpack](https://jitpack.io/#FlorianMichael/CheckHost4J).
You can also find instructions how to implement it into your build script there.
### Jar File
If you just want the latest jar file you can download it from the GitHub [Actions](https://github.com/FlorianMichael/CheckHost4J/actions) or use the [Release](https://github.com/FlorianMichael/CheckHost4J/releases).
This library requires you to have [Gson](https://mvnrepository.com/artifact/com.google.code.gson/gson/2.10.1) in your
class path
## API Terminology
The API main class is `CheckHost4J`, it contains all the methods to interact with the API.
```java
final CheckHost4J checkHost = CheckHost4J.INSTANCE;
```
You can either use the `CheckHost4J.INSTANCE` or create a new instance of `CheckHost4J` yourself, by creating
an own instance you can define the `IRequester` yourself, which is used to send the requests to the API.
```java
final CheckHost4J checkHost = new CheckHost4J(...);
```
The default `IRequester` is `JavaRequester`, which can be accessed via `JavaRequester.INSTANCE`, you can also
create a new instance using `new JavaRequester("")`.
```java
final CheckHost4J checkHost = new CheckHost4J(new JavaRequester("MyUserAgent"));
```
You can use the methods `CheckHost4J#ping`, `CheckHost4J#http`, `CheckHost4J#tcpPort`, `CheckHost4J#udpPort`
and `CheckHost4J#dns`
to get a `ResultNode` where T is the result type of the request (e.g. `PingResult`, `TCPResult`).
```java
final ResultNode pingResult = checkHost.ping("example.com", 80 /* max nodes */);
```
After you got the `ResultNode` you can use the `tickResults()` to update the `getResults()` list.
```java
// This will update the results list by sending the check-result request to the API,
// This might not update all results, because some might not be finished yet
// Which means you have to call this method multiple times to get all results (e.g. with a delay of 5 seconds)
pingResult.tickResults();
final Map results = pingResult.getResults();
results.forEach((serverNode, result) -> {
if (result == null) { // All results which are not finished yet will be null
System.out.println(serverNode.name + " is still checking...");
} else if (result.getErrorMessage() != null) {
System.out.println(serverNode.name + " failed: " + result.getErrorMessage());
} else {
System.out.println(serverNode.name + " responded: " + result.getSuccessfulPings() + "/" + result.getTotalPings());
}
});
```
You can also get all the server nodes which are being checked by using the `getNodes()` method.
```java
final List nodes = pingResult.getNodes();
```
The `de.florianmichael.checkhost4j.model.result` package contains all the result classes, which are used
to store the result of the requests.
To get a list of all Request types you can use the `ResultType` enum.