Merge branch 'master' into issue-235-Networks-create

src/main/java/com/amihaiemil/docker/FilteredUriBuilder.java

@@ -0,0 +1,67 @@
+/**
+ * Copyright (c) 2018, Mihai Emil Andronache
+ * All rights reserved.
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * 1)Redistributions of source code must retain the above copyright notice,
+ * this list of conditions and the following disclaimer.
+ * 2)Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following disclaimer in the documentation
+ * and/or other materials provided with the distribution.
+ * 3)Neither the name of docker-java-api nor the names of its
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+package com.amihaiemil.docker;
+
+import org.apache.http.client.utils.URIBuilder;
+
+import java.net.URI;
+import java.util.Map;
+
+/**
+ * {@link URIBuilder} with filtering.
+ * @author Paulo Lobo (pauloeduardolobo@gmail.com)
+ * @version $Id$
+ * @since 0.0.7
+ */
+final class FilteredUriBuilder extends URIBuilder {
+
+    /**
+     * Wrapped {@link URIBuilder}.
+     */
+    private final URIBuilder origin;
+
+    /**
+     * Filters.
+     */
+    private final Map<String, Iterable<String>> filters;
+
+    /**
+     * Constructor.
+     *
+     * @param builder Wrapped builder.
+     * @param filters Filters.
+     */
+    FilteredUriBuilder(final URIBuilder builder,
+        final Map<String, Iterable<String>> filters){
+        this.origin = builder;
+        this.filters = filters;
+    }
+
+    @Override
+    public URI build() {
+        throw new UnsupportedOperationException("filters not implemented yet");
+    }
+}

src/main/java/com/amihaiemil/docker/ListedImages.java

@@ -28,9 +28,6 @@
 import org.apache.http.client.HttpClient;
 import org.apache.http.client.methods.HttpGet;
 
-import javax.json.Json;
-import javax.json.JsonArrayBuilder;
-import javax.json.JsonObjectBuilder;
 import java.net.URI;
 import java.util.Collections;
 import java.util.HashMap;
@@ -80,18 +77,8 @@ final class ListedImages extends RtImages {
     public Iterator<Image> iterator() {
         final UncheckedUriBuilder uri = new UncheckedUriBuilder(
             super.baseUri().toString().concat("/json")
-        );
-        if (!this.filters.isEmpty()) {
-            final JsonObjectBuilder json = Json.createObjectBuilder();
-            this.filters.forEach(
-                (name, values) -> {
-                    final JsonArrayBuilder array = Json.createArrayBuilder();
-                    values.forEach(array::add);
-                    json.add(name, array);
-                }
-            );
-            uri.addParameter("filters", json.build().toString());
-        }
+        ).addFilters(this.filters);
+
         return new ResourcesIterator<>(
             super.client(),
             new HttpGet(uri.build()),

src/main/java/com/amihaiemil/docker/ListedPlugins.java

@@ -0,0 +1,63 @@
+/**
+ * Copyright (c) 2018, Mihai Emil Andronache
+ * All rights reserved.
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * 1)Redistributions of source code must retain the above copyright notice,
+ * this list of conditions and the following disclaimer.
+ * 2)Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following disclaimer in the documentation
+ * and/or other materials provided with the distribution.
+ * 3)Neither the name of docker-java-api nor the names of its
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+package com.amihaiemil.docker;
+
+import java.net.URI;
+import java.util.Iterator;
+import org.apache.http.client.HttpClient;
+
+/**
+ * Listed plugins.
+ * @author Boris Kuzmic (boris.kuzmic@gmail.com)
+ * @since 0.0.7
+ * @todo #231:30min Implement ListedPlugins iterator with filtering using Map.
+ *  See ListedImages or ListedVolumes as examples.
+ */
+final class ListedPlugins extends RtPlugins {
+
+    /**
+     * Ctor.
+     *
+     * @param client The http client.
+     * @param uri The URI for this Network API.
+     * @param dkr The docker entry point.
+     */
+    ListedPlugins(final HttpClient client, final URI uri, final Docker dkr) {
+        super(client, uri, dkr);
+    }
+
+    @Override
+    public Iterator<Plugin> iterator() {
+        throw new UnsupportedOperationException(
+            String.join(" ",
+                "ListedPlugins.iterator() is not yet implemented.",
+                "If you can contribute please",
+                "do it here: https://www.github.com/amihaiemil/docker-java-api"
+            )
+        );
+    }
+
+}

src/main/java/com/amihaiemil/docker/ListedVolumes.java

@@ -37,9 +37,6 @@
  * @author Marco Teixeira (marcoo.teixeira@gmail.com)
  * @version $Id$
  * @since 0.0.6
- * @todo #207:30min Finish implementation here, add a Map to this class, that
- *  would hold the actual filters and apply them when making the call in the
- *  iterator() method. Then uncomment filtering test in ListedVolumesTestCase.
  */
 final class ListedVolumes extends RtVolumes {
 
@@ -74,12 +71,14 @@ final class ListedVolumes extends RtVolumes {
 
     @Override
     public Iterator<Volume> iterator() {
+        final UncheckedUriBuilder uri = new UncheckedUriBuilder(
+                super.baseUri().toString()
+        ).addFilters(this.filters);
+
         return new ResourcesIterator<>(
             super.client(),
             new HttpGet(
-                String.format("%s/%s",
-                    super.baseUri().toString(),
-                    "volumes")
+                uri.build()
             ),
             volume -> new RtVolume(
                 volume,

src/main/java/com/amihaiemil/docker/Plugins.java

@@ -26,39 +26,42 @@
 package com.amihaiemil.docker;
 
 import java.io.IOException;
+import javax.json.JsonArray;
 
 /**
  * Plugins API.
  * @author Boris Kuzmic (boris.kuzmic@gmail.com)
  * @since 0.0.7
- * @todo #208:30min Continue implementing Plugins API methods. More information
- *  about available methods:
- *  https://docs.docker.com/engine/api/v1.35/#tag/Plugin
+ * @todo #232:30min Implement getting plugin privileges. More information
+ *  about API method can be found at:
+ *  https://docs.docker.com/engine/api/v1.35/#operation/GetPluginPrivileges
  */
-public interface Plugins {
+public interface Plugins extends Iterable<Plugin> {
 
     /**
      * Create a plugin.
      * @param name Name of the plugin.
+     * @param directory Path to plugin's data dir.
      * @throws IOException If something goes wrong.
      * @throws UnexpectedResponseException If the status response is not
      *  the expected one (200 OK).
      * @see <a href="https://docs.docker.com/engine/api/v1.35/#operation/PluginCreate">Create a plugin</a>
      */
-    void create(final String name)
+    void create(final String name, final String directory)
         throws IOException, UnexpectedResponseException;
 
     /**
      * Pulls and installs a plugin.
      * @param remote Remote reference for plugin to install.
      * @param name Local name for the pulled plugin.
-     * @return The installed {@link Plugin}.
+     * @param properties Json Array of plugin key-value properties.
      * @throws IOException If something goes wrong.
      * @throws UnexpectedResponseException If the status response is not
      *  the expected one (200 OK).
      * @see <a href="https://docs.docker.com/engine/api/v1.35/#operation/PluginPull">Install a plugin</a>
      */
-    Plugin pullAndInstall(final String remote, final String name)
+    void pullAndInstall(final String remote, final String name,
+                          final JsonArray properties)
         throws IOException, UnexpectedResponseException;
 
 }

src/main/java/com/amihaiemil/docker/RtPlugins.java

@@ -0,0 +1,99 @@
+package com.amihaiemil.docker;
+
+import java.io.IOException;
+import java.net.URI;
+import javax.json.JsonArray;
+import org.apache.http.HttpStatus;
+import org.apache.http.client.HttpClient;
+import org.apache.http.client.methods.HttpPost;
+import org.apache.http.entity.StringEntity;
+
+/**
+ * Runtime {@link Plugins}.
+ *
+ * @author Boris Kuzmic (boris.kuzmic@gmail.com)
+ * @since 0.0.7
+ */
+abstract class RtPlugins implements Plugins {
+
+    /**
+     * Apache HttpClient which sends the requests.
+     */
+    private final HttpClient client;
+
+    /**
+     * Base URI for Networks API.
+     */
+    private final URI baseUri;
+
+    /**
+     * Docker API.
+     */
+    private final Docker docker;
+
+    /**
+     * Ctor.
+     * @param client The http client.
+     * @param uri The URI for this Network API.
+     * @param dkr The docker entry point.
+     */
+    RtPlugins(final HttpClient client, final URI uri, final Docker dkr) {
+        this.client = client;
+        this.baseUri = uri;
+        this.docker = dkr;
+    }
+
+    @Override
+    public void create(final String name, final String directory)
+        throws IOException, UnexpectedResponseException {
+        final HttpPost create =
+            new HttpPost(
+                String.format("%s/%s?name=%s",
+                    this.baseUri.toString(),
+                    "create",
+                    name
+                )
+            );
+        try {
+            create.setEntity(
+                new StringEntity(directory)
+            );
+            this.client.execute(
+                create,
+                new MatchStatus(
+                    create.getURI(),
+                    HttpStatus.SC_NO_CONTENT
+                )
+            );
+        } finally {
+            create.releaseConnection();
+        }
+    }
+
+    @Override
+    public void pullAndInstall(final String remote, final String name,
+                               final JsonArray properties)
+        throws IOException, UnexpectedResponseException {
+        final HttpPost pull =
+            new HttpPost(
+                new UncheckedUriBuilder(this.baseUri.toString().concat("/pull"))
+                    .addParameter("remote", remote)
+                    .addParameter("name", name)
+                    .build()
+            );
+        try {
+            pull.setEntity(
+                new StringEntity(properties.toString())
+            );
+            this.client.execute(
+                pull,
+                new MatchStatus(
+                    pull.getURI(),
+                    HttpStatus.SC_NO_CONTENT
+                )
+            );
+        } finally {
+            pull.releaseConnection();
+        }
+    }
+}

src/main/java/com/amihaiemil/docker/UncheckedUriBuilder.java

@@ -27,6 +27,12 @@
 
 import java.net.URI;
 import java.net.URISyntaxException;
+import java.util.Map;
+
+import javax.json.Json;
+import javax.json.JsonArrayBuilder;
+import javax.json.JsonObjectBuilder;
+
 import org.apache.http.client.utils.URIBuilder;
 
 /**
@@ -58,6 +64,33 @@ public UncheckedUriBuilder addParameter(
         return this;
     }
 
+    /**
+     * Adds a JSON encoded `filters` parameter.
+     * 
+     * @param filters Value of the filters.
+     * @return A {@link UncheckedUriBuilder} instance.
+     * 
+     * @todo #240:30min Finish FilteredUriBuilder implementation moving this
+     *  method to that class and uncommenting test in FilteredUriBuilderTests
+     */
+    public UncheckedUriBuilder addFilters(
+        final Map<String, Iterable<String>> filters
+    ) {
+        if (filters != null && !filters.isEmpty()) {
+            final JsonObjectBuilder json = Json.createObjectBuilder();
+            filters.forEach(
+                (name, values) -> {
+                    final JsonArrayBuilder array = Json.createArrayBuilder();
+                    values.forEach(array::add);
+                    json.add(name, array);
+                }
+            );
+            this.addParameter("filters", json.build().toString());
+        }
+
+        return this;
+    }
+
     @Override
     public URI build() {
         try {