* Added Image.puller() for pulling images.

* Converted Image.pusher() from static to member method.
* Renamed ImageBuilder.dockerFile() to dockerfile().
* Added Container for creating and running containers.
* Automatically exclude files from the build context based on the contents of Dockerfile and .dockerignore
  files.
* Image.getById() and Image.tag() now throw ImageNotFoundException instead of FileNotFoundException
  when an image is not found.
* Replaced Image.getByDigest() with Image.getByPredicate().
* ImagePusher no longer sends platform if it's not set.
* Bugfixes
  * Image.getById(), ImagePusher.push() now handle image names that contain a slash (e.g. alpine/helm).
  * Looking up images was always failing because the code was looking for JSON property "id" instead of "Id".

Author: cowwoc

LICENSE-3RD-PARTY.md

@@ -23,10 +23,6 @@
     * [Core :: Utilities](https://jetty.org/jetty-core/jetty-util)
   * BSD 3-clause:
     * [ThreeTen-Extra](https://www.threeten.org/threeten-extra)
-  * Bouncy Castle Licence:
-    * [Bouncy Castle PKIX, CMS, EAC, TSP, PKCS, OCSP, CMP, and CRMF APIs](https://www.bouncycastle.org/java.html)
-    * [Bouncy Castle Provider](https://www.bouncycastle.org/java.html)
-    * [Bouncy Castle ASN.1 Extension and Utility APIs](https://www.bouncycastle.org/java.html)
   * Eclipse Public License - Version 2.0:
     * [Core :: ALPN :: Client](https://jetty.org/jetty-core/jetty-alpn/jetty-alpn-client)
     * [Core :: HTTP Client](https://jetty.org/jetty-core/jetty-client)

README.md

@@ -41,7 +41,7 @@ class Example
       assert (image2.equals(image));
 
       image.tag("rocket-ship", "local-tag");
-      Image.pusher(client, "rocket-ship", "remote-tag").
+      image.pusher(client, "rocket-ship", "remote-tag").
         credentials("username", "Pa33word").
         push();
     }

docs/changelog.md

@@ -2,6 +2,22 @@ Minor updates involving cosmetic changes have been omitted from this list.
 
 See https://github.com/cowwoc/docker/commits/main for a full list.
 
+## Version 0.5 - 2025/01/16
+
+* Added `Image.puller()` for pulling images.
+* Converted `Image.pusher()` from static to member method.
+* Renamed `ImageBuilder.dockerFile()` to `dockerfile()`.
+* Added `Container` for creating and running containers.
+* Automatically exclude files from the build context based on the contents of `Dockerfile` and `.dockerignore`
+  files.
+* `Image.getById()` and `Image.tag()` now throw `ImageNotFoundException` instead of `FileNotFoundException`
+  when an image is not found.
+* Replaced `Image.getByDigest()` with `Image.getByPredicate()`.
+* `ImagePusher` no longer sends `platform` if it's not set.
+* Bugfixes
+  * `Image.getById()`, `ImagePusher.push()` now handle image names that contain a slash (e.g. `alpine/helm`).
+  * Looking up images was always failing because the code was looking for JSON property `id` instead of `Id`.
+
 ## Version 0.4 - 2025/01/01
 
 * Bugfixes

pom.xml

@@ -1,5 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 	<modelVersion>4.0.0</modelVersion>
 	<groupId>com.github.cowwoc.docker</groupId>
 	<artifactId>docker</artifactId>
@@ -52,7 +53,7 @@
 		<pmd.version>7.9.0</pmd.version>
 		<maven.checkstyle.version>3.6.0</maven.checkstyle.version>
 		<checkstyle.failOnViolation>true</checkstyle.failOnViolation>
-		<requirements.version>10.5</requirements.version>
+		<requirements.version>10.9</requirements.version>
 	</properties>
 
 	<dependencies>
@@ -64,7 +65,7 @@
 		<dependency>
 			<groupId>ch.qos.logback</groupId>
 			<artifactId>logback-classic</artifactId>
-			<version>1.5.15</version>
+			<version>1.5.16</version>
 		</dependency>
 		<dependency>
 			<groupId>org.eclipse.jetty</groupId>
@@ -96,11 +97,6 @@
 			<artifactId>sshd-osgi</artifactId>
 			<version>2.14.0</version>
 		</dependency>
-		<dependency>
-			<groupId>org.bouncycastle</groupId>
-			<artifactId>bcpkix-jdk18on</artifactId>
-			<version>1.79</version>
-		</dependency>
 		<dependency>
 			<groupId>org.threeten</groupId>
 			<artifactId>threeten-extra</artifactId>

src/main/java/com/github/cowwoc/docker/client/DockerClient.java

@@ -16,9 +16,9 @@
 public interface DockerClient extends AutoCloseable, InternalClient
 {
 	/**
-	 * Creates a client that communicates over a Unix socket.
+	 * Creates a client that communicates with the server over a Unix socket.
 	 *
-	 * @param path the path of the unix path (e.g. {@code /var/run/docker.sock})
+	 * @param path the unix socket of the REST server (e.g. {@code /var/run/docker.sock})
 	 * @return a new client
 	 * @throws NullPointerException if {@code path} is null
 	 */
@@ -29,9 +29,9 @@ static DockerClient usingUnixSocket(Path path)
 	}
 
 	/**
-	 * Creates a client that communicates over TCP/IP.
+	 * Creates a client that communicates with the server over TCP/IP.
 	 *
-	 * @param uri the URI of the REST API server (e.g. {@code http://localhost:2375/})
+	 * @param uri the URI of the REST server (e.g. {@code http://localhost:2375/})
 	 * @return a new client
 	 * @throws NullPointerException if {@code uri} is null
 	 */
@@ -41,9 +41,9 @@ static DockerClient usingTcpIp(URI uri)
 	}
 
 	/**
-	 * Determines if the client was closed.
+	 * Determines if the client is closed.
 	 *
-	 * @return {@code true} if the client was closed
+	 * @return {@code true} if the client is closed
 	 */
 	boolean isClosed();
 

src/main/java/com/github/cowwoc/docker/exception/ContainerAlreadyStartedException.java

@@ -0,0 +1,45 @@
+package com.github.cowwoc.docker.exception;
+
+import com.github.cowwoc.docker.resource.Container;
+
+import java.io.Serial;
+
+import static com.github.cowwoc.requirements10.java.DefaultJavaValidators.requireThat;
+
+/**
+ * Thrown if the user attempts to start a container that is already started.
+ */
+public class ContainerAlreadyStartedException extends Exception
+{
+	@Serial
+	private static final long serialVersionUID = 0L;
+	private transient final Container container;
+
+	/**
+	 * Creates a new instance.
+	 *
+	 * @param container the container
+	 * @throws NullPointerException if {@code container} is null
+	 */
+	public ContainerAlreadyStartedException(Container container)
+	{
+		super(getMessage(container));
+		this.container = container;
+	}
+
+	private static String getMessage(Container container)
+	{
+		requireThat(container, "container").isNotNull();
+		return container.getName() + " (" + container.getId() + ") already started";
+	}
+
+	/**
+	 * Returns the container.
+	 *
+	 * @return the container
+	 */
+	public Container getContainer()
+	{
+		return container;
+	}
+}

src/main/java/com/github/cowwoc/docker/exception/ContainerNotFoundException.java

@@ -0,0 +1,34 @@
+package com.github.cowwoc.docker.exception;
+
+import java.io.IOException;
+import java.io.Serial;
+
+/**
+ * Thrown if a referenced container does not exist.
+ */
+public class ContainerNotFoundException extends IOException
+{
+	@Serial
+	private static final long serialVersionUID = 0L;
+
+	/**
+	 * Creates a new instance.
+	 *
+	 * @param message an explanation of what went wrong
+	 */
+	public ContainerNotFoundException(String message)
+	{
+		super(message);
+	}
+
+	/**
+	 * Creates a new instance.
+	 *
+	 * @param cause the underlying exception
+	 * @throws NullPointerException if {@code cause} is null
+	 */
+	public ContainerNotFoundException(Throwable cause)
+	{
+		super(cause);
+	}
+}

src/main/java/com/github/cowwoc/docker/exception/ImageNotFoundException.java

@@ -1,11 +1,12 @@
 package com.github.cowwoc.docker.exception;
 
+import java.io.IOException;
 import java.io.Serial;
 
 /**
  * Thrown if a referenced image does not exist.
  */
-public class ImageNotFoundException extends Exception
+public class ImageNotFoundException extends IOException
 {
 	@Serial
 	private static final long serialVersionUID = 0L;
@@ -19,4 +20,14 @@ public ImageNotFoundException(String message)
 	{
 		super(message);
 	}
+
+	/**
+	 * Creates a new instance.
+	 *
+	 * @param cause the underlying exception
+	 */
+	public ImageNotFoundException(Throwable cause)
+	{
+		super(cause);
+	}
 }