Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/amihaiemil/docker-java-api
Lightweight Java Docker client
https://github.com/amihaiemil/docker-java-api
docker docker-client docker-java-api elegantobjects java-8 oop-library
Last synced: 13 days ago
JSON representation
Lightweight Java Docker client
- Host: GitHub
- URL: https://github.com/amihaiemil/docker-java-api
- Owner: amihaiemil
- License: bsd-3-clause
- Created: 2018-01-28T09:06:36.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2021-06-04T01:21:45.000Z (over 3 years ago)
- Last Synced: 2024-10-12T15:40:57.969Z (about 1 month ago)
- Topics: docker, docker-client, docker-java-api, elegantobjects, java-8, oop-library
- Language: Java
- Homepage:
- Size: 750 KB
- Stars: 269
- Watchers: 21
- Forks: 53
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-docker - docker-java-api - Lightweight, truly object-oriented, Java client for Docker's API. By [@amihaiemil](https://github.com/amihaiemil) (Development with Docker / API Client)
- awesome-docker - docker-java-api - Lightweight, truly object-oriented, Java client for Docker's API. By [@amihaiemil](https://github.com/amihaiemil) (Development with Docker / API Client)
README
### docker-java-api
[](https://www.0crat.com/p/G6LPQQV2P)
[](https://travis-ci.org/amihaiemil/docker-java-api)
[](https://coveralls.io/github/amihaiemil/docker-java-api?branch=master)
[](https://hitsofcode.com/view/github/amihaiemil/docker-java-api)
[](https://www.0crat.com/contrib/G6LPQQV2P)
[](http://www.rultor.com/p/amihaiemil/docker-java-api)
[](https://www.jetbrains.com/idea/)
Lightweight, object-oriented, Docker client for Java
A Java library for the Docker Engine API. It is the equivalent of the ``docker`` command-line client, for Java applications.
Unlike other docker clients for Java, this one aims to be as lightweight as possible, with as few transitive dependencies as possible and it should cause absolutely no runtime conflicts with other frameworks or platforms like Java EE.
Another target is that this library should be a true API, not an SDK. Read [this](http://www.amihaiemil.com/2018/03/10/java-api-for-docker.html) blog post and [the wiki](https://github.com/amihaiemil/docker-java-api/wiki) for more details.
### Maven dependency
The library comes as a maven dependency:
```xml
com.amihaiemil.web
docker-java-api
0.0.13
```
**In order for it to work, you need to have an implementation of [JSON-P (JSR 374)](https://javaee.github.io/jsonp/index.html) in your classpath (it doesn't come transitively since most people are using Java EE APIs so, chances are it is already provided!). If you have no idea what this means, go [here](https://github.com/amihaiemil/docker-java-api/wiki/What-It-Is#implementation).**
If you are not using Maven, you can also download the fat jar.
### Usage Example And Wiki
Here is all you need to do in order to pull an Image and run a Container into the local Docker engine:
```java
final Container started = new UnixDocker(new File("/var/run/docker.sock"))
.images()
.pull("hello-world", "latest")
.run();
```
or, the same code snippet, less fluent:
```java
final Docker docker = new UnixDocker(new File("/var/run/docker.sock"));
final Images images = docker.images();
for(final Image image : images){
//iterate over the existing images
}
final Image helloWorld = images.pull("hello-world", "latest");
final Container started = helloWorld.run();
```
More info in the [Wiki](https://github.com/amihaiemil/docker-java-api/wiki).
### Contributing
If you would like to contribute, just open an issue or a PR.
Make sure the maven build:
``$mvn clean install -Pcheckstyle``
passes before making a PR. [Checkstyle](http://checkstyle.sourceforge.net/) will make sure
you're following our code style and guidlines.
### Running Integration Tests
In order to run the integration tests add the ``itcases`` profile to the maven command:
``$mvn clean install -Pcheckstyle -Pitcases``
Docker has to be installed and the ubuntu:latest image should be pulled on the machine, with the default configuration, in order for the IT cases to work.
### Stargazers over time
[](https://starchart.cc/amihaiemil/docker-java-api)