diff --git a/9.3.3/api/allclasses-index.html b/9.3.3/api/allclasses-index.html new file mode 100644 index 000000000..36c05f335 --- /dev/null +++ b/9.3.3/api/allclasses-index.html @@ -0,0 +1,629 @@ + + + + + +All Classes (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+
+
+

All Classes

+
+
+ +
+
+ + + diff --git a/9.3.3/api/allclasses.html b/9.3.3/api/allclasses.html new file mode 100644 index 000000000..14dd71752 --- /dev/null +++ b/9.3.3/api/allclasses.html @@ -0,0 +1,123 @@ + + + + + +All Classes (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + +
+

All Classes

+
+ +
+
+ + diff --git a/9.3.3/api/allpackages-index.html b/9.3.3/api/allpackages-index.html new file mode 100644 index 000000000..cc018412a --- /dev/null +++ b/9.3.3/api/allpackages-index.html @@ -0,0 +1,192 @@ + + + + + +All Packages (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+
+
+

All Packages

+
+
+ +
+
+ + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/DockerConventionJvmApplicationExtension.html b/9.3.3/api/com/bmuschko/gradle/docker/DockerConventionJvmApplicationExtension.html new file mode 100644 index 000000000..f39001e6e --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/DockerConventionJvmApplicationExtension.html @@ -0,0 +1,472 @@ + + + + + +DockerConventionJvmApplicationExtension (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker
+

Class DockerConventionJvmApplicationExtension

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        DockerConventionJvmApplicationExtension

        +
        public DockerConventionJvmApplicationExtension​(ObjectFactory objectFactory)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getBaseImage

        +
        public final Property<String> getBaseImage()
        +
        The Docker base image used for Java application. +

        + Defaults to openjdk:11.0.16-jre-slim.

        +
        • +
      + + + +
        +
      • +

        getMaintainer

        +
        public final Property<String> getMaintainer()
        +
        The maintainer of the image. +

        + Defaults to the value of the system property user.name.

        +
        • +
      + + + +
        +
      • +

        getUser

        +
        public final Property<String> getUser()
        +
        The username (or UID) and optionally the user group (or GID) to use as the default user and group for the container, e.g. johndoe:30000. +

        + Defaults to not setting a user. Usually that means running with the root user.

        +
        +
        Since:
        +
        9.3.0
        +
        +
        • +
      + + + +
        +
      • +

        getPorts

        +
        public final ListProperty<Integer> getPorts()
        +
        The Docker image exposed ports. +

        + Defaults to [8080].

        +
        • +
      + + + +
        +
      • +

        getImages

        +
        public final SetProperty<String> getImages()
        +
        The images used for the build and push operation e.g. vieux/apache:2.0. +

        + Defaults to [<project.group>/<applicationName>:<project.version>].

        +
        +
        Since:
        +
        6.0.0
        +
        +
        • +
      + + + +
        +
      • +

        getJvmArgs

        +
        public final ListProperty<String> getJvmArgs()
        +
        The JVM arguments used to start the Java program. +

        + Defaults to [].

        +
        +
        Since:
        +
        4.8.0
        +
        +
        • +
      + + + +
        +
      • +

        getMainClassName

        +
        public final Property<String> getMainClassName()
        +
        The main class name to use for starting the application e.g. com.bmuschko.app.Main. +

        + By default tries to automatically find the main class by scanning the classpath. + The value of this property takes precedence and circumvents classpath scanning.

        +
        +
        Since:
        +
        6.1.0
        +
        +
        • +
      + + + +
        +
      • +

        getArgs

        +
        public final ListProperty<String> getArgs()
        +
        The program arguments appended to Java application. +

        + Defaults to [].

        +
        +
        Since:
        +
        9.0.0
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/DockerConventionJvmApplicationPlugin.html b/9.3.3/api/com/bmuschko/gradle/docker/DockerConventionJvmApplicationPlugin.html new file mode 100644 index 000000000..ba3b91152 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/DockerConventionJvmApplicationPlugin.html @@ -0,0 +1,469 @@ + + + + + +DockerConventionJvmApplicationPlugin (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker
+

Class DockerConventionJvmApplicationPlugin<EXT extends DockerConventionJvmApplicationExtension>

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        SYNC_BUILD_CONTEXT_TASK_NAME

        +
        public static final String SYNC_BUILD_CONTEXT_TASK_NAME
        +
        The task name that copies the application files to a temporary directory for image creation.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        DOCKERFILE_TASK_NAME

        +
        public static final String DOCKERFILE_TASK_NAME
        +
        The task name that creates the Docker image for the Java application.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        BUILD_IMAGE_TASK_NAME

        +
        public static final String BUILD_IMAGE_TASK_NAME
        +
        The task name that builds the Docker image for the Java application.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        PUSH_IMAGE_TASK_NAME

        +
        public static final String PUSH_IMAGE_TASK_NAME
        +
        The task name that pushes created Docker image to the repository.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        DockerConventionJvmApplicationPlugin

        +
        public DockerConventionJvmApplicationPlugin()
        +
        • +
      +
      • +
    +
    + +
    + +
    +
    • +
+
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/DockerExtension.html b/9.3.3/api/com/bmuschko/gradle/docker/DockerExtension.html new file mode 100644 index 000000000..7eacdc8f2 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/DockerExtension.html @@ -0,0 +1,397 @@ + + + + + +DockerExtension (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker
+

Class DockerExtension

+
+
+ +
+
    +
  • +
    +
    public class DockerExtension
+extends Object
    +
    The extension for configuring the Docker communication via the remote API through the DockerRemoteApiPlugin. +

    + Other convention plugins like the DockerJavaApplicationPlugin and DockerSpringBootApplicationPlugin may further extend this extension as nested configuration elements. +

    + The following example demonstrates the use of the extension in a build script using the Groovy DSL: + 

    + docker {
+     url = 'https://192.168.59.103:2376'
+ }
+
    +
    • +
+
+
+ +
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getUrl

        +
        public final Property<String> getUrl()
        +
        The server URL to connect to via Docker’s remote API. +

        + Defaults to unix:///var/run/docker.sock for Unix systems and tcp://127.0.0.1:2375 for Windows systems.

        +
        • +
      + + + +
        +
      • +

        getCertPath

        +
        public final DirectoryProperty getCertPath()
        +
        The path to certificates for communicating with Docker over SSL. +

        + Defaults to value of environment variable DOCKER_CERT_PATH if set.

        +
        • +
      + + + +
        +
      • +

        getApiVersion

        +
        public final Property<String> getApiVersion()
        +
        The remote API version. For most cases this can be left null.
        +
        • +
      + + + +
        +
      • +

        getRegistryCredentials

        +
        public final DockerRegistryCredentials getRegistryCredentials()
        +
        The target Docker registry credentials.
        +
        • +
      + + + +
        +
      • +

        registryCredentials

        +
        public void registryCredentials​(Action<? super DockerRegistryCredentials> action)
        +
        Configures the target Docker registry credentials.
        +
        +
        Parameters:
        +
        action - The action against the Docker registry credentials
        +
        Since:
        +
        6.0.0
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/DockerJavaApplication.html b/9.3.3/api/com/bmuschko/gradle/docker/DockerJavaApplication.html new file mode 100644 index 000000000..6f11308b4 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/DockerJavaApplication.html @@ -0,0 +1,294 @@ + + + + + +DockerJavaApplication (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker
+

Class DockerJavaApplication

+
+
+ +
+
    +
  • +
    +
    public class DockerJavaApplication
+extends DockerConventionJvmApplicationExtension
    +
    The extension for configuring a Java application via the DockerJavaApplicationPlugin. +

    + Enhances the extension DockerExtension as child DSL element. +

    + The following example demonstrates the use of the extension in a build script using the Groovy DSL: + 

    + docker {
+     javaApplication {
+         baseImage = 'dockerfile/java:openjdk-7-jre'
+         maintainer = 'Benjamin Muschko "benjamin.muschko@gmail.com"'
+         ports = [9090, 5701]
+         tag = 'jettyapp:1.115'
+         jvmArgs = ['-Xms256m', '-Xmx2048m']
+    }
+ }
+
    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        DockerJavaApplication

        +
        public DockerJavaApplication​(ObjectFactory objectFactory)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/DockerJavaApplicationPlugin.html b/9.3.3/api/com/bmuschko/gradle/docker/DockerJavaApplicationPlugin.html new file mode 100644 index 000000000..50f5a50b6 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/DockerJavaApplicationPlugin.html @@ -0,0 +1,406 @@ + + + + + +DockerJavaApplicationPlugin (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker
+

Class DockerJavaApplicationPlugin

+
+
+ +
+ +
+
+ +
+
+ +
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/DockerRegistryCredentials.html b/9.3.3/api/com/bmuschko/gradle/docker/DockerRegistryCredentials.html new file mode 100644 index 000000000..6585f1676 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/DockerRegistryCredentials.html @@ -0,0 +1,455 @@ + + + + + +DockerRegistryCredentials (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker
+

Class DockerRegistryCredentials

+
+
+ +
+
    +
  • +
    +
    public class DockerRegistryCredentials
+extends Object
    +
    The extension for configuring the Docker communication via the remote API through the DockerRemoteApiPlugin. +

    + The following example demonstrates the use of the extension in a build script using the Groovy DSL: + 

    + docker {
+     registryCredentials {
+         username = 'bmuschko'
+         password = 'pwd'
+     }
+ }
+
    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        DEFAULT_URL

        +
        public static final String DEFAULT_URL
        +
        The registry URL used as default value for the property url.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        DockerRegistryCredentials

        +
        @Inject
+public DockerRegistryCredentials​(ObjectFactory objectFactory)
        +
        • +
      +
      • +
    +
    + +
    + +
    +
    • +
+
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/DockerRemoteApiPlugin.html b/9.3.3/api/com/bmuschko/gradle/docker/DockerRemoteApiPlugin.html new file mode 100644 index 000000000..3e924ee45 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/DockerRemoteApiPlugin.html @@ -0,0 +1,386 @@ + + + + + +DockerRemoteApiPlugin (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker
+

Class DockerRemoteApiPlugin

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Plugin<Project>
    +
    +
    +
    public class DockerRemoteApiPlugin
+extends Object
+implements Plugin<Project>
    +
    Gradle plugin that provides custom tasks for interacting with Docker via its remote API. +

    + Exposes the extension DockerExtension required to configure the communication and authentication with the Docker remote API. Provides Docker registry credential values from the extension to all custom tasks that implement RegistryCredentialsAware.

    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Field Detail

      + + + + + + + +
        +
      • +

        DEFAULT_TASK_GROUP

        +
        public static final String DEFAULT_TASK_GROUP
        +
        The group for all tasks created by this plugin.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        DockerRemoteApiPlugin

        +
        public DockerRemoteApiPlugin()
        +
        • +
      +
      • +
    +
    + +
    + +
    +
    • +
+
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/DockerSpringBootApplication.html b/9.3.3/api/com/bmuschko/gradle/docker/DockerSpringBootApplication.html new file mode 100644 index 000000000..f452dd592 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/DockerSpringBootApplication.html @@ -0,0 +1,298 @@ + + + + + +DockerSpringBootApplication (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker
+

Class DockerSpringBootApplication

+
+
+ +
+
    +
  • +
    +
    public class DockerSpringBootApplication
+extends DockerConventionJvmApplicationExtension
    +
    The extension for configuring a Spring Boot application via the DockerSpringBootApplicationPlugin. +

    + Enhances the extension DockerExtension as child DSL element. +

    + The following example demonstrates the use of the extension in a build script using the Groovy DSL: + 

    + docker {
+     springBootApplication {
+         baseImage = 'openjdk:8-alpine'
+         maintainer = 'Benjamin Muschko "benjamin.muschko@gmail.com"'
+         ports = [9090, 8080]
+         images = ['awesome-spring-boot:1.115', 'awesome-spring-boot:latest']
+         jvmArgs = ['-Dspring.profiles.active=production', '-Xmx2048m']
+     }
+ }
+
    +
    +
    Since:
    +
    3.4.5
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        DockerSpringBootApplication

        +
        public DockerSpringBootApplication​(ObjectFactory objectFactory)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/DockerSpringBootApplicationPlugin.html b/9.3.3/api/com/bmuschko/gradle/docker/DockerSpringBootApplicationPlugin.html new file mode 100644 index 000000000..9af9286a5 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/DockerSpringBootApplicationPlugin.html @@ -0,0 +1,410 @@ + + + + + +DockerSpringBootApplicationPlugin (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker
+

Class DockerSpringBootApplicationPlugin

+
+
+ +
+ +
+
+ +
+
+ +
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/domain/CopyFileToContainer.html b/9.3.3/api/com/bmuschko/gradle/docker/domain/CopyFileToContainer.html new file mode 100644 index 000000000..35884e235 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/domain/CopyFileToContainer.html @@ -0,0 +1,389 @@ + + + + + +CopyFileToContainer (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.domain
+

Class CopyFileToContainer

+
+
+ +
+
    +
  • +
    +
    public class CopyFileToContainer
+extends Object
    +
    Class holding metadata for an arbitrary copy-file-to-container invocation.
    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        CopyFileToContainer

        +
        public CopyFileToContainer()
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getHostPath

        +
        public Object getHostPath()
        +
        • +
      + + + +
        +
      • +

        setHostPath

        +
        public void setHostPath​(Object hostPath)
        +
        • +
      + + + +
        +
      • +

        getRemotePath

        +
        public Object getRemotePath()
        +
        • +
      + + + +
        +
      • +

        setRemotePath

        +
        public void setRemotePath​(Object remotePath)
        +
        • +
      + + + +
        +
      • +

        getIsTar

        +
        public boolean getIsTar()
        +
        • +
      + + + +
        +
      • +

        isIsTar

        +
        public boolean isIsTar()
        +
        • +
      + + + +
        +
      • +

        setIsTar

        +
        public void setIsTar​(boolean isTar)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/domain/ExecProbe.html b/9.3.3/api/com/bmuschko/gradle/docker/domain/ExecProbe.html new file mode 100644 index 000000000..d2706ac01 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/domain/ExecProbe.html @@ -0,0 +1,367 @@ + + + + + +ExecProbe (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.domain
+

Class ExecProbe

+
+
+ +
+
    +
  • +
    +
    public class ExecProbe
+extends Object
    +
    Class holding metadata for an arbitrary exec livenessProbe.
    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ExecProbe

        +
        public ExecProbe​(long pollTime,
+                 long pollInterval)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getPollTime

        +
        public long getPollTime()
        +
        • +
      + + + +
        +
      • +

        setPollTime

        +
        public void setPollTime​(long pollTime)
        +
        • +
      + + + +
        +
      • +

        getPollInterval

        +
        public long getPollInterval()
        +
        • +
      + + + +
        +
      • +

        setPollInterval

        +
        public void setPollInterval​(long pollInterval)
        +
        • +
      + + + + +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/domain/LivenessProbe.html b/9.3.3/api/com/bmuschko/gradle/docker/domain/LivenessProbe.html new file mode 100644 index 000000000..95e4f51db --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/domain/LivenessProbe.html @@ -0,0 +1,397 @@ + + + + + +LivenessProbe (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.domain
+

Class LivenessProbe

+
+
+ +
+
    +
  • +
    +
    public class LivenessProbe
+extends Object
    +
    Class holding metadata for an arbitrary liveness probe.
    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        LivenessProbe

        +
        public LivenessProbe​(long pollTime,
+                     long pollInterval,
+                     String logContains)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getPollTime

        +
        public long getPollTime()
        +
        • +
      + + + +
        +
      • +

        setPollTime

        +
        public void setPollTime​(long pollTime)
        +
        • +
      + + + +
        +
      • +

        getPollInterval

        +
        public long getPollInterval()
        +
        • +
      + + + +
        +
      • +

        setPollInterval

        +
        public void setPollInterval​(long pollInterval)
        +
        • +
      + + + +
        +
      • +

        getLogContains

        +
        public String getLogContains()
        +
        • +
      + + + +
        +
      • +

        setLogContains

        +
        public void setLogContains​(String logContains)
        +
        • +
      + + + + +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/domain/package-summary.html b/9.3.3/api/com/bmuschko/gradle/docker/domain/package-summary.html new file mode 100644 index 000000000..6a13fa1d1 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/domain/package-summary.html @@ -0,0 +1,178 @@ + + + + + +com.bmuschko.gradle.docker.domain (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+
+
+

Package com.bmuschko.gradle.docker.domain

+
+
+ +
+
+ + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/domain/package-tree.html b/9.3.3/api/com/bmuschko/gradle/docker/domain/package-tree.html new file mode 100644 index 000000000..1ee912b93 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/domain/package-tree.html @@ -0,0 +1,163 @@ + + + + + +com.bmuschko.gradle.docker.domain Class Hierarchy (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package com.bmuschko.gradle.docker.domain

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+ +
+
+
+ + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/internal/ConventionPluginHelper.html b/9.3.3/api/com/bmuschko/gradle/docker/internal/ConventionPluginHelper.html new file mode 100644 index 000000000..a56574624 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/internal/ConventionPluginHelper.html @@ -0,0 +1,278 @@ + + + + + +ConventionPluginHelper (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.internal
+

Class ConventionPluginHelper

+
+
+ +
+
    +
  • +
    +
    public final class ConventionPluginHelper
+extends Object
    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getMainJavaSourceSetOutput

        +
        public static SourceSetOutput getMainJavaSourceSetOutput​(Project project)
        +
        • +
      + + + +
        +
      • +

        createAppFilesCopySpec

        +
        public static CopySpec createAppFilesCopySpec​(Project project)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/internal/CopyUtils.html b/9.3.3/api/com/bmuschko/gradle/docker/internal/CopyUtils.html new file mode 100644 index 000000000..0798cf032 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/internal/CopyUtils.html @@ -0,0 +1,298 @@ + + + + + +CopyUtils (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.internal
+

Class CopyUtils

+
+
+ +
+
    +
  • +
    +
    public final class CopyUtils
+extends Object
    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        copySingleFile

        +
        public static void copySingleFile​(Path hostDestination,
+                                  Path tempDestination)
+                           throws IOException
        +
        Copy regular file inside tempDestination to, or into, hostDestination
        +
        +
        Throws:
        +
        IOException
        +
        +
        • +
      + + + +
        +
      • +

        copyMultipleFiles

        +
        public static void copyMultipleFiles​(Path hostDestination,
+                                     Path tempDestination)
+                              throws IOException
        +
        Copy files inside tempDestination into hostDestination
        +
        +
        Throws:
        +
        IOException
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/internal/DefaultDockerConfigResolver.html b/9.3.3/api/com/bmuschko/gradle/docker/internal/DefaultDockerConfigResolver.html new file mode 100644 index 000000000..5581ac6c9 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/internal/DefaultDockerConfigResolver.html @@ -0,0 +1,314 @@ + + + + + +DefaultDockerConfigResolver (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.internal
+

Class DefaultDockerConfigResolver

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        DefaultDockerConfigResolver

        +
        public DefaultDockerConfigResolver()
        +
        • +
      +
      • +
    +
    + +
    + +
    +
    • +
+
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/internal/DefaultDockerUrlValueSource.html b/9.3.3/api/com/bmuschko/gradle/docker/internal/DefaultDockerUrlValueSource.html new file mode 100644 index 000000000..c3119952b --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/internal/DefaultDockerUrlValueSource.html @@ -0,0 +1,320 @@ + + + + + +DefaultDockerUrlValueSource (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.internal
+

Class DefaultDockerUrlValueSource

+
+
+ +
+ +
+
+ +
+
+ +
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/internal/DockerConfigResolver.html b/9.3.3/api/com/bmuschko/gradle/docker/internal/DockerConfigResolver.html new file mode 100644 index 000000000..42df8c582 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/internal/DockerConfigResolver.html @@ -0,0 +1,252 @@ + + + + + +DockerConfigResolver (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.internal
+

Interface DockerConfigResolver

+
+
+
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getDefaultDockerCert

        +
        File getDefaultDockerCert()
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/internal/IOUtils.html b/9.3.3/api/com/bmuschko/gradle/docker/internal/IOUtils.html new file mode 100644 index 000000000..b90490533 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/internal/IOUtils.html @@ -0,0 +1,276 @@ + + + + + +IOUtils (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.internal
+

Class IOUtils

+
+
+ +
+
    +
  • +
    +
    public final class IOUtils
+extends Object
    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getProgressLogger

        +
        public static <T> org.gradle.internal.logging.progress.ProgressLogger getProgressLogger​(org.gradle.internal.service.ServiceRegistry registry,
+                                                                                        Class<T> clazz)
        +
        Create a progress logger for an arbitrary project and class.
        +
        +
        Parameters:
        +
        registry - the service registry.
        +
        clazz - optional class to pair the ProgressLogger to. Defaults to _this_ class if null.
        +
        Returns:
        +
        instance of ProgressLogger.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/internal/MainClassFinder.MainClass.html b/9.3.3/api/com/bmuschko/gradle/docker/internal/MainClassFinder.MainClass.html new file mode 100644 index 000000000..25a39702d --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/internal/MainClassFinder.MainClass.html @@ -0,0 +1,378 @@ + + + + + +MainClassFinder.MainClass (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.internal
+

Class MainClassFinder.MainClass

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    MainClassFinder
    +
    +
    +
    public static final class MainClassFinder.MainClass
+extends Object
    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MainClass

        +
        public MainClass​(String name,
+                 Set<String> annotationNames)
        +
        • +
      +
      • +
    +
    + +
    + +
    +
    • +
+
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/internal/MainClassFinder.MainClassCallback.html b/9.3.3/api/com/bmuschko/gradle/docker/internal/MainClassFinder.MainClassCallback.html new file mode 100644 index 000000000..03ed65740 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/internal/MainClassFinder.MainClassCallback.html @@ -0,0 +1,252 @@ + + + + + +MainClassFinder.MainClassCallback (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.internal
+

Interface MainClassFinder.MainClassCallback<T>

+
+
+
+
    +
  • +
    +
    Enclosing class:
    +
    MainClassFinder
    +
    +
    +
    public static interface MainClassFinder.MainClassCallback<T>
    +
    • +
+
+
+ +
+
+ +
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/internal/MainClassFinder.html b/9.3.3/api/com/bmuschko/gradle/docker/internal/MainClassFinder.html new file mode 100644 index 000000000..886e445f2 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/internal/MainClassFinder.html @@ -0,0 +1,380 @@ + + + + + +MainClassFinder (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.internal
+

Class MainClassFinder

+
+
+ +
+
    +
  • +
    +
    public class MainClassFinder
+extends Object
    +
    Original source from Spring Boot's loader tools licensed under Apache License Version 2.0.
    +
    • +
+
+
+ +
+
+ +
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/internal/OsUtils.html b/9.3.3/api/com/bmuschko/gradle/docker/internal/OsUtils.html new file mode 100644 index 000000000..10faa06cf --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/internal/OsUtils.html @@ -0,0 +1,264 @@ + + + + + +OsUtils (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.internal
+

Class OsUtils

+
+
+ +
+
    +
  • +
    +
    public final class OsUtils
+extends Object
    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        isWindows

        +
        public static Boolean isWindows()
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/internal/OutputCollector.html b/9.3.3/api/com/bmuschko/gradle/docker/internal/OutputCollector.html new file mode 100644 index 000000000..bbf0317d6 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/internal/OutputCollector.html @@ -0,0 +1,341 @@ + + + + + +OutputCollector (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.internal
+

Class OutputCollector

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Closeable, AutoCloseable
    +
    +
    +
    public final class OutputCollector
+extends Object
+implements Closeable
    +
    A utility class that will collect strings until a new line is encountered.
    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        OutputCollector

        +
        public OutputCollector​(Consumer<String> output)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        accept

        +
        public void accept​(String input)
        +
        Accept a string as input. The collector will save the inputs until a new line is encountered, or the collector + is closed. The newlines are stripped and not present in the output.
        +
        +
        Parameters:
        +
        input - The string to accept.
        +
        +
        • +
      + + + + +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/internal/RegistryAuthLocator.Factory.html b/9.3.3/api/com/bmuschko/gradle/docker/internal/RegistryAuthLocator.Factory.html new file mode 100644 index 000000000..bbfbdb570 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/internal/RegistryAuthLocator.Factory.html @@ -0,0 +1,312 @@ + + + + + +RegistryAuthLocator.Factory (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.internal
+

Class RegistryAuthLocator.Factory

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Factory

        +
        @Inject
+public Factory​(ExecOperations execOperations)
        +
        • +
      +
      • +
    +
    + +
    + +
    +
    • +
+
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/internal/RegistryAuthLocator.html b/9.3.3/api/com/bmuschko/gradle/docker/internal/RegistryAuthLocator.html new file mode 100644 index 000000000..6884b3bf4 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/internal/RegistryAuthLocator.html @@ -0,0 +1,414 @@ + + + + + +RegistryAuthLocator (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.internal
+

Class RegistryAuthLocator

+
+
+ +
+
    +
  • +
    +
    public class RegistryAuthLocator
+extends Object
    +
    Utility class to get credentials information from extension of type DockerRegistryCredentials or from $DOCKER_CONFIG/.docker/config.json file. +

    + Supports auth token, credentials store and credentials helpers. Only Linux OS is supported at the moment. Returns default auth object if called on Windows. +

    + The class is ported from the testcontainers-java project (PR 729).

    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      StringgetRegistry​(String image) +
      Extract registry name from the image name
      +
      com.github.dockerjava.api.model.AuthConfigurationslookupAllAuthConfigs() +
      Gets all authorization information + using $DOCKER_CONFIG/.docker/config.json file + If missing, an empty AuthConfigurations object is returned
      +
      com.github.dockerjava.api.model.AuthConfigurationslookupAllAuthConfigs​(DockerRegistryCredentials registryCredentials) +
      Gets all authorization information + using $DOCKER_CONFIG/.docker/config.json file + If missing, an AuthConfigurations object containing only the passed registryCredentials is returned
      +
      com.github.dockerjava.api.model.AuthConfigurationslookupAllAuthConfigs​(com.github.dockerjava.api.model.AuthConfig additionalAuthConfig) +
      Gets all authorization information + using $DOCKER_CONFIG/.docker/config.json file + If missing, an AuthConfigurations object containing only the passed additionalAuthConfig is returned
      +
      com.github.dockerjava.api.model.AuthConfiglookupAuthConfig​(String image, + DockerRegistryCredentials registryCredentials) +
      Gets authorization information + using $DOCKER_CONFIG/.docker/config.json file + If missing, gets the information from + the registryCredentials object
      +
      + +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        lookupAuthConfig

        +
        public com.github.dockerjava.api.model.AuthConfig lookupAuthConfig​(String image,
+                                                                   DockerRegistryCredentials registryCredentials)
        +
        Gets authorization information + using $DOCKER_CONFIG/.docker/config.json file + If missing, gets the information from + the registryCredentials object
        +
        +
        Parameters:
        +
        registryCredentials - extension of type registryCredentials
        +
        image - the name of docker image the action to be authorized for
        +
        Returns:
        +
        AuthConfig object with a credentials info or default object if + no credentials found
        +
        +
        • +
      + + + +
        +
      • +

        lookupAllAuthConfigs

        +
        public com.github.dockerjava.api.model.AuthConfigurations lookupAllAuthConfigs()
        +
        Gets all authorization information + using $DOCKER_CONFIG/.docker/config.json file + If missing, an empty AuthConfigurations object is returned
        +
        +
        Returns:
        +
        AuthConfigurations object containing all authorization information, + or an empty object if not available
        +
        +
        • +
      + + + +
        +
      • +

        lookupAllAuthConfigs

        +
        public com.github.dockerjava.api.model.AuthConfigurations lookupAllAuthConfigs​(DockerRegistryCredentials registryCredentials)
        +
        Gets all authorization information + using $DOCKER_CONFIG/.docker/config.json file + If missing, an AuthConfigurations object containing only the passed registryCredentials is returned
        +
        +
        Parameters:
        +
        registryCredentials - extension of type registryCredentials
        +
        Returns:
        +
        AuthConfigurations object containing all authorization information (if available), and the registryCredentials
        +
        +
        • +
      + + + +
        +
      • +

        lookupAllAuthConfigs

        +
        public com.github.dockerjava.api.model.AuthConfigurations lookupAllAuthConfigs​(com.github.dockerjava.api.model.AuthConfig additionalAuthConfig)
        +
        Gets all authorization information + using $DOCKER_CONFIG/.docker/config.json file + If missing, an AuthConfigurations object containing only the passed additionalAuthConfig is returned
        +
        +
        Parameters:
        +
        additionalAuthConfig - An additional AuthConfig object to add to the discovered authorization information.
        +
        Returns:
        +
        AuthConfigurations object containing all authorization information (if available), and the additionalAuthConfig
        +
        +
        • +
      + + + +
        +
      • +

        getRegistry

        +
        public String getRegistry​(String image)
        +
        Extract registry name from the image name
        +
        +
        Parameters:
        +
        image - the name of the docker image
        +
        Returns:
        +
        docker registry name
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/internal/RegularFileToStringTransformer.html b/9.3.3/api/com/bmuschko/gradle/docker/internal/RegularFileToStringTransformer.html new file mode 100644 index 000000000..43409782a --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/internal/RegularFileToStringTransformer.html @@ -0,0 +1,317 @@ + + + + + +RegularFileToStringTransformer (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.internal
+

Class RegularFileToStringTransformer

+
+
+ +
+ +
+
+ +
+
+ +
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/internal/package-summary.html b/9.3.3/api/com/bmuschko/gradle/docker/internal/package-summary.html new file mode 100644 index 000000000..b378d0ca3 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/internal/package-summary.html @@ -0,0 +1,233 @@ + + + + + +com.bmuschko.gradle.docker.internal (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+
+
+

Package com.bmuschko.gradle.docker.internal

+
+
+ +
+
+ + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/internal/package-tree.html b/9.3.3/api/com/bmuschko/gradle/docker/internal/package-tree.html new file mode 100644 index 000000000..ba7b63549 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/internal/package-tree.html @@ -0,0 +1,179 @@ + + + + + +com.bmuschko.gradle.docker.internal Class Hierarchy (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package com.bmuschko.gradle.docker.internal

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+ +
+
+

Interface Hierarchy

+ +
+
+
+ + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/internal/services/DockerClientService.Params.html b/9.3.3/api/com/bmuschko/gradle/docker/internal/services/DockerClientService.Params.html new file mode 100644 index 000000000..915c31924 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/internal/services/DockerClientService.Params.html @@ -0,0 +1,324 @@ + + + + + +DockerClientService.Params (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.internal.services
+

Interface DockerClientService.Params

+
+
+
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getUrl

        +
        Property<String> getUrl()
        +
        The server URL to connect to via Docker’s remote API.
        +
        +
        Returns:
        +
        The server URL
        +
        +
        • +
      + + + +
        +
      • +

        getCertPath

        +
        DirectoryProperty getCertPath()
        +
        The path to certificates for communicating with Docker over SSL.
        +
        +
        Returns:
        +
        The cert path
        +
        +
        • +
      + + + +
        +
      • +

        getApiVersion

        +
        Property<String> getApiVersion()
        +
        The remote API version.
        +
        +
        Returns:
        +
        The remote API
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/internal/services/DockerClientService.html b/9.3.3/api/com/bmuschko/gradle/docker/internal/services/DockerClientService.html new file mode 100644 index 000000000..ed5cefcb6 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/internal/services/DockerClientService.html @@ -0,0 +1,386 @@ + + + + + +DockerClientService (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.internal.services
+

Class DockerClientService

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        DockerClientService

        +
        @Inject
+public DockerClientService​(ObjectFactory objects)
        +
        Constructor for Docker client service.
        +
        +
        Parameters:
        +
        objects - The object factory
        +
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getDockerClient

        +
        public com.github.dockerjava.api.DockerClient getDockerClient​(Provider<String> urlProvider,
+                                                              Provider<Directory> certPathProvider,
+                                                              Provider<String> apiVersionProvider)
        +
        Returns the Docker client.
        +
        +
        Parameters:
        +
        urlProvider - Docker client url
        +
        certPathProvider - Docker client certificate path
        +
        apiVersionProvider - Docker client api version
        +
        Returns:
        +
        Docker client
        +
        +
        • +
      + + + + +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/internal/services/package-summary.html b/9.3.3/api/com/bmuschko/gradle/docker/internal/services/package-summary.html new file mode 100644 index 000000000..0e38ecd00 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/internal/services/package-summary.html @@ -0,0 +1,183 @@ + + + + + +com.bmuschko.gradle.docker.internal.services (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+
+
+

Package com.bmuschko.gradle.docker.internal.services

+
+
+ +
+
+ + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/internal/services/package-tree.html b/9.3.3/api/com/bmuschko/gradle/docker/internal/services/package-tree.html new file mode 100644 index 000000000..2c989140f --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/internal/services/package-tree.html @@ -0,0 +1,171 @@ + + + + + +com.bmuschko.gradle.docker.internal.services Class Hierarchy (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package com.bmuschko.gradle.docker.internal.services

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+ +
+
+

Interface Hierarchy

+ +
+
+
+ + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/package-summary.html b/9.3.3/api/com/bmuschko/gradle/docker/package-summary.html new file mode 100644 index 000000000..16e6ad6f8 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/package-summary.html @@ -0,0 +1,214 @@ + + + + + +com.bmuschko.gradle.docker (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+
+
+

Package com.bmuschko.gradle.docker

+
+
+ +
+
+ + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/package-tree.html b/9.3.3/api/com/bmuschko/gradle/docker/package-tree.html new file mode 100644 index 000000000..6d3bfd88f --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/package-tree.html @@ -0,0 +1,175 @@ + + + + + +com.bmuschko.gradle.docker Class Hierarchy (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package com.bmuschko.gradle.docker

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+ +
+
+
+ + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/AbstractDockerRemoteApiTask.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/AbstractDockerRemoteApiTask.html new file mode 100644 index 000000000..696b1aca3 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/AbstractDockerRemoteApiTask.html @@ -0,0 +1,620 @@ + + + + + +AbstractDockerRemoteApiTask (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks
+

Class AbstractDockerRemoteApiTask

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        AbstractDockerRemoteApiTask

        +
        public AbstractDockerRemoteApiTask()
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + + + + + + + + + + + + + + + + + + + + + +
        +
      • +

        onError

        +
        public void onError​(Action<? super Throwable> action)
        +
        Reacts to a potential error occurring during the operation.
        +
        +
        Parameters:
        +
        action - The action handling the error
        +
        Since:
        +
        4.0.0
        +
        +
        • +
      + + + +
        +
      • +

        onNext

        +
        public void onNext​(Action action)
        +
        Reacts to data returned by an operation.
        +
        +
        Parameters:
        +
        action - The action handling the data
        +
        Since:
        +
        4.0.0
        +
        +
        • +
      + + + + + + + +
        +
      • +

        onComplete

        +
        public void onComplete​(Runnable callback)
        +
        Reacts to the completion of the operation.
        +
        +
        Parameters:
        +
        callback - The callback to be executed
        +
        Since:
        +
        4.0.0
        +
        +
        • +
      + + + +
        +
      • +

        getDockerClient

        +
        @Internal
+public com.github.dockerjava.api.DockerClient getDockerClient()
        +
        Gets the Docker client uses to communicate with Docker via its remote API. + Initialized instance upon first request. + Returns the same instance for any successive method call. + To support the configuration cache we rely on DockerClientService's internal cache. +

        + Before accessing the Docker client, all data used for configuring its runtime behavior needs to be evaluated. + The data includes: +

          +
        1. The property values of this class
          2. +
        2. The plugin's extension property values
          3. +
        +

        + It is safe to access the Docker client under the following conditions: +

          +
        1. In the task action
          2. +
        2. In the task's constructor if used in Action or Closure of outputs.upToDateWhen
          3. +
        +
        +
        Returns:
        +
        The Docker client
        +
        +
        • +
      + + + +
        +
      • +

        getRegistryAuthLocator

        +
        @Internal
+protected RegistryAuthLocator getRegistryAuthLocator()
        +
        Returns the instance of RegistryAuthLocator. +

        + Unless other credentials information provided, the instance returns authConfig object provided by the Docker client.

        +
        +
        Returns:
        +
        The registry authentication locator
        +
        +
        • +
      + + + +
        +
      • +

        runRemoteCommand

        +
        public abstract void runRemoteCommand()
+                               throws Exception
        +
        +
        Throws:
        +
        Exception
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/DockerInfo.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/DockerInfo.html new file mode 100644 index 000000000..808697b90 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/DockerInfo.html @@ -0,0 +1,389 @@ + + + + + +DockerInfo (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks
+

Class DockerInfo

+
+
+ +
+ +
+
+ +
+
+ +
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/DockerOperation.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/DockerOperation.html new file mode 100644 index 000000000..e812b14db --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/DockerOperation.html @@ -0,0 +1,390 @@ + + + + + +DockerOperation (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks
+

Class DockerOperation

+
+
+ +
+ +
+
+ +
+
+ +
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/DockerVersion.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/DockerVersion.html new file mode 100644 index 000000000..972783d1f --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/DockerVersion.html @@ -0,0 +1,389 @@ + + + + + +DockerVersion (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks
+

Class DockerVersion

+
+
+ +
+ +
+
+ +
+
+ +
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/RegistryCredentialsAware.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/RegistryCredentialsAware.html new file mode 100644 index 000000000..7baced6ff --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/RegistryCredentialsAware.html @@ -0,0 +1,338 @@ + + + + + +RegistryCredentialsAware (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks
+

Interface RegistryCredentialsAware

+
+
+
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getRegistryCredentials

        +
        DockerRegistryCredentials getRegistryCredentials()
        +
        The target Docker registry credentials for usage with a task.
        +
        • +
      + + + +
        +
      • +

        registryCredentials

        +
        void registryCredentials​(Action<? super DockerRegistryCredentials> action)
        +
        Configures the target Docker registry credentials for use with a task.
        +
        +
        Parameters:
        +
        action - The action against the Docker registry credentials
        +
        Since:
        +
        6.0.0
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/DockerCopyFileFromContainer.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/DockerCopyFileFromContainer.html new file mode 100644 index 000000000..620beb64a --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/DockerCopyFileFromContainer.html @@ -0,0 +1,475 @@ + + + + + +DockerCopyFileFromContainer (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.container
+

Class DockerCopyFileFromContainer

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getRemotePath

        +
        @Input
+public final Property<String> getRemotePath()
        +
        Path inside container
        +
        • +
      + + + +
        +
      • +

        getHostPath

        +
        @Input
+public final Property<String> getHostPath()
        +
        Path on host to write remotePath to or into. +

        + If hostPath does not exist it will be created relative to + what we need it to be (e.g. regular file or directory). + This is consistent with how 'docker cp' behaves.

        +
        • +
      + + + +
        +
      • +

        getCompressed

        +
        @Input
+@Optional
+public final Property<Boolean> getCompressed()
        +
        Whether to leave file in its compressed state or not. +

        + Docker CP command hands back a tar stream regardless if we asked + for a regular file or directory. Thus, we can give the caller + back the tar file as-is or explode it to some destination like + 'docker cp' does.

        +
        • +
      + + + + +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/DockerCopyFileToContainer.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/DockerCopyFileToContainer.html new file mode 100644 index 000000000..f29ef7499 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/DockerCopyFileToContainer.html @@ -0,0 +1,525 @@ + + + + + +DockerCopyFileToContainer (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.container
+

Class DockerCopyFileToContainer

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        DockerCopyFileToContainer

        +
        public DockerCopyFileToContainer()
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + + + + + + + + + + + + + + + + + + + + + +
        +
      • +

        withFile

        +
        public void withFile​(Object hostPath,
+                     Object remotePath)
        +
        Add a file to be copied into container
        +
        +
        Parameters:
        +
        hostPath - can be either String, GString, File or Closure which returns any of the previous.
        +
        remotePath - can be either String, GString, File or Closure which returns any of the previous.
        +
        +
        • +
      + + + +
        +
      • +

        withTarFile

        +
        public void withTarFile​(Object hostPath,
+                        Object remotePath)
        +
        Add a tarfile to be copied into container
        +
        +
        Parameters:
        +
        hostPath - can be either String, GString, File or Closure which returns any of the previous.
        +
        remotePath - can be either String, GString, File or Closure which returns any of the previous.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/DockerCreateContainer.ExposedPort.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/DockerCreateContainer.ExposedPort.html new file mode 100644 index 000000000..a2462babc --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/DockerCreateContainer.ExposedPort.html @@ -0,0 +1,333 @@ + + + + + +DockerCreateContainer.ExposedPort (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.container
+

Class DockerCreateContainer.ExposedPort

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ExposedPort

        +
        public ExposedPort​(String internetProtocol,
+                   List<Integer> ports)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getInternetProtocol

        +
        public final String getInternetProtocol()
        +
        • +
      + + + +
        +
      • +

        getPorts

        +
        public final List<Integer> getPorts()
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/DockerCreateContainer.HealthCheckConfig.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/DockerCreateContainer.HealthCheckConfig.html new file mode 100644 index 000000000..e54c5c6bb --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/DockerCreateContainer.HealthCheckConfig.html @@ -0,0 +1,406 @@ + + + + + +DockerCreateContainer.HealthCheckConfig (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.container
+

Class DockerCreateContainer.HealthCheckConfig

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    DockerCreateContainer
    +
    +
    +
    public static class DockerCreateContainer.HealthCheckConfig
+extends Object
    +
    +
    Since:
    +
    6.7.0
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        HealthCheckConfig

        +
        @Inject
+public HealthCheckConfig​(ObjectFactory objectFactory)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getInterval

        +
        @Input
+@Optional
+public final Property<Long> getInterval()
        +
        The time to wait between checks in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit.
        +
        • +
      + + + +
        +
      • +

        getTimeout

        +
        @Input
+@Optional
+public final Property<Long> getTimeout()
        +
        The time to wait before considering the check to have hung. It should be 0 or at least 1000000 (1 ms). 0 means inherit.
        +
        • +
      + + + + + + + +
        +
      • +

        getRetries

        +
        @Input
+@Optional
+public final Property<Integer> getRetries()
        +
        The number of consecutive failures needed to consider a container as unhealthy. 0 means inherit.
        +
        • +
      + + + +
        +
      • +

        getStartPeriod

        +
        @Input
+@Optional
+public final Property<Long> getStartPeriod()
        +
        The time to wait for container initialization before starting health-retries countdown in nanoseconds. + It should be 0 or at least 1000000 (1 ms). 0 means inherit.
        +
        • +
      + + + +
        +
      • +

        cmd

        +
        public void cmd​(String shellCommand)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/DockerCreateContainer.HostConfig.LogConfig.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/DockerCreateContainer.HostConfig.LogConfig.html new file mode 100644 index 000000000..013f3bf2d --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/DockerCreateContainer.HostConfig.LogConfig.html @@ -0,0 +1,359 @@ + + + + + +DockerCreateContainer.HostConfig.LogConfig (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.container
+

Class DockerCreateContainer.HostConfig.LogConfig

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        LogConfig

        +
        public LogConfig()
        +
        • +
      +
      • +
    +
    + +
    + +
    +
    • +
+
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/DockerCreateContainer.HostConfig.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/DockerCreateContainer.HostConfig.html new file mode 100644 index 000000000..7db054592 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/DockerCreateContainer.HostConfig.html @@ -0,0 +1,779 @@ + + + + + +DockerCreateContainer.HostConfig (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.container
+

Class DockerCreateContainer.HostConfig

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    DockerCreateContainer
    +
    +
    +
    public static class DockerCreateContainer.HostConfig
+extends Object
    +
    +
    Since:
    +
    6.0.0
    +
    +
    • +
+
+
+ +
+
+ +
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/DockerCreateContainer.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/DockerCreateContainer.html new file mode 100644 index 000000000..a92527d63 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/DockerCreateContainer.html @@ -0,0 +1,900 @@ + + + + + +DockerCreateContainer (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.container
+

Class DockerCreateContainer

+
+
+ +
+ +
+
+ +
+
+ +
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/DockerExecContainer.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/DockerExecContainer.html new file mode 100644 index 000000000..e34a7e34c --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/DockerExecContainer.html @@ -0,0 +1,660 @@ + + + + + +DockerExecContainer (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.container
+

Class DockerExecContainer

+
+
+ +
+ +
+
+ +
+
+ +
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/DockerExistingContainer.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/DockerExistingContainer.html new file mode 100644 index 000000000..b6c1fa026 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/DockerExistingContainer.html @@ -0,0 +1,465 @@ + + + + + +DockerExistingContainer (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.container
+

Class DockerExistingContainer

+
+
+ +
+ +
+
+ +
+
+ +
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/DockerInspectContainer.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/DockerInspectContainer.html new file mode 100644 index 000000000..f528128e4 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/DockerInspectContainer.html @@ -0,0 +1,401 @@ + + + + + +DockerInspectContainer (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.container
+

Class DockerInspectContainer

+
+
+ +
+ +
+
+ +
+
+ +
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/DockerInspectExecContainer.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/DockerInspectExecContainer.html new file mode 100644 index 000000000..2c2a025b8 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/DockerInspectExecContainer.html @@ -0,0 +1,482 @@ + + + + + +DockerInspectExecContainer (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.container
+

Class DockerInspectExecContainer

+
+
+ +
+ +
+
+ +
+
+ +
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/DockerKillContainer.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/DockerKillContainer.html new file mode 100644 index 000000000..7b3aa1672 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/DockerKillContainer.html @@ -0,0 +1,401 @@ + + + + + +DockerKillContainer (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.container
+

Class DockerKillContainer

+
+
+ +
+ +
+
+ +
+
+ +
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/DockerLogsContainer.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/DockerLogsContainer.html new file mode 100644 index 000000000..58235eba8 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/DockerLogsContainer.html @@ -0,0 +1,601 @@ + + + + + +DockerLogsContainer (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.container
+

Class DockerLogsContainer

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Comparable<Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, ExtensionAware, Task, Configurable<Task>
    +
    +
    +
    public class DockerLogsContainer
+extends DockerExistingContainer
    +
    Copies the container logs into standard out/err, the same as the `docker logs` command. The container output + to standard out will go to standard out, and standard err to standard err.
    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        DockerLogsContainer

        +
        public DockerLogsContainer()
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getFollow

        +
        @Input
+@Optional
+public final Property<Boolean> getFollow()
        +
        Set to true to follow the output, which will cause this task to block until the container exists. + Default is unspecified (docker defaults to false).
        +
        • +
      + + + +
        +
      • +

        getTailAll

        +
        @Input
+@Optional
+public final Property<Boolean> getTailAll()
        +
        Set to true to copy all output since the container has started. For long running containers or containers + with a lot of output this could take a long time. This cannot be set if #tailCount is also set. Setting to false + leaves the decision of how many lines to copy to docker. + Default is unspecified (docker defaults to true).
        +
        • +
      + + + +
        +
      • +

        getTailCount

        +
        @Input
+@Optional
+public final Property<Integer> getTailCount()
        +
        Limit the number of lines of existing output. This cannot be set if #tailAll is also set. + Default is unspecified (docker defaults to all lines).
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        getShowTimestamps

        +
        @Input
+@Optional
+public final Property<Boolean> getShowTimestamps()
        +
        Set to the true to include a timestamp for each line in the output. + Default is unspecified (docker defaults to false).
        +
        • +
      + + + +
        +
      • +

        getSince

        +
        @Input
+@Optional
+public final Property<Date> getSince()
        +
        Limit the output to lines on or after the specified date. + Default is unspecified (docker defaults to all lines).
        +
        • +
      + + + + + + + +
        +
      • +

        getInternalSince

        +
        @Internal
+protected Date getInternalSince()
        +
        • +
      + + + + + + + + +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/DockerRemoveContainer.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/DockerRemoveContainer.html new file mode 100644 index 000000000..00e7b10c7 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/DockerRemoveContainer.html @@ -0,0 +1,433 @@ + + + + + +DockerRemoveContainer (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.container
+

Class DockerRemoveContainer

+
+
+ +
+ +
+
+ +
+
+ +
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/DockerRenameContainer.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/DockerRenameContainer.html new file mode 100644 index 000000000..3fd05a59f --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/DockerRenameContainer.html @@ -0,0 +1,416 @@ + + + + + +DockerRenameContainer (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.container
+

Class DockerRenameContainer

+
+
+ +
+ +
+
+ +
+
+ +
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/DockerRestartContainer.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/DockerRestartContainer.html new file mode 100644 index 000000000..1249e1223 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/DockerRestartContainer.html @@ -0,0 +1,420 @@ + + + + + +DockerRestartContainer (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.container
+

Class DockerRestartContainer

+
+
+ +
+ +
+
+ +
+
+ +
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/DockerStartContainer.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/DockerStartContainer.html new file mode 100644 index 000000000..1ea97e43e --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/DockerStartContainer.html @@ -0,0 +1,401 @@ + + + + + +DockerStartContainer (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.container
+

Class DockerStartContainer

+
+
+ +
+ +
+
+ +
+
+ +
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/DockerStopContainer.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/DockerStopContainer.html new file mode 100644 index 000000000..0a2f82ba6 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/DockerStopContainer.html @@ -0,0 +1,438 @@ + + + + + +DockerStopContainer (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.container
+

Class DockerStopContainer

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        DockerStopContainer

        +
        public DockerStopContainer()
        +
        • +
      +
      • +
    +
    + +
    + +
    +
    • +
+
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/DockerWaitContainer.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/DockerWaitContainer.html new file mode 100644 index 000000000..4165f9c2c --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/DockerWaitContainer.html @@ -0,0 +1,435 @@ + + + + + +DockerWaitContainer (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.container
+

Class DockerWaitContainer

+
+
+ +
+ +
+
+ +
+
+ +
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/package-summary.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/package-summary.html new file mode 100644 index 000000000..3c4632f12 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/package-summary.html @@ -0,0 +1,241 @@ + + + + + +com.bmuschko.gradle.docker.tasks.container (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+
+
+

Package com.bmuschko.gradle.docker.tasks.container

+
+
+ +
+
+ + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/package-tree.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/package-tree.html new file mode 100644 index 000000000..af2212f9c --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/container/package-tree.html @@ -0,0 +1,198 @@ + + + + + +com.bmuschko.gradle.docker.tasks.container Class Hierarchy (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package com.bmuschko.gradle.docker.tasks.container

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+ +
+
+
+ + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/DockerBuildImage.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/DockerBuildImage.html new file mode 100644 index 000000000..bbcd9b11e --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/DockerBuildImage.html @@ -0,0 +1,842 @@ + + + + + +DockerBuildImage (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.image
+

Class DockerBuildImage

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        DockerBuildImage

        +
        public DockerBuildImage()
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + + + + + + + + + +
        +
      • +

        getImages

        +
        @Input
+@Optional
+public final SetProperty<String> getImages()
        +
        The images including repository, image name and tag to be built e.g. vieux/apache:2.0.
        +
        +
        Since:
        +
        6.0.0
        +
        +
        • +
      + + + + + + + +
        +
      • +

        getRemove

        +
        @Input
+@Optional
+public final Property<Boolean> getRemove()
        +
        When true, remove intermediate containers after a successful build.
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        getLabels

        +
        @Input
+@Optional
+public MapProperty<String,​String> getLabels()
        +
        Labels to attach as metadata for to the image. +

        + This property is not final to allow build authors to remove the labels from the up-to-date + check by extending DockerBuildImage and annotating the overrided getLabels() method + with @Internal, example: + + 

        + import com.bmuschko.gradle.docker.tasks.image.DockerBuildImage
+
+ class CustomDockerBuildImage extends DockerBuildImage {
+    @Override
+    @Internal
+     MapProperty<String, String> getLabels() {
+         super.getLabels()
+     }
+ }
+
        +

        + A use case for excluding the labels from the up-to-date check is if build author wants to set build + information as labels (date, version-control-revision).

        +
        • +
      + + + + + + + + + + + + + + + +
        +
      • +

        getShmSize

        +
        @Input
+@Optional
+public final Property<Long> getShmSize()
        +
        Size of /dev/shm in bytes. + The size must be greater than 0. + If omitted the system uses 64MB.
        +
        • +
      + + + +
        +
      • +

        getMemory

        +
        @Input
+@Optional
+public final Property<Long> getMemory()
        +
        Memory allocated for build specified in bytes (no suffix is needed)
        +
        +
        Since:
        +
        7.3.0
        +
        +
        • +
      + + + +
        +
      • +

        getTarget

        +
        @Input
+@Optional
+public final Property<String> getTarget()
        +
        With this parameter it is possible to build a special stage in a multi-stage Docker file. +

        + This feature is only available for use with Docker 17.05 and higher.

        +
        +
        Since:
        +
        4.10.0
        +
        +
        • +
      + + + +
        +
      • +

        getExtraHosts

        +
        @Input
+@Optional
+public final SetProperty<String> getExtraHosts()
        +
        Build-time additional host list to pass to the image build in the format host:ip.
        +
        +
        Since:
        +
        6.2.0
        +
        +
        • +
      + + + +
        +
      • +

        getPlatform

        +
        @Input
+@Optional
+public final Property<String> getPlatform()
        +
        The target platform in the format os[/arch[/variant]], for example linux/s390x or darwin.
        +
        +
        Since:
        +
        7.1.0
        +
        +
        • +
      + + + + + + + +
        +
      • +

        getImageIdFile

        +
        @OutputFile
+public final RegularFileProperty getImageIdFile()
        +
        Output file containing the image ID of the built image. + Defaults to "$buildDir/.docker/$taskpath-imageId.txt". + If path contains ':' it will be replaced by '_'.
        +
        +
        Since:
        +
        4.9.0
        +
        +
        • +
      + + + +
        +
      • +

        getImageId

        +
        @Internal
+public final Property<String> getImageId()
        +
        The ID of the image built. The value of this property requires the task action to be executed.
        +
        • +
      + + + + + + + + +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/DockerCommitImage.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/DockerCommitImage.html new file mode 100644 index 000000000..ebf86c553 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/DockerCommitImage.html @@ -0,0 +1,572 @@ + + + + + +DockerCommitImage (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.image
+

Class DockerCommitImage

+
+
+ +
+ +
+
+ +
+
+ +
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/DockerExistingImage.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/DockerExistingImage.html new file mode 100644 index 000000000..d38dc9a95 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/DockerExistingImage.html @@ -0,0 +1,465 @@ + + + + + +DockerExistingImage (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.image
+

Class DockerExistingImage

+
+
+ +
+ +
+
+ +
+
+ +
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/DockerInspectImage.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/DockerInspectImage.html new file mode 100644 index 000000000..c318e54c1 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/DockerInspectImage.html @@ -0,0 +1,401 @@ + + + + + +DockerInspectImage (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.image
+

Class DockerInspectImage

+
+
+ +
+ +
+
+ +
+
+ +
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/DockerListImages.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/DockerListImages.html new file mode 100644 index 000000000..0ff4c8568 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/DockerListImages.html @@ -0,0 +1,453 @@ + + + + + +DockerListImages (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.image
+

Class DockerListImages

+
+
+ +
+ +
+
+ +
+
+ +
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/DockerLoadImage.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/DockerLoadImage.html new file mode 100644 index 000000000..c6183ee04 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/DockerLoadImage.html @@ -0,0 +1,407 @@ + + + + + +DockerLoadImage (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.image
+

Class DockerLoadImage

+
+
+ +
+ +
+
+ +
+
+ +
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/DockerPullImage.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/DockerPullImage.html new file mode 100644 index 000000000..342e37c92 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/DockerPullImage.html @@ -0,0 +1,496 @@ + + + + + +DockerPullImage (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.image
+

Class DockerPullImage

+
+
+ +
+ +
+
+ +
+
+ +
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/DockerPushImage.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/DockerPushImage.html new file mode 100644 index 000000000..f5ed6013e --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/DockerPushImage.html @@ -0,0 +1,473 @@ + + + + + +DockerPushImage (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.image
+

Class DockerPushImage

+
+
+ +
+ +
+
+ +
+
+ +
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/DockerRemoveImage.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/DockerRemoveImage.html new file mode 100644 index 000000000..16a789cda --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/DockerRemoveImage.html @@ -0,0 +1,417 @@ + + + + + +DockerRemoveImage (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.image
+

Class DockerRemoveImage

+
+
+ +
+ +
+
+ +
+
+ +
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/DockerSaveImage.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/DockerSaveImage.html new file mode 100644 index 000000000..870a552ff --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/DockerSaveImage.html @@ -0,0 +1,469 @@ + + + + + +DockerSaveImage (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.image
+

Class DockerSaveImage

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        DockerSaveImage

        +
        public DockerSaveImage()
        +
        • +
      +
      • +
    +
    + +
    + +
    +
    • +
+
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/DockerTagImage.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/DockerTagImage.html new file mode 100644 index 000000000..16e7366bd --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/DockerTagImage.html @@ -0,0 +1,456 @@ + + + + + +DockerTagImage (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.image
+

Class DockerTagImage

+
+
+ +
+ +
+
+ +
+
+ +
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.AddFileInstruction.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.AddFileInstruction.html new file mode 100644 index 000000000..15b592552 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.AddFileInstruction.html @@ -0,0 +1,393 @@ + + + + + +Dockerfile.AddFileInstruction (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.image
+

Class Dockerfile.AddFileInstruction

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    + +
    + +
    + +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getKeyword

        +
        public String getKeyword()
        +
        Gets the keyword of the instruction as used in the Dockerfile. +

        + For example the keyword of the Dockerfile.FromInstruction is FROM.

        +
        +
        Returns:
        +
        The instruction keyword
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.ArgInstruction.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.ArgInstruction.html new file mode 100644 index 000000000..64ae8dc63 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.ArgInstruction.html @@ -0,0 +1,393 @@ + + + + + +Dockerfile.ArgInstruction (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.image
+

Class Dockerfile.ArgInstruction

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ArgInstruction

        +
        public ArgInstruction​(String arg)
        +
        • +
      + + + +
        +
      • +

        ArgInstruction

        +
        public ArgInstruction​(Provider<String> provider)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getKeyword

        +
        public String getKeyword()
        +
        Gets the keyword of the instruction as used in the Dockerfile. +

        + For example the keyword of the Dockerfile.FromInstruction is FROM.

        +
        +
        Returns:
        +
        The instruction keyword
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.CommentInstruction.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.CommentInstruction.html new file mode 100644 index 000000000..607979621 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.CommentInstruction.html @@ -0,0 +1,397 @@ + + + + + +Dockerfile.CommentInstruction (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.image
+

Class Dockerfile.CommentInstruction

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        CommentInstruction

        +
        public CommentInstruction​(String command)
        +
        • +
      + + + +
        +
      • +

        CommentInstruction

        +
        public CommentInstruction​(Provider<String> commandProvider)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getKeyword

        +
        public String getKeyword()
        +
        Gets the keyword of the instruction as used in the Dockerfile. +

        + For example the keyword of the Dockerfile.FromInstruction is FROM.

        +
        +
        Returns:
        +
        The instruction keyword
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.CopyFile.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.CopyFile.html new file mode 100644 index 000000000..990ea6e55 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.CopyFile.html @@ -0,0 +1,358 @@ + + + + + +Dockerfile.CopyFile (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.image
+

Class Dockerfile.CopyFile

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        CopyFile

        +
        public CopyFile​(String src,
+                String dest)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        withStage

        +
        public Dockerfile.CopyFile withStage​(String stage)
        +
        Used to set the source location to a previous build stage.
        +
        +
        Parameters:
        +
        stage - The previous stage
        +
        Returns:
        +
        This instruction
        +
        +
        • +
      + + + +
        +
      • +

        getStage

        +
        @Nullable
+public String getStage()
        +
        Returns the previous build stage.
        +
        +
        Returns:
        +
        The previous stage
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.CopyFileInstruction.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.CopyFileInstruction.html new file mode 100644 index 000000000..78444de18 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.CopyFileInstruction.html @@ -0,0 +1,419 @@ + + + + + +Dockerfile.CopyFileInstruction (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.image
+

Class Dockerfile.CopyFileInstruction

+
+
+ +
+ +
+
+ +
+
+ +
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.DefaultCommandInstruction.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.DefaultCommandInstruction.html new file mode 100644 index 000000000..946197e98 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.DefaultCommandInstruction.html @@ -0,0 +1,393 @@ + + + + + +Dockerfile.DefaultCommandInstruction (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.image
+

Class Dockerfile.DefaultCommandInstruction

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        DefaultCommandInstruction

        +
        public DefaultCommandInstruction​(String... command)
        +
        • +
      + + + +
        +
      • +

        DefaultCommandInstruction

        +
        public DefaultCommandInstruction​(Provider<List<String>> provider)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getKeyword

        +
        public String getKeyword()
        +
        Gets the keyword of the instruction as used in the Dockerfile. +

        + For example the keyword of the Dockerfile.FromInstruction is FROM.

        +
        +
        Returns:
        +
        The instruction keyword
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.EntryPointInstruction.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.EntryPointInstruction.html new file mode 100644 index 000000000..29a30600f --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.EntryPointInstruction.html @@ -0,0 +1,393 @@ + + + + + +Dockerfile.EntryPointInstruction (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.image
+

Class Dockerfile.EntryPointInstruction

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        EntryPointInstruction

        +
        public EntryPointInstruction​(String... entryPoint)
        +
        • +
      + + + +
        +
      • +

        EntryPointInstruction

        +
        public EntryPointInstruction​(Provider<List<String>> provider)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getKeyword

        +
        public String getKeyword()
        +
        Gets the keyword of the instruction as used in the Dockerfile. +

        + For example the keyword of the Dockerfile.FromInstruction is FROM.

        +
        +
        Returns:
        +
        The instruction keyword
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.EnvironmentVariableInstruction.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.EnvironmentVariableInstruction.html new file mode 100644 index 000000000..a21f1875f --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.EnvironmentVariableInstruction.html @@ -0,0 +1,408 @@ + + + + + +Dockerfile.EnvironmentVariableInstruction (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.image
+

Class Dockerfile.EnvironmentVariableInstruction

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        EnvironmentVariableInstruction

        +
        public EnvironmentVariableInstruction​(String key,
+                                      String value)
        +
        • +
      + + + +
        +
      • +

        EnvironmentVariableInstruction

        +
        public EnvironmentVariableInstruction​(Map<String,​String> envVars)
        +
        • +
      + + + +
        +
      • +

        EnvironmentVariableInstruction

        +
        public EnvironmentVariableInstruction​(Provider<Map<String,​String>> provider)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getKeyword

        +
        public String getKeyword()
        +
        Gets the keyword of the instruction as used in the Dockerfile. +

        + For example the keyword of the Dockerfile.FromInstruction is FROM.

        +
        +
        Returns:
        +
        The instruction keyword
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.ExposePortInstruction.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.ExposePortInstruction.html new file mode 100644 index 000000000..5150f296d --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.ExposePortInstruction.html @@ -0,0 +1,407 @@ + + + + + +Dockerfile.ExposePortInstruction (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.image
+

Class Dockerfile.ExposePortInstruction

+
+
+ +
+ +
+
+ +
+
+ +
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.File.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.File.html new file mode 100644 index 000000000..530362301 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.File.html @@ -0,0 +1,392 @@ + + + + + +Dockerfile.File (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.image
+

Class Dockerfile.File

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        withChown

        +
        public Dockerfile.File withChown​(String chown)
        +
        Specifies a given username, groupname, or UID/GID combination to request specific ownership of the copied content with the help of the --chown option. +

        + Should be provided in the form of <user>:<group>.

        +
        +
        Parameters:
        +
        chown - The ownership of the copied content
        +
        +
        • +
      + + + +
        +
      • +

        getSrc

        +
        public String getSrc()
        +
        Return the source path.
        +
        +
        Returns:
        +
        The source path
        +
        +
        • +
      + + + +
        +
      • +

        getDest

        +
        public String getDest()
        +
        Returns the destination path.
        +
        +
        Returns:
        +
        The destination path
        +
        +
        • +
      + + + +
        +
      • +

        getChown

        +
        @Nullable
+public String getChown()
        +
        Returns the ownership of the copied content.
        +
        +
        Returns:
        +
        The ownership of the copied content
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.FileInstruction.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.FileInstruction.html new file mode 100644 index 000000000..1aefad3c2 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.FileInstruction.html @@ -0,0 +1,364 @@ + + + + + +Dockerfile.FileInstruction (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.image
+

Class Dockerfile.FileInstruction<T extends Dockerfile.File>

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + + + +
        +
      • +

        FileInstruction

        +
        public FileInstruction​(T file)
        +
        • +
      + + + +
        +
      • +

        FileInstruction

        +
        public FileInstruction​(Provider<T> provider)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        getText

        +
        public String getText()
        +
        Gets the full text of the instruction as used in the Dockerfile.
        +
        +
        Specified by:
        +
        getText in interface Dockerfile.Instruction
        +
        Returns:
        +
        The instruction
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.From.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.From.html new file mode 100644 index 000000000..e58dc0c97 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.From.html @@ -0,0 +1,410 @@ + + + + + +Dockerfile.From (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.image
+

Class Dockerfile.From

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        From

        +
        public From​(String image)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        withStage

        +
        public Dockerfile.From withStage​(String stage)
        +
        Sets a new build stage by adding AS name to the FROM instruction.
        +
        +
        Parameters:
        +
        stage - The stage
        +
        Returns:
        +
        This instruction
        +
        +
        • +
      + + + +
        +
      • +

        withPlatform

        +
        public Dockerfile.From withPlatform​(String platform)
        +
        Sets the platform by adding --platform to the FROM instruction.
        +
        +
        Parameters:
        +
        platform - The platform
        +
        Returns:
        +
        This instruction
        +
        +
        • +
      + + + +
        +
      • +

        getImage

        +
        public String getImage()
        +
        Returns the base image.
        +
        +
        Returns:
        +
        The base image
        +
        +
        • +
      + + + +
        +
      • +

        getStage

        +
        @Nullable
+public String getStage()
        +
        Returns the stage.
        +
        +
        Returns:
        +
        The stage
        +
        +
        • +
      + + + +
        +
      • +

        getPlatform

        +
        @Nullable
+public String getPlatform()
        +
        Returns the platform.
        +
        +
        Returns:
        +
        The platform
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.FromInstruction.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.FromInstruction.html new file mode 100644 index 000000000..63bb43438 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.FromInstruction.html @@ -0,0 +1,407 @@ + + + + + +Dockerfile.FromInstruction (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.image
+

Class Dockerfile.FromInstruction

+
+
+ +
+ +
+
+ +
+
+ +
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.GenericInstruction.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.GenericInstruction.html new file mode 100644 index 000000000..91e7455d4 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.GenericInstruction.html @@ -0,0 +1,363 @@ + + + + + +Dockerfile.GenericInstruction (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.image
+

Class Dockerfile.GenericInstruction

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Dockerfile.Instruction
    +
    +
    +
    Enclosing class:
    +
    Dockerfile
    +
    +
    +
    public static class Dockerfile.GenericInstruction
+extends Object
+implements Dockerfile.Instruction
    +
    An instruction that uses the provided value as-is without any additional formatting. +

    + Use this instruction if you want to provide a very complex instruction or if there's not a specific implementation of Dockerfile.Instruction that serves your use case.

    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        GenericInstruction

        +
        public GenericInstruction​(String instruction)
        +
        • +
      + + + +
        +
      • +

        GenericInstruction

        +
        public GenericInstruction​(Provider<String> instructionProvider)
        +
        • +
      +
      • +
    +
    + +
    + +
    +
    • +
+
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.Instruction.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.Instruction.html new file mode 100644 index 000000000..28e203dc4 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.Instruction.html @@ -0,0 +1,294 @@ + + + + + +Dockerfile.Instruction (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.image
+

Interface Dockerfile.Instruction

+
+
+
+ +
+
+
    +
  • + +
    + +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getKeyword

        +
        @Internal
+@Nullable
+String getKeyword()
        +
        Gets the keyword of the instruction as used in the Dockerfile. +

        + For example the keyword of the Dockerfile.FromInstruction is FROM.

        +
        +
        Returns:
        +
        The instruction keyword
        +
        +
        • +
      + + + +
        +
      • +

        getText

        +
        @Input
+@Optional
+@Nullable
+String getText()
        +
        Gets the full text of the instruction as used in the Dockerfile.
        +
        +
        Returns:
        +
        The instruction
        +
        Since:
        +
        3.6.0
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.LabelInstruction.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.LabelInstruction.html new file mode 100644 index 000000000..67e430d1c --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.LabelInstruction.html @@ -0,0 +1,393 @@ + + + + + +Dockerfile.LabelInstruction (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.image
+

Class Dockerfile.LabelInstruction

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        LabelInstruction

        +
        public LabelInstruction​(Map labels)
        +
        • +
      + + + + +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getKeyword

        +
        public String getKeyword()
        +
        Gets the keyword of the instruction as used in the Dockerfile. +

        + For example the keyword of the Dockerfile.FromInstruction is FROM.

        +
        +
        Returns:
        +
        The instruction keyword
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.MapInstruction.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.MapInstruction.html new file mode 100644 index 000000000..f468e4e0d --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.MapInstruction.html @@ -0,0 +1,347 @@ + + + + + +Dockerfile.MapInstruction (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.image
+

Class Dockerfile.MapInstruction

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getText

        +
        public String getText()
        +
        Gets the full text of the instruction as used in the Dockerfile.
        +
        +
        Specified by:
        +
        getText in interface Dockerfile.Instruction
        +
        Returns:
        +
        The instruction
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.OnBuildInstruction.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.OnBuildInstruction.html new file mode 100644 index 000000000..959a5f319 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.OnBuildInstruction.html @@ -0,0 +1,393 @@ + + + + + +Dockerfile.OnBuildInstruction (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.image
+

Class Dockerfile.OnBuildInstruction

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        OnBuildInstruction

        +
        public OnBuildInstruction​(String instruction)
        +
        • +
      + + + +
        +
      • +

        OnBuildInstruction

        +
        public OnBuildInstruction​(Provider<String> provider)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getKeyword

        +
        public String getKeyword()
        +
        Gets the keyword of the instruction as used in the Dockerfile. +

        + For example the keyword of the Dockerfile.FromInstruction is FROM.

        +
        +
        Returns:
        +
        The instruction keyword
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.RunCommandInstruction.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.RunCommandInstruction.html new file mode 100644 index 000000000..124747281 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.RunCommandInstruction.html @@ -0,0 +1,393 @@ + + + + + +Dockerfile.RunCommandInstruction (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.image
+

Class Dockerfile.RunCommandInstruction

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        RunCommandInstruction

        +
        public RunCommandInstruction​(String command)
        +
        • +
      + + + +
        +
      • +

        RunCommandInstruction

        +
        public RunCommandInstruction​(Provider<String> provider)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getKeyword

        +
        public String getKeyword()
        +
        Gets the keyword of the instruction as used in the Dockerfile. +

        + For example the keyword of the Dockerfile.FromInstruction is FROM.

        +
        +
        Returns:
        +
        The instruction keyword
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.StringArrayInstruction.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.StringArrayInstruction.html new file mode 100644 index 000000000..1d1beeb91 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.StringArrayInstruction.html @@ -0,0 +1,347 @@ + + + + + +Dockerfile.StringArrayInstruction (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.image
+

Class Dockerfile.StringArrayInstruction

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        StringArrayInstruction

        +
        public StringArrayInstruction​(String... command)
        +
        • +
      + + + +
        +
      • +

        StringArrayInstruction

        +
        public StringArrayInstruction​(Provider<List<String>> commandProvider)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getText

        +
        public String getText()
        +
        Gets the full text of the instruction as used in the Dockerfile.
        +
        +
        Specified by:
        +
        getText in interface Dockerfile.Instruction
        +
        Returns:
        +
        The instruction
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.StringCommandInstruction.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.StringCommandInstruction.html new file mode 100644 index 000000000..b3691c217 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.StringCommandInstruction.html @@ -0,0 +1,347 @@ + + + + + +Dockerfile.StringCommandInstruction (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.image
+

Class Dockerfile.StringCommandInstruction

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        StringCommandInstruction

        +
        public StringCommandInstruction​(String command)
        +
        • +
      + + + +
        +
      • +

        StringCommandInstruction

        +
        public StringCommandInstruction​(Provider<String> commandProvider)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getText

        +
        public String getText()
        +
        Gets the full text of the instruction as used in the Dockerfile.
        +
        +
        Specified by:
        +
        getText in interface Dockerfile.Instruction
        +
        Returns:
        +
        The instruction
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.UserInstruction.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.UserInstruction.html new file mode 100644 index 000000000..4bc46d2ef --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.UserInstruction.html @@ -0,0 +1,393 @@ + + + + + +Dockerfile.UserInstruction (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.image
+

Class Dockerfile.UserInstruction

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        UserInstruction

        +
        public UserInstruction​(String user)
        +
        • +
      + + + +
        +
      • +

        UserInstruction

        +
        public UserInstruction​(Provider<String> provider)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getKeyword

        +
        public String getKeyword()
        +
        Gets the keyword of the instruction as used in the Dockerfile. +

        + For example the keyword of the Dockerfile.FromInstruction is FROM.

        +
        +
        Returns:
        +
        The instruction keyword
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.VolumeInstruction.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.VolumeInstruction.html new file mode 100644 index 000000000..7a5d0195a --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.VolumeInstruction.html @@ -0,0 +1,392 @@ + + + + + +Dockerfile.VolumeInstruction (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.image
+

Class Dockerfile.VolumeInstruction

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        VolumeInstruction

        +
        public VolumeInstruction​(String... volume)
        +
        • +
      + + + + +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getKeyword

        +
        public String getKeyword()
        +
        Gets the keyword of the instruction as used in the Dockerfile. +

        + For example the keyword of the Dockerfile.FromInstruction is FROM.

        +
        +
        Returns:
        +
        The instruction keyword
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.WorkDirInstruction.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.WorkDirInstruction.html new file mode 100644 index 000000000..e3445ab7b --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.WorkDirInstruction.html @@ -0,0 +1,393 @@ + + + + + +Dockerfile.WorkDirInstruction (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.image
+

Class Dockerfile.WorkDirInstruction

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        WorkDirInstruction

        +
        public WorkDirInstruction​(String dir)
        +
        • +
      + + + +
        +
      • +

        WorkDirInstruction

        +
        public WorkDirInstruction​(Provider<String> provider)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getKeyword

        +
        public String getKeyword()
        +
        Gets the keyword of the instruction as used in the Dockerfile. +

        + For example the keyword of the Dockerfile.FromInstruction is FROM.

        +
        +
        Returns:
        +
        The instruction keyword
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.html new file mode 100644 index 000000000..6a20df913 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.html @@ -0,0 +1,2088 @@ + + + + + +Dockerfile (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.image
+

Class Dockerfile

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Dockerfile

        +
        public Dockerfile()
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getDestFile

        +
        @OutputFile
+public final RegularFileProperty getDestFile()
        +
        The destination file representing the Dockerfile. The destination file encourages the conventional file name Dockerfile but allows any arbitrary file name. +

        + Defaults to $buildDir/docker/Dockerfile. +

        + The method getDestDir() returns the parent directory of the Dockerfile.

        +
        • +
      + + + +
        +
      • +

        getInstructions

        +
        public ListProperty<Dockerfile.Instruction> getInstructions()
        +
        Returns all instructions used to generate the Dockerfile.
        +
        +
        Returns:
        +
        All instructions
        +
        +
        • +
      + + + +
        +
      • +

        getDestDir

        +
        @Internal
+public Provider<Directory> getDestDir()
        +
        Returns a provider representing the destination directory containing the Dockerfile.
        +
        +
        Returns:
        +
        The destination directory containing the Dockerfile
        +
        Since:
        +
        4.4.0
        +
        +
        • +
      + + + + + + + + + + + + + + + + + + + +
        +
      • +

        instruction

        +
        public void instruction​(String instruction)
        +
        Adds a full instruction as String. +

        + Example in Groovy DSL: +

        + 

        + task createDockerfile(type: Dockerfile) {
+     instruction('FROM ubuntu:14.04')
+     instruction('LABEL maintainer=benjamin.muschko@gmail.com')
+ }
+
        + The produced instructions look as follows: +

        + 

        + FROM ubuntu:14.04
+ LABEL maintainer=benjamin.muschko@gmail.com
+
        +
        +
        Parameters:
        +
        instruction - Instruction as String
        +
        See Also:
        +
        instruction(Provider)
        +
        +
        • +
      + + + +
        +
      • +

        instruction

        +
        public void instruction​(Provider<String> provider)
        +
        Adds a full instruction as Provider. +

        + Example in Groovy DSL: +

        + 

        + task createDockerfile(type: Dockerfile) {
+     instruction(project.provider(new Callable<String>() {
+         @Override
+         String call() throws Exception {
+             'FROM ubuntu:14.04'
+         }
+     }))
+ }
+
        + The produced instruction looks as follows: +

        + 

        + FROM ubuntu:14.04
+
        +
        +
        Parameters:
        +
        provider - Instruction as Provider
        +
        Since:
        +
        4.0.0
        +
        See Also:
        +
        instruction(String)
        +
        +
        • +
      + + + +
        +
      • +

        from

        +
        public void from​(String image)
        +
        The FROM instruction sets the Base Image for + subsequent instructions. +

        + Example in Groovy DSL: +

        + 

        + task createDockerfile(type: Dockerfile) {
+     from('ubuntu:14.04')
+ }
+
        + The produced instruction looks as follows: +

        + 

        + FROM ubuntu:14.04
+
        +
        +
        Parameters:
        +
        image - From definition
        +
        See Also:
        +
        from(From), +from(Provider)
        +
        +
        • +
      + + + +
        +
      • +

        from

        +
        public void from​(Dockerfile.From from)
        +
        The FROM instruction sets the Base Image for + subsequent instructions. +

        + Example in Groovy DSL: +

        + 

        + task createDockerfile(type: Dockerfile) {
+     from(new From('ubuntu:14.04'))
+ }
+
        + The produced instruction looks as follows: +

        + 

        + FROM ubuntu:14.04
+
        +
        +
        Parameters:
        +
        from - From definition
        +
        See Also:
        +
        from(String), +from(Provider)
        +
        +
        • +
      + + + +
        +
      • +

        from

        +
        public void from​(Provider<Dockerfile.From> provider)
        +
        A FROM instruction as Provider. +

        + Example in Groovy DSL: +

        + 

        + task createDockerfile(type: Dockerfile) {
+     from(project.provider(new Callable<Dockerfile.From>() {
+         @Override
+         Dockerfile.From call() throws Exception {
+             new Dockerfile.From('ubuntu:14.04')
+         }
+     }))
+ }
+
        + The produced instruction looks as follows: +

        + 

        + FROM ubuntu:14.04
+
        +
        +
        Parameters:
        +
        provider - From information as Provider
        +
        Since:
        +
        4.0.0
        +
        See Also:
        +
        from(From)
        +
        +
        • +
      + + + +
        +
      • +

        arg

        +
        public void arg​(String arg)
        +
        The ARG instruction defines a variable that + users can pass at build-time to the builder. +

        + Example in Groovy DSL: +

        + 

        + task createDockerfile(type: Dockerfile) {
+     arg('user1=someuser')
+ }
+
        + The produced instruction looks as follows: +

        + 

        + ARG user1=someuser
+
        +
        +
        Parameters:
        +
        arg - Argument to pass, possibly with default value.
        +
        See Also:
        +
        arg(Provider)
        +
        +
        • +
      + + + +
        +
      • +

        arg

        +
        public void arg​(Provider<String> provider)
        +
        An ARG instruction as Provider. +

        + Example in Groovy DSL: +

        + 

        + task createDockerfile(type: Dockerfile) {
+     arg(project.provider(new Callable<String>() {
+         @Override
+         String call() throws Exception {
+             'user1=someuser'
+         }
+     }))
+ }
+
        + The produced instruction looks as follows: +

        + 

        + ARG user1=someuser
+
        +
        +
        Parameters:
        +
        provider - Argument to pass as Provider
        +
        Since:
        +
        4.0.0
        +
        See Also:
        +
        arg(String)
        +
        +
        • +
      + + + +
        +
      • +

        runCommand

        +
        public void runCommand​(String command)
        +
        The RUN instruction will execute any commands in a + new layer on top of the current image and commit the results. +

        + Example in Groovy DSL: +

        + 

        + task createDockerfile(type: Dockerfile) {
+     runCommand('/bin/bash -c echo hello')
+ }
+
        + The produced instruction looks as follows: +

        + 

        + RUN /bin/bash -c echo hello
+
        +
        +
        Parameters:
        +
        command - Command
        +
        See Also:
        +
        runCommand(Provider)
        +
        +
        • +
      + + + +
        +
      • +

        runCommand

        +
        public void runCommand​(Provider<String> provider)
        +
        A RUN instruction as Provider. +

        + Example in Groovy DSL: +

        + 

        + task createDockerfile(type: Dockerfile) {
+     runCommand(project.provider(new Callable<String>() {
+         @Override
+         String call() throws Exception {
+             '/bin/bash -c echo hello'
+         }
+     }))
+ }
+
        + The produced instruction looks as follows: +

        + 

        + RUN /bin/bash -c echo hello
+
        +
        +
        Parameters:
        +
        provider - Command as Provider
        +
        Since:
        +
        4.0.0
        +
        See Also:
        +
        runCommand(String)
        +
        +
        • +
      + + + +
        +
      • +

        defaultCommand

        +
        public void defaultCommand​(String... command)
        +
        The main purpose of a CMD instruction is to provide + defaults for an executing container. +

        + Example in Groovy DSL: +

        + 

        + task createDockerfile(type: Dockerfile) {
+     defaultCommand('/usr/bin/wc', '--help')
+ }
+
        + The produced instruction looks as follows: +

        + 

        + CMD ["/usr/bin/wc", "--help"]
+
        +
        +
        Parameters:
        +
        command - Command
        +
        See Also:
        +
        defaultCommand(Provider)
        +
        +
        • +
      + + + +
        +
      • +

        defaultCommand

        +
        public void defaultCommand​(Provider<List<String>> provider)
        +
        A CMD instruction as Provider. +

        + Example in Groovy DSL: +

        + 

        + task createDockerfile(type: Dockerfile) {
+     defaultCommand(project.provider(new Callable<List<String>>() {
+         @Override
+         List<String> call() throws Exception {
+             ['/usr/bin/wc', '--help']
+         }
+     }))
+ }
+
        + The produced instruction looks as follows: +

        + 

        + CMD ["/usr/bin/wc", "--help"]
+
        +
        +
        Parameters:
        +
        provider - Command as Provider
        +
        Since:
        +
        4.0.0
        +
        See Also:
        +
        defaultCommand(String...)
        +
        +
        • +
      + + + +
        +
      • +

        exposePort

        +
        public void exposePort​(Integer... ports)
        +
        The EXPOSE instruction informs Docker that the + container will listen on the specified network ports at runtime. +

        + Example in Groovy DSL: +

        + 

        + task createDockerfile(type: Dockerfile) {
+     exposePort(8080, 9090)
+ }
+
        + The produced instruction looks as follows: +

        + 

        + EXPOSE 8080 9090
+
        +
        +
        Parameters:
        +
        ports - Ports
        +
        See Also:
        +
        exposePort(Provider)
        +
        +
        • +
      + + + +
        +
      • +

        exposePort

        +
        public void exposePort​(Provider<List<Integer>> provider)
        +
        A EXPOSE instruction as Provider. +

        + Example in Groovy DSL: +

        + 

        + task createDockerfile(type: Dockerfile) {
+     exposePort(project.provider(new Callable<List<Integer>>() {
+         @Override
+         List<Integer> call() throws Exception {
+             [8080, 9090]
+         }
+     }))
+ }
+
        + The produced instruction looks as follows: +

        + 

        + EXPOSE 8080 9090
+
        +
        +
        Parameters:
        +
        provider - Ports as Provider
        +
        Since:
        +
        4.0.0
        +
        See Also:
        +
        exposePort(Integer...)
        +
        +
        • +
      + + + +
        +
      • +

        environmentVariable

        +
        public void environmentVariable​(String key,
+                                String value)
        +
        The ENV instruction sets the environment variable + <key> to the value <value>. This value will be passed to all future RUN instructions. +

        + Example in Groovy DSL: +

        + 

        + task createDockerfile(type: Dockerfile) {
+     environmentVariable('MY_NAME', 'John Doe')
+ }
+
        + The produced instruction looks as follows: +

        + 

        + ENV MY_NAME=John Doe
+
        +
        +
        Parameters:
        +
        key - Key
        +
        value - Value
        +
        See Also:
        +
        environmentVariable(Map), +environmentVariable(Provider)
        +
        +
        • +
      + + + + + + + +
        +
      • +

        environmentVariable

        +
        public void environmentVariable​(Provider<Map<String,​String>> provider)
        +
        A ENV instruction as Provider. +

        + Example in Groovy DSL: +

        + 

        + task createDockerfile(type: Dockerfile) {
+     environmentVariable(project.provider(new Callable<Map<String, String>>() {
+         @Override
+         Map<String, String> call() throws Exception {
+             ['MY_NAME': 'John Doe']
+         }
+     }))
+ }
+
        + The produced instruction looks as follows: +

        + 

        + ENV MY_NAME=John Doe
+
        +
        +
        Parameters:
        +
        provider - Environment variables as Provider
        +
        Since:
        +
        4.0.0
        +
        See Also:
        +
        environmentVariable(String, String), +environmentVariable(Map)
        +
        +
        • +
      + + + +
        +
      • +

        addFile

        +
        public void addFile​(String src,
+                    String dest)
        +
        The ADD instruction copies new files, directories + or remote file URLs from <src> and adds them to the filesystem of the container at the path <dest>. +

        + Example in Groovy DSL: +

        + 

        + task createDockerfile(type: Dockerfile) {
+     addFile('test', '/absoluteDir/')
+ }
+
        + The produced instruction looks as follows: +

        + 

        + ADD test /absoluteDir/
+
        +
        +
        Parameters:
        +
        src - The source path
        +
        dest - The destination path
        +
        See Also:
        +
        addFile(File), +addFile(Provider)
        +
        +
        • +
      + + + +
        +
      • +

        addFile

        +
        public void addFile​(Dockerfile.File file)
        +
        The ADD instruction copies new files, directories + or remote file URLs from <src> and adds them to the filesystem of the container at the path <dest>. +

        + Example in Groovy DSL: +

        + 

        + task createDockerfile(type: Dockerfile) {
+     addFile(new Dockerfile.File('test', '/absoluteDir/'))
+ }
+
        + The produced instruction looks as follows: +

        + 

        + ADD test /absoluteDir/
+
        +
        +
        Parameters:
        +
        file - Dockerfile.File definition
        +
        See Also:
        +
        addFile(String, String), +addFile(Provider)
        +
        +
        • +
      + + + +
        +
      • +

        addFile

        +
        public void addFile​(Provider<Dockerfile.File> provider)
        +
        An ADD instruction as Provider. +

        + Example in Groovy DSL: +

        + 

        + task createDockerfile(type: Dockerfile) {
+     addFile(project.provider(new Callable<Dockerfile.File>() {
+         @Override
+         Dockerfile.File call() throws Exception {
+             new Dockerfile.File('test', '/absoluteDir/')
+         }
+     }))
+ }
+
        + The produced instruction looks as follows: +

        + 

        + ADD test /absoluteDir/
+
        +
        +
        Parameters:
        +
        provider - Add instruction as Provider
        +
        Since:
        +
        4.0.0
        +
        See Also:
        +
        addFile(String, String), +addFile(File)
        +
        +
        • +
      + + + +
        +
      • +

        copyFile

        +
        public void copyFile​(String src,
+                     String dest)
        +
        The COPY instruction copies new files or directories + from <src> and adds them to the filesystem of the container at the path <dest>. +

        + Example in Groovy DSL: +

        + 

        + task createDockerfile(type: Dockerfile) {
+     copyFile('test', '/absoluteDir/')
+ }
+
        + The produced instruction looks as follows: +

        + 

        + COPY test /absoluteDir/
+
        +
        +
        Parameters:
        +
        src - The source path
        +
        dest - The destination path
        +
        See Also:
        +
        copyFile(CopyFile), +copyFile(Provider)
        +
        +
        • +
      + + + +
        +
      • +

        copyFile

        +
        public void copyFile​(Dockerfile.CopyFile file)
        +
        The COPY instruction copies new files or directories + from <src> and adds them to the filesystem of the container at the path <dest>. +

        + Example in Groovy DSL: +

        + 

        + task createDockerfile(type: Dockerfile) {
+     copyFile(new Dockerfile.CopyFile('test', '/absoluteDir/'))
+ }
+
        + The produced instruction looks as follows: +

        + 

        + COPY test /absoluteDir/
+
        +
        +
        Parameters:
        +
        file - CopyFile definition
        +
        See Also:
        +
        copyFile(String, String), +copyFile(Provider)
        +
        +
        • +
      + + + +
        +
      • +

        copyFile

        +
        public void copyFile​(Provider<Dockerfile.CopyFile> provider)
        +
        A COPY instruction as Provider. +

        + Example in Groovy DSL: +

        + 

        + task createDockerfile(type: Dockerfile) {
+     copyFile(project.provider(new Callable<Dockerfile.CopyFile>() {
+         @Override
+         Dockerfile.CopyFile call() throws Exception {
+             new Dockerfile.CopyFile('test', '/absoluteDir/')
+         }
+     }))
+ }
+
        + The produced instruction looks as follows: +

        + 

        + COPY test /absoluteDir/
+
        +
        +
        Parameters:
        +
        provider - Copy instruction as Provider
        +
        Since:
        +
        4.0.0
        +
        See Also:
        +
        copyFile(String, String), +copyFile(CopyFile)
        +
        +
        • +
      + + + +
        +
      • +

        entryPoint

        +
        public void entryPoint​(String... entryPoint)
        +
        An ENTRYPOINT allows you to configure a container + that will run as an executable. +

        + Example in Groovy DSL: +

        + 

        + task createDockerfile(type: Dockerfile) {
+     entryPoint('top', '-b')
+ }
+
        + The produced instruction looks as follows: +

        + 

        + ENTRYPOINT ["top", "-b"]
+
        +
        +
        Parameters:
        +
        entryPoint - Entry point
        +
        See Also:
        +
        entryPoint(Provider)
        +
        +
        • +
      + + + +
        +
      • +

        entryPoint

        +
        public void entryPoint​(Provider<List<String>> provider)
        +
        A ENTRYPOINT as Provider. +

        + Example in Groovy DSL: +

        + 

        + task createDockerfile(type: Dockerfile) {
+     entryPoint(project.provider(new Callable<List<String>>() {
+         @Override
+         List<String> call() throws Exception {
+             ['top', '-b']
+         }
+     }))
+ }
+
        + The produced instruction looks as follows: +

        + 

        + ENTRYPOINT ["top", "-b"]
+
        +
        +
        Parameters:
        +
        provider - Entry point
        +
        Since:
        +
        4.0.0
        +
        See Also:
        +
        entryPoint(String...)
        +
        +
        • +
      + + + +
        +
      • +

        volume

        +
        public void volume​(String... volume)
        +
        The VOLUME instruction will create a mount point + with the specified name and mark it as holding externally mounted volumes from native host or other containers. +

        + Example in Groovy DSL: +

        + 

        + task createDockerfile(type: Dockerfile) {
+     volume('/myvol')
+ }
+
        + The produced instruction looks as follows: +

        + 

        + VOLUME ["/myvol"]
+
        +
        +
        Parameters:
        +
        volume - Volume
        +
        See Also:
        +
        volume(Provider)
        +
        +
        • +
      + + + +
        +
      • +

        volume

        +
        public void volume​(Provider<List<String>> provider)
        +
        A VOLUME instruction as Provider. +

        + Example in Groovy DSL: +

        + 

        + task createDockerfile(type: Dockerfile) {
+     volume(project.provider(new Callable<List<String>>() {
+         @Override
+         List<String> call() throws Exception {
+             ['/myvol']
+         }
+     }))
+ }
+
        + The produced instruction looks as follows: +

        + 

        + VOLUME ["/myvol"]
+
        +
        +
        Parameters:
        +
        provider - Volume
        +
        Since:
        +
        4.0.0
        +
        See Also:
        +
        volume(String...)
        +
        +
        • +
      + + + +
        +
      • +

        user

        +
        public void user​(String user)
        +
        The USER instruction sets the user name or UID to + use when running the image and for any RUN, CMD and ENTRYPOINT instructions that follow it in the Dockerfile. +

        + Example in Groovy DSL: +

        + 

        + task createDockerfile(type: Dockerfile) {
+     user('patrick')
+ }
+
        + The produced instruction looks as follows: +

        + 

        + USER patrick
+
        +
        +
        Parameters:
        +
        user - User
        +
        See Also:
        +
        user(Provider)
        +
        +
        • +
      + + + +
        +
      • +

        user

        +
        public void user​(Provider<String> provider)
        +
        A USER instruction as Provider. +

        + Example in Groovy DSL: +

        + 

        + task createDockerfile(type: Dockerfile) {
+     user(project.provider(new Callable<String>() {
+         @Override
+         String call() throws Exception {
+             'patrick'
+         }
+     }))
+ }
+
        + The produced instruction looks as follows: +

        + 

        + USER patrick
+
        +
        +
        Parameters:
        +
        provider - User as Provider
        +
        Since:
        +
        4.0.0
        +
        See Also:
        +
        user(String)
        +
        +
        • +
      + + + +
        +
      • +

        workingDir

        +
        public void workingDir​(String dir)
        +
        The WORKDIR instruction sets the working directory + for any RUN, CMD and ENTRYPOINT instructions that follow it in the Dockerfile. +

        + Example in Groovy DSL: +

        + 

        + task createDockerfile(type: Dockerfile) {
+     workingDir('/path/to/workdir')
+ }
+
        + The produced instruction looks as follows: +

        + 

        + WORKDIR /path/to/workdir
+
        +
        +
        Parameters:
        +
        dir - Directory
        +
        See Also:
        +
        workingDir(Provider)
        +
        +
        • +
      + + + +
        +
      • +

        workingDir

        +
        public void workingDir​(Provider<String> provider)
        +
        A WORKDIR instruction as Provider. +

        + Example in Groovy DSL: +

        + 

        + task createDockerfile(type: Dockerfile) {
+     workingDir(project.provider(new Callable<String>() {
+         @Override
+         String call() throws Exception {
+             '/path/to/workdir'
+         }
+     }))
+ }
+
        + The produced instruction looks as follows: +

        + 

        + WORKDIR /path/to/workdir
+
        +
        +
        Parameters:
        +
        provider - Directory
        +
        Since:
        +
        4.0.0
        +
        See Also:
        +
        workingDir(String)
        +
        +
        • +
      + + + +
        +
      • +

        onBuild

        +
        public void onBuild​(String instruction)
        +
        The ONBUILD instruction adds to the image a + trigger instruction to be executed at a later time, when the image is used as the base for another build. +

        + Example in Groovy DSL: +

        + 

        + task createDockerfile(type: Dockerfile) {
+     onBuild('ADD . /app/src')
+ }
+
        + The produced instruction looks as follows: +

        + 

        + ONBUILD ADD . /app/src
+
        +
        +
        Parameters:
        +
        instruction - Instruction
        +
        See Also:
        +
        onBuild(Provider)
        +
        +
        • +
      + + + +
        +
      • +

        onBuild

        +
        public void onBuild​(Provider<String> provider)
        +
        A ONBUILD instruction as Provider. +

        + Example in Groovy DSL: +

        + 

        + task createDockerfile(type: Dockerfile) {
+     onBuild(project.provider(new Callable<String>() {
+         @Override
+         String call() throws Exception {
+             'ADD . /app/src'
+         }
+     }))
+ }
+
        + The produced instruction looks as follows: +

        + 

        + ONBUILD ADD . /app/src
+
        +
        +
        Parameters:
        +
        provider - Instruction
        +
        Since:
        +
        4.0.0
        +
        See Also:
        +
        onBuild(String)
        +
        +
        • +
      + + + +
        +
      • +

        label

        +
        public void label​(Map<String,​String> labels)
        +
        The LABEL instruction adds metadata to an image. +

        + Example in Groovy DSL: +

        + 

        + task createDockerfile(type: Dockerfile) {
+     label(['version': '1.0'])
+ }
+
        + The produced instruction looks as follows: +

        + 

        + LABEL version=1.0
+
        +
        +
        Parameters:
        +
        labels - Labels
        +
        See Also:
        +
        label(Provider)
        +
        +
        • +
      + + + +
        +
      • +

        label

        +
        public void label​(Provider<Map<String,​String>> provider)
        +
        A LABEL instruction as Provider. +

        + Example in Groovy DSL: +

        + 

        + task createDockerfile(type: Dockerfile) {
+     label(project.provider(new Callable<Map<String, String>>() {
+         @Override
+         Map<String, String> call() throws Exception {
+             ['version': '1.0']
+         }
+     }))
+ }
+
        + The produced instruction looks as follows: +

        + 

        + LABEL version=1.0
+
        +
        +
        Parameters:
        +
        provider - Labels as Provider
        +
        Since:
        +
        4.0.0
        +
        See Also:
        +
        label(Map)
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/package-summary.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/package-summary.html new file mode 100644 index 000000000..f741d69e9 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/package-summary.html @@ -0,0 +1,363 @@ + + + + + +com.bmuschko.gradle.docker.tasks.image (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+
+
+

Package com.bmuschko.gradle.docker.tasks.image

+
+
+ +
+
+ + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/package-tree.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/package-tree.html new file mode 100644 index 000000000..4d7f1d34f --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/image/package-tree.html @@ -0,0 +1,235 @@ + + + + + +com.bmuschko.gradle.docker.tasks.image Class Hierarchy (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package com.bmuschko.gradle.docker.tasks.image

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+ +
+
+

Interface Hierarchy

+ +
+
+
+ + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/network/DockerCreateNetwork.Ipam.Config.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/network/DockerCreateNetwork.Ipam.Config.html new file mode 100644 index 000000000..b0438c3d9 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/network/DockerCreateNetwork.Ipam.Config.html @@ -0,0 +1,414 @@ + + + + + +DockerCreateNetwork.Ipam.Config (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.network
+

Class DockerCreateNetwork.Ipam.Config

+
+
+ +
+ +
+
+ +
+
+ +
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/network/DockerCreateNetwork.Ipam.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/network/DockerCreateNetwork.Ipam.html new file mode 100644 index 000000000..4fe479288 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/network/DockerCreateNetwork.Ipam.html @@ -0,0 +1,348 @@ + + + + + +DockerCreateNetwork.Ipam (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.network
+

Class DockerCreateNetwork.Ipam

+
+
+ +
+ +
+
+ +
+
+ +
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/network/DockerCreateNetwork.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/network/DockerCreateNetwork.html new file mode 100644 index 000000000..bd933abff --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/network/DockerCreateNetwork.html @@ -0,0 +1,464 @@ + + + + + +DockerCreateNetwork (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.network
+

Class DockerCreateNetwork

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        DockerCreateNetwork

        +
        @Inject
+public DockerCreateNetwork​(ObjectFactory objects)
        +
        • +
      +
      • +
    +
    + +
    + +
    +
    • +
+
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/network/DockerExistingNetwork.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/network/DockerExistingNetwork.html new file mode 100644 index 000000000..a873e77c3 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/network/DockerExistingNetwork.html @@ -0,0 +1,465 @@ + + + + + +DockerExistingNetwork (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.network
+

Class DockerExistingNetwork

+
+
+ +
+ +
+
+ +
+
+ +
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/network/DockerInspectNetwork.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/network/DockerInspectNetwork.html new file mode 100644 index 000000000..b2c8740ee --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/network/DockerInspectNetwork.html @@ -0,0 +1,401 @@ + + + + + +DockerInspectNetwork (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.network
+

Class DockerInspectNetwork

+
+
+ +
+ +
+
+ +
+
+ +
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/network/DockerRemoveNetwork.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/network/DockerRemoveNetwork.html new file mode 100644 index 000000000..4d337a292 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/network/DockerRemoveNetwork.html @@ -0,0 +1,401 @@ + + + + + +DockerRemoveNetwork (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.bmuschko.gradle.docker.tasks.network
+

Class DockerRemoveNetwork

+
+
+ +
+ +
+
+ +
+
+ +
+
+
+ + + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/network/package-summary.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/network/package-summary.html new file mode 100644 index 000000000..4a70bfbea --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/network/package-summary.html @@ -0,0 +1,184 @@ + + + + + +com.bmuschko.gradle.docker.tasks.network (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+
+
+

Package com.bmuschko.gradle.docker.tasks.network

+
+
+ +
+
+ + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/network/package-tree.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/network/package-tree.html new file mode 100644 index 000000000..3e1b78f6e --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/network/package-tree.html @@ -0,0 +1,181 @@ + + + + + +com.bmuschko.gradle.docker.tasks.network Class Hierarchy (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package com.bmuschko.gradle.docker.tasks.network

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+ +
+
+
+ + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/package-summary.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/package-summary.html new file mode 100644 index 000000000..b5daaee37 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/package-summary.html @@ -0,0 +1,193 @@ + + + + + +com.bmuschko.gradle.docker.tasks (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+
+
+

Package com.bmuschko.gradle.docker.tasks

+
+
+ +
+
+ + + diff --git a/9.3.3/api/com/bmuschko/gradle/docker/tasks/package-tree.html b/9.3.3/api/com/bmuschko/gradle/docker/tasks/package-tree.html new file mode 100644 index 000000000..3c148e8c4 --- /dev/null +++ b/9.3.3/api/com/bmuschko/gradle/docker/tasks/package-tree.html @@ -0,0 +1,198 @@ + + + + + +com.bmuschko.gradle.docker.tasks Class Hierarchy (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package com.bmuschko.gradle.docker.tasks

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+
    +
  • java.lang.Object +
      +
    • org.gradle.api.internal.AbstractTask (implements org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal) + +
      • +
    +
    • +
+
+
+

Interface Hierarchy

+ +
+
+
+ + + diff --git a/9.3.3/api/constant-values.html b/9.3.3/api/constant-values.html new file mode 100644 index 000000000..9e6ddaf3c --- /dev/null +++ b/9.3.3/api/constant-values.html @@ -0,0 +1,570 @@ + + + + + +Constant Field Values (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+
+
+

Constant Field Values

+
+

Contents

+ +
+
+
+ + +
+

com.bmuschko.*

+ + +
+
+
+ + + diff --git a/9.3.3/api/deprecated-list.html b/9.3.3/api/deprecated-list.html new file mode 100644 index 000000000..38a66e547 --- /dev/null +++ b/9.3.3/api/deprecated-list.html @@ -0,0 +1,172 @@ + + + + + +Deprecated List (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+
+
+

Deprecated API

+

Contents

+ +
+
+ + + +
+
+ + + diff --git a/9.3.3/api/element-list b/9.3.3/api/element-list new file mode 100644 index 000000000..e5d733172 --- /dev/null +++ b/9.3.3/api/element-list @@ -0,0 +1,8 @@ +com.bmuschko.gradle.docker +com.bmuschko.gradle.docker.domain +com.bmuschko.gradle.docker.internal +com.bmuschko.gradle.docker.internal.services +com.bmuschko.gradle.docker.tasks +com.bmuschko.gradle.docker.tasks.container +com.bmuschko.gradle.docker.tasks.image +com.bmuschko.gradle.docker.tasks.network diff --git a/9.3.3/api/help-doc.html b/9.3.3/api/help-doc.html new file mode 100644 index 000000000..557ec3ccc --- /dev/null +++ b/9.3.3/api/help-doc.html @@ -0,0 +1,272 @@ + + + + + +API Help (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+
+
+

How This API Document Is Organized

+
This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.
+
+
+ +
+This help file applies to API documentation generated by the standard doclet.
+
+ + + diff --git a/9.3.3/api/index-all.html b/9.3.3/api/index-all.html new file mode 100644 index 000000000..947637486 --- /dev/null +++ b/9.3.3/api/index-all.html @@ -0,0 +1,2070 @@ + + + + + +Index (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+
+
A B C D E F G H I J K L M O P R S T U V W _ 
All Classes All Packages + + +

A

+
+
AbstractDockerRemoteApiTask - Class in com.bmuschko.gradle.docker.tasks
+
 
+
AbstractDockerRemoteApiTask() - Constructor for class com.bmuschko.gradle.docker.tasks.AbstractDockerRemoteApiTask
+
 
+
accept(String) - Method in class com.bmuschko.gradle.docker.internal.OutputCollector
+
+
Accept a string as input.
+
+
addFile(Dockerfile.File) - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile
+
+
The ADD instruction copies new files, directories + or remote file URLs from <src> and adds them to the filesystem of the container at the path <dest>.
+
+
addFile(String, String) - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile
+
+
The ADD instruction copies new files, directories + or remote file URLs from <src> and adds them to the filesystem of the container at the path <dest>.
+
+
addFile(Provider<Dockerfile.File>) - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile
+
+
An ADD instruction as Provider.
+
+
AddFileInstruction(Dockerfile.File) - Constructor for class com.bmuschko.gradle.docker.tasks.image.Dockerfile.AddFileInstruction
+
 
+
AddFileInstruction(Provider<Dockerfile.File>) - Constructor for class com.bmuschko.gradle.docker.tasks.image.Dockerfile.AddFileInstruction
+
 
+
apply(Project) - Method in class com.bmuschko.gradle.docker.DockerConventionJvmApplicationPlugin
+
 
+
apply(Project) - Method in class com.bmuschko.gradle.docker.DockerRemoteApiPlugin
+
 
+
arg(String) - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile
+
+
The ARG instruction defines a variable that + users can pass at build-time to the builder.
+
+
arg(Provider<String>) - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile
+
+
An ARG instruction as Provider.
+
+
ArgInstruction(String) - Constructor for class com.bmuschko.gradle.docker.tasks.image.Dockerfile.ArgInstruction
+
 
+
ArgInstruction(Provider<String>) - Constructor for class com.bmuschko.gradle.docker.tasks.image.Dockerfile.ArgInstruction
+
 
+
asPasswordCredentials() - Method in class com.bmuschko.gradle.docker.DockerRegistryCredentials
+
+
Translates the Docker registry credentials into a PasswordCredentials.
+
+
+ + + +

B

+
+
BUILD_IMAGE_TASK_NAME - Static variable in class com.bmuschko.gradle.docker.DockerConventionJvmApplicationPlugin
+
+
The task name that builds the Docker image for the Java application.
+
+
+ + + +

C

+
+
close() - Method in class com.bmuschko.gradle.docker.internal.OutputCollector
+
 
+
close() - Method in class com.bmuschko.gradle.docker.internal.services.DockerClientService
+
 
+
cmd(String) - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer.HealthCheckConfig
+
 
+
com.bmuschko.gradle.docker - package com.bmuschko.gradle.docker
+
 
+
com.bmuschko.gradle.docker.domain - package com.bmuschko.gradle.docker.domain
+
 
+
com.bmuschko.gradle.docker.internal - package com.bmuschko.gradle.docker.internal
+
 
+
com.bmuschko.gradle.docker.internal.services - package com.bmuschko.gradle.docker.internal.services
+
 
+
com.bmuschko.gradle.docker.tasks - package com.bmuschko.gradle.docker.tasks
+
 
+
com.bmuschko.gradle.docker.tasks.container - package com.bmuschko.gradle.docker.tasks.container
+
 
+
com.bmuschko.gradle.docker.tasks.image - package com.bmuschko.gradle.docker.tasks.image
+
 
+
com.bmuschko.gradle.docker.tasks.network - package com.bmuschko.gradle.docker.tasks.network
+
 
+
CommentInstruction(String) - Constructor for class com.bmuschko.gradle.docker.tasks.image.Dockerfile.CommentInstruction
+
 
+
CommentInstruction(Provider<String>) - Constructor for class com.bmuschko.gradle.docker.tasks.image.Dockerfile.CommentInstruction
+
 
+
Config() - Constructor for class com.bmuschko.gradle.docker.tasks.network.DockerCreateNetwork.Ipam.Config
+
 
+
configureExtension(ObjectFactory, DockerExtension) - Method in class com.bmuschko.gradle.docker.DockerConventionJvmApplicationPlugin
+
 
+
configureExtension(ObjectFactory, DockerExtension) - Method in class com.bmuschko.gradle.docker.DockerJavaApplicationPlugin
+
 
+
configureExtension(ObjectFactory, DockerExtension) - Method in class com.bmuschko.gradle.docker.DockerSpringBootApplicationPlugin
+
 
+
ConventionPluginHelper - Class in com.bmuschko.gradle.docker.internal
+
 
+
copyFile(Dockerfile.CopyFile) - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile
+
+
The COPY instruction copies new files or directories + from <src> and adds them to the filesystem of the container at the path <dest>.
+
+
copyFile(String, String) - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile
+
+
The COPY instruction copies new files or directories + from <src> and adds them to the filesystem of the container at the path <dest>.
+
+
copyFile(Provider<Dockerfile.CopyFile>) - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile
+
+
A COPY instruction as Provider.
+
+
CopyFile(String, String) - Constructor for class com.bmuschko.gradle.docker.tasks.image.Dockerfile.CopyFile
+
 
+
CopyFileInstruction(Dockerfile.CopyFile) - Constructor for class com.bmuschko.gradle.docker.tasks.image.Dockerfile.CopyFileInstruction
+
 
+
CopyFileInstruction(Provider<Dockerfile.CopyFile>) - Constructor for class com.bmuschko.gradle.docker.tasks.image.Dockerfile.CopyFileInstruction
+
 
+
CopyFileToContainer - Class in com.bmuschko.gradle.docker.domain
+
+
Class holding metadata for an arbitrary copy-file-to-container invocation.
+
+
CopyFileToContainer() - Constructor for class com.bmuschko.gradle.docker.domain.CopyFileToContainer
+
 
+
copyMultipleFiles(Path, Path) - Static method in class com.bmuschko.gradle.docker.internal.CopyUtils
+
+
Copy files inside tempDestination into hostDestination
+
+
copySingleFile(Path, Path) - Static method in class com.bmuschko.gradle.docker.internal.CopyUtils
+
+
Copy regular file inside tempDestination to, or into, hostDestination
+
+
CopyUtils - Class in com.bmuschko.gradle.docker.internal
+
 
+
create() - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile
+
 
+
createAppFilesCopySpec(Project) - Static method in class com.bmuschko.gradle.docker.internal.ConventionPluginHelper
+
 
+
+ + + +

D

+
+
DEFAULT_TASK_GROUP - Static variable in class com.bmuschko.gradle.docker.DockerRemoteApiPlugin
+
+
The group for all tasks created by this plugin.
+
+
DEFAULT_URL - Static variable in class com.bmuschko.gradle.docker.DockerRegistryCredentials
+
+
The registry URL used as default value for the property DockerRegistryCredentials.url.
+
+
defaultCommand(String...) - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile
+
+
The main purpose of a CMD instruction is to provide + defaults for an executing container.
+
+
defaultCommand(Provider<List<String>>) - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile
+
+
A CMD instruction as Provider.
+
+
DefaultCommandInstruction(String...) - Constructor for class com.bmuschko.gradle.docker.tasks.image.Dockerfile.DefaultCommandInstruction
+
 
+
DefaultCommandInstruction(Provider<List<String>>) - Constructor for class com.bmuschko.gradle.docker.tasks.image.Dockerfile.DefaultCommandInstruction
+
 
+
DefaultDockerConfigResolver - Class in com.bmuschko.gradle.docker.internal
+
 
+
DefaultDockerConfigResolver() - Constructor for class com.bmuschko.gradle.docker.internal.DefaultDockerConfigResolver
+
 
+
DefaultDockerUrlValueSource - Class in com.bmuschko.gradle.docker.internal
+
 
+
DefaultDockerUrlValueSource() - Constructor for class com.bmuschko.gradle.docker.internal.DefaultDockerUrlValueSource
+
 
+
DockerBuildImage - Class in com.bmuschko.gradle.docker.tasks.image
+
 
+
DockerBuildImage() - Constructor for class com.bmuschko.gradle.docker.tasks.image.DockerBuildImage
+
 
+
DockerClientService - Class in com.bmuschko.gradle.docker.internal.services
+
+
Build service for Docker client.
+
+
DockerClientService(ObjectFactory) - Constructor for class com.bmuschko.gradle.docker.internal.services.DockerClientService
+
+
Constructor for Docker client service.
+
+
DockerClientService.Params - Interface in com.bmuschko.gradle.docker.internal.services
+
+
Parameters for build service.
+
+
DockerCommitImage - Class in com.bmuschko.gradle.docker.tasks.image
+
 
+
DockerCommitImage() - Constructor for class com.bmuschko.gradle.docker.tasks.image.DockerCommitImage
+
 
+
DockerConfigResolver - Interface in com.bmuschko.gradle.docker.internal
+
 
+
DockerConventionJvmApplicationExtension - Class in com.bmuschko.gradle.docker
+
+
The extension for configuring a conventional JVM Docker plugin.
+
+
DockerConventionJvmApplicationExtension(ObjectFactory) - Constructor for class com.bmuschko.gradle.docker.DockerConventionJvmApplicationExtension
+
 
+
DockerConventionJvmApplicationPlugin<EXT extends DockerConventionJvmApplicationExtension> - Class in com.bmuschko.gradle.docker
+
+
The abstract class for all conventional JVM application plugins.
+
+
DockerConventionJvmApplicationPlugin() - Constructor for class com.bmuschko.gradle.docker.DockerConventionJvmApplicationPlugin
+
 
+
DockerCopyFileFromContainer - Class in com.bmuschko.gradle.docker.tasks.container
+
 
+
DockerCopyFileFromContainer(ObjectFactory, ProjectLayout, FileSystemOperations, ArchiveOperations) - Constructor for class com.bmuschko.gradle.docker.tasks.container.DockerCopyFileFromContainer
+
 
+
DockerCopyFileToContainer - Class in com.bmuschko.gradle.docker.tasks.container
+
 
+
DockerCopyFileToContainer() - Constructor for class com.bmuschko.gradle.docker.tasks.container.DockerCopyFileToContainer
+
 
+
DockerCreateContainer - Class in com.bmuschko.gradle.docker.tasks.container
+
 
+
DockerCreateContainer(ObjectFactory) - Constructor for class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer
+
 
+
DockerCreateContainer.ExposedPort - Class in com.bmuschko.gradle.docker.tasks.container
+
 
+
DockerCreateContainer.HealthCheckConfig - Class in com.bmuschko.gradle.docker.tasks.container
+
 
+
DockerCreateContainer.HostConfig - Class in com.bmuschko.gradle.docker.tasks.container
+
 
+
DockerCreateContainer.HostConfig.LogConfig - Class in com.bmuschko.gradle.docker.tasks.container
+
 
+
DockerCreateNetwork - Class in com.bmuschko.gradle.docker.tasks.network
+
 
+
DockerCreateNetwork(ObjectFactory) - Constructor for class com.bmuschko.gradle.docker.tasks.network.DockerCreateNetwork
+
 
+
DockerCreateNetwork.Ipam - Class in com.bmuschko.gradle.docker.tasks.network
+
 
+
DockerCreateNetwork.Ipam.Config - Class in com.bmuschko.gradle.docker.tasks.network
+
 
+
DockerExecContainer - Class in com.bmuschko.gradle.docker.tasks.container
+
 
+
DockerExecContainer() - Constructor for class com.bmuschko.gradle.docker.tasks.container.DockerExecContainer
+
 
+
DockerExistingContainer - Class in com.bmuschko.gradle.docker.tasks.container
+
 
+
DockerExistingContainer() - Constructor for class com.bmuschko.gradle.docker.tasks.container.DockerExistingContainer
+
 
+
DockerExistingImage - Class in com.bmuschko.gradle.docker.tasks.image
+
 
+
DockerExistingImage() - Constructor for class com.bmuschko.gradle.docker.tasks.image.DockerExistingImage
+
 
+
DockerExistingNetwork - Class in com.bmuschko.gradle.docker.tasks.network
+
 
+
DockerExistingNetwork() - Constructor for class com.bmuschko.gradle.docker.tasks.network.DockerExistingNetwork
+
 
+
DockerExtension - Class in com.bmuschko.gradle.docker
+
+
The extension for configuring the Docker communication via the remote API through the DockerRemoteApiPlugin.
+
+
DockerExtension(ObjectFactory, ProviderFactory) - Constructor for class com.bmuschko.gradle.docker.DockerExtension
+
 
+
Dockerfile - Class in com.bmuschko.gradle.docker.tasks.image
+
+
Creates a Dockerfile based on the provided instructions.
+
+
Dockerfile() - Constructor for class com.bmuschko.gradle.docker.tasks.image.Dockerfile
+
 
+
DOCKERFILE_TASK_NAME - Static variable in class com.bmuschko.gradle.docker.DockerConventionJvmApplicationPlugin
+
+
The task name that creates the Docker image for the Java application.
+
+
Dockerfile.AddFileInstruction - Class in com.bmuschko.gradle.docker.tasks.image
+
+
Represents a ADD instruction.
+
+
Dockerfile.ArgInstruction - Class in com.bmuschko.gradle.docker.tasks.image
+
+
Represents a ARG instruction.
+
+
Dockerfile.CommentInstruction - Class in com.bmuschko.gradle.docker.tasks.image
+
+
Represents a comment instruction.
+
+
Dockerfile.CopyFile - Class in com.bmuschko.gradle.docker.tasks.image
+
+
Input data for a Dockerfile.CopyFileInstruction.
+
+
Dockerfile.CopyFileInstruction - Class in com.bmuschko.gradle.docker.tasks.image
+
+
Represents a COPY instruction.
+
+
Dockerfile.DefaultCommandInstruction - Class in com.bmuschko.gradle.docker.tasks.image
+
+
Represents a CMD instruction.
+
+
Dockerfile.EntryPointInstruction - Class in com.bmuschko.gradle.docker.tasks.image
+
+
Represents a ENTRYPOINT instruction.
+
+
Dockerfile.EnvironmentVariableInstruction - Class in com.bmuschko.gradle.docker.tasks.image
+
+
Represents a ENV instruction.
+
+
Dockerfile.ExposePortInstruction - Class in com.bmuschko.gradle.docker.tasks.image
+
+
Represents a EXPOSE instruction.
+
+
Dockerfile.File - Class in com.bmuschko.gradle.docker.tasks.image
+
+
Input data for a Dockerfile.AddFileInstruction or Dockerfile.CopyFileInstruction.
+
+
Dockerfile.FileInstruction<T extends Dockerfile.File> - Class in com.bmuschko.gradle.docker.tasks.image
+
+
An instruction whose value is a Dockerfile.File.
+
+
Dockerfile.From - Class in com.bmuschko.gradle.docker.tasks.image
+
+
Input data for a Dockerfile.FromInstruction.
+
+
Dockerfile.FromInstruction - Class in com.bmuschko.gradle.docker.tasks.image
+
+
Represents a FROM instruction.
+
+
Dockerfile.GenericInstruction - Class in com.bmuschko.gradle.docker.tasks.image
+
+
An instruction that uses the provided value as-is without any additional formatting.
+
+
Dockerfile.Instruction - Interface in com.bmuschko.gradle.docker.tasks.image
+
+
A representation of an instruction in a Dockerfile.
+
+
Dockerfile.LabelInstruction - Class in com.bmuschko.gradle.docker.tasks.image
+
+
Represents a LABEL instruction.
+
+
Dockerfile.MapInstruction - Class in com.bmuschko.gradle.docker.tasks.image
+
+
An instruction whose value is a Map.
+
+
Dockerfile.OnBuildInstruction - Class in com.bmuschko.gradle.docker.tasks.image
+
+
Represents a ONBUILD instruction.
+
+
Dockerfile.RunCommandInstruction - Class in com.bmuschko.gradle.docker.tasks.image
+
+
Represents a RUN instruction.
+
+
Dockerfile.StringArrayInstruction - Class in com.bmuschko.gradle.docker.tasks.image
+
+
An instruction whose value is a String array.
+
+
Dockerfile.StringCommandInstruction - Class in com.bmuschko.gradle.docker.tasks.image
+
+
An instruction whose value is a String.
+
+
Dockerfile.UserInstruction - Class in com.bmuschko.gradle.docker.tasks.image
+
+
Represents a USER instruction.
+
+
Dockerfile.VolumeInstruction - Class in com.bmuschko.gradle.docker.tasks.image
+
 
+
Dockerfile.WorkDirInstruction - Class in com.bmuschko.gradle.docker.tasks.image
+
+
Represents a WORKDIR instruction.
+
+
DockerInfo - Class in com.bmuschko.gradle.docker.tasks
+
 
+
DockerInfo() - Constructor for class com.bmuschko.gradle.docker.tasks.DockerInfo
+
 
+
DockerInspectContainer - Class in com.bmuschko.gradle.docker.tasks.container
+
 
+
DockerInspectContainer() - Constructor for class com.bmuschko.gradle.docker.tasks.container.DockerInspectContainer
+
 
+
DockerInspectExecContainer - Class in com.bmuschko.gradle.docker.tasks.container
+
+
Inspects task executed inside container + with DockerExecContainer command.
+
+
DockerInspectExecContainer() - Constructor for class com.bmuschko.gradle.docker.tasks.container.DockerInspectExecContainer
+
 
+
DockerInspectImage - Class in com.bmuschko.gradle.docker.tasks.image
+
 
+
DockerInspectImage() - Constructor for class com.bmuschko.gradle.docker.tasks.image.DockerInspectImage
+
 
+
DockerInspectNetwork - Class in com.bmuschko.gradle.docker.tasks.network
+
 
+
DockerInspectNetwork() - Constructor for class com.bmuschko.gradle.docker.tasks.network.DockerInspectNetwork
+
 
+
DockerJavaApplication - Class in com.bmuschko.gradle.docker
+
+
The extension for configuring a Java application via the DockerJavaApplicationPlugin.
+
+
DockerJavaApplication(ObjectFactory) - Constructor for class com.bmuschko.gradle.docker.DockerJavaApplication
+
 
+
DockerJavaApplicationPlugin - Class in com.bmuschko.gradle.docker
+
+
Opinionated Gradle plugin for creating and pushing a Docker image for a Java application.
+
+
DockerJavaApplicationPlugin() - Constructor for class com.bmuschko.gradle.docker.DockerJavaApplicationPlugin
+
 
+
DockerKillContainer - Class in com.bmuschko.gradle.docker.tasks.container
+
 
+
DockerKillContainer() - Constructor for class com.bmuschko.gradle.docker.tasks.container.DockerKillContainer
+
 
+
DockerListImages - Class in com.bmuschko.gradle.docker.tasks.image
+
 
+
DockerListImages() - Constructor for class com.bmuschko.gradle.docker.tasks.image.DockerListImages
+
 
+
DockerLoadImage - Class in com.bmuschko.gradle.docker.tasks.image
+
 
+
DockerLoadImage() - Constructor for class com.bmuschko.gradle.docker.tasks.image.DockerLoadImage
+
 
+
DockerLogsContainer - Class in com.bmuschko.gradle.docker.tasks.container
+
+
Copies the container logs into standard out/err, the same as the `docker logs` command.
+
+
DockerLogsContainer() - Constructor for class com.bmuschko.gradle.docker.tasks.container.DockerLogsContainer
+
 
+
DockerOperation - Class in com.bmuschko.gradle.docker.tasks
+
+
Passes the underlying `docker-java` client to the defined `onNext` closure if it exists.
+
+
DockerOperation() - Constructor for class com.bmuschko.gradle.docker.tasks.DockerOperation
+
 
+
DockerPullImage - Class in com.bmuschko.gradle.docker.tasks.image
+
 
+
DockerPullImage() - Constructor for class com.bmuschko.gradle.docker.tasks.image.DockerPullImage
+
 
+
DockerPushImage - Class in com.bmuschko.gradle.docker.tasks.image
+
 
+
DockerPushImage() - Constructor for class com.bmuschko.gradle.docker.tasks.image.DockerPushImage
+
 
+
DockerRegistryCredentials - Class in com.bmuschko.gradle.docker
+
+
The extension for configuring the Docker communication via the remote API through the DockerRemoteApiPlugin.
+
+
DockerRegistryCredentials(ObjectFactory) - Constructor for class com.bmuschko.gradle.docker.DockerRegistryCredentials
+
 
+
DockerRemoteApiPlugin - Class in com.bmuschko.gradle.docker
+
+
Gradle plugin that provides custom tasks for interacting with Docker via its remote API.
+
+
DockerRemoteApiPlugin() - Constructor for class com.bmuschko.gradle.docker.DockerRemoteApiPlugin
+
 
+
DockerRemoveContainer - Class in com.bmuschko.gradle.docker.tasks.container
+
 
+
DockerRemoveContainer() - Constructor for class com.bmuschko.gradle.docker.tasks.container.DockerRemoveContainer
+
 
+
DockerRemoveImage - Class in com.bmuschko.gradle.docker.tasks.image
+
 
+
DockerRemoveImage() - Constructor for class com.bmuschko.gradle.docker.tasks.image.DockerRemoveImage
+
 
+
DockerRemoveNetwork - Class in com.bmuschko.gradle.docker.tasks.network
+
 
+
DockerRemoveNetwork() - Constructor for class com.bmuschko.gradle.docker.tasks.network.DockerRemoveNetwork
+
 
+
DockerRenameContainer - Class in com.bmuschko.gradle.docker.tasks.container
+
 
+
DockerRenameContainer() - Constructor for class com.bmuschko.gradle.docker.tasks.container.DockerRenameContainer
+
 
+
DockerRestartContainer - Class in com.bmuschko.gradle.docker.tasks.container
+
 
+
DockerRestartContainer() - Constructor for class com.bmuschko.gradle.docker.tasks.container.DockerRestartContainer
+
 
+
DockerSaveImage - Class in com.bmuschko.gradle.docker.tasks.image
+
 
+
DockerSaveImage() - Constructor for class com.bmuschko.gradle.docker.tasks.image.DockerSaveImage
+
 
+
DockerSpringBootApplication - Class in com.bmuschko.gradle.docker
+
+
The extension for configuring a Spring Boot application via the DockerSpringBootApplicationPlugin.
+
+
DockerSpringBootApplication(ObjectFactory) - Constructor for class com.bmuschko.gradle.docker.DockerSpringBootApplication
+
 
+
DockerSpringBootApplicationPlugin - Class in com.bmuschko.gradle.docker
+
+
Opinionated Gradle plugin for creating and pushing a Docker image for a Spring Boot application.
+
+
DockerSpringBootApplicationPlugin() - Constructor for class com.bmuschko.gradle.docker.DockerSpringBootApplicationPlugin
+
 
+
DockerStartContainer - Class in com.bmuschko.gradle.docker.tasks.container
+
 
+
DockerStartContainer() - Constructor for class com.bmuschko.gradle.docker.tasks.container.DockerStartContainer
+
 
+
DockerStopContainer - Class in com.bmuschko.gradle.docker.tasks.container
+
 
+
DockerStopContainer() - Constructor for class com.bmuschko.gradle.docker.tasks.container.DockerStopContainer
+
 
+
DockerTagImage - Class in com.bmuschko.gradle.docker.tasks.image
+
 
+
DockerTagImage() - Constructor for class com.bmuschko.gradle.docker.tasks.image.DockerTagImage
+
 
+
DockerVersion - Class in com.bmuschko.gradle.docker.tasks
+
 
+
DockerVersion() - Constructor for class com.bmuschko.gradle.docker.tasks.DockerVersion
+
 
+
DockerWaitContainer - Class in com.bmuschko.gradle.docker.tasks.container
+
 
+
DockerWaitContainer() - Constructor for class com.bmuschko.gradle.docker.tasks.container.DockerWaitContainer
+
 
+
doRunRemoteCommand(DockerClient) - Method in class com.bmuschko.gradle.docker.tasks.container.DockerExecContainer
+
 
+
doWith(MainClassFinder.MainClass) - Method in interface com.bmuschko.gradle.docker.internal.MainClassFinder.MainClassCallback
+
 
+
doWithMainClasses(File, MainClassFinder.MainClassCallback<T>) - Static method in class com.bmuschko.gradle.docker.internal.MainClassFinder
+
 
+
+ + + +

E

+
+
entryPoint(String...) - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile
+
+
An ENTRYPOINT allows you to configure a container + that will run as an executable.
+
+
entryPoint(Provider<List<String>>) - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile
+
+
A ENTRYPOINT as Provider.
+
+
EntryPointInstruction(String...) - Constructor for class com.bmuschko.gradle.docker.tasks.image.Dockerfile.EntryPointInstruction
+
 
+
EntryPointInstruction(Provider<List<String>>) - Constructor for class com.bmuschko.gradle.docker.tasks.image.Dockerfile.EntryPointInstruction
+
 
+
environmentVariable(String, String) - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile
+
+
The ENV instruction sets the environment variable + <key> to the value <value>.
+
+
environmentVariable(Map<String, String>) - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile
+
+
A ENV instruction as Map.
+
+
environmentVariable(Provider<Map<String, String>>) - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile
+
+
A ENV instruction as Provider.
+
+
EnvironmentVariableInstruction(String, String) - Constructor for class com.bmuschko.gradle.docker.tasks.image.Dockerfile.EnvironmentVariableInstruction
+
 
+
EnvironmentVariableInstruction(Map<String, String>) - Constructor for class com.bmuschko.gradle.docker.tasks.image.Dockerfile.EnvironmentVariableInstruction
+
 
+
EnvironmentVariableInstruction(Provider<Map<String, String>>) - Constructor for class com.bmuschko.gradle.docker.tasks.image.Dockerfile.EnvironmentVariableInstruction
+
 
+
equals(Object) - Method in class com.bmuschko.gradle.docker.internal.MainClassFinder.MainClass
+
 
+
execProbe(long, long) - Method in class com.bmuschko.gradle.docker.tasks.container.DockerExecContainer
+
+
Define the livenessProbe options for this exec.
+
+
ExecProbe - Class in com.bmuschko.gradle.docker.domain
+
+
Class holding metadata for an arbitrary exec livenessProbe.
+
+
ExecProbe(long, long) - Constructor for class com.bmuschko.gradle.docker.domain.ExecProbe
+
 
+
ExposedPort(String, List<Integer>) - Constructor for class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer.ExposedPort
+
 
+
exposePort(Integer...) - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile
+
+
The EXPOSE instruction informs Docker that the + container will listen on the specified network ports at runtime.
+
+
exposePort(Provider<List<Integer>>) - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile
+
+
A EXPOSE instruction as Provider.
+
+
ExposePortInstruction(Integer...) - Constructor for class com.bmuschko.gradle.docker.tasks.image.Dockerfile.ExposePortInstruction
+
 
+
ExposePortInstruction(Provider<List<Integer>>) - Constructor for class com.bmuschko.gradle.docker.tasks.image.Dockerfile.ExposePortInstruction
+
 
+
exposePorts(String, List<Integer>) - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer
+
 
+
EXTENSION_NAME - Static variable in class com.bmuschko.gradle.docker.DockerRemoteApiPlugin
+
+
The name of the extension.
+
+
+ + + +

F

+
+
Factory(ExecOperations) - Constructor for class com.bmuschko.gradle.docker.internal.RegistryAuthLocator.Factory
+
 
+
File(String, String) - Constructor for class com.bmuschko.gradle.docker.tasks.image.Dockerfile.File
+
 
+
FileInstruction(Provider<T>) - Constructor for class com.bmuschko.gradle.docker.tasks.image.Dockerfile.FileInstruction
+
 
+
FileInstruction(T) - Constructor for class com.bmuschko.gradle.docker.tasks.image.Dockerfile.FileInstruction
+
 
+
findMainClassName(File) - Method in class com.bmuschko.gradle.docker.DockerConventionJvmApplicationPlugin
+
 
+
findMainClassName(File) - Method in class com.bmuschko.gradle.docker.DockerJavaApplicationPlugin
+
 
+
findMainClassName(File) - Method in class com.bmuschko.gradle.docker.DockerSpringBootApplicationPlugin
+
 
+
findSingleMainClass(File) - Static method in class com.bmuschko.gradle.docker.internal.MainClassFinder
+
 
+
findSingleMainClass(File, String) - Static method in class com.bmuschko.gradle.docker.internal.MainClassFinder
+
 
+
from(Dockerfile.From) - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile
+
+
The FROM instruction sets the Base Image for + subsequent instructions.
+
+
from(String) - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile
+
+
The FROM instruction sets the Base Image for + subsequent instructions.
+
+
from(Provider<Dockerfile.From>) - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile
+
+
A FROM instruction as Provider.
+
+
From(String) - Constructor for class com.bmuschko.gradle.docker.tasks.image.Dockerfile.From
+
 
+
FromInstruction(Dockerfile.From) - Constructor for class com.bmuschko.gradle.docker.tasks.image.Dockerfile.FromInstruction
+
 
+
FromInstruction(Provider<Dockerfile.From>) - Constructor for class com.bmuschko.gradle.docker.tasks.image.Dockerfile.FromInstruction
+
 
+
+ + + +

G

+
+
GenericInstruction(String) - Constructor for class com.bmuschko.gradle.docker.tasks.image.Dockerfile.GenericInstruction
+
 
+
GenericInstruction(Provider<String>) - Constructor for class com.bmuschko.gradle.docker.tasks.image.Dockerfile.GenericInstruction
+
 
+
getAnnotationNames() - Method in class com.bmuschko.gradle.docker.internal.MainClassFinder.MainClass
+
 
+
getApiVersion() - Method in class com.bmuschko.gradle.docker.DockerExtension
+
+
The remote API version.
+
+
getApiVersion() - Method in interface com.bmuschko.gradle.docker.internal.services.DockerClientService.Params
+
+
The remote API version.
+
+
getApiVersion() - Method in class com.bmuschko.gradle.docker.tasks.AbstractDockerRemoteApiTask
+
+
The Docker remote API version.
+
+
getArgs() - Method in class com.bmuschko.gradle.docker.DockerConventionJvmApplicationExtension
+
+
The program arguments appended to Java application.
+
+
getAttachStderr() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer
+
 
+
getAttachStderr() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerExecContainer
+
 
+
getAttachStderr() - Method in class com.bmuschko.gradle.docker.tasks.image.DockerCommitImage
+
 
+
getAttachStdin() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer
+
 
+
getAttachStdin() - Method in class com.bmuschko.gradle.docker.tasks.image.DockerCommitImage
+
 
+
getAttachStdout() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer
+
 
+
getAttachStdout() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerExecContainer
+
 
+
getAuthor() - Method in class com.bmuschko.gradle.docker.tasks.image.DockerCommitImage
+
+
Author of image e.g.
+
+
getAutoRemove() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer.HostConfig
+
+
Automatically remove the container when the container's process exits.
+
+
getAwaitStatusTimeout() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerWaitContainer
+
+
Wait timeout in seconds.
+
+
getBaseImage() - Method in class com.bmuschko.gradle.docker.DockerConventionJvmApplicationExtension
+
+
The Docker base image used for Java application.
+
+
getBinds() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer.HostConfig
+
 
+
getBuildArgs() - Method in class com.bmuschko.gradle.docker.tasks.image.DockerBuildImage
+
+
Build-time variables to pass to the image build.
+
+
getCacheFrom() - Method in class com.bmuschko.gradle.docker.tasks.image.DockerBuildImage
+
+
Images to consider as cache sources.
+
+
getCapAdd() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer.HostConfig
+
 
+
getCapDrop() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer.HostConfig
+
 
+
getCertPath() - Method in class com.bmuschko.gradle.docker.DockerExtension
+
+
The path to certificates for communicating with Docker over SSL.
+
+
getCertPath() - Method in interface com.bmuschko.gradle.docker.internal.services.DockerClientService.Params
+
+
The path to certificates for communicating with Docker over SSL.
+
+
getCertPath() - Method in class com.bmuschko.gradle.docker.tasks.AbstractDockerRemoteApiTask
+
+
Path to the Docker certificate and key.
+
+
getChown() - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile.File
+
+
Returns the ownership of the copied content.
+
+
getCmd() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer
+
 
+
getCmd() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer.HealthCheckConfig
+
 
+
getCommands() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerExecContainer
+
 
+
getCompressed() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCopyFileFromContainer
+
+
Whether to leave file in its compressed state or not.
+
+
getConfig() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer.HostConfig.LogConfig
+
 
+
getConfigs() - Method in class com.bmuschko.gradle.docker.tasks.network.DockerCreateNetwork.Ipam
+
 
+
getContainerId() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer
+
+
The ID of the container created.
+
+
getContainerId() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerExistingContainer
+
+
The ID or name of container used to perform operation.
+
+
getContainerIdFile() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer
+
+
Output file containing the container ID of the container created.
+
+
getContainerName() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer
+
 
+
getCopyFiles() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCopyFileToContainer
+
 
+
getCpuset() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer.HostConfig
+
 
+
getDangling() - Method in class com.bmuschko.gradle.docker.tasks.image.DockerListImages
+
 
+
getDefaultDockerCert() - Method in class com.bmuschko.gradle.docker.internal.DefaultDockerConfigResolver
+
 
+
getDefaultDockerCert() - Method in interface com.bmuschko.gradle.docker.internal.DockerConfigResolver
+
 
+
getDest() - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile.File
+
+
Returns the destination path.
+
+
getDestDir() - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile
+
+
Returns a provider representing the destination directory containing the Dockerfile.
+
+
getDestFile() - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile
+
+
The destination file representing the Dockerfile.
+
+
getDestFile() - Method in class com.bmuschko.gradle.docker.tasks.image.DockerSaveImage
+
+
Where to save image.
+
+
getDevices() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer.HostConfig
+
 
+
getDns() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer.HostConfig
+
 
+
getDockerClient() - Method in class com.bmuschko.gradle.docker.tasks.AbstractDockerRemoteApiTask
+
+
Gets the Docker client uses to communicate with Docker via its remote API.
+
+
getDockerClient(Provider<String>, Provider<Directory>, Provider<String>) - Method in class com.bmuschko.gradle.docker.internal.services.DockerClientService
+
+
Returns the Docker client.
+
+
getDockerClientService() - Method in class com.bmuschko.gradle.docker.tasks.AbstractDockerRemoteApiTask
+
 
+
getDockerFile() - Method in class com.bmuschko.gradle.docker.tasks.image.DockerBuildImage
+
+
The Dockerfile to use to build the image.
+
+
getDriver() - Method in class com.bmuschko.gradle.docker.tasks.network.DockerCreateNetwork.Ipam
+
 
+
getEmail() - Method in class com.bmuschko.gradle.docker.DockerRegistryCredentials
+
+
Registry email address needed to push images.
+
+
getEntrypoint() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer
+
 
+
getEnvVars() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer
+
 
+
getExecId() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerInspectExecContainer
+
+
The ID name of exec used to perform operation.
+
+
getExecIds() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerExecContainer
+
 
+
getExecProbe() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerExecContainer
+
 
+
getExitCode() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerWaitContainer
+
 
+
getExposedPorts() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer
+
 
+
getExtraHosts() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer.HostConfig
+
 
+
getExtraHosts() - Method in class com.bmuschko.gradle.docker.tasks.image.DockerBuildImage
+
+
Build-time additional host list to pass to the image build in the format host:ip.
+
+
getFile() - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile.FileInstruction
+
 
+
getFollow() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerLogsContainer
+
+
Set to true to follow the output, which will cause this task to block until the container exists.
+
+
getForce() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerRemoveContainer
+
 
+
getForce() - Method in class com.bmuschko.gradle.docker.tasks.image.DockerRemoveImage
+
 
+
getForce() - Method in class com.bmuschko.gradle.docker.tasks.image.DockerTagImage
+
+
Forces tagging.
+
+
getGateway() - Method in class com.bmuschko.gradle.docker.tasks.network.DockerCreateNetwork.Ipam.Config
+
 
+
getGroups() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer.HostConfig
+
+
A list of additional groups that the container process will run as.
+
+
getHealthCheck() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer
+
 
+
getHostConfig() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer
+
 
+
getHostName() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer
+
 
+
getHostPath() - Method in class com.bmuschko.gradle.docker.domain.CopyFileToContainer
+
 
+
getHostPath() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCopyFileFromContainer
+
+
Path on host to write remotePath to or into.
+
+
getHostPath() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCopyFileToContainer
+
+
File path on host to copy into container
+
+
getImage() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer
+
 
+
getImage() - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile.From
+
+
Returns the base image.
+
+
getImage() - Method in class com.bmuschko.gradle.docker.tasks.image.DockerPullImage
+
+
The image including repository, image name and tag to be pulled e.g.
+
+
getImageFile() - Method in class com.bmuschko.gradle.docker.tasks.image.DockerLoadImage
+
 
+
getImageId() - Method in class com.bmuschko.gradle.docker.tasks.image.DockerBuildImage
+
+
The ID of the image built.
+
+
getImageId() - Method in class com.bmuschko.gradle.docker.tasks.image.DockerCommitImage
+
+
The ID of the image committed.
+
+
getImageId() - Method in class com.bmuschko.gradle.docker.tasks.image.DockerExistingImage
+
+
The ID or name of image used to perform operation.
+
+
getImageIdFile() - Method in class com.bmuschko.gradle.docker.tasks.image.DockerBuildImage
+
+
Output file containing the image ID of the built image.
+
+
getImageIdFile() - Method in class com.bmuschko.gradle.docker.tasks.image.DockerCommitImage
+
+
Output file containing the image ID of the image committed.
+
+
getImageIdsFile() - Method in class com.bmuschko.gradle.docker.tasks.image.DockerSaveImage
+
+
Output file containing the image IDs of the saved images.
+
+
getImageName() - Method in class com.bmuschko.gradle.docker.tasks.image.DockerListImages
+
 
+
getImages() - Method in class com.bmuschko.gradle.docker.DockerConventionJvmApplicationExtension
+
+
The images used for the build and push operation e.g.
+
+
getImages() - Method in class com.bmuschko.gradle.docker.tasks.image.DockerBuildImage
+
+
The images including repository, image name and tag to be built e.g.
+
+
getImages() - Method in class com.bmuschko.gradle.docker.tasks.image.DockerPushImage
+
+
The images including repository, image name and tag to be pushed e.g.
+
+
getImages() - Method in class com.bmuschko.gradle.docker.tasks.image.DockerSaveImage
+
+
The images including repository, image name and tag to be saved e.g.
+
+
getInputDir() - Method in class com.bmuschko.gradle.docker.tasks.image.DockerBuildImage
+
+
Input directory containing the build context.
+
+
getInstructions() - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile
+
+
Returns all instructions used to generate the Dockerfile.
+
+
getInternalSince() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerLogsContainer
+
 
+
getInternetProtocol() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer.ExposedPort
+
 
+
getInterval() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer.HealthCheckConfig
+
+
The time to wait between checks in nanoseconds.
+
+
getIpam() - Method in class com.bmuschko.gradle.docker.tasks.network.DockerCreateNetwork
+
+
The IP address management (IPAM) for managing IP address space on a network.
+
+
getIpcMode() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer.HostConfig
+
+
The IPC mode for the container.
+
+
getIpRange() - Method in class com.bmuschko.gradle.docker.tasks.network.DockerCreateNetwork.Ipam.Config
+
 
+
getIpv4Address() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer
+
 
+
getIsTar() - Method in class com.bmuschko.gradle.docker.domain.CopyFileToContainer
+
 
+
getJvmArgs() - Method in class com.bmuschko.gradle.docker.DockerConventionJvmApplicationExtension
+
+
The JVM arguments used to start the Java program.
+
+
getKeyword() - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile.AddFileInstruction
+
+
Gets the keyword of the instruction as used in the Dockerfile.
+
+
getKeyword() - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile.ArgInstruction
+
+
Gets the keyword of the instruction as used in the Dockerfile.
+
+
getKeyword() - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile.CommentInstruction
+
+
Gets the keyword of the instruction as used in the Dockerfile.
+
+
getKeyword() - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile.CopyFileInstruction
+
+
Gets the keyword of the instruction as used in the Dockerfile.
+
+
getKeyword() - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile.DefaultCommandInstruction
+
+
Gets the keyword of the instruction as used in the Dockerfile.
+
+
getKeyword() - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile.EntryPointInstruction
+
+
Gets the keyword of the instruction as used in the Dockerfile.
+
+
getKeyword() - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile.EnvironmentVariableInstruction
+
+
Gets the keyword of the instruction as used in the Dockerfile.
+
+
getKeyword() - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile.ExposePortInstruction
+
+
Gets the keyword of the instruction as used in the Dockerfile.
+
+
getKeyword() - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile.FromInstruction
+
+
Gets the keyword of the instruction as used in the Dockerfile.
+
+
getKeyword() - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile.GenericInstruction
+
+
Gets the keyword of the instruction as used in the Dockerfile.
+
+
getKeyword() - Method in interface com.bmuschko.gradle.docker.tasks.image.Dockerfile.Instruction
+
+
Gets the keyword of the instruction as used in the Dockerfile.
+
+
getKeyword() - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile.LabelInstruction
+
+
Gets the keyword of the instruction as used in the Dockerfile.
+
+
getKeyword() - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile.OnBuildInstruction
+
+
Gets the keyword of the instruction as used in the Dockerfile.
+
+
getKeyword() - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile.RunCommandInstruction
+
+
Gets the keyword of the instruction as used in the Dockerfile.
+
+
getKeyword() - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile.UserInstruction
+
+
Gets the keyword of the instruction as used in the Dockerfile.
+
+
getKeyword() - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile.VolumeInstruction
+
+
Gets the keyword of the instruction as used in the Dockerfile.
+
+
getKeyword() - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile.WorkDirInstruction
+
+
Gets the keyword of the instruction as used in the Dockerfile.
+
+
getLabels() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer
+
 
+
getLabels() - Method in class com.bmuschko.gradle.docker.tasks.image.DockerBuildImage
+
+
Labels to attach as metadata for to the image.
+
+
getLabels() - Method in class com.bmuschko.gradle.docker.tasks.image.DockerListImages
+
 
+
getLinks() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer.HostConfig
+
 
+
getLogConfig() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer.HostConfig
+
 
+
getLogContains() - Method in class com.bmuschko.gradle.docker.domain.LivenessProbe
+
 
+
getMacAddress() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer
+
 
+
getMainClassName() - Method in class com.bmuschko.gradle.docker.DockerConventionJvmApplicationExtension
+
+
The main class name to use for starting the application e.g.
+
+
getMainJavaSourceSetOutput(Project) - Static method in class com.bmuschko.gradle.docker.internal.ConventionPluginHelper
+
 
+
getMaintainer() - Method in class com.bmuschko.gradle.docker.DockerConventionJvmApplicationExtension
+
+
The maintainer of the image.
+
+
getMemory() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer.HostConfig
+
 
+
getMemory() - Method in class com.bmuschko.gradle.docker.tasks.image.DockerBuildImage
+
+
Memory allocated for build specified in bytes (no suffix is needed)
+
+
getMemorySwap() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer.HostConfig
+
 
+
getMessage() - Method in class com.bmuschko.gradle.docker.tasks.image.DockerCommitImage
+
+
Commit message.
+
+
getName() - Method in class com.bmuschko.gradle.docker.internal.MainClassFinder.MainClass
+
 
+
getNetwork() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer.HostConfig
+
 
+
getNetwork() - Method in class com.bmuschko.gradle.docker.tasks.image.DockerBuildImage
+
+
Networking mode for the RUN instructions during build.
+
+
getNetworkAliases() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer
+
 
+
getNetworkId() - Method in class com.bmuschko.gradle.docker.tasks.network.DockerCreateNetwork
+
+
The id of the created network.
+
+
getNetworkId() - Method in class com.bmuschko.gradle.docker.tasks.network.DockerExistingNetwork
+
+
The ID or name of the network to perform the operation on.
+
+
getNetworkID() - Method in class com.bmuschko.gradle.docker.tasks.network.DockerCreateNetwork.Ipam.Config
+
 
+
getNetworkName() - Method in class com.bmuschko.gradle.docker.tasks.network.DockerCreateNetwork
+
+
The name of the network to be created.
+
+
getNextHandler() - Method in class com.bmuschko.gradle.docker.tasks.AbstractDockerRemoteApiTask
+
 
+
getNoCache() - Method in class com.bmuschko.gradle.docker.tasks.image.DockerBuildImage
+
+
When true, do not use docker cache when building the image.
+
+
getPassword() - Method in class com.bmuschko.gradle.docker.DockerRegistryCredentials
+
+
Registry password needed to push images.
+
+
getPause() - Method in class com.bmuschko.gradle.docker.tasks.image.DockerCommitImage
+
 
+
getPid() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer
+
 
+
getPlatform() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer
+
+
The target platform in the format os[/arch[/variant]], for example linux/s390x or darwin.
+
+
getPlatform() - Method in class com.bmuschko.gradle.docker.tasks.image.DockerBuildImage
+
+
The target platform in the format os[/arch[/variant]], for example linux/s390x or darwin.
+
+
getPlatform() - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile.From
+
+
Returns the platform.
+
+
getPlatform() - Method in class com.bmuschko.gradle.docker.tasks.image.DockerPullImage
+
+
The target platform in the format os[/arch[/variant]], for example linux/s390x or darwin.
+
+
getPollInterval() - Method in class com.bmuschko.gradle.docker.domain.ExecProbe
+
 
+
getPollInterval() - Method in class com.bmuschko.gradle.docker.domain.LivenessProbe
+
 
+
getPollTime() - Method in class com.bmuschko.gradle.docker.domain.ExecProbe
+
 
+
getPollTime() - Method in class com.bmuschko.gradle.docker.domain.LivenessProbe
+
 
+
getPortBindings() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer.HostConfig
+
 
+
getPorts() - Method in class com.bmuschko.gradle.docker.DockerConventionJvmApplicationExtension
+
+
The Docker image exposed ports.
+
+
getPorts() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer.ExposedPort
+
 
+
getPortSpecs() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer
+
 
+
getPrivileged() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer.HostConfig
+
 
+
getProgressLogger(ServiceRegistry, Class<T>) - Static method in class com.bmuschko.gradle.docker.internal.IOUtils
+
+
Create a progress logger for an arbitrary project and class.
+
+
getPublishAll() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer.HostConfig
+
 
+
getPull() - Method in class com.bmuschko.gradle.docker.tasks.image.DockerBuildImage
+
+
When true, always attempt to pull a newer version of the image.
+
+
getQuiet() - Method in class com.bmuschko.gradle.docker.tasks.image.DockerBuildImage
+
+
When true, suppress the build output and print image ID on success.
+
+
getRegistry(String) - Method in class com.bmuschko.gradle.docker.internal.RegistryAuthLocator
+
+
Extract registry name from the image name
+
+
getRegistryAuthLocator() - Method in class com.bmuschko.gradle.docker.tasks.AbstractDockerRemoteApiTask
+
+
Returns the instance of RegistryAuthLocator.
+
+
getRegistryCredentials() - Method in class com.bmuschko.gradle.docker.DockerExtension
+
+
The target Docker registry credentials.
+
+
getRegistryCredentials() - Method in class com.bmuschko.gradle.docker.tasks.image.DockerBuildImage
+
+
The target Docker registry credentials for usage with a task.
+
+
getRegistryCredentials() - Method in class com.bmuschko.gradle.docker.tasks.image.DockerPullImage
+
+
The target Docker registry credentials for usage with a task.
+
+
getRegistryCredentials() - Method in class com.bmuschko.gradle.docker.tasks.image.DockerPushImage
+
+
The target Docker registry credentials for usage with a task.
+
+
getRegistryCredentials() - Method in interface com.bmuschko.gradle.docker.tasks.RegistryCredentialsAware
+
+
The target Docker registry credentials for usage with a task.
+
+
getRemotePath() - Method in class com.bmuschko.gradle.docker.domain.CopyFileToContainer
+
 
+
getRemotePath() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCopyFileFromContainer
+
+
Path inside container
+
+
getRemotePath() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCopyFileToContainer
+
+
Path of file inside container
+
+
getRemove() - Method in class com.bmuschko.gradle.docker.tasks.image.DockerBuildImage
+
+
When true, remove intermediate containers after a successful build.
+
+
getRemoveVolumes() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerRemoveContainer
+
 
+
getRenameTo() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerRenameContainer
+
 
+
getRepository() - Method in class com.bmuschko.gradle.docker.tasks.image.DockerCommitImage
+
+
The repository and image name e.g.
+
+
getRepository() - Method in class com.bmuschko.gradle.docker.tasks.image.DockerTagImage
+
+
The repository to tag in.
+
+
getRestartPolicy() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer.HostConfig
+
 
+
getRetries() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer.HealthCheckConfig
+
+
The number of consecutive failures needed to consider a container as unhealthy.
+
+
getShmSize() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer.HostConfig
+
+
Size of /dev/shm in bytes.
+
+
getShmSize() - Method in class com.bmuschko.gradle.docker.tasks.image.DockerBuildImage
+
+
Size of /dev/shm in bytes.
+
+
getShowAll() - Method in class com.bmuschko.gradle.docker.tasks.image.DockerListImages
+
 
+
getShowTimestamps() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerLogsContainer
+
+
Set to the true to include a timestamp for each line in the output.
+
+
getSince() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerLogsContainer
+
+
Limit the output to lines on or after the specified date.
+
+
getSink() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerLogsContainer
+
+
Sink to write log output into.
+
+
getSrc() - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile.File
+
+
Return the source path.
+
+
getStage() - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile.CopyFile
+
+
Returns the previous build stage.
+
+
getStage() - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile.From
+
+
Returns the stage.
+
+
getStartPeriod() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer.HealthCheckConfig
+
+
The time to wait for container initialization before starting health-retries countdown in nanoseconds.
+
+
getStdErr() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerLogsContainer
+
+
Include standard err.
+
+
getStdinOnce() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer
+
 
+
getStdinOpen() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer
+
 
+
getStdOut() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerLogsContainer
+
+
Include standard out.
+
+
getSubnet() - Method in class com.bmuschko.gradle.docker.tasks.network.DockerCreateNetwork.Ipam.Config
+
 
+
getSuccessOnExitCodes() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerExecContainer
+
 
+
getSysctls() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer.HostConfig
+
+
The namespaced kernel parameters (sysctls) in the container.
+
+
getTag() - Method in class com.bmuschko.gradle.docker.tasks.image.DockerCommitImage
+
+
The tag e.g.
+
+
getTag() - Method in class com.bmuschko.gradle.docker.tasks.image.DockerTagImage
+
+
Image name to be tagged.
+
+
getTailAll() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerLogsContainer
+
+
Set to true to copy all output since the container has started.
+
+
getTailCount() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerLogsContainer
+
+
Limit the number of lines of existing output.
+
+
getTarFile() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCopyFileToContainer
+
+
Tar file we will copy into container
+
+
getTarget() - Method in class com.bmuschko.gradle.docker.tasks.image.DockerBuildImage
+
+
With this parameter it is possible to build a special stage in a multi-stage Docker file.
+
+
getText() - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile.CopyFileInstruction
+
 
+
getText() - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile.ExposePortInstruction
+
+
Gets the full text of the instruction as used in the Dockerfile.
+
+
getText() - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile.FileInstruction
+
+
Gets the full text of the instruction as used in the Dockerfile.
+
+
getText() - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile.FromInstruction
+
+
Gets the full text of the instruction as used in the Dockerfile.
+
+
getText() - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile.GenericInstruction
+
+
Gets the full text of the instruction as used in the Dockerfile.
+
+
getText() - Method in interface com.bmuschko.gradle.docker.tasks.image.Dockerfile.Instruction
+
+
Gets the full text of the instruction as used in the Dockerfile.
+
+
getText() - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile.MapInstruction
+
+
Gets the full text of the instruction as used in the Dockerfile.
+
+
getText() - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile.StringArrayInstruction
+
+
Gets the full text of the instruction as used in the Dockerfile.
+
+
getText() - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile.StringCommandInstruction
+
+
Gets the full text of the instruction as used in the Dockerfile.
+
+
getTimeout() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer.HealthCheckConfig
+
+
The time to wait before considering the check to have hung.
+
+
getTmpFs() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer.HostConfig
+
+
Docker container tmpfs support.
+
+
getTty() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer
+
 
+
getType() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer.HostConfig.LogConfig
+
 
+
getUrl() - Method in class com.bmuschko.gradle.docker.DockerExtension
+
+
The server URL to connect to via Docker’s remote API.
+
+
getUrl() - Method in class com.bmuschko.gradle.docker.DockerRegistryCredentials
+
+
Registry URL needed to push images.
+
+
getUrl() - Method in interface com.bmuschko.gradle.docker.internal.services.DockerClientService.Params
+
+
The server URL to connect to via Docker’s remote API.
+
+
getUrl() - Method in class com.bmuschko.gradle.docker.tasks.AbstractDockerRemoteApiTask
+
+
Docker remote API server URL.
+
+
getUseCompression() - Method in class com.bmuschko.gradle.docker.tasks.image.DockerSaveImage
+
 
+
getUser() - Method in class com.bmuschko.gradle.docker.DockerConventionJvmApplicationExtension
+
+
The username (or UID) and optionally the user group (or GID) to use as the default user and group for the container, e.g.
+
+
getUser() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer
+
 
+
getUser() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerExecContainer
+
+
Username or UID to execute the command as, with optional colon separated group or gid in format: + <name|uid>[:<group|gid>]
+
+
getUsername() - Method in class com.bmuschko.gradle.docker.DockerRegistryCredentials
+
+
Registry username needed to push images.
+
+
getVolumes() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer
+
 
+
getVolumesFrom() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer.HostConfig
+
 
+
getWaitTime() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerRestartContainer
+
+
Restart timeout in seconds.
+
+
getWaitTime() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerStopContainer
+
+
Stop timeout in seconds.
+
+
getWorkingDir() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer
+
 
+
getWorkingDir() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerExecContainer
+
+
Working directory in which the command is going to be executed.
+
+
+ + + +

H

+
+
hashCode() - Method in class com.bmuschko.gradle.docker.internal.MainClassFinder.MainClass
+
 
+
HealthCheckConfig(ObjectFactory) - Constructor for class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer.HealthCheckConfig
+
 
+
HostConfig(ObjectFactory) - Constructor for class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer.HostConfig
+
 
+
+ + + +

I

+
+
instruction(String) - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile
+
+
Adds a full instruction as String.
+
+
instruction(Provider<String>) - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile
+
+
Adds a full instruction as Provider.
+
+
instructionsFromTemplate(File) - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile
+
+
Adds instructions to the Dockerfile from a template file.
+
+
instructionsFromTemplate(String) - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile
+
+
Adds instructions to the Dockerfile from a template file.
+
+
instructionsFromTemplate(Provider<RegularFile>) - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile
+
+
Adds instructions to the Dockerfile from a template file.
+
+
IOUtils - Class in com.bmuschko.gradle.docker.internal
+
 
+
Ipam(ObjectFactory) - Constructor for class com.bmuschko.gradle.docker.tasks.network.DockerCreateNetwork.Ipam
+
 
+
isIsTar() - Method in class com.bmuschko.gradle.docker.domain.CopyFileToContainer
+
 
+
isWindows() - Static method in class com.bmuschko.gradle.docker.internal.OsUtils
+
 
+
+ + + +

J

+
+
JAVA_APPLICATION_EXTENSION_NAME - Static variable in class com.bmuschko.gradle.docker.DockerJavaApplicationPlugin
+
+
The name of extension registered with type DockerJavaApplication.
+
+
+ + + +

K

+
+
KEYWORD - Static variable in class com.bmuschko.gradle.docker.tasks.image.Dockerfile.AddFileInstruction
+
 
+
KEYWORD - Static variable in class com.bmuschko.gradle.docker.tasks.image.Dockerfile.ArgInstruction
+
 
+
KEYWORD - Static variable in class com.bmuschko.gradle.docker.tasks.image.Dockerfile.CommentInstruction
+
 
+
KEYWORD - Static variable in class com.bmuschko.gradle.docker.tasks.image.Dockerfile.CopyFileInstruction
+
 
+
KEYWORD - Static variable in class com.bmuschko.gradle.docker.tasks.image.Dockerfile.DefaultCommandInstruction
+
 
+
KEYWORD - Static variable in class com.bmuschko.gradle.docker.tasks.image.Dockerfile.EntryPointInstruction
+
 
+
KEYWORD - Static variable in class com.bmuschko.gradle.docker.tasks.image.Dockerfile.EnvironmentVariableInstruction
+
 
+
KEYWORD - Static variable in class com.bmuschko.gradle.docker.tasks.image.Dockerfile.ExposePortInstruction
+
 
+
KEYWORD - Static variable in class com.bmuschko.gradle.docker.tasks.image.Dockerfile.FromInstruction
+
 
+
KEYWORD - Static variable in class com.bmuschko.gradle.docker.tasks.image.Dockerfile.LabelInstruction
+
 
+
KEYWORD - Static variable in class com.bmuschko.gradle.docker.tasks.image.Dockerfile.OnBuildInstruction
+
 
+
KEYWORD - Static variable in class com.bmuschko.gradle.docker.tasks.image.Dockerfile.RunCommandInstruction
+
 
+
KEYWORD - Static variable in class com.bmuschko.gradle.docker.tasks.image.Dockerfile.UserInstruction
+
 
+
KEYWORD - Static variable in class com.bmuschko.gradle.docker.tasks.image.Dockerfile.VolumeInstruction
+
 
+
KEYWORD - Static variable in class com.bmuschko.gradle.docker.tasks.image.Dockerfile.WorkDirInstruction
+
 
+
+ + + +

L

+
+
label(Map<String, String>) - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile
+
+
The LABEL instruction adds metadata to an image.
+
+
label(Provider<Map<String, String>>) - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile
+
+
A LABEL instruction as Provider.
+
+
LabelInstruction(Map) - Constructor for class com.bmuschko.gradle.docker.tasks.image.Dockerfile.LabelInstruction
+
 
+
LabelInstruction(Provider<Map<String, String>>) - Constructor for class com.bmuschko.gradle.docker.tasks.image.Dockerfile.LabelInstruction
+
 
+
LivenessProbe - Class in com.bmuschko.gradle.docker.domain
+
+
Class holding metadata for an arbitrary liveness probe.
+
+
LivenessProbe(long, long, String) - Constructor for class com.bmuschko.gradle.docker.domain.LivenessProbe
+
 
+
logAndProcessResponse(DockerClient) - Method in class com.bmuschko.gradle.docker.tasks.container.DockerLogsContainer
+
 
+
logConfig(String, Map<String, String>) - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer.HostConfig
+
 
+
LogConfig() - Constructor for class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer.HostConfig.LogConfig
+
 
+
lookupAllAuthConfigs() - Method in class com.bmuschko.gradle.docker.internal.RegistryAuthLocator
+
+
Gets all authorization information + using $DOCKER_CONFIG/.docker/config.json file + If missing, an empty AuthConfigurations object is returned
+
+
lookupAllAuthConfigs(DockerRegistryCredentials) - Method in class com.bmuschko.gradle.docker.internal.RegistryAuthLocator
+
+
Gets all authorization information + using $DOCKER_CONFIG/.docker/config.json file + If missing, an AuthConfigurations object containing only the passed registryCredentials is returned
+
+
lookupAllAuthConfigs(AuthConfig) - Method in class com.bmuschko.gradle.docker.internal.RegistryAuthLocator
+
+
Gets all authorization information + using $DOCKER_CONFIG/.docker/config.json file + If missing, an AuthConfigurations object containing only the passed additionalAuthConfig is returned
+
+
lookupAuthConfig(String, DockerRegistryCredentials) - Method in class com.bmuschko.gradle.docker.internal.RegistryAuthLocator
+
+
Gets authorization information + using $DOCKER_CONFIG/.docker/config.json file + If missing, gets the information from + the registryCredentials object
+
+
+ + + +

M

+
+
MainClass(String, Set<String>) - Constructor for class com.bmuschko.gradle.docker.internal.MainClassFinder.MainClass
+
 
+
MainClassFinder - Class in com.bmuschko.gradle.docker.internal
+
+
Original source from Spring Boot's loader tools licensed under Apache License Version 2.0.
+
+
MainClassFinder() - Constructor for class com.bmuschko.gradle.docker.internal.MainClassFinder
+
 
+
MainClassFinder.MainClass - Class in com.bmuschko.gradle.docker.internal
+
 
+
MainClassFinder.MainClassCallback<T> - Interface in com.bmuschko.gradle.docker.internal
+
 
+
MapInstruction(Map<String, String>) - Constructor for class com.bmuschko.gradle.docker.tasks.image.Dockerfile.MapInstruction
+
 
+
MapInstruction(Provider<Map<String, String>>) - Constructor for class com.bmuschko.gradle.docker.tasks.image.Dockerfile.MapInstruction
+
 
+
+ + + +

O

+
+
obtain() - Method in class com.bmuschko.gradle.docker.internal.DefaultDockerUrlValueSource
+
 
+
onBuild(String) - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile
+
+
The ONBUILD instruction adds to the image a + trigger instruction to be executed at a later time, when the image is used as the base for another build.
+
+
onBuild(Provider<String>) - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile
+
+
A ONBUILD instruction as Provider.
+
+
OnBuildInstruction(String) - Constructor for class com.bmuschko.gradle.docker.tasks.image.Dockerfile.OnBuildInstruction
+
 
+
OnBuildInstruction(Provider<String>) - Constructor for class com.bmuschko.gradle.docker.tasks.image.Dockerfile.OnBuildInstruction
+
 
+
onComplete(Runnable) - Method in class com.bmuschko.gradle.docker.tasks.AbstractDockerRemoteApiTask
+
+
Reacts to the completion of the operation.
+
+
onError(Action<? super Throwable>) - Method in class com.bmuschko.gradle.docker.tasks.AbstractDockerRemoteApiTask
+
+
Reacts to a potential error occurring during the operation.
+
+
onNext(Action) - Method in class com.bmuschko.gradle.docker.tasks.AbstractDockerRemoteApiTask
+
+
Reacts to data returned by an operation.
+
+
OsUtils - Class in com.bmuschko.gradle.docker.internal
+
 
+
OutputCollector - Class in com.bmuschko.gradle.docker.internal
+
+
A utility class that will collect strings until a new line is encountered.
+
+
OutputCollector(Consumer<String>) - Constructor for class com.bmuschko.gradle.docker.internal.OutputCollector
+
 
+
+ + + +

P

+
+
PUSH_IMAGE_TASK_NAME - Static variable in class com.bmuschko.gradle.docker.DockerConventionJvmApplicationPlugin
+
+
The task name that pushes created Docker image to the repository.
+
+
+ + + +

R

+
+
RegistryAuthLocator - Class in com.bmuschko.gradle.docker.internal
+
+
Utility class to get credentials information from extension of type DockerRegistryCredentials or from $DOCKER_CONFIG/.docker/config.json file.
+
+
RegistryAuthLocator.Factory - Class in com.bmuschko.gradle.docker.internal
+
 
+
registryCredentials(Action<? super DockerRegistryCredentials>) - Method in class com.bmuschko.gradle.docker.DockerExtension
+
+
Configures the target Docker registry credentials.
+
+
registryCredentials(Action<? super DockerRegistryCredentials>) - Method in class com.bmuschko.gradle.docker.tasks.image.DockerBuildImage
+
+
Configures the target Docker registry credentials for use with a task.
+
+
registryCredentials(Action<? super DockerRegistryCredentials>) - Method in class com.bmuschko.gradle.docker.tasks.image.DockerPullImage
+
+
Configures the target Docker registry credentials for use with a task.
+
+
registryCredentials(Action<? super DockerRegistryCredentials>) - Method in class com.bmuschko.gradle.docker.tasks.image.DockerPushImage
+
+
Configures the target Docker registry credentials for use with a task.
+
+
registryCredentials(Action<? super DockerRegistryCredentials>) - Method in interface com.bmuschko.gradle.docker.tasks.RegistryCredentialsAware
+
+
Configures the target Docker registry credentials for use with a task.
+
+
RegistryCredentialsAware - Interface in com.bmuschko.gradle.docker.tasks
+
 
+
RegularFileToStringTransformer - Class in com.bmuschko.gradle.docker.internal
+
 
+
RegularFileToStringTransformer() - Constructor for class com.bmuschko.gradle.docker.internal.RegularFileToStringTransformer
+
 
+
restartPolicy(String, int) - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer.HostConfig
+
 
+
runCommand(String) - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile
+
+
The RUN instruction will execute any commands in a + new layer on top of the current image and commit the results.
+
+
runCommand(Provider<String>) - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile
+
+
A RUN instruction as Provider.
+
+
RunCommandInstruction(String) - Constructor for class com.bmuschko.gradle.docker.tasks.image.Dockerfile.RunCommandInstruction
+
 
+
RunCommandInstruction(Provider<String>) - Constructor for class com.bmuschko.gradle.docker.tasks.image.Dockerfile.RunCommandInstruction
+
 
+
runRemoteCommand() - Method in class com.bmuschko.gradle.docker.tasks.AbstractDockerRemoteApiTask
+
 
+
runRemoteCommand() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCopyFileFromContainer
+
 
+
runRemoteCommand() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCopyFileToContainer
+
 
+
runRemoteCommand() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer
+
 
+
runRemoteCommand() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerExecContainer
+
 
+
runRemoteCommand() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerInspectContainer
+
 
+
runRemoteCommand() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerInspectExecContainer
+
 
+
runRemoteCommand() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerKillContainer
+
 
+
runRemoteCommand() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerLogsContainer
+
 
+
runRemoteCommand() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerRemoveContainer
+
 
+
runRemoteCommand() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerRenameContainer
+
 
+
runRemoteCommand() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerRestartContainer
+
 
+
runRemoteCommand() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerStartContainer
+
 
+
runRemoteCommand() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerStopContainer
+
 
+
runRemoteCommand() - Method in class com.bmuschko.gradle.docker.tasks.container.DockerWaitContainer
+
 
+
runRemoteCommand() - Method in class com.bmuschko.gradle.docker.tasks.DockerInfo
+
 
+
runRemoteCommand() - Method in class com.bmuschko.gradle.docker.tasks.DockerOperation
+
 
+
runRemoteCommand() - Method in class com.bmuschko.gradle.docker.tasks.DockerVersion
+
 
+
runRemoteCommand() - Method in class com.bmuschko.gradle.docker.tasks.image.DockerBuildImage
+
 
+
runRemoteCommand() - Method in class com.bmuschko.gradle.docker.tasks.image.DockerCommitImage
+
 
+
runRemoteCommand() - Method in class com.bmuschko.gradle.docker.tasks.image.DockerInspectImage
+
 
+
runRemoteCommand() - Method in class com.bmuschko.gradle.docker.tasks.image.DockerListImages
+
 
+
runRemoteCommand() - Method in class com.bmuschko.gradle.docker.tasks.image.DockerLoadImage
+
 
+
runRemoteCommand() - Method in class com.bmuschko.gradle.docker.tasks.image.DockerPullImage
+
 
+
runRemoteCommand() - Method in class com.bmuschko.gradle.docker.tasks.image.DockerPushImage
+
 
+
runRemoteCommand() - Method in class com.bmuschko.gradle.docker.tasks.image.DockerRemoveImage
+
 
+
runRemoteCommand() - Method in class com.bmuschko.gradle.docker.tasks.image.DockerSaveImage
+
 
+
runRemoteCommand() - Method in class com.bmuschko.gradle.docker.tasks.image.DockerTagImage
+
 
+
runRemoteCommand() - Method in class com.bmuschko.gradle.docker.tasks.network.DockerCreateNetwork
+
 
+
runRemoteCommand() - Method in class com.bmuschko.gradle.docker.tasks.network.DockerInspectNetwork
+
 
+
runRemoteCommand() - Method in class com.bmuschko.gradle.docker.tasks.network.DockerRemoveNetwork
+
 
+
+ + + +

S

+
+
setConfig(Map<String, String>) - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer.HostConfig.LogConfig
+
 
+
setExecProbe(ExecProbe) - Method in class com.bmuschko.gradle.docker.tasks.container.DockerExecContainer
+
 
+
setGateway(String) - Method in class com.bmuschko.gradle.docker.tasks.network.DockerCreateNetwork.Ipam.Config
+
 
+
setHostPath(Object) - Method in class com.bmuschko.gradle.docker.domain.CopyFileToContainer
+
 
+
setIpRange(String) - Method in class com.bmuschko.gradle.docker.tasks.network.DockerCreateNetwork.Ipam.Config
+
 
+
setIsTar(boolean) - Method in class com.bmuschko.gradle.docker.domain.CopyFileToContainer
+
 
+
setLogContains(String) - Method in class com.bmuschko.gradle.docker.domain.LivenessProbe
+
 
+
setNetworkID(String) - Method in class com.bmuschko.gradle.docker.tasks.network.DockerCreateNetwork.Ipam.Config
+
 
+
setPollInterval(long) - Method in class com.bmuschko.gradle.docker.domain.ExecProbe
+
 
+
setPollInterval(long) - Method in class com.bmuschko.gradle.docker.domain.LivenessProbe
+
 
+
setPollTime(long) - Method in class com.bmuschko.gradle.docker.domain.ExecProbe
+
 
+
setPollTime(long) - Method in class com.bmuschko.gradle.docker.domain.LivenessProbe
+
 
+
setRemotePath(Object) - Method in class com.bmuschko.gradle.docker.domain.CopyFileToContainer
+
 
+
setSubnet(String) - Method in class com.bmuschko.gradle.docker.tasks.network.DockerCreateNetwork.Ipam.Config
+
 
+
setType(String) - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer.HostConfig.LogConfig
+
 
+
SPRING_BOOT_APPLICATION_EXTENSION_NAME - Static variable in class com.bmuschko.gradle.docker.DockerSpringBootApplicationPlugin
+
+
The name of extension registered with type DockerSpringBootApplication.
+
+
start() - Method in class com.bmuschko.gradle.docker.tasks.AbstractDockerRemoteApiTask
+
 
+
StringArrayInstruction(String...) - Constructor for class com.bmuschko.gradle.docker.tasks.image.Dockerfile.StringArrayInstruction
+
 
+
StringArrayInstruction(Provider<List<String>>) - Constructor for class com.bmuschko.gradle.docker.tasks.image.Dockerfile.StringArrayInstruction
+
 
+
StringCommandInstruction(String) - Constructor for class com.bmuschko.gradle.docker.tasks.image.Dockerfile.StringCommandInstruction
+
 
+
StringCommandInstruction(Provider<String>) - Constructor for class com.bmuschko.gradle.docker.tasks.image.Dockerfile.StringCommandInstruction
+
 
+
SYNC_BUILD_CONTEXT_TASK_NAME - Static variable in class com.bmuschko.gradle.docker.DockerConventionJvmApplicationPlugin
+
+
The task name that copies the application files to a temporary directory for image creation.
+
+
+ + + +

T

+
+
targetContainerId(String) - Method in class com.bmuschko.gradle.docker.tasks.container.DockerExistingContainer
+
+
Sets the target container ID or name.
+
+
targetContainerId(Callable<String>) - Method in class com.bmuschko.gradle.docker.tasks.container.DockerExistingContainer
+
+
Sets the target container ID or name.
+
+
targetContainerId(Provider<String>) - Method in class com.bmuschko.gradle.docker.tasks.container.DockerExistingContainer
+
+
Sets the target container ID or name.
+
+
targetExecId(String) - Method in class com.bmuschko.gradle.docker.tasks.container.DockerInspectExecContainer
+
+
Sets the target exec ID or name.
+
+
targetExecId(Callable<String>) - Method in class com.bmuschko.gradle.docker.tasks.container.DockerInspectExecContainer
+
+
Sets the target exec ID or name.
+
+
targetExecId(Provider<String>) - Method in class com.bmuschko.gradle.docker.tasks.container.DockerInspectExecContainer
+
+
Sets the target exec ID or name.
+
+
targetImageId(String) - Method in class com.bmuschko.gradle.docker.tasks.image.DockerExistingImage
+
+
Sets the target image ID or name.
+
+
targetImageId(Callable<String>) - Method in class com.bmuschko.gradle.docker.tasks.image.DockerExistingImage
+
+
Sets the target image ID or name.
+
+
targetImageId(Provider<String>) - Method in class com.bmuschko.gradle.docker.tasks.image.DockerExistingImage
+
+
Sets the target image ID or name.
+
+
targetNetworkId(String) - Method in class com.bmuschko.gradle.docker.tasks.network.DockerExistingNetwork
+
+
Sets the target network ID or name.
+
+
targetNetworkId(Callable<String>) - Method in class com.bmuschko.gradle.docker.tasks.network.DockerExistingNetwork
+
+
Sets the target network ID or name.
+
+
targetNetworkId(Provider<String>) - Method in class com.bmuschko.gradle.docker.tasks.network.DockerExistingNetwork
+
+
Sets the target network ID or name.
+
+
toString() - Method in class com.bmuschko.gradle.docker.domain.ExecProbe
+
 
+
toString() - Method in class com.bmuschko.gradle.docker.domain.LivenessProbe
+
 
+
toString() - Method in class com.bmuschko.gradle.docker.internal.MainClassFinder.MainClass
+
 
+
transform(RegularFile) - Method in class com.bmuschko.gradle.docker.internal.RegularFileToStringTransformer
+
 
+
+ + + +

U

+
+
user(String) - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile
+
+
The USER instruction sets the user name or UID to + use when running the image and for any RUN, CMD and ENTRYPOINT instructions that follow it in the Dockerfile.
+
+
user(Provider<String>) - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile
+
+
A USER instruction as Provider.
+
+
UserInstruction(String) - Constructor for class com.bmuschko.gradle.docker.tasks.image.Dockerfile.UserInstruction
+
 
+
UserInstruction(Provider<String>) - Constructor for class com.bmuschko.gradle.docker.tasks.image.Dockerfile.UserInstruction
+
 
+
+ + + +

V

+
+
volume(String...) - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile
+
+
The VOLUME instruction will create a mount point + with the specified name and mark it as holding externally mounted volumes from native host or other containers.
+
+
volume(Provider<List<String>>) - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile
+
+
A VOLUME instruction as Provider.
+
+
VolumeInstruction(String...) - Constructor for class com.bmuschko.gradle.docker.tasks.image.Dockerfile.VolumeInstruction
+
 
+
VolumeInstruction(Provider<List<String>>) - Constructor for class com.bmuschko.gradle.docker.tasks.image.Dockerfile.VolumeInstruction
+
 
+
+ + + +

W

+
+
withChown(String) - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile.File
+
+
Specifies a given username, groupname, or UID/GID combination to request specific ownership of the copied content with the help of the --chown option.
+
+
withCommand(String[]) - Method in class com.bmuschko.gradle.docker.tasks.container.DockerExecContainer
+
+
Deprecated. +
Use the method named DockerExecContainer.getCommands() directly
+
+
+
withCommand(List<String>) - Method in class com.bmuschko.gradle.docker.tasks.container.DockerExecContainer
+
+
Deprecated. +
Use the method named DockerExecContainer.getCommands() directly
+
+
+
withDefaults() - Method in class com.bmuschko.gradle.docker.internal.RegistryAuthLocator.Factory
+
+
Creates new instance
+
+
withEnvVar(String, String) - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer
+
 
+
withFile(Object, Object) - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCopyFileToContainer
+
+
Add a file to be copied into container
+
+
withPlatform(String) - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile.From
+
+
Sets the platform by adding --platform to the FROM instruction.
+
+
withStage(String) - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile.CopyFile
+
+
Used to set the source location to a previous build stage.
+
+
withStage(String) - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile.From
+
+
Sets a new build stage by adding AS name to the FROM instruction.
+
+
withTarFile(Object, Object) - Method in class com.bmuschko.gradle.docker.tasks.container.DockerCopyFileToContainer
+
+
Add a tarfile to be copied into container
+
+
WorkDirInstruction(String) - Constructor for class com.bmuschko.gradle.docker.tasks.image.Dockerfile.WorkDirInstruction
+
 
+
WorkDirInstruction(Provider<String>) - Constructor for class com.bmuschko.gradle.docker.tasks.image.Dockerfile.WorkDirInstruction
+
 
+
workingDir(String) - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile
+
+
The WORKDIR instruction sets the working directory + for any RUN, CMD and ENTRYPOINT instructions that follow it in the Dockerfile.
+
+
workingDir(Provider<String>) - Method in class com.bmuschko.gradle.docker.tasks.image.Dockerfile
+
+
A WORKDIR instruction as Provider.
+
+
+ + + +

_

+
+
_runRemoteCommand(DockerClient, String, Integer) - Static method in class com.bmuschko.gradle.docker.tasks.container.DockerStopContainer
+
 
+
+A B C D E F G H I J K L M O P R S T U V W _ 
All Classes All Packages
+
+ + + diff --git a/9.3.3/api/index.html b/9.3.3/api/index.html new file mode 100644 index 000000000..2d1d407c4 --- /dev/null +++ b/9.3.3/api/index.html @@ -0,0 +1,188 @@ + + + + + +Overview (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+
+
+

gradle-docker-plugin 9.3.3 API

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Packages 
PackageDescription
com.bmuschko.gradle.docker 
com.bmuschko.gradle.docker.domain 
com.bmuschko.gradle.docker.internal 
com.bmuschko.gradle.docker.internal.services 
com.bmuschko.gradle.docker.tasks 
com.bmuschko.gradle.docker.tasks.container 
com.bmuschko.gradle.docker.tasks.image 
com.bmuschko.gradle.docker.tasks.network 
+
+
+ + + diff --git a/9.3.3/api/jquery-ui.overrides.css b/9.3.3/api/jquery-ui.overrides.css new file mode 100644 index 000000000..facf852c2 --- /dev/null +++ b/9.3.3/api/jquery-ui.overrides.css @@ -0,0 +1,35 @@ +/* + * Copyright (c) 2020, 2022, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +.ui-state-active, +.ui-widget-content .ui-state-active, +.ui-widget-header .ui-state-active, +a.ui-button:active, +.ui-button:active, +.ui-button.ui-state-active:hover { + /* Overrides the color of selection used in jQuery UI */ + background: #F8981D; + border: 1px solid #F8981D; +} diff --git a/9.3.3/api/jquery/external/jquery/jquery.js b/9.3.3/api/jquery/external/jquery/jquery.js new file mode 100644 index 000000000..50937333b --- /dev/null +++ b/9.3.3/api/jquery/external/jquery/jquery.js @@ -0,0 +1,10872 @@ +/*! + * jQuery JavaScript Library v3.5.1 + * https://jquery.com/ + * + * Includes Sizzle.js + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://jquery.org/license + * + * Date: 2020-05-04T22:49Z + */ +( function( global, factory ) { + + "use strict"; + + if ( typeof module === "object" && typeof module.exports === "object" ) { + + // For CommonJS and CommonJS-like environments where a proper `window` + // is present, execute the factory and get jQuery. + // For environments that do not have a `window` with a `document` + // (such as Node.js), expose a factory as module.exports. + // This accentuates the need for the creation of a real `window`. + // e.g. var jQuery = require("jquery")(window); + // See ticket #14549 for more info. + module.exports = global.document ? + factory( global, true ) : + function( w ) { + if ( !w.document ) { + throw new Error( "jQuery requires a window with a document" ); + } + return factory( w ); + }; + } else { + factory( global ); + } + +// Pass this if window is not defined yet +} )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) { + +// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1 +// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode +// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common +// enough that all such attempts are guarded in a try block. +"use strict"; + +var arr = []; + +var getProto = Object.getPrototypeOf; + +var slice = arr.slice; + +var flat = arr.flat ? function( array ) { + return arr.flat.call( array ); +} : function( array ) { + return arr.concat.apply( [], array ); +}; + + +var push = arr.push; + +var indexOf = arr.indexOf; + +var class2type = {}; + +var toString = class2type.toString; + +var hasOwn = class2type.hasOwnProperty; + +var fnToString = hasOwn.toString; + +var ObjectFunctionString = fnToString.call( Object ); + +var support = {}; + +var isFunction = function isFunction( obj ) { + + // Support: Chrome <=57, Firefox <=52 + // In some browsers, typeof returns "function" for HTML elements + // (i.e., `typeof document.createElement( "object" ) === "function"`). + // We don't want to classify *any* DOM node as a function. + return typeof obj === "function" && typeof obj.nodeType !== "number"; + }; + + +var isWindow = function isWindow( obj ) { + return obj != null && obj === obj.window; + }; + + +var document = window.document; + + + + var preservedScriptAttributes = { + type: true, + src: true, + nonce: true, + noModule: true + }; + + function DOMEval( code, node, doc ) { + doc = doc || document; + + var i, val, + script = doc.createElement( "script" ); + + script.text = code; + if ( node ) { + for ( i in preservedScriptAttributes ) { + + // Support: Firefox 64+, Edge 18+ + // Some browsers don't support the "nonce" property on scripts. + // On the other hand, just using `getAttribute` is not enough as + // the `nonce` attribute is reset to an empty string whenever it + // becomes browsing-context connected. + // See https://github.com/whatwg/html/issues/2369 + // See https://html.spec.whatwg.org/#nonce-attributes + // The `node.getAttribute` check was added for the sake of + // `jQuery.globalEval` so that it can fake a nonce-containing node + // via an object. + val = node[ i ] || node.getAttribute && node.getAttribute( i ); + if ( val ) { + script.setAttribute( i, val ); + } + } + } + doc.head.appendChild( script ).parentNode.removeChild( script ); + } + + +function toType( obj ) { + if ( obj == null ) { + return obj + ""; + } + + // Support: Android <=2.3 only (functionish RegExp) + return typeof obj === "object" || typeof obj === "function" ? + class2type[ toString.call( obj ) ] || "object" : + typeof obj; +} +/* global Symbol */ +// Defining this global in .eslintrc.json would create a danger of using the global +// unguarded in another place, it seems safer to define global only for this module + + + +var + version = "3.5.1", + + // Define a local copy of jQuery + jQuery = function( selector, context ) { + + // The jQuery object is actually just the init constructor 'enhanced' + // Need init if jQuery is called (just allow error to be thrown if not included) + return new jQuery.fn.init( selector, context ); + }; + +jQuery.fn = jQuery.prototype = { + + // The current version of jQuery being used + jquery: version, + + constructor: jQuery, + + // The default length of a jQuery object is 0 + length: 0, + + toArray: function() { + return slice.call( this ); + }, + + // Get the Nth element in the matched element set OR + // Get the whole matched element set as a clean array + get: function( num ) { + + // Return all the elements in a clean array + if ( num == null ) { + return slice.call( this ); + } + + // Return just the one element from the set + return num < 0 ? this[ num + this.length ] : this[ num ]; + }, + + // Take an array of elements and push it onto the stack + // (returning the new matched element set) + pushStack: function( elems ) { + + // Build a new jQuery matched element set + var ret = jQuery.merge( this.constructor(), elems ); + + // Add the old object onto the stack (as a reference) + ret.prevObject = this; + + // Return the newly-formed element set + return ret; + }, + + // Execute a callback for every element in the matched set. + each: function( callback ) { + return jQuery.each( this, callback ); + }, + + map: function( callback ) { + return this.pushStack( jQuery.map( this, function( elem, i ) { + return callback.call( elem, i, elem ); + } ) ); + }, + + slice: function() { + return this.pushStack( slice.apply( this, arguments ) ); + }, + + first: function() { + return this.eq( 0 ); + }, + + last: function() { + return this.eq( -1 ); + }, + + even: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return ( i + 1 ) % 2; + } ) ); + }, + + odd: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return i % 2; + } ) ); + }, + + eq: function( i ) { + var len = this.length, + j = +i + ( i < 0 ? len : 0 ); + return this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] ); + }, + + end: function() { + return this.prevObject || this.constructor(); + }, + + // For internal use only. + // Behaves like an Array's method, not like a jQuery method. + push: push, + sort: arr.sort, + splice: arr.splice +}; + +jQuery.extend = jQuery.fn.extend = function() { + var options, name, src, copy, copyIsArray, clone, + target = arguments[ 0 ] || {}, + i = 1, + length = arguments.length, + deep = false; + + // Handle a deep copy situation + if ( typeof target === "boolean" ) { + deep = target; + + // Skip the boolean and the target + target = arguments[ i ] || {}; + i++; + } + + // Handle case when target is a string or something (possible in deep copy) + if ( typeof target !== "object" && !isFunction( target ) ) { + target = {}; + } + + // Extend jQuery itself if only one argument is passed + if ( i === length ) { + target = this; + i--; + } + + for ( ; i < length; i++ ) { + + // Only deal with non-null/undefined values + if ( ( options = arguments[ i ] ) != null ) { + + // Extend the base object + for ( name in options ) { + copy = options[ name ]; + + // Prevent Object.prototype pollution + // Prevent never-ending loop + if ( name === "__proto__" || target === copy ) { + continue; + } + + // Recurse if we're merging plain objects or arrays + if ( deep && copy && ( jQuery.isPlainObject( copy ) || + ( copyIsArray = Array.isArray( copy ) ) ) ) { + src = target[ name ]; + + // Ensure proper type for the source value + if ( copyIsArray && !Array.isArray( src ) ) { + clone = []; + } else if ( !copyIsArray && !jQuery.isPlainObject( src ) ) { + clone = {}; + } else { + clone = src; + } + copyIsArray = false; + + // Never move original objects, clone them + target[ name ] = jQuery.extend( deep, clone, copy ); + + // Don't bring in undefined values + } else if ( copy !== undefined ) { + target[ name ] = copy; + } + } + } + } + + // Return the modified object + return target; +}; + +jQuery.extend( { + + // Unique for each copy of jQuery on the page + expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ), + + // Assume jQuery is ready without the ready module + isReady: true, + + error: function( msg ) { + throw new Error( msg ); + }, + + noop: function() {}, + + isPlainObject: function( obj ) { + var proto, Ctor; + + // Detect obvious negatives + // Use toString instead of jQuery.type to catch host objects + if ( !obj || toString.call( obj ) !== "[object Object]" ) { + return false; + } + + proto = getProto( obj ); + + // Objects with no prototype (e.g., `Object.create( null )`) are plain + if ( !proto ) { + return true; + } + + // Objects with prototype are plain iff they were constructed by a global Object function + Ctor = hasOwn.call( proto, "constructor" ) && proto.constructor; + return typeof Ctor === "function" && fnToString.call( Ctor ) === ObjectFunctionString; + }, + + isEmptyObject: function( obj ) { + var name; + + for ( name in obj ) { + return false; + } + return true; + }, + + // Evaluates a script in a provided context; falls back to the global one + // if not specified. + globalEval: function( code, options, doc ) { + DOMEval( code, { nonce: options && options.nonce }, doc ); + }, + + each: function( obj, callback ) { + var length, i = 0; + + if ( isArrayLike( obj ) ) { + length = obj.length; + for ( ; i < length; i++ ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } else { + for ( i in obj ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } + + return obj; + }, + + // results is for internal usage only + makeArray: function( arr, results ) { + var ret = results || []; + + if ( arr != null ) { + if ( isArrayLike( Object( arr ) ) ) { + jQuery.merge( ret, + typeof arr === "string" ? + [ arr ] : arr + ); + } else { + push.call( ret, arr ); + } + } + + return ret; + }, + + inArray: function( elem, arr, i ) { + return arr == null ? -1 : indexOf.call( arr, elem, i ); + }, + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + merge: function( first, second ) { + var len = +second.length, + j = 0, + i = first.length; + + for ( ; j < len; j++ ) { + first[ i++ ] = second[ j ]; + } + + first.length = i; + + return first; + }, + + grep: function( elems, callback, invert ) { + var callbackInverse, + matches = [], + i = 0, + length = elems.length, + callbackExpect = !invert; + + // Go through the array, only saving the items + // that pass the validator function + for ( ; i < length; i++ ) { + callbackInverse = !callback( elems[ i ], i ); + if ( callbackInverse !== callbackExpect ) { + matches.push( elems[ i ] ); + } + } + + return matches; + }, + + // arg is for internal usage only + map: function( elems, callback, arg ) { + var length, value, + i = 0, + ret = []; + + // Go through the array, translating each of the items to their new values + if ( isArrayLike( elems ) ) { + length = elems.length; + for ( ; i < length; i++ ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + + // Go through every key on the object, + } else { + for ( i in elems ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + } + + // Flatten any nested arrays + return flat( ret ); + }, + + // A global GUID counter for objects + guid: 1, + + // jQuery.support is not used in Core but other projects attach their + // properties to it so it needs to exist. + support: support +} ); + +if ( typeof Symbol === "function" ) { + jQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ]; +} + +// Populate the class2type map +jQuery.each( "Boolean Number String Function Array Date RegExp Object Error Symbol".split( " " ), +function( _i, name ) { + class2type[ "[object " + name + "]" ] = name.toLowerCase(); +} ); + +function isArrayLike( obj ) { + + // Support: real iOS 8.2 only (not reproducible in simulator) + // `in` check used to prevent JIT error (gh-2145) + // hasOwn isn't used here due to false negatives + // regarding Nodelist length in IE + var length = !!obj && "length" in obj && obj.length, + type = toType( obj ); + + if ( isFunction( obj ) || isWindow( obj ) ) { + return false; + } + + return type === "array" || length === 0 || + typeof length === "number" && length > 0 && ( length - 1 ) in obj; +} +var Sizzle = +/*! + * Sizzle CSS Selector Engine v2.3.5 + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://js.foundation/ + * + * Date: 2020-03-14 + */ +( function( window ) { +var i, + support, + Expr, + getText, + isXML, + tokenize, + compile, + select, + outermostContext, + sortInput, + hasDuplicate, + + // Local document vars + setDocument, + document, + docElem, + documentIsHTML, + rbuggyQSA, + rbuggyMatches, + matches, + contains, + + // Instance-specific data + expando = "sizzle" + 1 * new Date(), + preferredDoc = window.document, + dirruns = 0, + done = 0, + classCache = createCache(), + tokenCache = createCache(), + compilerCache = createCache(), + nonnativeSelectorCache = createCache(), + sortOrder = function( a, b ) { + if ( a === b ) { + hasDuplicate = true; + } + return 0; + }, + + // Instance methods + hasOwn = ( {} ).hasOwnProperty, + arr = [], + pop = arr.pop, + pushNative = arr.push, + push = arr.push, + slice = arr.slice, + + // Use a stripped-down indexOf as it's faster than native + // https://jsperf.com/thor-indexof-vs-for/5 + indexOf = function( list, elem ) { + var i = 0, + len = list.length; + for ( ; i < len; i++ ) { + if ( list[ i ] === elem ) { + return i; + } + } + return -1; + }, + + booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|" + + "ismap|loop|multiple|open|readonly|required|scoped", + + // Regular expressions + + // http://www.w3.org/TR/css3-selectors/#whitespace + whitespace = "[\\x20\\t\\r\\n\\f]", + + // https://www.w3.org/TR/css-syntax-3/#ident-token-diagram + identifier = "(?:\\\\[\\da-fA-F]{1,6}" + whitespace + + "?|\\\\[^\\r\\n\\f]|[\\w-]|[^\0-\\x7f])+", + + // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors + attributes = "\\[" + whitespace + "*(" + identifier + ")(?:" + whitespace + + + // Operator (capture 2) + "*([*^$|!~]?=)" + whitespace + + + // "Attribute values must be CSS identifiers [capture 5] + // or strings [capture 3 or capture 4]" + "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + + whitespace + "*\\]", + + pseudos = ":(" + identifier + ")(?:\\((" + + + // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments: + // 1. quoted (capture 3; capture 4 or capture 5) + "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" + + + // 2. simple (capture 6) + "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" + + + // 3. anything else (capture 2) + ".*" + + ")\\)|)", + + // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter + rwhitespace = new RegExp( whitespace + "+", "g" ), + rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + + whitespace + "+$", "g" ), + + rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ), + rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + + "*" ), + rdescend = new RegExp( whitespace + "|>" ), + + rpseudo = new RegExp( pseudos ), + ridentifier = new RegExp( "^" + identifier + "$" ), + + matchExpr = { + "ID": new RegExp( "^#(" + identifier + ")" ), + "CLASS": new RegExp( "^\\.(" + identifier + ")" ), + "TAG": new RegExp( "^(" + identifier + "|[*])" ), + "ATTR": new RegExp( "^" + attributes ), + "PSEUDO": new RegExp( "^" + pseudos ), + "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + + whitespace + "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + + whitespace + "*(\\d+)|))" + whitespace + "*\\)|)", "i" ), + "bool": new RegExp( "^(?:" + booleans + ")$", "i" ), + + // For use in libraries implementing .is() + // We use this for POS matching in `select` + "needsContext": new RegExp( "^" + whitespace + + "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" + whitespace + + "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" ) + }, + + rhtml = /HTML$/i, + rinputs = /^(?:input|select|textarea|button)$/i, + rheader = /^h\d$/i, + + rnative = /^[^{]+\{\s*\[native \w/, + + // Easily-parseable/retrievable ID or TAG or CLASS selectors + rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/, + + rsibling = /[+~]/, + + // CSS escapes + // http://www.w3.org/TR/CSS21/syndata.html#escaped-characters + runescape = new RegExp( "\\\\[\\da-fA-F]{1,6}" + whitespace + "?|\\\\([^\\r\\n\\f])", "g" ), + funescape = function( escape, nonHex ) { + var high = "0x" + escape.slice( 1 ) - 0x10000; + + return nonHex ? + + // Strip the backslash prefix from a non-hex escape sequence + nonHex : + + // Replace a hexadecimal escape sequence with the encoded Unicode code point + // Support: IE <=11+ + // For values outside the Basic Multilingual Plane (BMP), manually construct a + // surrogate pair + high < 0 ? + String.fromCharCode( high + 0x10000 ) : + String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 ); + }, + + // CSS string/identifier serialization + // https://drafts.csswg.org/cssom/#common-serializing-idioms + rcssescape = /([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g, + fcssescape = function( ch, asCodePoint ) { + if ( asCodePoint ) { + + // U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER + if ( ch === "\0" ) { + return "\uFFFD"; + } + + // Control characters and (dependent upon position) numbers get escaped as code points + return ch.slice( 0, -1 ) + "\\" + + ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " "; + } + + // Other potentially-special ASCII characters get backslash-escaped + return "\\" + ch; + }, + + // Used for iframes + // See setDocument() + // Removing the function wrapper causes a "Permission Denied" + // error in IE + unloadHandler = function() { + setDocument(); + }, + + inDisabledFieldset = addCombinator( + function( elem ) { + return elem.disabled === true && elem.nodeName.toLowerCase() === "fieldset"; + }, + { dir: "parentNode", next: "legend" } + ); + +// Optimize for push.apply( _, NodeList ) +try { + push.apply( + ( arr = slice.call( preferredDoc.childNodes ) ), + preferredDoc.childNodes + ); + + // Support: Android<4.0 + // Detect silently failing push.apply + // eslint-disable-next-line no-unused-expressions + arr[ preferredDoc.childNodes.length ].nodeType; +} catch ( e ) { + push = { apply: arr.length ? + + // Leverage slice if possible + function( target, els ) { + pushNative.apply( target, slice.call( els ) ); + } : + + // Support: IE<9 + // Otherwise append directly + function( target, els ) { + var j = target.length, + i = 0; + + // Can't trust NodeList.length + while ( ( target[ j++ ] = els[ i++ ] ) ) {} + target.length = j - 1; + } + }; +} + +function Sizzle( selector, context, results, seed ) { + var m, i, elem, nid, match, groups, newSelector, + newContext = context && context.ownerDocument, + + // nodeType defaults to 9, since context defaults to document + nodeType = context ? context.nodeType : 9; + + results = results || []; + + // Return early from calls with invalid selector or context + if ( typeof selector !== "string" || !selector || + nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) { + + return results; + } + + // Try to shortcut find operations (as opposed to filters) in HTML documents + if ( !seed ) { + setDocument( context ); + context = context || document; + + if ( documentIsHTML ) { + + // If the selector is sufficiently simple, try using a "get*By*" DOM method + // (excepting DocumentFragment context, where the methods don't exist) + if ( nodeType !== 11 && ( match = rquickExpr.exec( selector ) ) ) { + + // ID selector + if ( ( m = match[ 1 ] ) ) { + + // Document context + if ( nodeType === 9 ) { + if ( ( elem = context.getElementById( m ) ) ) { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( elem.id === m ) { + results.push( elem ); + return results; + } + } else { + return results; + } + + // Element context + } else { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( newContext && ( elem = newContext.getElementById( m ) ) && + contains( context, elem ) && + elem.id === m ) { + + results.push( elem ); + return results; + } + } + + // Type selector + } else if ( match[ 2 ] ) { + push.apply( results, context.getElementsByTagName( selector ) ); + return results; + + // Class selector + } else if ( ( m = match[ 3 ] ) && support.getElementsByClassName && + context.getElementsByClassName ) { + + push.apply( results, context.getElementsByClassName( m ) ); + return results; + } + } + + // Take advantage of querySelectorAll + if ( support.qsa && + !nonnativeSelectorCache[ selector + " " ] && + ( !rbuggyQSA || !rbuggyQSA.test( selector ) ) && + + // Support: IE 8 only + // Exclude object elements + ( nodeType !== 1 || context.nodeName.toLowerCase() !== "object" ) ) { + + newSelector = selector; + newContext = context; + + // qSA considers elements outside a scoping root when evaluating child or + // descendant combinators, which is not what we want. + // In such cases, we work around the behavior by prefixing every selector in the + // list with an ID selector referencing the scope context. + // The technique has to be used as well when a leading combinator is used + // as such selectors are not recognized by querySelectorAll. + // Thanks to Andrew Dupont for this technique. + if ( nodeType === 1 && + ( rdescend.test( selector ) || rcombinators.test( selector ) ) ) { + + // Expand context for sibling selectors + newContext = rsibling.test( selector ) && testContext( context.parentNode ) || + context; + + // We can use :scope instead of the ID hack if the browser + // supports it & if we're not changing the context. + if ( newContext !== context || !support.scope ) { + + // Capture the context ID, setting it first if necessary + if ( ( nid = context.getAttribute( "id" ) ) ) { + nid = nid.replace( rcssescape, fcssescape ); + } else { + context.setAttribute( "id", ( nid = expando ) ); + } + } + + // Prefix every selector in the list + groups = tokenize( selector ); + i = groups.length; + while ( i-- ) { + groups[ i ] = ( nid ? "#" + nid : ":scope" ) + " " + + toSelector( groups[ i ] ); + } + newSelector = groups.join( "," ); + } + + try { + push.apply( results, + newContext.querySelectorAll( newSelector ) + ); + return results; + } catch ( qsaError ) { + nonnativeSelectorCache( selector, true ); + } finally { + if ( nid === expando ) { + context.removeAttribute( "id" ); + } + } + } + } + } + + // All others + return select( selector.replace( rtrim, "$1" ), context, results, seed ); +} + +/** + * Create key-value caches of limited size + * @returns {function(string, object)} Returns the Object data after storing it on itself with + * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength) + * deleting the oldest entry + */ +function createCache() { + var keys = []; + + function cache( key, value ) { + + // Use (key + " ") to avoid collision with native prototype properties (see Issue #157) + if ( keys.push( key + " " ) > Expr.cacheLength ) { + + // Only keep the most recent entries + delete cache[ keys.shift() ]; + } + return ( cache[ key + " " ] = value ); + } + return cache; +} + +/** + * Mark a function for special use by Sizzle + * @param {Function} fn The function to mark + */ +function markFunction( fn ) { + fn[ expando ] = true; + return fn; +} + +/** + * Support testing using an element + * @param {Function} fn Passed the created element and returns a boolean result + */ +function assert( fn ) { + var el = document.createElement( "fieldset" ); + + try { + return !!fn( el ); + } catch ( e ) { + return false; + } finally { + + // Remove from its parent by default + if ( el.parentNode ) { + el.parentNode.removeChild( el ); + } + + // release memory in IE + el = null; + } +} + +/** + * Adds the same handler for all of the specified attrs + * @param {String} attrs Pipe-separated list of attributes + * @param {Function} handler The method that will be applied + */ +function addHandle( attrs, handler ) { + var arr = attrs.split( "|" ), + i = arr.length; + + while ( i-- ) { + Expr.attrHandle[ arr[ i ] ] = handler; + } +} + +/** + * Checks document order of two siblings + * @param {Element} a + * @param {Element} b + * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b + */ +function siblingCheck( a, b ) { + var cur = b && a, + diff = cur && a.nodeType === 1 && b.nodeType === 1 && + a.sourceIndex - b.sourceIndex; + + // Use IE sourceIndex if available on both nodes + if ( diff ) { + return diff; + } + + // Check if b follows a + if ( cur ) { + while ( ( cur = cur.nextSibling ) ) { + if ( cur === b ) { + return -1; + } + } + } + + return a ? 1 : -1; +} + +/** + * Returns a function to use in pseudos for input types + * @param {String} type + */ +function createInputPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for buttons + * @param {String} type + */ +function createButtonPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return ( name === "input" || name === "button" ) && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for :enabled/:disabled + * @param {Boolean} disabled true for :disabled; false for :enabled + */ +function createDisabledPseudo( disabled ) { + + // Known :disabled false positives: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable + return function( elem ) { + + // Only certain elements can match :enabled or :disabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-enabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-disabled + if ( "form" in elem ) { + + // Check for inherited disabledness on relevant non-disabled elements: + // * listed form-associated elements in a disabled fieldset + // https://html.spec.whatwg.org/multipage/forms.html#category-listed + // https://html.spec.whatwg.org/multipage/forms.html#concept-fe-disabled + // * option elements in a disabled optgroup + // https://html.spec.whatwg.org/multipage/forms.html#concept-option-disabled + // All such elements have a "form" property. + if ( elem.parentNode && elem.disabled === false ) { + + // Option elements defer to a parent optgroup if present + if ( "label" in elem ) { + if ( "label" in elem.parentNode ) { + return elem.parentNode.disabled === disabled; + } else { + return elem.disabled === disabled; + } + } + + // Support: IE 6 - 11 + // Use the isDisabled shortcut property to check for disabled fieldset ancestors + return elem.isDisabled === disabled || + + // Where there is no isDisabled, check manually + /* jshint -W018 */ + elem.isDisabled !== !disabled && + inDisabledFieldset( elem ) === disabled; + } + + return elem.disabled === disabled; + + // Try to winnow out elements that can't be disabled before trusting the disabled property. + // Some victims get caught in our net (label, legend, menu, track), but it shouldn't + // even exist on them, let alone have a boolean value. + } else if ( "label" in elem ) { + return elem.disabled === disabled; + } + + // Remaining elements are neither :enabled nor :disabled + return false; + }; +} + +/** + * Returns a function to use in pseudos for positionals + * @param {Function} fn + */ +function createPositionalPseudo( fn ) { + return markFunction( function( argument ) { + argument = +argument; + return markFunction( function( seed, matches ) { + var j, + matchIndexes = fn( [], seed.length, argument ), + i = matchIndexes.length; + + // Match elements found at the specified indexes + while ( i-- ) { + if ( seed[ ( j = matchIndexes[ i ] ) ] ) { + seed[ j ] = !( matches[ j ] = seed[ j ] ); + } + } + } ); + } ); +} + +/** + * Checks a node for validity as a Sizzle context + * @param {Element|Object=} context + * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value + */ +function testContext( context ) { + return context && typeof context.getElementsByTagName !== "undefined" && context; +} + +// Expose support vars for convenience +support = Sizzle.support = {}; + +/** + * Detects XML nodes + * @param {Element|Object} elem An element or a document + * @returns {Boolean} True iff elem is a non-HTML XML node + */ +isXML = Sizzle.isXML = function( elem ) { + var namespace = elem.namespaceURI, + docElem = ( elem.ownerDocument || elem ).documentElement; + + // Support: IE <=8 + // Assume HTML when documentElement doesn't yet exist, such as inside loading iframes + // https://bugs.jquery.com/ticket/4833 + return !rhtml.test( namespace || docElem && docElem.nodeName || "HTML" ); +}; + +/** + * Sets document-related variables once based on the current document + * @param {Element|Object} [doc] An element or document object to use to set the document + * @returns {Object} Returns the current document + */ +setDocument = Sizzle.setDocument = function( node ) { + var hasCompare, subWindow, + doc = node ? node.ownerDocument || node : preferredDoc; + + // Return early if doc is invalid or already selected + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( doc == document || doc.nodeType !== 9 || !doc.documentElement ) { + return document; + } + + // Update global variables + document = doc; + docElem = document.documentElement; + documentIsHTML = !isXML( document ); + + // Support: IE 9 - 11+, Edge 12 - 18+ + // Accessing iframe documents after unload throws "permission denied" errors (jQuery #13936) + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( preferredDoc != document && + ( subWindow = document.defaultView ) && subWindow.top !== subWindow ) { + + // Support: IE 11, Edge + if ( subWindow.addEventListener ) { + subWindow.addEventListener( "unload", unloadHandler, false ); + + // Support: IE 9 - 10 only + } else if ( subWindow.attachEvent ) { + subWindow.attachEvent( "onunload", unloadHandler ); + } + } + + // Support: IE 8 - 11+, Edge 12 - 18+, Chrome <=16 - 25 only, Firefox <=3.6 - 31 only, + // Safari 4 - 5 only, Opera <=11.6 - 12.x only + // IE/Edge & older browsers don't support the :scope pseudo-class. + // Support: Safari 6.0 only + // Safari 6.0 supports :scope but it's an alias of :root there. + support.scope = assert( function( el ) { + docElem.appendChild( el ).appendChild( document.createElement( "div" ) ); + return typeof el.querySelectorAll !== "undefined" && + !el.querySelectorAll( ":scope fieldset div" ).length; + } ); + + /* Attributes + ---------------------------------------------------------------------- */ + + // Support: IE<8 + // Verify that getAttribute really returns attributes and not properties + // (excepting IE8 booleans) + support.attributes = assert( function( el ) { + el.className = "i"; + return !el.getAttribute( "className" ); + } ); + + /* getElement(s)By* + ---------------------------------------------------------------------- */ + + // Check if getElementsByTagName("*") returns only elements + support.getElementsByTagName = assert( function( el ) { + el.appendChild( document.createComment( "" ) ); + return !el.getElementsByTagName( "*" ).length; + } ); + + // Support: IE<9 + support.getElementsByClassName = rnative.test( document.getElementsByClassName ); + + // Support: IE<10 + // Check if getElementById returns elements by name + // The broken getElementById methods don't pick up programmatically-set names, + // so use a roundabout getElementsByName test + support.getById = assert( function( el ) { + docElem.appendChild( el ).id = expando; + return !document.getElementsByName || !document.getElementsByName( expando ).length; + } ); + + // ID filter and find + if ( support.getById ) { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + return elem.getAttribute( "id" ) === attrId; + }; + }; + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var elem = context.getElementById( id ); + return elem ? [ elem ] : []; + } + }; + } else { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + var node = typeof elem.getAttributeNode !== "undefined" && + elem.getAttributeNode( "id" ); + return node && node.value === attrId; + }; + }; + + // Support: IE 6 - 7 only + // getElementById is not reliable as a find shortcut + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var node, i, elems, + elem = context.getElementById( id ); + + if ( elem ) { + + // Verify the id attribute + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + + // Fall back on getElementsByName + elems = context.getElementsByName( id ); + i = 0; + while ( ( elem = elems[ i++ ] ) ) { + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + } + } + + return []; + } + }; + } + + // Tag + Expr.find[ "TAG" ] = support.getElementsByTagName ? + function( tag, context ) { + if ( typeof context.getElementsByTagName !== "undefined" ) { + return context.getElementsByTagName( tag ); + + // DocumentFragment nodes don't have gEBTN + } else if ( support.qsa ) { + return context.querySelectorAll( tag ); + } + } : + + function( tag, context ) { + var elem, + tmp = [], + i = 0, + + // By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too + results = context.getElementsByTagName( tag ); + + // Filter out possible comments + if ( tag === "*" ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem.nodeType === 1 ) { + tmp.push( elem ); + } + } + + return tmp; + } + return results; + }; + + // Class + Expr.find[ "CLASS" ] = support.getElementsByClassName && function( className, context ) { + if ( typeof context.getElementsByClassName !== "undefined" && documentIsHTML ) { + return context.getElementsByClassName( className ); + } + }; + + /* QSA/matchesSelector + ---------------------------------------------------------------------- */ + + // QSA and matchesSelector support + + // matchesSelector(:active) reports false when true (IE9/Opera 11.5) + rbuggyMatches = []; + + // qSa(:focus) reports false when true (Chrome 21) + // We allow this because of a bug in IE8/9 that throws an error + // whenever `document.activeElement` is accessed on an iframe + // So, we allow :focus to pass through QSA all the time to avoid the IE error + // See https://bugs.jquery.com/ticket/13378 + rbuggyQSA = []; + + if ( ( support.qsa = rnative.test( document.querySelectorAll ) ) ) { + + // Build QSA regex + // Regex strategy adopted from Diego Perini + assert( function( el ) { + + var input; + + // Select is set to empty string on purpose + // This is to test IE's treatment of not explicitly + // setting a boolean content attribute, + // since its presence should be enough + // https://bugs.jquery.com/ticket/12359 + docElem.appendChild( el ).innerHTML = "" + + ""; + + // Support: IE8, Opera 11-12.16 + // Nothing should be selected when empty strings follow ^= or $= or *= + // The test attribute must be unknown in Opera but "safe" for WinRT + // https://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section + if ( el.querySelectorAll( "[msallowcapture^='']" ).length ) { + rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" ); + } + + // Support: IE8 + // Boolean attributes and "value" are not treated correctly + if ( !el.querySelectorAll( "[selected]" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" ); + } + + // Support: Chrome<29, Android<4.4, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.8+ + if ( !el.querySelectorAll( "[id~=" + expando + "-]" ).length ) { + rbuggyQSA.push( "~=" ); + } + + // Support: IE 11+, Edge 15 - 18+ + // IE 11/Edge don't find elements on a `[name='']` query in some cases. + // Adding a temporary attribute to the document before the selection works + // around the issue. + // Interestingly, IE 10 & older don't seem to have the issue. + input = document.createElement( "input" ); + input.setAttribute( "name", "" ); + el.appendChild( input ); + if ( !el.querySelectorAll( "[name='']" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*name" + whitespace + "*=" + + whitespace + "*(?:''|\"\")" ); + } + + // Webkit/Opera - :checked should return selected option elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + // IE8 throws error here and will not see later tests + if ( !el.querySelectorAll( ":checked" ).length ) { + rbuggyQSA.push( ":checked" ); + } + + // Support: Safari 8+, iOS 8+ + // https://bugs.webkit.org/show_bug.cgi?id=136851 + // In-page `selector#id sibling-combinator selector` fails + if ( !el.querySelectorAll( "a#" + expando + "+*" ).length ) { + rbuggyQSA.push( ".#.+[+~]" ); + } + + // Support: Firefox <=3.6 - 5 only + // Old Firefox doesn't throw on a badly-escaped identifier. + el.querySelectorAll( "\\\f" ); + rbuggyQSA.push( "[\\r\\n\\f]" ); + } ); + + assert( function( el ) { + el.innerHTML = "" + + ""; + + // Support: Windows 8 Native Apps + // The type and name attributes are restricted during .innerHTML assignment + var input = document.createElement( "input" ); + input.setAttribute( "type", "hidden" ); + el.appendChild( input ).setAttribute( "name", "D" ); + + // Support: IE8 + // Enforce case-sensitivity of name attribute + if ( el.querySelectorAll( "[name=d]" ).length ) { + rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" ); + } + + // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled) + // IE8 throws error here and will not see later tests + if ( el.querySelectorAll( ":enabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: IE9-11+ + // IE's :disabled selector does not pick up the children of disabled fieldsets + docElem.appendChild( el ).disabled = true; + if ( el.querySelectorAll( ":disabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: Opera 10 - 11 only + // Opera 10-11 does not throw on post-comma invalid pseudos + el.querySelectorAll( "*,:x" ); + rbuggyQSA.push( ",.*:" ); + } ); + } + + if ( ( support.matchesSelector = rnative.test( ( matches = docElem.matches || + docElem.webkitMatchesSelector || + docElem.mozMatchesSelector || + docElem.oMatchesSelector || + docElem.msMatchesSelector ) ) ) ) { + + assert( function( el ) { + + // Check to see if it's possible to do matchesSelector + // on a disconnected node (IE 9) + support.disconnectedMatch = matches.call( el, "*" ); + + // This should fail with an exception + // Gecko does not error, returns false instead + matches.call( el, "[s!='']:x" ); + rbuggyMatches.push( "!=", pseudos ); + } ); + } + + rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join( "|" ) ); + rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join( "|" ) ); + + /* Contains + ---------------------------------------------------------------------- */ + hasCompare = rnative.test( docElem.compareDocumentPosition ); + + // Element contains another + // Purposefully self-exclusive + // As in, an element does not contain itself + contains = hasCompare || rnative.test( docElem.contains ) ? + function( a, b ) { + var adown = a.nodeType === 9 ? a.documentElement : a, + bup = b && b.parentNode; + return a === bup || !!( bup && bup.nodeType === 1 && ( + adown.contains ? + adown.contains( bup ) : + a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16 + ) ); + } : + function( a, b ) { + if ( b ) { + while ( ( b = b.parentNode ) ) { + if ( b === a ) { + return true; + } + } + } + return false; + }; + + /* Sorting + ---------------------------------------------------------------------- */ + + // Document order sorting + sortOrder = hasCompare ? + function( a, b ) { + + // Flag for duplicate removal + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + // Sort on method existence if only one input has compareDocumentPosition + var compare = !a.compareDocumentPosition - !b.compareDocumentPosition; + if ( compare ) { + return compare; + } + + // Calculate position if both inputs belong to the same document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + compare = ( a.ownerDocument || a ) == ( b.ownerDocument || b ) ? + a.compareDocumentPosition( b ) : + + // Otherwise we know they are disconnected + 1; + + // Disconnected nodes + if ( compare & 1 || + ( !support.sortDetached && b.compareDocumentPosition( a ) === compare ) ) { + + // Choose the first element that is related to our preferred document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( a == document || a.ownerDocument == preferredDoc && + contains( preferredDoc, a ) ) { + return -1; + } + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( b == document || b.ownerDocument == preferredDoc && + contains( preferredDoc, b ) ) { + return 1; + } + + // Maintain original order + return sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + } + + return compare & 4 ? -1 : 1; + } : + function( a, b ) { + + // Exit early if the nodes are identical + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + var cur, + i = 0, + aup = a.parentNode, + bup = b.parentNode, + ap = [ a ], + bp = [ b ]; + + // Parentless nodes are either documents or disconnected + if ( !aup || !bup ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + return a == document ? -1 : + b == document ? 1 : + /* eslint-enable eqeqeq */ + aup ? -1 : + bup ? 1 : + sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + + // If the nodes are siblings, we can do a quick check + } else if ( aup === bup ) { + return siblingCheck( a, b ); + } + + // Otherwise we need full lists of their ancestors for comparison + cur = a; + while ( ( cur = cur.parentNode ) ) { + ap.unshift( cur ); + } + cur = b; + while ( ( cur = cur.parentNode ) ) { + bp.unshift( cur ); + } + + // Walk down the tree looking for a discrepancy + while ( ap[ i ] === bp[ i ] ) { + i++; + } + + return i ? + + // Do a sibling check if the nodes have a common ancestor + siblingCheck( ap[ i ], bp[ i ] ) : + + // Otherwise nodes in our document sort first + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + ap[ i ] == preferredDoc ? -1 : + bp[ i ] == preferredDoc ? 1 : + /* eslint-enable eqeqeq */ + 0; + }; + + return document; +}; + +Sizzle.matches = function( expr, elements ) { + return Sizzle( expr, null, null, elements ); +}; + +Sizzle.matchesSelector = function( elem, expr ) { + setDocument( elem ); + + if ( support.matchesSelector && documentIsHTML && + !nonnativeSelectorCache[ expr + " " ] && + ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) && + ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) { + + try { + var ret = matches.call( elem, expr ); + + // IE 9's matchesSelector returns false on disconnected nodes + if ( ret || support.disconnectedMatch || + + // As well, disconnected nodes are said to be in a document + // fragment in IE 9 + elem.document && elem.document.nodeType !== 11 ) { + return ret; + } + } catch ( e ) { + nonnativeSelectorCache( expr, true ); + } + } + + return Sizzle( expr, document, null, [ elem ] ).length > 0; +}; + +Sizzle.contains = function( context, elem ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( context.ownerDocument || context ) != document ) { + setDocument( context ); + } + return contains( context, elem ); +}; + +Sizzle.attr = function( elem, name ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( elem.ownerDocument || elem ) != document ) { + setDocument( elem ); + } + + var fn = Expr.attrHandle[ name.toLowerCase() ], + + // Don't get fooled by Object.prototype properties (jQuery #13807) + val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ? + fn( elem, name, !documentIsHTML ) : + undefined; + + return val !== undefined ? + val : + support.attributes || !documentIsHTML ? + elem.getAttribute( name ) : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; +}; + +Sizzle.escape = function( sel ) { + return ( sel + "" ).replace( rcssescape, fcssescape ); +}; + +Sizzle.error = function( msg ) { + throw new Error( "Syntax error, unrecognized expression: " + msg ); +}; + +/** + * Document sorting and removing duplicates + * @param {ArrayLike} results + */ +Sizzle.uniqueSort = function( results ) { + var elem, + duplicates = [], + j = 0, + i = 0; + + // Unless we *know* we can detect duplicates, assume their presence + hasDuplicate = !support.detectDuplicates; + sortInput = !support.sortStable && results.slice( 0 ); + results.sort( sortOrder ); + + if ( hasDuplicate ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem === results[ i ] ) { + j = duplicates.push( i ); + } + } + while ( j-- ) { + results.splice( duplicates[ j ], 1 ); + } + } + + // Clear input after sorting to release objects + // See https://github.com/jquery/sizzle/pull/225 + sortInput = null; + + return results; +}; + +/** + * Utility function for retrieving the text value of an array of DOM nodes + * @param {Array|Element} elem + */ +getText = Sizzle.getText = function( elem ) { + var node, + ret = "", + i = 0, + nodeType = elem.nodeType; + + if ( !nodeType ) { + + // If no nodeType, this is expected to be an array + while ( ( node = elem[ i++ ] ) ) { + + // Do not traverse comment nodes + ret += getText( node ); + } + } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) { + + // Use textContent for elements + // innerText usage removed for consistency of new lines (jQuery #11153) + if ( typeof elem.textContent === "string" ) { + return elem.textContent; + } else { + + // Traverse its children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + ret += getText( elem ); + } + } + } else if ( nodeType === 3 || nodeType === 4 ) { + return elem.nodeValue; + } + + // Do not include comment or processing instruction nodes + + return ret; +}; + +Expr = Sizzle.selectors = { + + // Can be adjusted by the user + cacheLength: 50, + + createPseudo: markFunction, + + match: matchExpr, + + attrHandle: {}, + + find: {}, + + relative: { + ">": { dir: "parentNode", first: true }, + " ": { dir: "parentNode" }, + "+": { dir: "previousSibling", first: true }, + "~": { dir: "previousSibling" } + }, + + preFilter: { + "ATTR": function( match ) { + match[ 1 ] = match[ 1 ].replace( runescape, funescape ); + + // Move the given value to match[3] whether quoted or unquoted + match[ 3 ] = ( match[ 3 ] || match[ 4 ] || + match[ 5 ] || "" ).replace( runescape, funescape ); + + if ( match[ 2 ] === "~=" ) { + match[ 3 ] = " " + match[ 3 ] + " "; + } + + return match.slice( 0, 4 ); + }, + + "CHILD": function( match ) { + + /* matches from matchExpr["CHILD"] + 1 type (only|nth|...) + 2 what (child|of-type) + 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...) + 4 xn-component of xn+y argument ([+-]?\d*n|) + 5 sign of xn-component + 6 x of xn-component + 7 sign of y-component + 8 y of y-component + */ + match[ 1 ] = match[ 1 ].toLowerCase(); + + if ( match[ 1 ].slice( 0, 3 ) === "nth" ) { + + // nth-* requires argument + if ( !match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + // numeric x and y parameters for Expr.filter.CHILD + // remember that false/true cast respectively to 0/1 + match[ 4 ] = +( match[ 4 ] ? + match[ 5 ] + ( match[ 6 ] || 1 ) : + 2 * ( match[ 3 ] === "even" || match[ 3 ] === "odd" ) ); + match[ 5 ] = +( ( match[ 7 ] + match[ 8 ] ) || match[ 3 ] === "odd" ); + + // other types prohibit arguments + } else if ( match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + return match; + }, + + "PSEUDO": function( match ) { + var excess, + unquoted = !match[ 6 ] && match[ 2 ]; + + if ( matchExpr[ "CHILD" ].test( match[ 0 ] ) ) { + return null; + } + + // Accept quoted arguments as-is + if ( match[ 3 ] ) { + match[ 2 ] = match[ 4 ] || match[ 5 ] || ""; + + // Strip excess characters from unquoted arguments + } else if ( unquoted && rpseudo.test( unquoted ) && + + // Get excess from tokenize (recursively) + ( excess = tokenize( unquoted, true ) ) && + + // advance to the next closing parenthesis + ( excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length ) ) { + + // excess is a negative index + match[ 0 ] = match[ 0 ].slice( 0, excess ); + match[ 2 ] = unquoted.slice( 0, excess ); + } + + // Return only captures needed by the pseudo filter method (type and argument) + return match.slice( 0, 3 ); + } + }, + + filter: { + + "TAG": function( nodeNameSelector ) { + var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase(); + return nodeNameSelector === "*" ? + function() { + return true; + } : + function( elem ) { + return elem.nodeName && elem.nodeName.toLowerCase() === nodeName; + }; + }, + + "CLASS": function( className ) { + var pattern = classCache[ className + " " ]; + + return pattern || + ( pattern = new RegExp( "(^|" + whitespace + + ")" + className + "(" + whitespace + "|$)" ) ) && classCache( + className, function( elem ) { + return pattern.test( + typeof elem.className === "string" && elem.className || + typeof elem.getAttribute !== "undefined" && + elem.getAttribute( "class" ) || + "" + ); + } ); + }, + + "ATTR": function( name, operator, check ) { + return function( elem ) { + var result = Sizzle.attr( elem, name ); + + if ( result == null ) { + return operator === "!="; + } + if ( !operator ) { + return true; + } + + result += ""; + + /* eslint-disable max-len */ + + return operator === "=" ? result === check : + operator === "!=" ? result !== check : + operator === "^=" ? check && result.indexOf( check ) === 0 : + operator === "*=" ? check && result.indexOf( check ) > -1 : + operator === "$=" ? check && result.slice( -check.length ) === check : + operator === "~=" ? ( " " + result.replace( rwhitespace, " " ) + " " ).indexOf( check ) > -1 : + operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" : + false; + /* eslint-enable max-len */ + + }; + }, + + "CHILD": function( type, what, _argument, first, last ) { + var simple = type.slice( 0, 3 ) !== "nth", + forward = type.slice( -4 ) !== "last", + ofType = what === "of-type"; + + return first === 1 && last === 0 ? + + // Shortcut for :nth-*(n) + function( elem ) { + return !!elem.parentNode; + } : + + function( elem, _context, xml ) { + var cache, uniqueCache, outerCache, node, nodeIndex, start, + dir = simple !== forward ? "nextSibling" : "previousSibling", + parent = elem.parentNode, + name = ofType && elem.nodeName.toLowerCase(), + useCache = !xml && !ofType, + diff = false; + + if ( parent ) { + + // :(first|last|only)-(child|of-type) + if ( simple ) { + while ( dir ) { + node = elem; + while ( ( node = node[ dir ] ) ) { + if ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) { + + return false; + } + } + + // Reverse direction for :only-* (if we haven't yet done so) + start = dir = type === "only" && !start && "nextSibling"; + } + return true; + } + + start = [ forward ? parent.firstChild : parent.lastChild ]; + + // non-xml :nth-child(...) stores cache data on `parent` + if ( forward && useCache ) { + + // Seek `elem` from a previously-cached index + + // ...in a gzip-friendly way + node = parent; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex && cache[ 2 ]; + node = nodeIndex && parent.childNodes[ nodeIndex ]; + + while ( ( node = ++nodeIndex && node && node[ dir ] || + + // Fallback to seeking `elem` from the start + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + // When found, cache indexes on `parent` and break + if ( node.nodeType === 1 && ++diff && node === elem ) { + uniqueCache[ type ] = [ dirruns, nodeIndex, diff ]; + break; + } + } + + } else { + + // Use previously-cached element index if available + if ( useCache ) { + + // ...in a gzip-friendly way + node = elem; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex; + } + + // xml :nth-child(...) + // or :nth-last-child(...) or :nth(-last)?-of-type(...) + if ( diff === false ) { + + // Use the same loop as above to seek `elem` from the start + while ( ( node = ++nodeIndex && node && node[ dir ] || + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + if ( ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) && + ++diff ) { + + // Cache the index of each encountered element + if ( useCache ) { + outerCache = node[ expando ] || + ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + uniqueCache[ type ] = [ dirruns, diff ]; + } + + if ( node === elem ) { + break; + } + } + } + } + } + + // Incorporate the offset, then check against cycle size + diff -= last; + return diff === first || ( diff % first === 0 && diff / first >= 0 ); + } + }; + }, + + "PSEUDO": function( pseudo, argument ) { + + // pseudo-class names are case-insensitive + // http://www.w3.org/TR/selectors/#pseudo-classes + // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters + // Remember that setFilters inherits from pseudos + var args, + fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] || + Sizzle.error( "unsupported pseudo: " + pseudo ); + + // The user may use createPseudo to indicate that + // arguments are needed to create the filter function + // just as Sizzle does + if ( fn[ expando ] ) { + return fn( argument ); + } + + // But maintain support for old signatures + if ( fn.length > 1 ) { + args = [ pseudo, pseudo, "", argument ]; + return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ? + markFunction( function( seed, matches ) { + var idx, + matched = fn( seed, argument ), + i = matched.length; + while ( i-- ) { + idx = indexOf( seed, matched[ i ] ); + seed[ idx ] = !( matches[ idx ] = matched[ i ] ); + } + } ) : + function( elem ) { + return fn( elem, 0, args ); + }; + } + + return fn; + } + }, + + pseudos: { + + // Potentially complex pseudos + "not": markFunction( function( selector ) { + + // Trim the selector passed to compile + // to avoid treating leading and trailing + // spaces as combinators + var input = [], + results = [], + matcher = compile( selector.replace( rtrim, "$1" ) ); + + return matcher[ expando ] ? + markFunction( function( seed, matches, _context, xml ) { + var elem, + unmatched = matcher( seed, null, xml, [] ), + i = seed.length; + + // Match elements unmatched by `matcher` + while ( i-- ) { + if ( ( elem = unmatched[ i ] ) ) { + seed[ i ] = !( matches[ i ] = elem ); + } + } + } ) : + function( elem, _context, xml ) { + input[ 0 ] = elem; + matcher( input, null, xml, results ); + + // Don't keep the element (issue #299) + input[ 0 ] = null; + return !results.pop(); + }; + } ), + + "has": markFunction( function( selector ) { + return function( elem ) { + return Sizzle( selector, elem ).length > 0; + }; + } ), + + "contains": markFunction( function( text ) { + text = text.replace( runescape, funescape ); + return function( elem ) { + return ( elem.textContent || getText( elem ) ).indexOf( text ) > -1; + }; + } ), + + // "Whether an element is represented by a :lang() selector + // is based solely on the element's language value + // being equal to the identifier C, + // or beginning with the identifier C immediately followed by "-". + // The matching of C against the element's language value is performed case-insensitively. + // The identifier C does not have to be a valid language name." + // http://www.w3.org/TR/selectors/#lang-pseudo + "lang": markFunction( function( lang ) { + + // lang value must be a valid identifier + if ( !ridentifier.test( lang || "" ) ) { + Sizzle.error( "unsupported lang: " + lang ); + } + lang = lang.replace( runescape, funescape ).toLowerCase(); + return function( elem ) { + var elemLang; + do { + if ( ( elemLang = documentIsHTML ? + elem.lang : + elem.getAttribute( "xml:lang" ) || elem.getAttribute( "lang" ) ) ) { + + elemLang = elemLang.toLowerCase(); + return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0; + } + } while ( ( elem = elem.parentNode ) && elem.nodeType === 1 ); + return false; + }; + } ), + + // Miscellaneous + "target": function( elem ) { + var hash = window.location && window.location.hash; + return hash && hash.slice( 1 ) === elem.id; + }, + + "root": function( elem ) { + return elem === docElem; + }, + + "focus": function( elem ) { + return elem === document.activeElement && + ( !document.hasFocus || document.hasFocus() ) && + !!( elem.type || elem.href || ~elem.tabIndex ); + }, + + // Boolean properties + "enabled": createDisabledPseudo( false ), + "disabled": createDisabledPseudo( true ), + + "checked": function( elem ) { + + // In CSS3, :checked should return both checked and selected elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + var nodeName = elem.nodeName.toLowerCase(); + return ( nodeName === "input" && !!elem.checked ) || + ( nodeName === "option" && !!elem.selected ); + }, + + "selected": function( elem ) { + + // Accessing this property makes selected-by-default + // options in Safari work properly + if ( elem.parentNode ) { + // eslint-disable-next-line no-unused-expressions + elem.parentNode.selectedIndex; + } + + return elem.selected === true; + }, + + // Contents + "empty": function( elem ) { + + // http://www.w3.org/TR/selectors/#empty-pseudo + // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5), + // but not by others (comment: 8; processing instruction: 7; etc.) + // nodeType < 6 works because attributes (2) do not appear as children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + if ( elem.nodeType < 6 ) { + return false; + } + } + return true; + }, + + "parent": function( elem ) { + return !Expr.pseudos[ "empty" ]( elem ); + }, + + // Element/input types + "header": function( elem ) { + return rheader.test( elem.nodeName ); + }, + + "input": function( elem ) { + return rinputs.test( elem.nodeName ); + }, + + "button": function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === "button" || name === "button"; + }, + + "text": function( elem ) { + var attr; + return elem.nodeName.toLowerCase() === "input" && + elem.type === "text" && + + // Support: IE<8 + // New HTML5 attribute values (e.g., "search") appear with elem.type === "text" + ( ( attr = elem.getAttribute( "type" ) ) == null || + attr.toLowerCase() === "text" ); + }, + + // Position-in-collection + "first": createPositionalPseudo( function() { + return [ 0 ]; + } ), + + "last": createPositionalPseudo( function( _matchIndexes, length ) { + return [ length - 1 ]; + } ), + + "eq": createPositionalPseudo( function( _matchIndexes, length, argument ) { + return [ argument < 0 ? argument + length : argument ]; + } ), + + "even": createPositionalPseudo( function( matchIndexes, length ) { + var i = 0; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "odd": createPositionalPseudo( function( matchIndexes, length ) { + var i = 1; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "lt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? + argument + length : + argument > length ? + length : + argument; + for ( ; --i >= 0; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "gt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? argument + length : argument; + for ( ; ++i < length; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ) + } +}; + +Expr.pseudos[ "nth" ] = Expr.pseudos[ "eq" ]; + +// Add button/input type pseudos +for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) { + Expr.pseudos[ i ] = createInputPseudo( i ); +} +for ( i in { submit: true, reset: true } ) { + Expr.pseudos[ i ] = createButtonPseudo( i ); +} + +// Easy API for creating new setFilters +function setFilters() {} +setFilters.prototype = Expr.filters = Expr.pseudos; +Expr.setFilters = new setFilters(); + +tokenize = Sizzle.tokenize = function( selector, parseOnly ) { + var matched, match, tokens, type, + soFar, groups, preFilters, + cached = tokenCache[ selector + " " ]; + + if ( cached ) { + return parseOnly ? 0 : cached.slice( 0 ); + } + + soFar = selector; + groups = []; + preFilters = Expr.preFilter; + + while ( soFar ) { + + // Comma and first run + if ( !matched || ( match = rcomma.exec( soFar ) ) ) { + if ( match ) { + + // Don't consume trailing commas as valid + soFar = soFar.slice( match[ 0 ].length ) || soFar; + } + groups.push( ( tokens = [] ) ); + } + + matched = false; + + // Combinators + if ( ( match = rcombinators.exec( soFar ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + + // Cast descendant combinators to space + type: match[ 0 ].replace( rtrim, " " ) + } ); + soFar = soFar.slice( matched.length ); + } + + // Filters + for ( type in Expr.filter ) { + if ( ( match = matchExpr[ type ].exec( soFar ) ) && ( !preFilters[ type ] || + ( match = preFilters[ type ]( match ) ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + type: type, + matches: match + } ); + soFar = soFar.slice( matched.length ); + } + } + + if ( !matched ) { + break; + } + } + + // Return the length of the invalid excess + // if we're just parsing + // Otherwise, throw an error or return tokens + return parseOnly ? + soFar.length : + soFar ? + Sizzle.error( selector ) : + + // Cache the tokens + tokenCache( selector, groups ).slice( 0 ); +}; + +function toSelector( tokens ) { + var i = 0, + len = tokens.length, + selector = ""; + for ( ; i < len; i++ ) { + selector += tokens[ i ].value; + } + return selector; +} + +function addCombinator( matcher, combinator, base ) { + var dir = combinator.dir, + skip = combinator.next, + key = skip || dir, + checkNonElements = base && key === "parentNode", + doneName = done++; + + return combinator.first ? + + // Check against closest ancestor/preceding element + function( elem, context, xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + return matcher( elem, context, xml ); + } + } + return false; + } : + + // Check against all ancestor/preceding elements + function( elem, context, xml ) { + var oldCache, uniqueCache, outerCache, + newCache = [ dirruns, doneName ]; + + // We can't set arbitrary data on XML nodes, so they don't benefit from combinator caching + if ( xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + if ( matcher( elem, context, xml ) ) { + return true; + } + } + } + } else { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + outerCache = elem[ expando ] || ( elem[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ elem.uniqueID ] || + ( outerCache[ elem.uniqueID ] = {} ); + + if ( skip && skip === elem.nodeName.toLowerCase() ) { + elem = elem[ dir ] || elem; + } else if ( ( oldCache = uniqueCache[ key ] ) && + oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) { + + // Assign to newCache so results back-propagate to previous elements + return ( newCache[ 2 ] = oldCache[ 2 ] ); + } else { + + // Reuse newcache so results back-propagate to previous elements + uniqueCache[ key ] = newCache; + + // A match means we're done; a fail means we have to keep checking + if ( ( newCache[ 2 ] = matcher( elem, context, xml ) ) ) { + return true; + } + } + } + } + } + return false; + }; +} + +function elementMatcher( matchers ) { + return matchers.length > 1 ? + function( elem, context, xml ) { + var i = matchers.length; + while ( i-- ) { + if ( !matchers[ i ]( elem, context, xml ) ) { + return false; + } + } + return true; + } : + matchers[ 0 ]; +} + +function multipleContexts( selector, contexts, results ) { + var i = 0, + len = contexts.length; + for ( ; i < len; i++ ) { + Sizzle( selector, contexts[ i ], results ); + } + return results; +} + +function condense( unmatched, map, filter, context, xml ) { + var elem, + newUnmatched = [], + i = 0, + len = unmatched.length, + mapped = map != null; + + for ( ; i < len; i++ ) { + if ( ( elem = unmatched[ i ] ) ) { + if ( !filter || filter( elem, context, xml ) ) { + newUnmatched.push( elem ); + if ( mapped ) { + map.push( i ); + } + } + } + } + + return newUnmatched; +} + +function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) { + if ( postFilter && !postFilter[ expando ] ) { + postFilter = setMatcher( postFilter ); + } + if ( postFinder && !postFinder[ expando ] ) { + postFinder = setMatcher( postFinder, postSelector ); + } + return markFunction( function( seed, results, context, xml ) { + var temp, i, elem, + preMap = [], + postMap = [], + preexisting = results.length, + + // Get initial elements from seed or context + elems = seed || multipleContexts( + selector || "*", + context.nodeType ? [ context ] : context, + [] + ), + + // Prefilter to get matcher input, preserving a map for seed-results synchronization + matcherIn = preFilter && ( seed || !selector ) ? + condense( elems, preMap, preFilter, context, xml ) : + elems, + + matcherOut = matcher ? + + // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results, + postFinder || ( seed ? preFilter : preexisting || postFilter ) ? + + // ...intermediate processing is necessary + [] : + + // ...otherwise use results directly + results : + matcherIn; + + // Find primary matches + if ( matcher ) { + matcher( matcherIn, matcherOut, context, xml ); + } + + // Apply postFilter + if ( postFilter ) { + temp = condense( matcherOut, postMap ); + postFilter( temp, [], context, xml ); + + // Un-match failing elements by moving them back to matcherIn + i = temp.length; + while ( i-- ) { + if ( ( elem = temp[ i ] ) ) { + matcherOut[ postMap[ i ] ] = !( matcherIn[ postMap[ i ] ] = elem ); + } + } + } + + if ( seed ) { + if ( postFinder || preFilter ) { + if ( postFinder ) { + + // Get the final matcherOut by condensing this intermediate into postFinder contexts + temp = []; + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) ) { + + // Restore matcherIn since elem is not yet a final match + temp.push( ( matcherIn[ i ] = elem ) ); + } + } + postFinder( null, ( matcherOut = [] ), temp, xml ); + } + + // Move matched elements from seed to results to keep them synchronized + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) && + ( temp = postFinder ? indexOf( seed, elem ) : preMap[ i ] ) > -1 ) { + + seed[ temp ] = !( results[ temp ] = elem ); + } + } + } + + // Add elements to results, through postFinder if defined + } else { + matcherOut = condense( + matcherOut === results ? + matcherOut.splice( preexisting, matcherOut.length ) : + matcherOut + ); + if ( postFinder ) { + postFinder( null, results, matcherOut, xml ); + } else { + push.apply( results, matcherOut ); + } + } + } ); +} + +function matcherFromTokens( tokens ) { + var checkContext, matcher, j, + len = tokens.length, + leadingRelative = Expr.relative[ tokens[ 0 ].type ], + implicitRelative = leadingRelative || Expr.relative[ " " ], + i = leadingRelative ? 1 : 0, + + // The foundational matcher ensures that elements are reachable from top-level context(s) + matchContext = addCombinator( function( elem ) { + return elem === checkContext; + }, implicitRelative, true ), + matchAnyContext = addCombinator( function( elem ) { + return indexOf( checkContext, elem ) > -1; + }, implicitRelative, true ), + matchers = [ function( elem, context, xml ) { + var ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || ( + ( checkContext = context ).nodeType ? + matchContext( elem, context, xml ) : + matchAnyContext( elem, context, xml ) ); + + // Avoid hanging onto element (issue #299) + checkContext = null; + return ret; + } ]; + + for ( ; i < len; i++ ) { + if ( ( matcher = Expr.relative[ tokens[ i ].type ] ) ) { + matchers = [ addCombinator( elementMatcher( matchers ), matcher ) ]; + } else { + matcher = Expr.filter[ tokens[ i ].type ].apply( null, tokens[ i ].matches ); + + // Return special upon seeing a positional matcher + if ( matcher[ expando ] ) { + + // Find the next relative operator (if any) for proper handling + j = ++i; + for ( ; j < len; j++ ) { + if ( Expr.relative[ tokens[ j ].type ] ) { + break; + } + } + return setMatcher( + i > 1 && elementMatcher( matchers ), + i > 1 && toSelector( + + // If the preceding token was a descendant combinator, insert an implicit any-element `*` + tokens + .slice( 0, i - 1 ) + .concat( { value: tokens[ i - 2 ].type === " " ? "*" : "" } ) + ).replace( rtrim, "$1" ), + matcher, + i < j && matcherFromTokens( tokens.slice( i, j ) ), + j < len && matcherFromTokens( ( tokens = tokens.slice( j ) ) ), + j < len && toSelector( tokens ) + ); + } + matchers.push( matcher ); + } + } + + return elementMatcher( matchers ); +} + +function matcherFromGroupMatchers( elementMatchers, setMatchers ) { + var bySet = setMatchers.length > 0, + byElement = elementMatchers.length > 0, + superMatcher = function( seed, context, xml, results, outermost ) { + var elem, j, matcher, + matchedCount = 0, + i = "0", + unmatched = seed && [], + setMatched = [], + contextBackup = outermostContext, + + // We must always have either seed elements or outermost context + elems = seed || byElement && Expr.find[ "TAG" ]( "*", outermost ), + + // Use integer dirruns iff this is the outermost matcher + dirrunsUnique = ( dirruns += contextBackup == null ? 1 : Math.random() || 0.1 ), + len = elems.length; + + if ( outermost ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + outermostContext = context == document || context || outermost; + } + + // Add elements passing elementMatchers directly to results + // Support: IE<9, Safari + // Tolerate NodeList properties (IE: "length"; Safari: ) matching elements by id + for ( ; i !== len && ( elem = elems[ i ] ) != null; i++ ) { + if ( byElement && elem ) { + j = 0; + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( !context && elem.ownerDocument != document ) { + setDocument( elem ); + xml = !documentIsHTML; + } + while ( ( matcher = elementMatchers[ j++ ] ) ) { + if ( matcher( elem, context || document, xml ) ) { + results.push( elem ); + break; + } + } + if ( outermost ) { + dirruns = dirrunsUnique; + } + } + + // Track unmatched elements for set filters + if ( bySet ) { + + // They will have gone through all possible matchers + if ( ( elem = !matcher && elem ) ) { + matchedCount--; + } + + // Lengthen the array for every element, matched or not + if ( seed ) { + unmatched.push( elem ); + } + } + } + + // `i` is now the count of elements visited above, and adding it to `matchedCount` + // makes the latter nonnegative. + matchedCount += i; + + // Apply set filters to unmatched elements + // NOTE: This can be skipped if there are no unmatched elements (i.e., `matchedCount` + // equals `i`), unless we didn't visit _any_ elements in the above loop because we have + // no element matchers and no seed. + // Incrementing an initially-string "0" `i` allows `i` to remain a string only in that + // case, which will result in a "00" `matchedCount` that differs from `i` but is also + // numerically zero. + if ( bySet && i !== matchedCount ) { + j = 0; + while ( ( matcher = setMatchers[ j++ ] ) ) { + matcher( unmatched, setMatched, context, xml ); + } + + if ( seed ) { + + // Reintegrate element matches to eliminate the need for sorting + if ( matchedCount > 0 ) { + while ( i-- ) { + if ( !( unmatched[ i ] || setMatched[ i ] ) ) { + setMatched[ i ] = pop.call( results ); + } + } + } + + // Discard index placeholder values to get only actual matches + setMatched = condense( setMatched ); + } + + // Add matches to results + push.apply( results, setMatched ); + + // Seedless set matches succeeding multiple successful matchers stipulate sorting + if ( outermost && !seed && setMatched.length > 0 && + ( matchedCount + setMatchers.length ) > 1 ) { + + Sizzle.uniqueSort( results ); + } + } + + // Override manipulation of globals by nested matchers + if ( outermost ) { + dirruns = dirrunsUnique; + outermostContext = contextBackup; + } + + return unmatched; + }; + + return bySet ? + markFunction( superMatcher ) : + superMatcher; +} + +compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) { + var i, + setMatchers = [], + elementMatchers = [], + cached = compilerCache[ selector + " " ]; + + if ( !cached ) { + + // Generate a function of recursive functions that can be used to check each element + if ( !match ) { + match = tokenize( selector ); + } + i = match.length; + while ( i-- ) { + cached = matcherFromTokens( match[ i ] ); + if ( cached[ expando ] ) { + setMatchers.push( cached ); + } else { + elementMatchers.push( cached ); + } + } + + // Cache the compiled function + cached = compilerCache( + selector, + matcherFromGroupMatchers( elementMatchers, setMatchers ) + ); + + // Save selector and tokenization + cached.selector = selector; + } + return cached; +}; + +/** + * A low-level selection function that works with Sizzle's compiled + * selector functions + * @param {String|Function} selector A selector or a pre-compiled + * selector function built with Sizzle.compile + * @param {Element} context + * @param {Array} [results] + * @param {Array} [seed] A set of elements to match against + */ +select = Sizzle.select = function( selector, context, results, seed ) { + var i, tokens, token, type, find, + compiled = typeof selector === "function" && selector, + match = !seed && tokenize( ( selector = compiled.selector || selector ) ); + + results = results || []; + + // Try to minimize operations if there is only one selector in the list and no seed + // (the latter of which guarantees us context) + if ( match.length === 1 ) { + + // Reduce context if the leading compound selector is an ID + tokens = match[ 0 ] = match[ 0 ].slice( 0 ); + if ( tokens.length > 2 && ( token = tokens[ 0 ] ).type === "ID" && + context.nodeType === 9 && documentIsHTML && Expr.relative[ tokens[ 1 ].type ] ) { + + context = ( Expr.find[ "ID" ]( token.matches[ 0 ] + .replace( runescape, funescape ), context ) || [] )[ 0 ]; + if ( !context ) { + return results; + + // Precompiled matchers will still verify ancestry, so step up a level + } else if ( compiled ) { + context = context.parentNode; + } + + selector = selector.slice( tokens.shift().value.length ); + } + + // Fetch a seed set for right-to-left matching + i = matchExpr[ "needsContext" ].test( selector ) ? 0 : tokens.length; + while ( i-- ) { + token = tokens[ i ]; + + // Abort if we hit a combinator + if ( Expr.relative[ ( type = token.type ) ] ) { + break; + } + if ( ( find = Expr.find[ type ] ) ) { + + // Search, expanding context for leading sibling combinators + if ( ( seed = find( + token.matches[ 0 ].replace( runescape, funescape ), + rsibling.test( tokens[ 0 ].type ) && testContext( context.parentNode ) || + context + ) ) ) { + + // If seed is empty or no tokens remain, we can return early + tokens.splice( i, 1 ); + selector = seed.length && toSelector( tokens ); + if ( !selector ) { + push.apply( results, seed ); + return results; + } + + break; + } + } + } + } + + // Compile and execute a filtering function if one is not provided + // Provide `match` to avoid retokenization if we modified the selector above + ( compiled || compile( selector, match ) )( + seed, + context, + !documentIsHTML, + results, + !context || rsibling.test( selector ) && testContext( context.parentNode ) || context + ); + return results; +}; + +// One-time assignments + +// Sort stability +support.sortStable = expando.split( "" ).sort( sortOrder ).join( "" ) === expando; + +// Support: Chrome 14-35+ +// Always assume duplicates if they aren't passed to the comparison function +support.detectDuplicates = !!hasDuplicate; + +// Initialize against the default document +setDocument(); + +// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27) +// Detached nodes confoundingly follow *each other* +support.sortDetached = assert( function( el ) { + + // Should return 1, but returns 4 (following) + return el.compareDocumentPosition( document.createElement( "fieldset" ) ) & 1; +} ); + +// Support: IE<8 +// Prevent attribute/property "interpolation" +// https://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx +if ( !assert( function( el ) { + el.innerHTML = ""; + return el.firstChild.getAttribute( "href" ) === "#"; +} ) ) { + addHandle( "type|href|height|width", function( elem, name, isXML ) { + if ( !isXML ) { + return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 ); + } + } ); +} + +// Support: IE<9 +// Use defaultValue in place of getAttribute("value") +if ( !support.attributes || !assert( function( el ) { + el.innerHTML = ""; + el.firstChild.setAttribute( "value", "" ); + return el.firstChild.getAttribute( "value" ) === ""; +} ) ) { + addHandle( "value", function( elem, _name, isXML ) { + if ( !isXML && elem.nodeName.toLowerCase() === "input" ) { + return elem.defaultValue; + } + } ); +} + +// Support: IE<9 +// Use getAttributeNode to fetch booleans when getAttribute lies +if ( !assert( function( el ) { + return el.getAttribute( "disabled" ) == null; +} ) ) { + addHandle( booleans, function( elem, name, isXML ) { + var val; + if ( !isXML ) { + return elem[ name ] === true ? name.toLowerCase() : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; + } + } ); +} + +return Sizzle; + +} )( window ); + + + +jQuery.find = Sizzle; +jQuery.expr = Sizzle.selectors; + +// Deprecated +jQuery.expr[ ":" ] = jQuery.expr.pseudos; +jQuery.uniqueSort = jQuery.unique = Sizzle.uniqueSort; +jQuery.text = Sizzle.getText; +jQuery.isXMLDoc = Sizzle.isXML; +jQuery.contains = Sizzle.contains; +jQuery.escapeSelector = Sizzle.escape; + + + + +var dir = function( elem, dir, until ) { + var matched = [], + truncate = until !== undefined; + + while ( ( elem = elem[ dir ] ) && elem.nodeType !== 9 ) { + if ( elem.nodeType === 1 ) { + if ( truncate && jQuery( elem ).is( until ) ) { + break; + } + matched.push( elem ); + } + } + return matched; +}; + + +var siblings = function( n, elem ) { + var matched = []; + + for ( ; n; n = n.nextSibling ) { + if ( n.nodeType === 1 && n !== elem ) { + matched.push( n ); + } + } + + return matched; +}; + + +var rneedsContext = jQuery.expr.match.needsContext; + + + +function nodeName( elem, name ) { + + return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase(); + +}; +var rsingleTag = ( /^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i ); + + + +// Implement the identical functionality for filter and not +function winnow( elements, qualifier, not ) { + if ( isFunction( qualifier ) ) { + return jQuery.grep( elements, function( elem, i ) { + return !!qualifier.call( elem, i, elem ) !== not; + } ); + } + + // Single element + if ( qualifier.nodeType ) { + return jQuery.grep( elements, function( elem ) { + return ( elem === qualifier ) !== not; + } ); + } + + // Arraylike of elements (jQuery, arguments, Array) + if ( typeof qualifier !== "string" ) { + return jQuery.grep( elements, function( elem ) { + return ( indexOf.call( qualifier, elem ) > -1 ) !== not; + } ); + } + + // Filtered directly for both simple and complex selectors + return jQuery.filter( qualifier, elements, not ); +} + +jQuery.filter = function( expr, elems, not ) { + var elem = elems[ 0 ]; + + if ( not ) { + expr = ":not(" + expr + ")"; + } + + if ( elems.length === 1 && elem.nodeType === 1 ) { + return jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : []; + } + + return jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) { + return elem.nodeType === 1; + } ) ); +}; + +jQuery.fn.extend( { + find: function( selector ) { + var i, ret, + len = this.length, + self = this; + + if ( typeof selector !== "string" ) { + return this.pushStack( jQuery( selector ).filter( function() { + for ( i = 0; i < len; i++ ) { + if ( jQuery.contains( self[ i ], this ) ) { + return true; + } + } + } ) ); + } + + ret = this.pushStack( [] ); + + for ( i = 0; i < len; i++ ) { + jQuery.find( selector, self[ i ], ret ); + } + + return len > 1 ? jQuery.uniqueSort( ret ) : ret; + }, + filter: function( selector ) { + return this.pushStack( winnow( this, selector || [], false ) ); + }, + not: function( selector ) { + return this.pushStack( winnow( this, selector || [], true ) ); + }, + is: function( selector ) { + return !!winnow( + this, + + // If this is a positional/relative selector, check membership in the returned set + // so $("p:first").is("p:last") won't return true for a doc with two "p". + typeof selector === "string" && rneedsContext.test( selector ) ? + jQuery( selector ) : + selector || [], + false + ).length; + } +} ); + + +// Initialize a jQuery object + + +// A central reference to the root jQuery(document) +var rootjQuery, + + // A simple way to check for HTML strings + // Prioritize #id over to avoid XSS via location.hash (#9521) + // Strict HTML recognition (#11290: must start with <) + // Shortcut simple #id case for speed + rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/, + + init = jQuery.fn.init = function( selector, context, root ) { + var match, elem; + + // HANDLE: $(""), $(null), $(undefined), $(false) + if ( !selector ) { + return this; + } + + // Method init() accepts an alternate rootjQuery + // so migrate can support jQuery.sub (gh-2101) + root = root || rootjQuery; + + // Handle HTML strings + if ( typeof selector === "string" ) { + if ( selector[ 0 ] === "<" && + selector[ selector.length - 1 ] === ">" && + selector.length >= 3 ) { + + // Assume that strings that start and end with <> are HTML and skip the regex check + match = [ null, selector, null ]; + + } else { + match = rquickExpr.exec( selector ); + } + + // Match html or make sure no context is specified for #id + if ( match && ( match[ 1 ] || !context ) ) { + + // HANDLE: $(html) -> $(array) + if ( match[ 1 ] ) { + context = context instanceof jQuery ? context[ 0 ] : context; + + // Option to run scripts is true for back-compat + // Intentionally let the error be thrown if parseHTML is not present + jQuery.merge( this, jQuery.parseHTML( + match[ 1 ], + context && context.nodeType ? context.ownerDocument || context : document, + true + ) ); + + // HANDLE: $(html, props) + if ( rsingleTag.test( match[ 1 ] ) && jQuery.isPlainObject( context ) ) { + for ( match in context ) { + + // Properties of context are called as methods if possible + if ( isFunction( this[ match ] ) ) { + this[ match ]( context[ match ] ); + + // ...and otherwise set as attributes + } else { + this.attr( match, context[ match ] ); + } + } + } + + return this; + + // HANDLE: $(#id) + } else { + elem = document.getElementById( match[ 2 ] ); + + if ( elem ) { + + // Inject the element directly into the jQuery object + this[ 0 ] = elem; + this.length = 1; + } + return this; + } + + // HANDLE: $(expr, $(...)) + } else if ( !context || context.jquery ) { + return ( context || root ).find( selector ); + + // HANDLE: $(expr, context) + // (which is just equivalent to: $(context).find(expr) + } else { + return this.constructor( context ).find( selector ); + } + + // HANDLE: $(DOMElement) + } else if ( selector.nodeType ) { + this[ 0 ] = selector; + this.length = 1; + return this; + + // HANDLE: $(function) + // Shortcut for document ready + } else if ( isFunction( selector ) ) { + return root.ready !== undefined ? + root.ready( selector ) : + + // Execute immediately if ready is not present + selector( jQuery ); + } + + return jQuery.makeArray( selector, this ); + }; + +// Give the init function the jQuery prototype for later instantiation +init.prototype = jQuery.fn; + +// Initialize central reference +rootjQuery = jQuery( document ); + + +var rparentsprev = /^(?:parents|prev(?:Until|All))/, + + // Methods guaranteed to produce a unique set when starting from a unique set + guaranteedUnique = { + children: true, + contents: true, + next: true, + prev: true + }; + +jQuery.fn.extend( { + has: function( target ) { + var targets = jQuery( target, this ), + l = targets.length; + + return this.filter( function() { + var i = 0; + for ( ; i < l; i++ ) { + if ( jQuery.contains( this, targets[ i ] ) ) { + return true; + } + } + } ); + }, + + closest: function( selectors, context ) { + var cur, + i = 0, + l = this.length, + matched = [], + targets = typeof selectors !== "string" && jQuery( selectors ); + + // Positional selectors never match, since there's no _selection_ context + if ( !rneedsContext.test( selectors ) ) { + for ( ; i < l; i++ ) { + for ( cur = this[ i ]; cur && cur !== context; cur = cur.parentNode ) { + + // Always skip document fragments + if ( cur.nodeType < 11 && ( targets ? + targets.index( cur ) > -1 : + + // Don't pass non-elements to Sizzle + cur.nodeType === 1 && + jQuery.find.matchesSelector( cur, selectors ) ) ) { + + matched.push( cur ); + break; + } + } + } + } + + return this.pushStack( matched.length > 1 ? jQuery.uniqueSort( matched ) : matched ); + }, + + // Determine the position of an element within the set + index: function( elem ) { + + // No argument, return index in parent + if ( !elem ) { + return ( this[ 0 ] && this[ 0 ].parentNode ) ? this.first().prevAll().length : -1; + } + + // Index in selector + if ( typeof elem === "string" ) { + return indexOf.call( jQuery( elem ), this[ 0 ] ); + } + + // Locate the position of the desired element + return indexOf.call( this, + + // If it receives a jQuery object, the first element is used + elem.jquery ? elem[ 0 ] : elem + ); + }, + + add: function( selector, context ) { + return this.pushStack( + jQuery.uniqueSort( + jQuery.merge( this.get(), jQuery( selector, context ) ) + ) + ); + }, + + addBack: function( selector ) { + return this.add( selector == null ? + this.prevObject : this.prevObject.filter( selector ) + ); + } +} ); + +function sibling( cur, dir ) { + while ( ( cur = cur[ dir ] ) && cur.nodeType !== 1 ) {} + return cur; +} + +jQuery.each( { + parent: function( elem ) { + var parent = elem.parentNode; + return parent && parent.nodeType !== 11 ? parent : null; + }, + parents: function( elem ) { + return dir( elem, "parentNode" ); + }, + parentsUntil: function( elem, _i, until ) { + return dir( elem, "parentNode", until ); + }, + next: function( elem ) { + return sibling( elem, "nextSibling" ); + }, + prev: function( elem ) { + return sibling( elem, "previousSibling" ); + }, + nextAll: function( elem ) { + return dir( elem, "nextSibling" ); + }, + prevAll: function( elem ) { + return dir( elem, "previousSibling" ); + }, + nextUntil: function( elem, _i, until ) { + return dir( elem, "nextSibling", until ); + }, + prevUntil: function( elem, _i, until ) { + return dir( elem, "previousSibling", until ); + }, + siblings: function( elem ) { + return siblings( ( elem.parentNode || {} ).firstChild, elem ); + }, + children: function( elem ) { + return siblings( elem.firstChild ); + }, + contents: function( elem ) { + if ( elem.contentDocument != null && + + // Support: IE 11+ + // elements with no `data` attribute has an object + // `contentDocument` with a `null` prototype. + getProto( elem.contentDocument ) ) { + + return elem.contentDocument; + } + + // Support: IE 9 - 11 only, iOS 7 only, Android Browser <=4.3 only + // Treat the template element as a regular one in browsers that + // don't support it. + if ( nodeName( elem, "template" ) ) { + elem = elem.content || elem; + } + + return jQuery.merge( [], elem.childNodes ); + } +}, function( name, fn ) { + jQuery.fn[ name ] = function( until, selector ) { + var matched = jQuery.map( this, fn, until ); + + if ( name.slice( -5 ) !== "Until" ) { + selector = until; + } + + if ( selector && typeof selector === "string" ) { + matched = jQuery.filter( selector, matched ); + } + + if ( this.length > 1 ) { + + // Remove duplicates + if ( !guaranteedUnique[ name ] ) { + jQuery.uniqueSort( matched ); + } + + // Reverse order for parents* and prev-derivatives + if ( rparentsprev.test( name ) ) { + matched.reverse(); + } + } + + return this.pushStack( matched ); + }; +} ); +var rnothtmlwhite = ( /[^\x20\t\r\n\f]+/g ); + + + +// Convert String-formatted options into Object-formatted ones +function createOptions( options ) { + var object = {}; + jQuery.each( options.match( rnothtmlwhite ) || [], function( _, flag ) { + object[ flag ] = true; + } ); + return object; +} + +/* + * Create a callback list using the following parameters: + * + * options: an optional list of space-separated options that will change how + * the callback list behaves or a more traditional option object + * + * By default a callback list will act like an event callback list and can be + * "fired" multiple times. + * + * Possible options: + * + * once: will ensure the callback list can only be fired once (like a Deferred) + * + * memory: will keep track of previous values and will call any callback added + * after the list has been fired right away with the latest "memorized" + * values (like a Deferred) + * + * unique: will ensure a callback can only be added once (no duplicate in the list) + * + * stopOnFalse: interrupt callings when a callback returns false + * + */ +jQuery.Callbacks = function( options ) { + + // Convert options from String-formatted to Object-formatted if needed + // (we check in cache first) + options = typeof options === "string" ? + createOptions( options ) : + jQuery.extend( {}, options ); + + var // Flag to know if list is currently firing + firing, + + // Last fire value for non-forgettable lists + memory, + + // Flag to know if list was already fired + fired, + + // Flag to prevent firing + locked, + + // Actual callback list + list = [], + + // Queue of execution data for repeatable lists + queue = [], + + // Index of currently firing callback (modified by add/remove as needed) + firingIndex = -1, + + // Fire callbacks + fire = function() { + + // Enforce single-firing + locked = locked || options.once; + + // Execute callbacks for all pending executions, + // respecting firingIndex overrides and runtime changes + fired = firing = true; + for ( ; queue.length; firingIndex = -1 ) { + memory = queue.shift(); + while ( ++firingIndex < list.length ) { + + // Run callback and check for early termination + if ( list[ firingIndex ].apply( memory[ 0 ], memory[ 1 ] ) === false && + options.stopOnFalse ) { + + // Jump to end and forget the data so .add doesn't re-fire + firingIndex = list.length; + memory = false; + } + } + } + + // Forget the data if we're done with it + if ( !options.memory ) { + memory = false; + } + + firing = false; + + // Clean up if we're done firing for good + if ( locked ) { + + // Keep an empty list if we have data for future add calls + if ( memory ) { + list = []; + + // Otherwise, this object is spent + } else { + list = ""; + } + } + }, + + // Actual Callbacks object + self = { + + // Add a callback or a collection of callbacks to the list + add: function() { + if ( list ) { + + // If we have memory from a past run, we should fire after adding + if ( memory && !firing ) { + firingIndex = list.length - 1; + queue.push( memory ); + } + + ( function add( args ) { + jQuery.each( args, function( _, arg ) { + if ( isFunction( arg ) ) { + if ( !options.unique || !self.has( arg ) ) { + list.push( arg ); + } + } else if ( arg && arg.length && toType( arg ) !== "string" ) { + + // Inspect recursively + add( arg ); + } + } ); + } )( arguments ); + + if ( memory && !firing ) { + fire(); + } + } + return this; + }, + + // Remove a callback from the list + remove: function() { + jQuery.each( arguments, function( _, arg ) { + var index; + while ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) { + list.splice( index, 1 ); + + // Handle firing indexes + if ( index <= firingIndex ) { + firingIndex--; + } + } + } ); + return this; + }, + + // Check if a given callback is in the list. + // If no argument is given, return whether or not list has callbacks attached. + has: function( fn ) { + return fn ? + jQuery.inArray( fn, list ) > -1 : + list.length > 0; + }, + + // Remove all callbacks from the list + empty: function() { + if ( list ) { + list = []; + } + return this; + }, + + // Disable .fire and .add + // Abort any current/pending executions + // Clear all callbacks and values + disable: function() { + locked = queue = []; + list = memory = ""; + return this; + }, + disabled: function() { + return !list; + }, + + // Disable .fire + // Also disable .add unless we have memory (since it would have no effect) + // Abort any pending executions + lock: function() { + locked = queue = []; + if ( !memory && !firing ) { + list = memory = ""; + } + return this; + }, + locked: function() { + return !!locked; + }, + + // Call all callbacks with the given context and arguments + fireWith: function( context, args ) { + if ( !locked ) { + args = args || []; + args = [ context, args.slice ? args.slice() : args ]; + queue.push( args ); + if ( !firing ) { + fire(); + } + } + return this; + }, + + // Call all the callbacks with the given arguments + fire: function() { + self.fireWith( this, arguments ); + return this; + }, + + // To know if the callbacks have already been called at least once + fired: function() { + return !!fired; + } + }; + + return self; +}; + + +function Identity( v ) { + return v; +} +function Thrower( ex ) { + throw ex; +} + +function adoptValue( value, resolve, reject, noValue ) { + var method; + + try { + + // Check for promise aspect first to privilege synchronous behavior + if ( value && isFunction( ( method = value.promise ) ) ) { + method.call( value ).done( resolve ).fail( reject ); + + // Other thenables + } else if ( value && isFunction( ( method = value.then ) ) ) { + method.call( value, resolve, reject ); + + // Other non-thenables + } else { + + // Control `resolve` arguments by letting Array#slice cast boolean `noValue` to integer: + // * false: [ value ].slice( 0 ) => resolve( value ) + // * true: [ value ].slice( 1 ) => resolve() + resolve.apply( undefined, [ value ].slice( noValue ) ); + } + + // For Promises/A+, convert exceptions into rejections + // Since jQuery.when doesn't unwrap thenables, we can skip the extra checks appearing in + // Deferred#then to conditionally suppress rejection. + } catch ( value ) { + + // Support: Android 4.0 only + // Strict mode functions invoked without .call/.apply get global-object context + reject.apply( undefined, [ value ] ); + } +} + +jQuery.extend( { + + Deferred: function( func ) { + var tuples = [ + + // action, add listener, callbacks, + // ... .then handlers, argument index, [final state] + [ "notify", "progress", jQuery.Callbacks( "memory" ), + jQuery.Callbacks( "memory" ), 2 ], + [ "resolve", "done", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 0, "resolved" ], + [ "reject", "fail", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 1, "rejected" ] + ], + state = "pending", + promise = { + state: function() { + return state; + }, + always: function() { + deferred.done( arguments ).fail( arguments ); + return this; + }, + "catch": function( fn ) { + return promise.then( null, fn ); + }, + + // Keep pipe for back-compat + pipe: function( /* fnDone, fnFail, fnProgress */ ) { + var fns = arguments; + + return jQuery.Deferred( function( newDefer ) { + jQuery.each( tuples, function( _i, tuple ) { + + // Map tuples (progress, done, fail) to arguments (done, fail, progress) + var fn = isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ]; + + // deferred.progress(function() { bind to newDefer or newDefer.notify }) + // deferred.done(function() { bind to newDefer or newDefer.resolve }) + // deferred.fail(function() { bind to newDefer or newDefer.reject }) + deferred[ tuple[ 1 ] ]( function() { + var returned = fn && fn.apply( this, arguments ); + if ( returned && isFunction( returned.promise ) ) { + returned.promise() + .progress( newDefer.notify ) + .done( newDefer.resolve ) + .fail( newDefer.reject ); + } else { + newDefer[ tuple[ 0 ] + "With" ]( + this, + fn ? [ returned ] : arguments + ); + } + } ); + } ); + fns = null; + } ).promise(); + }, + then: function( onFulfilled, onRejected, onProgress ) { + var maxDepth = 0; + function resolve( depth, deferred, handler, special ) { + return function() { + var that = this, + args = arguments, + mightThrow = function() { + var returned, then; + + // Support: Promises/A+ section 2.3.3.3.3 + // https://promisesaplus.com/#point-59 + // Ignore double-resolution attempts + if ( depth < maxDepth ) { + return; + } + + returned = handler.apply( that, args ); + + // Support: Promises/A+ section 2.3.1 + // https://promisesaplus.com/#point-48 + if ( returned === deferred.promise() ) { + throw new TypeError( "Thenable self-resolution" ); + } + + // Support: Promises/A+ sections 2.3.3.1, 3.5 + // https://promisesaplus.com/#point-54 + // https://promisesaplus.com/#point-75 + // Retrieve `then` only once + then = returned && + + // Support: Promises/A+ section 2.3.4 + // https://promisesaplus.com/#point-64 + // Only check objects and functions for thenability + ( typeof returned === "object" || + typeof returned === "function" ) && + returned.then; + + // Handle a returned thenable + if ( isFunction( then ) ) { + + // Special processors (notify) just wait for resolution + if ( special ) { + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ) + ); + + // Normal processors (resolve) also hook into progress + } else { + + // ...and disregard older resolution values + maxDepth++; + + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ), + resolve( maxDepth, deferred, Identity, + deferred.notifyWith ) + ); + } + + // Handle all other returned values + } else { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Identity ) { + that = undefined; + args = [ returned ]; + } + + // Process the value(s) + // Default process is resolve + ( special || deferred.resolveWith )( that, args ); + } + }, + + // Only normal processors (resolve) catch and reject exceptions + process = special ? + mightThrow : + function() { + try { + mightThrow(); + } catch ( e ) { + + if ( jQuery.Deferred.exceptionHook ) { + jQuery.Deferred.exceptionHook( e, + process.stackTrace ); + } + + // Support: Promises/A+ section 2.3.3.3.4.1 + // https://promisesaplus.com/#point-61 + // Ignore post-resolution exceptions + if ( depth + 1 >= maxDepth ) { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Thrower ) { + that = undefined; + args = [ e ]; + } + + deferred.rejectWith( that, args ); + } + } + }; + + // Support: Promises/A+ section 2.3.3.3.1 + // https://promisesaplus.com/#point-57 + // Re-resolve promises immediately to dodge false rejection from + // subsequent errors + if ( depth ) { + process(); + } else { + + // Call an optional hook to record the stack, in case of exception + // since it's otherwise lost when execution goes async + if ( jQuery.Deferred.getStackHook ) { + process.stackTrace = jQuery.Deferred.getStackHook(); + } + window.setTimeout( process ); + } + }; + } + + return jQuery.Deferred( function( newDefer ) { + + // progress_handlers.add( ... ) + tuples[ 0 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onProgress ) ? + onProgress : + Identity, + newDefer.notifyWith + ) + ); + + // fulfilled_handlers.add( ... ) + tuples[ 1 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onFulfilled ) ? + onFulfilled : + Identity + ) + ); + + // rejected_handlers.add( ... ) + tuples[ 2 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onRejected ) ? + onRejected : + Thrower + ) + ); + } ).promise(); + }, + + // Get a promise for this deferred + // If obj is provided, the promise aspect is added to the object + promise: function( obj ) { + return obj != null ? jQuery.extend( obj, promise ) : promise; + } + }, + deferred = {}; + + // Add list-specific methods + jQuery.each( tuples, function( i, tuple ) { + var list = tuple[ 2 ], + stateString = tuple[ 5 ]; + + // promise.progress = list.add + // promise.done = list.add + // promise.fail = list.add + promise[ tuple[ 1 ] ] = list.add; + + // Handle state + if ( stateString ) { + list.add( + function() { + + // state = "resolved" (i.e., fulfilled) + // state = "rejected" + state = stateString; + }, + + // rejected_callbacks.disable + // fulfilled_callbacks.disable + tuples[ 3 - i ][ 2 ].disable, + + // rejected_handlers.disable + // fulfilled_handlers.disable + tuples[ 3 - i ][ 3 ].disable, + + // progress_callbacks.lock + tuples[ 0 ][ 2 ].lock, + + // progress_handlers.lock + tuples[ 0 ][ 3 ].lock + ); + } + + // progress_handlers.fire + // fulfilled_handlers.fire + // rejected_handlers.fire + list.add( tuple[ 3 ].fire ); + + // deferred.notify = function() { deferred.notifyWith(...) } + // deferred.resolve = function() { deferred.resolveWith(...) } + // deferred.reject = function() { deferred.rejectWith(...) } + deferred[ tuple[ 0 ] ] = function() { + deferred[ tuple[ 0 ] + "With" ]( this === deferred ? undefined : this, arguments ); + return this; + }; + + // deferred.notifyWith = list.fireWith + // deferred.resolveWith = list.fireWith + // deferred.rejectWith = list.fireWith + deferred[ tuple[ 0 ] + "With" ] = list.fireWith; + } ); + + // Make the deferred a promise + promise.promise( deferred ); + + // Call given func if any + if ( func ) { + func.call( deferred, deferred ); + } + + // All done! + return deferred; + }, + + // Deferred helper + when: function( singleValue ) { + var + + // count of uncompleted subordinates + remaining = arguments.length, + + // count of unprocessed arguments + i = remaining, + + // subordinate fulfillment data + resolveContexts = Array( i ), + resolveValues = slice.call( arguments ), + + // the master Deferred + master = jQuery.Deferred(), + + // subordinate callback factory + updateFunc = function( i ) { + return function( value ) { + resolveContexts[ i ] = this; + resolveValues[ i ] = arguments.length > 1 ? slice.call( arguments ) : value; + if ( !( --remaining ) ) { + master.resolveWith( resolveContexts, resolveValues ); + } + }; + }; + + // Single- and empty arguments are adopted like Promise.resolve + if ( remaining <= 1 ) { + adoptValue( singleValue, master.done( updateFunc( i ) ).resolve, master.reject, + !remaining ); + + // Use .then() to unwrap secondary thenables (cf. gh-3000) + if ( master.state() === "pending" || + isFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) { + + return master.then(); + } + } + + // Multiple arguments are aggregated like Promise.all array elements + while ( i-- ) { + adoptValue( resolveValues[ i ], updateFunc( i ), master.reject ); + } + + return master.promise(); + } +} ); + + +// These usually indicate a programmer mistake during development, +// warn about them ASAP rather than swallowing them by default. +var rerrorNames = /^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/; + +jQuery.Deferred.exceptionHook = function( error, stack ) { + + // Support: IE 8 - 9 only + // Console exists when dev tools are open, which can happen at any time + if ( window.console && window.console.warn && error && rerrorNames.test( error.name ) ) { + window.console.warn( "jQuery.Deferred exception: " + error.message, error.stack, stack ); + } +}; + + + + +jQuery.readyException = function( error ) { + window.setTimeout( function() { + throw error; + } ); +}; + + + + +// The deferred used on DOM ready +var readyList = jQuery.Deferred(); + +jQuery.fn.ready = function( fn ) { + + readyList + .then( fn ) + + // Wrap jQuery.readyException in a function so that the lookup + // happens at the time of error handling instead of callback + // registration. + .catch( function( error ) { + jQuery.readyException( error ); + } ); + + return this; +}; + +jQuery.extend( { + + // Is the DOM ready to be used? Set to true once it occurs. + isReady: false, + + // A counter to track how many items to wait for before + // the ready event fires. See #6781 + readyWait: 1, + + // Handle when the DOM is ready + ready: function( wait ) { + + // Abort if there are pending holds or we're already ready + if ( wait === true ? --jQuery.readyWait : jQuery.isReady ) { + return; + } + + // Remember that the DOM is ready + jQuery.isReady = true; + + // If a normal DOM Ready event fired, decrement, and wait if need be + if ( wait !== true && --jQuery.readyWait > 0 ) { + return; + } + + // If there are functions bound, to execute + readyList.resolveWith( document, [ jQuery ] ); + } +} ); + +jQuery.ready.then = readyList.then; + +// The ready event handler and self cleanup method +function completed() { + document.removeEventListener( "DOMContentLoaded", completed ); + window.removeEventListener( "load", completed ); + jQuery.ready(); +} + +// Catch cases where $(document).ready() is called +// after the browser event has already occurred. +// Support: IE <=9 - 10 only +// Older IE sometimes signals "interactive" too soon +if ( document.readyState === "complete" || + ( document.readyState !== "loading" && !document.documentElement.doScroll ) ) { + + // Handle it asynchronously to allow scripts the opportunity to delay ready + window.setTimeout( jQuery.ready ); + +} else { + + // Use the handy event callback + document.addEventListener( "DOMContentLoaded", completed ); + + // A fallback to window.onload, that will always work + window.addEventListener( "load", completed ); +} + + + + +// Multifunctional method to get and set values of a collection +// The value/s can optionally be executed if it's a function +var access = function( elems, fn, key, value, chainable, emptyGet, raw ) { + var i = 0, + len = elems.length, + bulk = key == null; + + // Sets many values + if ( toType( key ) === "object" ) { + chainable = true; + for ( i in key ) { + access( elems, fn, i, key[ i ], true, emptyGet, raw ); + } + + // Sets one value + } else if ( value !== undefined ) { + chainable = true; + + if ( !isFunction( value ) ) { + raw = true; + } + + if ( bulk ) { + + // Bulk operations run against the entire set + if ( raw ) { + fn.call( elems, value ); + fn = null; + + // ...except when executing function values + } else { + bulk = fn; + fn = function( elem, _key, value ) { + return bulk.call( jQuery( elem ), value ); + }; + } + } + + if ( fn ) { + for ( ; i < len; i++ ) { + fn( + elems[ i ], key, raw ? + value : + value.call( elems[ i ], i, fn( elems[ i ], key ) ) + ); + } + } + } + + if ( chainable ) { + return elems; + } + + // Gets + if ( bulk ) { + return fn.call( elems ); + } + + return len ? fn( elems[ 0 ], key ) : emptyGet; +}; + + +// Matches dashed string for camelizing +var rmsPrefix = /^-ms-/, + rdashAlpha = /-([a-z])/g; + +// Used by camelCase as callback to replace() +function fcamelCase( _all, letter ) { + return letter.toUpperCase(); +} + +// Convert dashed to camelCase; used by the css and data modules +// Support: IE <=9 - 11, Edge 12 - 15 +// Microsoft forgot to hump their vendor prefix (#9572) +function camelCase( string ) { + return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); +} +var acceptData = function( owner ) { + + // Accepts only: + // - Node + // - Node.ELEMENT_NODE + // - Node.DOCUMENT_NODE + // - Object + // - Any + return owner.nodeType === 1 || owner.nodeType === 9 || !( +owner.nodeType ); +}; + + + + +function Data() { + this.expando = jQuery.expando + Data.uid++; +} + +Data.uid = 1; + +Data.prototype = { + + cache: function( owner ) { + + // Check if the owner object already has a cache + var value = owner[ this.expando ]; + + // If not, create one + if ( !value ) { + value = {}; + + // We can accept data for non-element nodes in modern browsers, + // but we should not, see #8335. + // Always return an empty object. + if ( acceptData( owner ) ) { + + // If it is a node unlikely to be stringify-ed or looped over + // use plain assignment + if ( owner.nodeType ) { + owner[ this.expando ] = value; + + // Otherwise secure it in a non-enumerable property + // configurable must be true to allow the property to be + // deleted when data is removed + } else { + Object.defineProperty( owner, this.expando, { + value: value, + configurable: true + } ); + } + } + } + + return value; + }, + set: function( owner, data, value ) { + var prop, + cache = this.cache( owner ); + + // Handle: [ owner, key, value ] args + // Always use camelCase key (gh-2257) + if ( typeof data === "string" ) { + cache[ camelCase( data ) ] = value; + + // Handle: [ owner, { properties } ] args + } else { + + // Copy the properties one-by-one to the cache object + for ( prop in data ) { + cache[ camelCase( prop ) ] = data[ prop ]; + } + } + return cache; + }, + get: function( owner, key ) { + return key === undefined ? + this.cache( owner ) : + + // Always use camelCase key (gh-2257) + owner[ this.expando ] && owner[ this.expando ][ camelCase( key ) ]; + }, + access: function( owner, key, value ) { + + // In cases where either: + // + // 1. No key was specified + // 2. A string key was specified, but no value provided + // + // Take the "read" path and allow the get method to determine + // which value to return, respectively either: + // + // 1. The entire cache object + // 2. The data stored at the key + // + if ( key === undefined || + ( ( key && typeof key === "string" ) && value === undefined ) ) { + + return this.get( owner, key ); + } + + // When the key is not a string, or both a key and value + // are specified, set or extend (existing objects) with either: + // + // 1. An object of properties + // 2. A key and value + // + this.set( owner, key, value ); + + // Since the "set" path can have two possible entry points + // return the expected data based on which path was taken[*] + return value !== undefined ? value : key; + }, + remove: function( owner, key ) { + var i, + cache = owner[ this.expando ]; + + if ( cache === undefined ) { + return; + } + + if ( key !== undefined ) { + + // Support array or space separated string of keys + if ( Array.isArray( key ) ) { + + // If key is an array of keys... + // We always set camelCase keys, so remove that. + key = key.map( camelCase ); + } else { + key = camelCase( key ); + + // If a key with the spaces exists, use it. + // Otherwise, create an array by matching non-whitespace + key = key in cache ? + [ key ] : + ( key.match( rnothtmlwhite ) || [] ); + } + + i = key.length; + + while ( i-- ) { + delete cache[ key[ i ] ]; + } + } + + // Remove the expando if there's no more data + if ( key === undefined || jQuery.isEmptyObject( cache ) ) { + + // Support: Chrome <=35 - 45 + // Webkit & Blink performance suffers when deleting properties + // from DOM nodes, so set to undefined instead + // https://bugs.chromium.org/p/chromium/issues/detail?id=378607 (bug restricted) + if ( owner.nodeType ) { + owner[ this.expando ] = undefined; + } else { + delete owner[ this.expando ]; + } + } + }, + hasData: function( owner ) { + var cache = owner[ this.expando ]; + return cache !== undefined && !jQuery.isEmptyObject( cache ); + } +}; +var dataPriv = new Data(); + +var dataUser = new Data(); + + + +// Implementation Summary +// +// 1. Enforce API surface and semantic compatibility with 1.9.x branch +// 2. Improve the module's maintainability by reducing the storage +// paths to a single mechanism. +// 3. Use the same single mechanism to support "private" and "user" data. +// 4. _Never_ expose "private" data to user code (TODO: Drop _data, _removeData) +// 5. Avoid exposing implementation details on user objects (eg. expando properties) +// 6. Provide a clear path for implementation upgrade to WeakMap in 2014 + +var rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/, + rmultiDash = /[A-Z]/g; + +function getData( data ) { + if ( data === "true" ) { + return true; + } + + if ( data === "false" ) { + return false; + } + + if ( data === "null" ) { + return null; + } + + // Only convert to a number if it doesn't change the string + if ( data === +data + "" ) { + return +data; + } + + if ( rbrace.test( data ) ) { + return JSON.parse( data ); + } + + return data; +} + +function dataAttr( elem, key, data ) { + var name; + + // If nothing was found internally, try to fetch any + // data from the HTML5 data-* attribute + if ( data === undefined && elem.nodeType === 1 ) { + name = "data-" + key.replace( rmultiDash, "-$&" ).toLowerCase(); + data = elem.getAttribute( name ); + + if ( typeof data === "string" ) { + try { + data = getData( data ); + } catch ( e ) {} + + // Make sure we set the data so it isn't changed later + dataUser.set( elem, key, data ); + } else { + data = undefined; + } + } + return data; +} + +jQuery.extend( { + hasData: function( elem ) { + return dataUser.hasData( elem ) || dataPriv.hasData( elem ); + }, + + data: function( elem, name, data ) { + return dataUser.access( elem, name, data ); + }, + + removeData: function( elem, name ) { + dataUser.remove( elem, name ); + }, + + // TODO: Now that all calls to _data and _removeData have been replaced + // with direct calls to dataPriv methods, these can be deprecated. + _data: function( elem, name, data ) { + return dataPriv.access( elem, name, data ); + }, + + _removeData: function( elem, name ) { + dataPriv.remove( elem, name ); + } +} ); + +jQuery.fn.extend( { + data: function( key, value ) { + var i, name, data, + elem = this[ 0 ], + attrs = elem && elem.attributes; + + // Gets all values + if ( key === undefined ) { + if ( this.length ) { + data = dataUser.get( elem ); + + if ( elem.nodeType === 1 && !dataPriv.get( elem, "hasDataAttrs" ) ) { + i = attrs.length; + while ( i-- ) { + + // Support: IE 11 only + // The attrs elements can be null (#14894) + if ( attrs[ i ] ) { + name = attrs[ i ].name; + if ( name.indexOf( "data-" ) === 0 ) { + name = camelCase( name.slice( 5 ) ); + dataAttr( elem, name, data[ name ] ); + } + } + } + dataPriv.set( elem, "hasDataAttrs", true ); + } + } + + return data; + } + + // Sets multiple values + if ( typeof key === "object" ) { + return this.each( function() { + dataUser.set( this, key ); + } ); + } + + return access( this, function( value ) { + var data; + + // The calling jQuery object (element matches) is not empty + // (and therefore has an element appears at this[ 0 ]) and the + // `value` parameter was not undefined. An empty jQuery object + // will result in `undefined` for elem = this[ 0 ] which will + // throw an exception if an attempt to read a data cache is made. + if ( elem && value === undefined ) { + + // Attempt to get data from the cache + // The key will always be camelCased in Data + data = dataUser.get( elem, key ); + if ( data !== undefined ) { + return data; + } + + // Attempt to "discover" the data in + // HTML5 custom data-* attrs + data = dataAttr( elem, key ); + if ( data !== undefined ) { + return data; + } + + // We tried really hard, but the data doesn't exist. + return; + } + + // Set the data... + this.each( function() { + + // We always store the camelCased key + dataUser.set( this, key, value ); + } ); + }, null, value, arguments.length > 1, null, true ); + }, + + removeData: function( key ) { + return this.each( function() { + dataUser.remove( this, key ); + } ); + } +} ); + + +jQuery.extend( { + queue: function( elem, type, data ) { + var queue; + + if ( elem ) { + type = ( type || "fx" ) + "queue"; + queue = dataPriv.get( elem, type ); + + // Speed up dequeue by getting out quickly if this is just a lookup + if ( data ) { + if ( !queue || Array.isArray( data ) ) { + queue = dataPriv.access( elem, type, jQuery.makeArray( data ) ); + } else { + queue.push( data ); + } + } + return queue || []; + } + }, + + dequeue: function( elem, type ) { + type = type || "fx"; + + var queue = jQuery.queue( elem, type ), + startLength = queue.length, + fn = queue.shift(), + hooks = jQuery._queueHooks( elem, type ), + next = function() { + jQuery.dequeue( elem, type ); + }; + + // If the fx queue is dequeued, always remove the progress sentinel + if ( fn === "inprogress" ) { + fn = queue.shift(); + startLength--; + } + + if ( fn ) { + + // Add a progress sentinel to prevent the fx queue from being + // automatically dequeued + if ( type === "fx" ) { + queue.unshift( "inprogress" ); + } + + // Clear up the last queue stop function + delete hooks.stop; + fn.call( elem, next, hooks ); + } + + if ( !startLength && hooks ) { + hooks.empty.fire(); + } + }, + + // Not public - generate a queueHooks object, or return the current one + _queueHooks: function( elem, type ) { + var key = type + "queueHooks"; + return dataPriv.get( elem, key ) || dataPriv.access( elem, key, { + empty: jQuery.Callbacks( "once memory" ).add( function() { + dataPriv.remove( elem, [ type + "queue", key ] ); + } ) + } ); + } +} ); + +jQuery.fn.extend( { + queue: function( type, data ) { + var setter = 2; + + if ( typeof type !== "string" ) { + data = type; + type = "fx"; + setter--; + } + + if ( arguments.length < setter ) { + return jQuery.queue( this[ 0 ], type ); + } + + return data === undefined ? + this : + this.each( function() { + var queue = jQuery.queue( this, type, data ); + + // Ensure a hooks for this queue + jQuery._queueHooks( this, type ); + + if ( type === "fx" && queue[ 0 ] !== "inprogress" ) { + jQuery.dequeue( this, type ); + } + } ); + }, + dequeue: function( type ) { + return this.each( function() { + jQuery.dequeue( this, type ); + } ); + }, + clearQueue: function( type ) { + return this.queue( type || "fx", [] ); + }, + + // Get a promise resolved when queues of a certain type + // are emptied (fx is the type by default) + promise: function( type, obj ) { + var tmp, + count = 1, + defer = jQuery.Deferred(), + elements = this, + i = this.length, + resolve = function() { + if ( !( --count ) ) { + defer.resolveWith( elements, [ elements ] ); + } + }; + + if ( typeof type !== "string" ) { + obj = type; + type = undefined; + } + type = type || "fx"; + + while ( i-- ) { + tmp = dataPriv.get( elements[ i ], type + "queueHooks" ); + if ( tmp && tmp.empty ) { + count++; + tmp.empty.add( resolve ); + } + } + resolve(); + return defer.promise( obj ); + } +} ); +var pnum = ( /[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/ ).source; + +var rcssNum = new RegExp( "^(?:([+-])=|)(" + pnum + ")([a-z%]*)$", "i" ); + + +var cssExpand = [ "Top", "Right", "Bottom", "Left" ]; + +var documentElement = document.documentElement; + + + + var isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ); + }, + composed = { composed: true }; + + // Support: IE 9 - 11+, Edge 12 - 18+, iOS 10.0 - 10.2 only + // Check attachment across shadow DOM boundaries when possible (gh-3504) + // Support: iOS 10.0-10.2 only + // Early iOS 10 versions support `attachShadow` but not `getRootNode`, + // leading to errors. We need to check for `getRootNode`. + if ( documentElement.getRootNode ) { + isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ) || + elem.getRootNode( composed ) === elem.ownerDocument; + }; + } +var isHiddenWithinTree = function( elem, el ) { + + // isHiddenWithinTree might be called from jQuery#filter function; + // in that case, element will be second argument + elem = el || elem; + + // Inline style trumps all + return elem.style.display === "none" || + elem.style.display === "" && + + // Otherwise, check computed style + // Support: Firefox <=43 - 45 + // Disconnected elements can have computed display: none, so first confirm that elem is + // in the document. + isAttached( elem ) && + + jQuery.css( elem, "display" ) === "none"; + }; + + + +function adjustCSS( elem, prop, valueParts, tween ) { + var adjusted, scale, + maxIterations = 20, + currentValue = tween ? + function() { + return tween.cur(); + } : + function() { + return jQuery.css( elem, prop, "" ); + }, + initial = currentValue(), + unit = valueParts && valueParts[ 3 ] || ( jQuery.cssNumber[ prop ] ? "" : "px" ), + + // Starting value computation is required for potential unit mismatches + initialInUnit = elem.nodeType && + ( jQuery.cssNumber[ prop ] || unit !== "px" && +initial ) && + rcssNum.exec( jQuery.css( elem, prop ) ); + + if ( initialInUnit && initialInUnit[ 3 ] !== unit ) { + + // Support: Firefox <=54 + // Halve the iteration target value to prevent interference from CSS upper bounds (gh-2144) + initial = initial / 2; + + // Trust units reported by jQuery.css + unit = unit || initialInUnit[ 3 ]; + + // Iteratively approximate from a nonzero starting point + initialInUnit = +initial || 1; + + while ( maxIterations-- ) { + + // Evaluate and update our best guess (doubling guesses that zero out). + // Finish if the scale equals or crosses 1 (making the old*new product non-positive). + jQuery.style( elem, prop, initialInUnit + unit ); + if ( ( 1 - scale ) * ( 1 - ( scale = currentValue() / initial || 0.5 ) ) <= 0 ) { + maxIterations = 0; + } + initialInUnit = initialInUnit / scale; + + } + + initialInUnit = initialInUnit * 2; + jQuery.style( elem, prop, initialInUnit + unit ); + + // Make sure we update the tween properties later on + valueParts = valueParts || []; + } + + if ( valueParts ) { + initialInUnit = +initialInUnit || +initial || 0; + + // Apply relative offset (+=/-=) if specified + adjusted = valueParts[ 1 ] ? + initialInUnit + ( valueParts[ 1 ] + 1 ) * valueParts[ 2 ] : + +valueParts[ 2 ]; + if ( tween ) { + tween.unit = unit; + tween.start = initialInUnit; + tween.end = adjusted; + } + } + return adjusted; +} + + +var defaultDisplayMap = {}; + +function getDefaultDisplay( elem ) { + var temp, + doc = elem.ownerDocument, + nodeName = elem.nodeName, + display = defaultDisplayMap[ nodeName ]; + + if ( display ) { + return display; + } + + temp = doc.body.appendChild( doc.createElement( nodeName ) ); + display = jQuery.css( temp, "display" ); + + temp.parentNode.removeChild( temp ); + + if ( display === "none" ) { + display = "block"; + } + defaultDisplayMap[ nodeName ] = display; + + return display; +} + +function showHide( elements, show ) { + var display, elem, + values = [], + index = 0, + length = elements.length; + + // Determine new display value for elements that need to change + for ( ; index < length; index++ ) { + elem = elements[ index ]; + if ( !elem.style ) { + continue; + } + + display = elem.style.display; + if ( show ) { + + // Since we force visibility upon cascade-hidden elements, an immediate (and slow) + // check is required in this first loop unless we have a nonempty display value (either + // inline or about-to-be-restored) + if ( display === "none" ) { + values[ index ] = dataPriv.get( elem, "display" ) || null; + if ( !values[ index ] ) { + elem.style.display = ""; + } + } + if ( elem.style.display === "" && isHiddenWithinTree( elem ) ) { + values[ index ] = getDefaultDisplay( elem ); + } + } else { + if ( display !== "none" ) { + values[ index ] = "none"; + + // Remember what we're overwriting + dataPriv.set( elem, "display", display ); + } + } + } + + // Set the display of the elements in a second loop to avoid constant reflow + for ( index = 0; index < length; index++ ) { + if ( values[ index ] != null ) { + elements[ index ].style.display = values[ index ]; + } + } + + return elements; +} + +jQuery.fn.extend( { + show: function() { + return showHide( this, true ); + }, + hide: function() { + return showHide( this ); + }, + toggle: function( state ) { + if ( typeof state === "boolean" ) { + return state ? this.show() : this.hide(); + } + + return this.each( function() { + if ( isHiddenWithinTree( this ) ) { + jQuery( this ).show(); + } else { + jQuery( this ).hide(); + } + } ); + } +} ); +var rcheckableType = ( /^(?:checkbox|radio)$/i ); + +var rtagName = ( /<([a-z][^\/\0>\x20\t\r\n\f]*)/i ); + +var rscriptType = ( /^$|^module$|\/(?:java|ecma)script/i ); + + + +( function() { + var fragment = document.createDocumentFragment(), + div = fragment.appendChild( document.createElement( "div" ) ), + input = document.createElement( "input" ); + + // Support: Android 4.0 - 4.3 only + // Check state lost if the name is set (#11217) + // Support: Windows Web Apps (WWA) + // `name` and `type` must use .setAttribute for WWA (#14901) + input.setAttribute( "type", "radio" ); + input.setAttribute( "checked", "checked" ); + input.setAttribute( "name", "t" ); + + div.appendChild( input ); + + // Support: Android <=4.1 only + // Older WebKit doesn't clone checked state correctly in fragments + support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked; + + // Support: IE <=11 only + // Make sure textarea (and checkbox) defaultValue is properly cloned + div.innerHTML = ""; + support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue; + + // Support: IE <=9 only + // IE <=9 replaces "; + support.option = !!div.lastChild; +} )(); + + +// We have to close these tags to support XHTML (#13200) +var wrapMap = { + + // XHTML parsers do not magically insert elements in the + // same way that tag soup parsers do. So we cannot shorten + // this by omitting or other required elements. + thead: [ 1, "", "
" ], + col: [ 2, "", "
" ], + tr: [ 2, "", "
" ], + td: [ 3, "", "
" ], + + _default: [ 0, "", "" ] +}; + +wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; +wrapMap.th = wrapMap.td; + +// Support: IE <=9 only +if ( !support.option ) { + wrapMap.optgroup = wrapMap.option = [ 1, "" ]; +} + + +function getAll( context, tag ) { + + // Support: IE <=9 - 11 only + // Use typeof to avoid zero-argument method invocation on host objects (#15151) + var ret; + + if ( typeof context.getElementsByTagName !== "undefined" ) { + ret = context.getElementsByTagName( tag || "*" ); + + } else if ( typeof context.querySelectorAll !== "undefined" ) { + ret = context.querySelectorAll( tag || "*" ); + + } else { + ret = []; + } + + if ( tag === undefined || tag && nodeName( context, tag ) ) { + return jQuery.merge( [ context ], ret ); + } + + return ret; +} + + +// Mark scripts as having already been evaluated +function setGlobalEval( elems, refElements ) { + var i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + dataPriv.set( + elems[ i ], + "globalEval", + !refElements || dataPriv.get( refElements[ i ], "globalEval" ) + ); + } +} + + +var rhtml = /<|&#?\w+;/; + +function buildFragment( elems, context, scripts, selection, ignored ) { + var elem, tmp, tag, wrap, attached, j, + fragment = context.createDocumentFragment(), + nodes = [], + i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + elem = elems[ i ]; + + if ( elem || elem === 0 ) { + + // Add nodes directly + if ( toType( elem ) === "object" ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem ); + + // Convert non-html into a text node + } else if ( !rhtml.test( elem ) ) { + nodes.push( context.createTextNode( elem ) ); + + // Convert html into DOM nodes + } else { + tmp = tmp || fragment.appendChild( context.createElement( "div" ) ); + + // Deserialize a standard representation + tag = ( rtagName.exec( elem ) || [ "", "" ] )[ 1 ].toLowerCase(); + wrap = wrapMap[ tag ] || wrapMap._default; + tmp.innerHTML = wrap[ 1 ] + jQuery.htmlPrefilter( elem ) + wrap[ 2 ]; + + // Descend through wrappers to the right content + j = wrap[ 0 ]; + while ( j-- ) { + tmp = tmp.lastChild; + } + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, tmp.childNodes ); + + // Remember the top-level container + tmp = fragment.firstChild; + + // Ensure the created nodes are orphaned (#12392) + tmp.textContent = ""; + } + } + } + + // Remove wrapper from fragment + fragment.textContent = ""; + + i = 0; + while ( ( elem = nodes[ i++ ] ) ) { + + // Skip elements already in the context collection (trac-4087) + if ( selection && jQuery.inArray( elem, selection ) > -1 ) { + if ( ignored ) { + ignored.push( elem ); + } + continue; + } + + attached = isAttached( elem ); + + // Append to fragment + tmp = getAll( fragment.appendChild( elem ), "script" ); + + // Preserve script evaluation history + if ( attached ) { + setGlobalEval( tmp ); + } + + // Capture executables + if ( scripts ) { + j = 0; + while ( ( elem = tmp[ j++ ] ) ) { + if ( rscriptType.test( elem.type || "" ) ) { + scripts.push( elem ); + } + } + } + } + + return fragment; +} + + +var + rkeyEvent = /^key/, + rmouseEvent = /^(?:mouse|pointer|contextmenu|drag|drop)|click/, + rtypenamespace = /^([^.]*)(?:\.(.+)|)/; + +function returnTrue() { + return true; +} + +function returnFalse() { + return false; +} + +// Support: IE <=9 - 11+ +// focus() and blur() are asynchronous, except when they are no-op. +// So expect focus to be synchronous when the element is already active, +// and blur to be synchronous when the element is not already active. +// (focus and blur are always synchronous in other supported browsers, +// this just defines when we can count on it). +function expectSync( elem, type ) { + return ( elem === safeActiveElement() ) === ( type === "focus" ); +} + +// Support: IE <=9 only +// Accessing document.activeElement can throw unexpectedly +// https://bugs.jquery.com/ticket/13393 +function safeActiveElement() { + try { + return document.activeElement; + } catch ( err ) { } +} + +function on( elem, types, selector, data, fn, one ) { + var origFn, type; + + // Types can be a map of types/handlers + if ( typeof types === "object" ) { + + // ( types-Object, selector, data ) + if ( typeof selector !== "string" ) { + + // ( types-Object, data ) + data = data || selector; + selector = undefined; + } + for ( type in types ) { + on( elem, type, selector, data, types[ type ], one ); + } + return elem; + } + + if ( data == null && fn == null ) { + + // ( types, fn ) + fn = selector; + data = selector = undefined; + } else if ( fn == null ) { + if ( typeof selector === "string" ) { + + // ( types, selector, fn ) + fn = data; + data = undefined; + } else { + + // ( types, data, fn ) + fn = data; + data = selector; + selector = undefined; + } + } + if ( fn === false ) { + fn = returnFalse; + } else if ( !fn ) { + return elem; + } + + if ( one === 1 ) { + origFn = fn; + fn = function( event ) { + + // Can use an empty set, since event contains the info + jQuery().off( event ); + return origFn.apply( this, arguments ); + }; + + // Use same guid so caller can remove using origFn + fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ ); + } + return elem.each( function() { + jQuery.event.add( this, types, fn, data, selector ); + } ); +} + +/* + * Helper functions for managing events -- not part of the public interface. + * Props to Dean Edwards' addEvent library for many of the ideas. + */ +jQuery.event = { + + global: {}, + + add: function( elem, types, handler, data, selector ) { + + var handleObjIn, eventHandle, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.get( elem ); + + // Only attach events to objects that accept data + if ( !acceptData( elem ) ) { + return; + } + + // Caller can pass in an object of custom data in lieu of the handler + if ( handler.handler ) { + handleObjIn = handler; + handler = handleObjIn.handler; + selector = handleObjIn.selector; + } + + // Ensure that invalid selectors throw exceptions at attach time + // Evaluate against documentElement in case elem is a non-element node (e.g., document) + if ( selector ) { + jQuery.find.matchesSelector( documentElement, selector ); + } + + // Make sure that the handler has a unique ID, used to find/remove it later + if ( !handler.guid ) { + handler.guid = jQuery.guid++; + } + + // Init the element's event structure and main handler, if this is the first + if ( !( events = elemData.events ) ) { + events = elemData.events = Object.create( null ); + } + if ( !( eventHandle = elemData.handle ) ) { + eventHandle = elemData.handle = function( e ) { + + // Discard the second event of a jQuery.event.trigger() and + // when an event is called after a page has unloaded + return typeof jQuery !== "undefined" && jQuery.event.triggered !== e.type ? + jQuery.event.dispatch.apply( elem, arguments ) : undefined; + }; + } + + // Handle multiple events separated by a space + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // There *must* be a type, no attaching namespace-only handlers + if ( !type ) { + continue; + } + + // If event changes its type, use the special event handlers for the changed type + special = jQuery.event.special[ type ] || {}; + + // If selector defined, determine special event api type, otherwise given type + type = ( selector ? special.delegateType : special.bindType ) || type; + + // Update special based on newly reset type + special = jQuery.event.special[ type ] || {}; + + // handleObj is passed to all event handlers + handleObj = jQuery.extend( { + type: type, + origType: origType, + data: data, + handler: handler, + guid: handler.guid, + selector: selector, + needsContext: selector && jQuery.expr.match.needsContext.test( selector ), + namespace: namespaces.join( "." ) + }, handleObjIn ); + + // Init the event handler queue if we're the first + if ( !( handlers = events[ type ] ) ) { + handlers = events[ type ] = []; + handlers.delegateCount = 0; + + // Only use addEventListener if the special events handler returns false + if ( !special.setup || + special.setup.call( elem, data, namespaces, eventHandle ) === false ) { + + if ( elem.addEventListener ) { + elem.addEventListener( type, eventHandle ); + } + } + } + + if ( special.add ) { + special.add.call( elem, handleObj ); + + if ( !handleObj.handler.guid ) { + handleObj.handler.guid = handler.guid; + } + } + + // Add to the element's handler list, delegates in front + if ( selector ) { + handlers.splice( handlers.delegateCount++, 0, handleObj ); + } else { + handlers.push( handleObj ); + } + + // Keep track of which events have ever been used, for event optimization + jQuery.event.global[ type ] = true; + } + + }, + + // Detach an event or set of events from an element + remove: function( elem, types, handler, selector, mappedTypes ) { + + var j, origCount, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.hasData( elem ) && dataPriv.get( elem ); + + if ( !elemData || !( events = elemData.events ) ) { + return; + } + + // Once for each type.namespace in types; type may be omitted + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // Unbind all events (on this namespace, if provided) for the element + if ( !type ) { + for ( type in events ) { + jQuery.event.remove( elem, type + types[ t ], handler, selector, true ); + } + continue; + } + + special = jQuery.event.special[ type ] || {}; + type = ( selector ? special.delegateType : special.bindType ) || type; + handlers = events[ type ] || []; + tmp = tmp[ 2 ] && + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ); + + // Remove matching events + origCount = j = handlers.length; + while ( j-- ) { + handleObj = handlers[ j ]; + + if ( ( mappedTypes || origType === handleObj.origType ) && + ( !handler || handler.guid === handleObj.guid ) && + ( !tmp || tmp.test( handleObj.namespace ) ) && + ( !selector || selector === handleObj.selector || + selector === "**" && handleObj.selector ) ) { + handlers.splice( j, 1 ); + + if ( handleObj.selector ) { + handlers.delegateCount--; + } + if ( special.remove ) { + special.remove.call( elem, handleObj ); + } + } + } + + // Remove generic event handler if we removed something and no more handlers exist + // (avoids potential for endless recursion during removal of special event handlers) + if ( origCount && !handlers.length ) { + if ( !special.teardown || + special.teardown.call( elem, namespaces, elemData.handle ) === false ) { + + jQuery.removeEvent( elem, type, elemData.handle ); + } + + delete events[ type ]; + } + } + + // Remove data and the expando if it's no longer used + if ( jQuery.isEmptyObject( events ) ) { + dataPriv.remove( elem, "handle events" ); + } + }, + + dispatch: function( nativeEvent ) { + + var i, j, ret, matched, handleObj, handlerQueue, + args = new Array( arguments.length ), + + // Make a writable jQuery.Event from the native event object + event = jQuery.event.fix( nativeEvent ), + + handlers = ( + dataPriv.get( this, "events" ) || Object.create( null ) + )[ event.type ] || [], + special = jQuery.event.special[ event.type ] || {}; + + // Use the fix-ed jQuery.Event rather than the (read-only) native event + args[ 0 ] = event; + + for ( i = 1; i < arguments.length; i++ ) { + args[ i ] = arguments[ i ]; + } + + event.delegateTarget = this; + + // Call the preDispatch hook for the mapped type, and let it bail if desired + if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) { + return; + } + + // Determine handlers + handlerQueue = jQuery.event.handlers.call( this, event, handlers ); + + // Run delegates first; they may want to stop propagation beneath us + i = 0; + while ( ( matched = handlerQueue[ i++ ] ) && !event.isPropagationStopped() ) { + event.currentTarget = matched.elem; + + j = 0; + while ( ( handleObj = matched.handlers[ j++ ] ) && + !event.isImmediatePropagationStopped() ) { + + // If the event is namespaced, then each handler is only invoked if it is + // specially universal or its namespaces are a superset of the event's. + if ( !event.rnamespace || handleObj.namespace === false || + event.rnamespace.test( handleObj.namespace ) ) { + + event.handleObj = handleObj; + event.data = handleObj.data; + + ret = ( ( jQuery.event.special[ handleObj.origType ] || {} ).handle || + handleObj.handler ).apply( matched.elem, args ); + + if ( ret !== undefined ) { + if ( ( event.result = ret ) === false ) { + event.preventDefault(); + event.stopPropagation(); + } + } + } + } + } + + // Call the postDispatch hook for the mapped type + if ( special.postDispatch ) { + special.postDispatch.call( this, event ); + } + + return event.result; + }, + + handlers: function( event, handlers ) { + var i, handleObj, sel, matchedHandlers, matchedSelectors, + handlerQueue = [], + delegateCount = handlers.delegateCount, + cur = event.target; + + // Find delegate handlers + if ( delegateCount && + + // Support: IE <=9 + // Black-hole SVG instance trees (trac-13180) + cur.nodeType && + + // Support: Firefox <=42 + // Suppress spec-violating clicks indicating a non-primary pointer button (trac-3861) + // https://www.w3.org/TR/DOM-Level-3-Events/#event-type-click + // Support: IE 11 only + // ...but not arrow key "clicks" of radio inputs, which can have `button` -1 (gh-2343) + !( event.type === "click" && event.button >= 1 ) ) { + + for ( ; cur !== this; cur = cur.parentNode || this ) { + + // Don't check non-elements (#13208) + // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764) + if ( cur.nodeType === 1 && !( event.type === "click" && cur.disabled === true ) ) { + matchedHandlers = []; + matchedSelectors = {}; + for ( i = 0; i < delegateCount; i++ ) { + handleObj = handlers[ i ]; + + // Don't conflict with Object.prototype properties (#13203) + sel = handleObj.selector + " "; + + if ( matchedSelectors[ sel ] === undefined ) { + matchedSelectors[ sel ] = handleObj.needsContext ? + jQuery( sel, this ).index( cur ) > -1 : + jQuery.find( sel, this, null, [ cur ] ).length; + } + if ( matchedSelectors[ sel ] ) { + matchedHandlers.push( handleObj ); + } + } + if ( matchedHandlers.length ) { + handlerQueue.push( { elem: cur, handlers: matchedHandlers } ); + } + } + } + } + + // Add the remaining (directly-bound) handlers + cur = this; + if ( delegateCount < handlers.length ) { + handlerQueue.push( { elem: cur, handlers: handlers.slice( delegateCount ) } ); + } + + return handlerQueue; + }, + + addProp: function( name, hook ) { + Object.defineProperty( jQuery.Event.prototype, name, { + enumerable: true, + configurable: true, + + get: isFunction( hook ) ? + function() { + if ( this.originalEvent ) { + return hook( this.originalEvent ); + } + } : + function() { + if ( this.originalEvent ) { + return this.originalEvent[ name ]; + } + }, + + set: function( value ) { + Object.defineProperty( this, name, { + enumerable: true, + configurable: true, + writable: true, + value: value + } ); + } + } ); + }, + + fix: function( originalEvent ) { + return originalEvent[ jQuery.expando ] ? + originalEvent : + new jQuery.Event( originalEvent ); + }, + + special: { + load: { + + // Prevent triggered image.load events from bubbling to window.load + noBubble: true + }, + click: { + + // Utilize native event to ensure correct state for checkable inputs + setup: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Claim the first handler + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + // dataPriv.set( el, "click", ... ) + leverageNative( el, "click", returnTrue ); + } + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Force setup before triggering a click + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + leverageNative( el, "click" ); + } + + // Return non-false to allow normal event-path propagation + return true; + }, + + // For cross-browser consistency, suppress native .click() on links + // Also prevent it if we're currently inside a leveraged native-event stack + _default: function( event ) { + var target = event.target; + return rcheckableType.test( target.type ) && + target.click && nodeName( target, "input" ) && + dataPriv.get( target, "click" ) || + nodeName( target, "a" ); + } + }, + + beforeunload: { + postDispatch: function( event ) { + + // Support: Firefox 20+ + // Firefox doesn't alert if the returnValue field is not set. + if ( event.result !== undefined && event.originalEvent ) { + event.originalEvent.returnValue = event.result; + } + } + } + } +}; + +// Ensure the presence of an event listener that handles manually-triggered +// synthetic events by interrupting progress until reinvoked in response to +// *native* events that it fires directly, ensuring that state changes have +// already occurred before other listeners are invoked. +function leverageNative( el, type, expectSync ) { + + // Missing expectSync indicates a trigger call, which must force setup through jQuery.event.add + if ( !expectSync ) { + if ( dataPriv.get( el, type ) === undefined ) { + jQuery.event.add( el, type, returnTrue ); + } + return; + } + + // Register the controller as a special universal handler for all event namespaces + dataPriv.set( el, type, false ); + jQuery.event.add( el, type, { + namespace: false, + handler: function( event ) { + var notAsync, result, + saved = dataPriv.get( this, type ); + + if ( ( event.isTrigger & 1 ) && this[ type ] ) { + + // Interrupt processing of the outer synthetic .trigger()ed event + // Saved data should be false in such cases, but might be a leftover capture object + // from an async native handler (gh-4350) + if ( !saved.length ) { + + // Store arguments for use when handling the inner native event + // There will always be at least one argument (an event object), so this array + // will not be confused with a leftover capture object. + saved = slice.call( arguments ); + dataPriv.set( this, type, saved ); + + // Trigger the native event and capture its result + // Support: IE <=9 - 11+ + // focus() and blur() are asynchronous + notAsync = expectSync( this, type ); + this[ type ](); + result = dataPriv.get( this, type ); + if ( saved !== result || notAsync ) { + dataPriv.set( this, type, false ); + } else { + result = {}; + } + if ( saved !== result ) { + + // Cancel the outer synthetic event + event.stopImmediatePropagation(); + event.preventDefault(); + return result.value; + } + + // If this is an inner synthetic event for an event with a bubbling surrogate + // (focus or blur), assume that the surrogate already propagated from triggering the + // native event and prevent that from happening again here. + // This technically gets the ordering wrong w.r.t. to `.trigger()` (in which the + // bubbling surrogate propagates *after* the non-bubbling base), but that seems + // less bad than duplication. + } else if ( ( jQuery.event.special[ type ] || {} ).delegateType ) { + event.stopPropagation(); + } + + // If this is a native event triggered above, everything is now in order + // Fire an inner synthetic event with the original arguments + } else if ( saved.length ) { + + // ...and capture the result + dataPriv.set( this, type, { + value: jQuery.event.trigger( + + // Support: IE <=9 - 11+ + // Extend with the prototype to reset the above stopImmediatePropagation() + jQuery.extend( saved[ 0 ], jQuery.Event.prototype ), + saved.slice( 1 ), + this + ) + } ); + + // Abort handling of the native event + event.stopImmediatePropagation(); + } + } + } ); +} + +jQuery.removeEvent = function( elem, type, handle ) { + + // This "if" is needed for plain objects + if ( elem.removeEventListener ) { + elem.removeEventListener( type, handle ); + } +}; + +jQuery.Event = function( src, props ) { + + // Allow instantiation without the 'new' keyword + if ( !( this instanceof jQuery.Event ) ) { + return new jQuery.Event( src, props ); + } + + // Event object + if ( src && src.type ) { + this.originalEvent = src; + this.type = src.type; + + // Events bubbling up the document may have been marked as prevented + // by a handler lower down the tree; reflect the correct value. + this.isDefaultPrevented = src.defaultPrevented || + src.defaultPrevented === undefined && + + // Support: Android <=2.3 only + src.returnValue === false ? + returnTrue : + returnFalse; + + // Create target properties + // Support: Safari <=6 - 7 only + // Target should not be a text node (#504, #13143) + this.target = ( src.target && src.target.nodeType === 3 ) ? + src.target.parentNode : + src.target; + + this.currentTarget = src.currentTarget; + this.relatedTarget = src.relatedTarget; + + // Event type + } else { + this.type = src; + } + + // Put explicitly provided properties onto the event object + if ( props ) { + jQuery.extend( this, props ); + } + + // Create a timestamp if incoming event doesn't have one + this.timeStamp = src && src.timeStamp || Date.now(); + + // Mark it as fixed + this[ jQuery.expando ] = true; +}; + +// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding +// https://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html +jQuery.Event.prototype = { + constructor: jQuery.Event, + isDefaultPrevented: returnFalse, + isPropagationStopped: returnFalse, + isImmediatePropagationStopped: returnFalse, + isSimulated: false, + + preventDefault: function() { + var e = this.originalEvent; + + this.isDefaultPrevented = returnTrue; + + if ( e && !this.isSimulated ) { + e.preventDefault(); + } + }, + stopPropagation: function() { + var e = this.originalEvent; + + this.isPropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopPropagation(); + } + }, + stopImmediatePropagation: function() { + var e = this.originalEvent; + + this.isImmediatePropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopImmediatePropagation(); + } + + this.stopPropagation(); + } +}; + +// Includes all common event props including KeyEvent and MouseEvent specific props +jQuery.each( { + altKey: true, + bubbles: true, + cancelable: true, + changedTouches: true, + ctrlKey: true, + detail: true, + eventPhase: true, + metaKey: true, + pageX: true, + pageY: true, + shiftKey: true, + view: true, + "char": true, + code: true, + charCode: true, + key: true, + keyCode: true, + button: true, + buttons: true, + clientX: true, + clientY: true, + offsetX: true, + offsetY: true, + pointerId: true, + pointerType: true, + screenX: true, + screenY: true, + targetTouches: true, + toElement: true, + touches: true, + + which: function( event ) { + var button = event.button; + + // Add which for key events + if ( event.which == null && rkeyEvent.test( event.type ) ) { + return event.charCode != null ? event.charCode : event.keyCode; + } + + // Add which for click: 1 === left; 2 === middle; 3 === right + if ( !event.which && button !== undefined && rmouseEvent.test( event.type ) ) { + if ( button & 1 ) { + return 1; + } + + if ( button & 2 ) { + return 3; + } + + if ( button & 4 ) { + return 2; + } + + return 0; + } + + return event.which; + } +}, jQuery.event.addProp ); + +jQuery.each( { focus: "focusin", blur: "focusout" }, function( type, delegateType ) { + jQuery.event.special[ type ] = { + + // Utilize native event if possible so blur/focus sequence is correct + setup: function() { + + // Claim the first handler + // dataPriv.set( this, "focus", ... ) + // dataPriv.set( this, "blur", ... ) + leverageNative( this, type, expectSync ); + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function() { + + // Force setup before trigger + leverageNative( this, type ); + + // Return non-false to allow normal event-path propagation + return true; + }, + + delegateType: delegateType + }; +} ); + +// Create mouseenter/leave events using mouseover/out and event-time checks +// so that event delegation works in jQuery. +// Do the same for pointerenter/pointerleave and pointerover/pointerout +// +// Support: Safari 7 only +// Safari sends mouseenter too often; see: +// https://bugs.chromium.org/p/chromium/issues/detail?id=470258 +// for the description of the bug (it existed in older Chrome versions as well). +jQuery.each( { + mouseenter: "mouseover", + mouseleave: "mouseout", + pointerenter: "pointerover", + pointerleave: "pointerout" +}, function( orig, fix ) { + jQuery.event.special[ orig ] = { + delegateType: fix, + bindType: fix, + + handle: function( event ) { + var ret, + target = this, + related = event.relatedTarget, + handleObj = event.handleObj; + + // For mouseenter/leave call the handler if related is outside the target. + // NB: No relatedTarget if the mouse left/entered the browser window + if ( !related || ( related !== target && !jQuery.contains( target, related ) ) ) { + event.type = handleObj.origType; + ret = handleObj.handler.apply( this, arguments ); + event.type = fix; + } + return ret; + } + }; +} ); + +jQuery.fn.extend( { + + on: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn ); + }, + one: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn, 1 ); + }, + off: function( types, selector, fn ) { + var handleObj, type; + if ( types && types.preventDefault && types.handleObj ) { + + // ( event ) dispatched jQuery.Event + handleObj = types.handleObj; + jQuery( types.delegateTarget ).off( + handleObj.namespace ? + handleObj.origType + "." + handleObj.namespace : + handleObj.origType, + handleObj.selector, + handleObj.handler + ); + return this; + } + if ( typeof types === "object" ) { + + // ( types-object [, selector] ) + for ( type in types ) { + this.off( type, selector, types[ type ] ); + } + return this; + } + if ( selector === false || typeof selector === "function" ) { + + // ( types [, fn] ) + fn = selector; + selector = undefined; + } + if ( fn === false ) { + fn = returnFalse; + } + return this.each( function() { + jQuery.event.remove( this, types, fn, selector ); + } ); + } +} ); + + +var + + // Support: IE <=10 - 11, Edge 12 - 13 only + // In IE/Edge using regex groups here causes severe slowdowns. + // See https://connect.microsoft.com/IE/feedback/details/1736512/ + rnoInnerhtml = /\s*$/g; + +// Prefer a tbody over its parent table for containing new rows +function manipulationTarget( elem, content ) { + if ( nodeName( elem, "table" ) && + nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ) { + + return jQuery( elem ).children( "tbody" )[ 0 ] || elem; + } + + return elem; +} + +// Replace/restore the type attribute of script elements for safe DOM manipulation +function disableScript( elem ) { + elem.type = ( elem.getAttribute( "type" ) !== null ) + "/" + elem.type; + return elem; +} +function restoreScript( elem ) { + if ( ( elem.type || "" ).slice( 0, 5 ) === "true/" ) { + elem.type = elem.type.slice( 5 ); + } else { + elem.removeAttribute( "type" ); + } + + return elem; +} + +function cloneCopyEvent( src, dest ) { + var i, l, type, pdataOld, udataOld, udataCur, events; + + if ( dest.nodeType !== 1 ) { + return; + } + + // 1. Copy private data: events, handlers, etc. + if ( dataPriv.hasData( src ) ) { + pdataOld = dataPriv.get( src ); + events = pdataOld.events; + + if ( events ) { + dataPriv.remove( dest, "handle events" ); + + for ( type in events ) { + for ( i = 0, l = events[ type ].length; i < l; i++ ) { + jQuery.event.add( dest, type, events[ type ][ i ] ); + } + } + } + } + + // 2. Copy user data + if ( dataUser.hasData( src ) ) { + udataOld = dataUser.access( src ); + udataCur = jQuery.extend( {}, udataOld ); + + dataUser.set( dest, udataCur ); + } +} + +// Fix IE bugs, see support tests +function fixInput( src, dest ) { + var nodeName = dest.nodeName.toLowerCase(); + + // Fails to persist the checked state of a cloned checkbox or radio button. + if ( nodeName === "input" && rcheckableType.test( src.type ) ) { + dest.checked = src.checked; + + // Fails to return the selected option to the default selected state when cloning options + } else if ( nodeName === "input" || nodeName === "textarea" ) { + dest.defaultValue = src.defaultValue; + } +} + +function domManip( collection, args, callback, ignored ) { + + // Flatten any nested arrays + args = flat( args ); + + var fragment, first, scripts, hasScripts, node, doc, + i = 0, + l = collection.length, + iNoClone = l - 1, + value = args[ 0 ], + valueIsFunction = isFunction( value ); + + // We can't cloneNode fragments that contain checked, in WebKit + if ( valueIsFunction || + ( l > 1 && typeof value === "string" && + !support.checkClone && rchecked.test( value ) ) ) { + return collection.each( function( index ) { + var self = collection.eq( index ); + if ( valueIsFunction ) { + args[ 0 ] = value.call( this, index, self.html() ); + } + domManip( self, args, callback, ignored ); + } ); + } + + if ( l ) { + fragment = buildFragment( args, collection[ 0 ].ownerDocument, false, collection, ignored ); + first = fragment.firstChild; + + if ( fragment.childNodes.length === 1 ) { + fragment = first; + } + + // Require either new content or an interest in ignored elements to invoke the callback + if ( first || ignored ) { + scripts = jQuery.map( getAll( fragment, "script" ), disableScript ); + hasScripts = scripts.length; + + // Use the original fragment for the last item + // instead of the first because it can end up + // being emptied incorrectly in certain situations (#8070). + for ( ; i < l; i++ ) { + node = fragment; + + if ( i !== iNoClone ) { + node = jQuery.clone( node, true, true ); + + // Keep references to cloned scripts for later restoration + if ( hasScripts ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( scripts, getAll( node, "script" ) ); + } + } + + callback.call( collection[ i ], node, i ); + } + + if ( hasScripts ) { + doc = scripts[ scripts.length - 1 ].ownerDocument; + + // Reenable scripts + jQuery.map( scripts, restoreScript ); + + // Evaluate executable scripts on first document insertion + for ( i = 0; i < hasScripts; i++ ) { + node = scripts[ i ]; + if ( rscriptType.test( node.type || "" ) && + !dataPriv.access( node, "globalEval" ) && + jQuery.contains( doc, node ) ) { + + if ( node.src && ( node.type || "" ).toLowerCase() !== "module" ) { + + // Optional AJAX dependency, but won't run scripts if not present + if ( jQuery._evalUrl && !node.noModule ) { + jQuery._evalUrl( node.src, { + nonce: node.nonce || node.getAttribute( "nonce" ) + }, doc ); + } + } else { + DOMEval( node.textContent.replace( rcleanScript, "" ), node, doc ); + } + } + } + } + } + } + + return collection; +} + +function remove( elem, selector, keepData ) { + var node, + nodes = selector ? jQuery.filter( selector, elem ) : elem, + i = 0; + + for ( ; ( node = nodes[ i ] ) != null; i++ ) { + if ( !keepData && node.nodeType === 1 ) { + jQuery.cleanData( getAll( node ) ); + } + + if ( node.parentNode ) { + if ( keepData && isAttached( node ) ) { + setGlobalEval( getAll( node, "script" ) ); + } + node.parentNode.removeChild( node ); + } + } + + return elem; +} + +jQuery.extend( { + htmlPrefilter: function( html ) { + return html; + }, + + clone: function( elem, dataAndEvents, deepDataAndEvents ) { + var i, l, srcElements, destElements, + clone = elem.cloneNode( true ), + inPage = isAttached( elem ); + + // Fix IE cloning issues + if ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) && + !jQuery.isXMLDoc( elem ) ) { + + // We eschew Sizzle here for performance reasons: https://jsperf.com/getall-vs-sizzle/2 + destElements = getAll( clone ); + srcElements = getAll( elem ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + fixInput( srcElements[ i ], destElements[ i ] ); + } + } + + // Copy the events from the original to the clone + if ( dataAndEvents ) { + if ( deepDataAndEvents ) { + srcElements = srcElements || getAll( elem ); + destElements = destElements || getAll( clone ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + cloneCopyEvent( srcElements[ i ], destElements[ i ] ); + } + } else { + cloneCopyEvent( elem, clone ); + } + } + + // Preserve script evaluation history + destElements = getAll( clone, "script" ); + if ( destElements.length > 0 ) { + setGlobalEval( destElements, !inPage && getAll( elem, "script" ) ); + } + + // Return the cloned set + return clone; + }, + + cleanData: function( elems ) { + var data, elem, type, + special = jQuery.event.special, + i = 0; + + for ( ; ( elem = elems[ i ] ) !== undefined; i++ ) { + if ( acceptData( elem ) ) { + if ( ( data = elem[ dataPriv.expando ] ) ) { + if ( data.events ) { + for ( type in data.events ) { + if ( special[ type ] ) { + jQuery.event.remove( elem, type ); + + // This is a shortcut to avoid jQuery.event.remove's overhead + } else { + jQuery.removeEvent( elem, type, data.handle ); + } + } + } + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataPriv.expando ] = undefined; + } + if ( elem[ dataUser.expando ] ) { + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataUser.expando ] = undefined; + } + } + } + } +} ); + +jQuery.fn.extend( { + detach: function( selector ) { + return remove( this, selector, true ); + }, + + remove: function( selector ) { + return remove( this, selector ); + }, + + text: function( value ) { + return access( this, function( value ) { + return value === undefined ? + jQuery.text( this ) : + this.empty().each( function() { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + this.textContent = value; + } + } ); + }, null, value, arguments.length ); + }, + + append: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.appendChild( elem ); + } + } ); + }, + + prepend: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.insertBefore( elem, target.firstChild ); + } + } ); + }, + + before: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this ); + } + } ); + }, + + after: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this.nextSibling ); + } + } ); + }, + + empty: function() { + var elem, + i = 0; + + for ( ; ( elem = this[ i ] ) != null; i++ ) { + if ( elem.nodeType === 1 ) { + + // Prevent memory leaks + jQuery.cleanData( getAll( elem, false ) ); + + // Remove any remaining nodes + elem.textContent = ""; + } + } + + return this; + }, + + clone: function( dataAndEvents, deepDataAndEvents ) { + dataAndEvents = dataAndEvents == null ? false : dataAndEvents; + deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents; + + return this.map( function() { + return jQuery.clone( this, dataAndEvents, deepDataAndEvents ); + } ); + }, + + html: function( value ) { + return access( this, function( value ) { + var elem = this[ 0 ] || {}, + i = 0, + l = this.length; + + if ( value === undefined && elem.nodeType === 1 ) { + return elem.innerHTML; + } + + // See if we can take a shortcut and just use innerHTML + if ( typeof value === "string" && !rnoInnerhtml.test( value ) && + !wrapMap[ ( rtagName.exec( value ) || [ "", "" ] )[ 1 ].toLowerCase() ] ) { + + value = jQuery.htmlPrefilter( value ); + + try { + for ( ; i < l; i++ ) { + elem = this[ i ] || {}; + + // Remove element nodes and prevent memory leaks + if ( elem.nodeType === 1 ) { + jQuery.cleanData( getAll( elem, false ) ); + elem.innerHTML = value; + } + } + + elem = 0; + + // If using innerHTML throws an exception, use the fallback method + } catch ( e ) {} + } + + if ( elem ) { + this.empty().append( value ); + } + }, null, value, arguments.length ); + }, + + replaceWith: function() { + var ignored = []; + + // Make the changes, replacing each non-ignored context element with the new content + return domManip( this, arguments, function( elem ) { + var parent = this.parentNode; + + if ( jQuery.inArray( this, ignored ) < 0 ) { + jQuery.cleanData( getAll( this ) ); + if ( parent ) { + parent.replaceChild( elem, this ); + } + } + + // Force callback invocation + }, ignored ); + } +} ); + +jQuery.each( { + appendTo: "append", + prependTo: "prepend", + insertBefore: "before", + insertAfter: "after", + replaceAll: "replaceWith" +}, function( name, original ) { + jQuery.fn[ name ] = function( selector ) { + var elems, + ret = [], + insert = jQuery( selector ), + last = insert.length - 1, + i = 0; + + for ( ; i <= last; i++ ) { + elems = i === last ? this : this.clone( true ); + jQuery( insert[ i ] )[ original ]( elems ); + + // Support: Android <=4.0 only, PhantomJS 1 only + // .get() because push.apply(_, arraylike) throws on ancient WebKit + push.apply( ret, elems.get() ); + } + + return this.pushStack( ret ); + }; +} ); +var rnumnonpx = new RegExp( "^(" + pnum + ")(?!px)[a-z%]+$", "i" ); + +var getStyles = function( elem ) { + + // Support: IE <=11 only, Firefox <=30 (#15098, #14150) + // IE throws on elements created in popups + // FF meanwhile throws on frame elements through "defaultView.getComputedStyle" + var view = elem.ownerDocument.defaultView; + + if ( !view || !view.opener ) { + view = window; + } + + return view.getComputedStyle( elem ); + }; + +var swap = function( elem, options, callback ) { + var ret, name, + old = {}; + + // Remember the old values, and insert the new ones + for ( name in options ) { + old[ name ] = elem.style[ name ]; + elem.style[ name ] = options[ name ]; + } + + ret = callback.call( elem ); + + // Revert the old values + for ( name in options ) { + elem.style[ name ] = old[ name ]; + } + + return ret; +}; + + +var rboxStyle = new RegExp( cssExpand.join( "|" ), "i" ); + + + +( function() { + + // Executing both pixelPosition & boxSizingReliable tests require only one layout + // so they're executed at the same time to save the second computation. + function computeStyleTests() { + + // This is a singleton, we need to execute it only once + if ( !div ) { + return; + } + + container.style.cssText = "position:absolute;left:-11111px;width:60px;" + + "margin-top:1px;padding:0;border:0"; + div.style.cssText = + "position:relative;display:block;box-sizing:border-box;overflow:scroll;" + + "margin:auto;border:1px;padding:1px;" + + "width:60%;top:1%"; + documentElement.appendChild( container ).appendChild( div ); + + var divStyle = window.getComputedStyle( div ); + pixelPositionVal = divStyle.top !== "1%"; + + // Support: Android 4.0 - 4.3 only, Firefox <=3 - 44 + reliableMarginLeftVal = roundPixelMeasures( divStyle.marginLeft ) === 12; + + // Support: Android 4.0 - 4.3 only, Safari <=9.1 - 10.1, iOS <=7.0 - 9.3 + // Some styles come back with percentage values, even though they shouldn't + div.style.right = "60%"; + pixelBoxStylesVal = roundPixelMeasures( divStyle.right ) === 36; + + // Support: IE 9 - 11 only + // Detect misreporting of content dimensions for box-sizing:border-box elements + boxSizingReliableVal = roundPixelMeasures( divStyle.width ) === 36; + + // Support: IE 9 only + // Detect overflow:scroll screwiness (gh-3699) + // Support: Chrome <=64 + // Don't get tricked when zoom affects offsetWidth (gh-4029) + div.style.position = "absolute"; + scrollboxSizeVal = roundPixelMeasures( div.offsetWidth / 3 ) === 12; + + documentElement.removeChild( container ); + + // Nullify the div so it wouldn't be stored in the memory and + // it will also be a sign that checks already performed + div = null; + } + + function roundPixelMeasures( measure ) { + return Math.round( parseFloat( measure ) ); + } + + var pixelPositionVal, boxSizingReliableVal, scrollboxSizeVal, pixelBoxStylesVal, + reliableTrDimensionsVal, reliableMarginLeftVal, + container = document.createElement( "div" ), + div = document.createElement( "div" ); + + // Finish early in limited (non-browser) environments + if ( !div.style ) { + return; + } + + // Support: IE <=9 - 11 only + // Style of cloned element affects source element cloned (#8908) + div.style.backgroundClip = "content-box"; + div.cloneNode( true ).style.backgroundClip = ""; + support.clearCloneStyle = div.style.backgroundClip === "content-box"; + + jQuery.extend( support, { + boxSizingReliable: function() { + computeStyleTests(); + return boxSizingReliableVal; + }, + pixelBoxStyles: function() { + computeStyleTests(); + return pixelBoxStylesVal; + }, + pixelPosition: function() { + computeStyleTests(); + return pixelPositionVal; + }, + reliableMarginLeft: function() { + computeStyleTests(); + return reliableMarginLeftVal; + }, + scrollboxSize: function() { + computeStyleTests(); + return scrollboxSizeVal; + }, + + // Support: IE 9 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Behavior in IE 9 is more subtle than in newer versions & it passes + // some versions of this test; make sure not to make it pass there! + reliableTrDimensions: function() { + var table, tr, trChild, trStyle; + if ( reliableTrDimensionsVal == null ) { + table = document.createElement( "table" ); + tr = document.createElement( "tr" ); + trChild = document.createElement( "div" ); + + table.style.cssText = "position:absolute;left:-11111px"; + tr.style.height = "1px"; + trChild.style.height = "9px"; + + documentElement + .appendChild( table ) + .appendChild( tr ) + .appendChild( trChild ); + + trStyle = window.getComputedStyle( tr ); + reliableTrDimensionsVal = parseInt( trStyle.height ) > 3; + + documentElement.removeChild( table ); + } + return reliableTrDimensionsVal; + } + } ); +} )(); + + +function curCSS( elem, name, computed ) { + var width, minWidth, maxWidth, ret, + + // Support: Firefox 51+ + // Retrieving style before computed somehow + // fixes an issue with getting wrong values + // on detached elements + style = elem.style; + + computed = computed || getStyles( elem ); + + // getPropertyValue is needed for: + // .css('filter') (IE 9 only, #12537) + // .css('--customProperty) (#3144) + if ( computed ) { + ret = computed.getPropertyValue( name ) || computed[ name ]; + + if ( ret === "" && !isAttached( elem ) ) { + ret = jQuery.style( elem, name ); + } + + // A tribute to the "awesome hack by Dean Edwards" + // Android Browser returns percentage for some values, + // but width seems to be reliably pixels. + // This is against the CSSOM draft spec: + // https://drafts.csswg.org/cssom/#resolved-values + if ( !support.pixelBoxStyles() && rnumnonpx.test( ret ) && rboxStyle.test( name ) ) { + + // Remember the original values + width = style.width; + minWidth = style.minWidth; + maxWidth = style.maxWidth; + + // Put in the new values to get a computed value out + style.minWidth = style.maxWidth = style.width = ret; + ret = computed.width; + + // Revert the changed values + style.width = width; + style.minWidth = minWidth; + style.maxWidth = maxWidth; + } + } + + return ret !== undefined ? + + // Support: IE <=9 - 11 only + // IE returns zIndex value as an integer. + ret + "" : + ret; +} + + +function addGetHookIf( conditionFn, hookFn ) { + + // Define the hook, we'll check on the first run if it's really needed. + return { + get: function() { + if ( conditionFn() ) { + + // Hook not needed (or it's not possible to use it due + // to missing dependency), remove it. + delete this.get; + return; + } + + // Hook needed; redefine it so that the support test is not executed again. + return ( this.get = hookFn ).apply( this, arguments ); + } + }; +} + + +var cssPrefixes = [ "Webkit", "Moz", "ms" ], + emptyStyle = document.createElement( "div" ).style, + vendorProps = {}; + +// Return a vendor-prefixed property or undefined +function vendorPropName( name ) { + + // Check for vendor prefixed names + var capName = name[ 0 ].toUpperCase() + name.slice( 1 ), + i = cssPrefixes.length; + + while ( i-- ) { + name = cssPrefixes[ i ] + capName; + if ( name in emptyStyle ) { + return name; + } + } +} + +// Return a potentially-mapped jQuery.cssProps or vendor prefixed property +function finalPropName( name ) { + var final = jQuery.cssProps[ name ] || vendorProps[ name ]; + + if ( final ) { + return final; + } + if ( name in emptyStyle ) { + return name; + } + return vendorProps[ name ] = vendorPropName( name ) || name; +} + + +var + + // Swappable if display is none or starts with table + // except "table", "table-cell", or "table-caption" + // See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display + rdisplayswap = /^(none|table(?!-c[ea]).+)/, + rcustomProp = /^--/, + cssShow = { position: "absolute", visibility: "hidden", display: "block" }, + cssNormalTransform = { + letterSpacing: "0", + fontWeight: "400" + }; + +function setPositiveNumber( _elem, value, subtract ) { + + // Any relative (+/-) values have already been + // normalized at this point + var matches = rcssNum.exec( value ); + return matches ? + + // Guard against undefined "subtract", e.g., when used as in cssHooks + Math.max( 0, matches[ 2 ] - ( subtract || 0 ) ) + ( matches[ 3 ] || "px" ) : + value; +} + +function boxModelAdjustment( elem, dimension, box, isBorderBox, styles, computedVal ) { + var i = dimension === "width" ? 1 : 0, + extra = 0, + delta = 0; + + // Adjustment may not be necessary + if ( box === ( isBorderBox ? "border" : "content" ) ) { + return 0; + } + + for ( ; i < 4; i += 2 ) { + + // Both box models exclude margin + if ( box === "margin" ) { + delta += jQuery.css( elem, box + cssExpand[ i ], true, styles ); + } + + // If we get here with a content-box, we're seeking "padding" or "border" or "margin" + if ( !isBorderBox ) { + + // Add padding + delta += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + + // For "border" or "margin", add border + if ( box !== "padding" ) { + delta += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + + // But still keep track of it otherwise + } else { + extra += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + + // If we get here with a border-box (content + padding + border), we're seeking "content" or + // "padding" or "margin" + } else { + + // For "content", subtract padding + if ( box === "content" ) { + delta -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + } + + // For "content" or "padding", subtract border + if ( box !== "margin" ) { + delta -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + } + } + + // Account for positive content-box scroll gutter when requested by providing computedVal + if ( !isBorderBox && computedVal >= 0 ) { + + // offsetWidth/offsetHeight is a rounded sum of content, padding, scroll gutter, and border + // Assuming integer scroll gutter, subtract the rest and round down + delta += Math.max( 0, Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + computedVal - + delta - + extra - + 0.5 + + // If offsetWidth/offsetHeight is unknown, then we can't determine content-box scroll gutter + // Use an explicit zero to avoid NaN (gh-3964) + ) ) || 0; + } + + return delta; +} + +function getWidthOrHeight( elem, dimension, extra ) { + + // Start with computed style + var styles = getStyles( elem ), + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-4322). + // Fake content-box until we know it's needed to know the true value. + boxSizingNeeded = !support.boxSizingReliable() || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + valueIsBorderBox = isBorderBox, + + val = curCSS( elem, dimension, styles ), + offsetProp = "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ); + + // Support: Firefox <=54 + // Return a confounding non-pixel value or feign ignorance, as appropriate. + if ( rnumnonpx.test( val ) ) { + if ( !extra ) { + return val; + } + val = "auto"; + } + + + // Support: IE 9 - 11 only + // Use offsetWidth/offsetHeight for when box sizing is unreliable. + // In those cases, the computed value can be trusted to be border-box. + if ( ( !support.boxSizingReliable() && isBorderBox || + + // Support: IE 10 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Interestingly, in some cases IE 9 doesn't suffer from this issue. + !support.reliableTrDimensions() && nodeName( elem, "tr" ) || + + // Fall back to offsetWidth/offsetHeight when value is "auto" + // This happens for inline elements with no explicit setting (gh-3571) + val === "auto" || + + // Support: Android <=4.1 - 4.3 only + // Also use offsetWidth/offsetHeight for misreported inline dimensions (gh-3602) + !parseFloat( val ) && jQuery.css( elem, "display", false, styles ) === "inline" ) && + + // Make sure the element is visible & connected + elem.getClientRects().length ) { + + isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box"; + + // Where available, offsetWidth/offsetHeight approximate border box dimensions. + // Where not available (e.g., SVG), assume unreliable box-sizing and interpret the + // retrieved value as a content box dimension. + valueIsBorderBox = offsetProp in elem; + if ( valueIsBorderBox ) { + val = elem[ offsetProp ]; + } + } + + // Normalize "" and auto + val = parseFloat( val ) || 0; + + // Adjust for the element's box model + return ( val + + boxModelAdjustment( + elem, + dimension, + extra || ( isBorderBox ? "border" : "content" ), + valueIsBorderBox, + styles, + + // Provide the current computed size to request scroll gutter calculation (gh-3589) + val + ) + ) + "px"; +} + +jQuery.extend( { + + // Add in style property hooks for overriding the default + // behavior of getting and setting a style property + cssHooks: { + opacity: { + get: function( elem, computed ) { + if ( computed ) { + + // We should always get a number back from opacity + var ret = curCSS( elem, "opacity" ); + return ret === "" ? "1" : ret; + } + } + } + }, + + // Don't automatically add "px" to these possibly-unitless properties + cssNumber: { + "animationIterationCount": true, + "columnCount": true, + "fillOpacity": true, + "flexGrow": true, + "flexShrink": true, + "fontWeight": true, + "gridArea": true, + "gridColumn": true, + "gridColumnEnd": true, + "gridColumnStart": true, + "gridRow": true, + "gridRowEnd": true, + "gridRowStart": true, + "lineHeight": true, + "opacity": true, + "order": true, + "orphans": true, + "widows": true, + "zIndex": true, + "zoom": true + }, + + // Add in properties whose names you wish to fix before + // setting or getting the value + cssProps: {}, + + // Get and set the style property on a DOM Node + style: function( elem, name, value, extra ) { + + // Don't set styles on text and comment nodes + if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) { + return; + } + + // Make sure that we're working with the right name + var ret, type, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ), + style = elem.style; + + // Make sure that we're working with the right name. We don't + // want to query the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Gets hook for the prefixed version, then unprefixed version + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // Check if we're setting a value + if ( value !== undefined ) { + type = typeof value; + + // Convert "+=" or "-=" to relative numbers (#7345) + if ( type === "string" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) { + value = adjustCSS( elem, name, ret ); + + // Fixes bug #9237 + type = "number"; + } + + // Make sure that null and NaN values aren't set (#7116) + if ( value == null || value !== value ) { + return; + } + + // If a number was passed in, add the unit (except for certain CSS properties) + // The isCustomProp check can be removed in jQuery 4.0 when we only auto-append + // "px" to a few hardcoded values. + if ( type === "number" && !isCustomProp ) { + value += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? "" : "px" ); + } + + // background-* props affect original clone's values + if ( !support.clearCloneStyle && value === "" && name.indexOf( "background" ) === 0 ) { + style[ name ] = "inherit"; + } + + // If a hook was provided, use that value, otherwise just set the specified value + if ( !hooks || !( "set" in hooks ) || + ( value = hooks.set( elem, value, extra ) ) !== undefined ) { + + if ( isCustomProp ) { + style.setProperty( name, value ); + } else { + style[ name ] = value; + } + } + + } else { + + // If a hook was provided get the non-computed value from there + if ( hooks && "get" in hooks && + ( ret = hooks.get( elem, false, extra ) ) !== undefined ) { + + return ret; + } + + // Otherwise just get the value from the style object + return style[ name ]; + } + }, + + css: function( elem, name, extra, styles ) { + var val, num, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ); + + // Make sure that we're working with the right name. We don't + // want to modify the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Try prefixed name followed by the unprefixed name + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // If a hook was provided get the computed value from there + if ( hooks && "get" in hooks ) { + val = hooks.get( elem, true, extra ); + } + + // Otherwise, if a way to get the computed value exists, use that + if ( val === undefined ) { + val = curCSS( elem, name, styles ); + } + + // Convert "normal" to computed value + if ( val === "normal" && name in cssNormalTransform ) { + val = cssNormalTransform[ name ]; + } + + // Make numeric if forced or a qualifier was provided and val looks numeric + if ( extra === "" || extra ) { + num = parseFloat( val ); + return extra === true || isFinite( num ) ? num || 0 : val; + } + + return val; + } +} ); + +jQuery.each( [ "height", "width" ], function( _i, dimension ) { + jQuery.cssHooks[ dimension ] = { + get: function( elem, computed, extra ) { + if ( computed ) { + + // Certain elements can have dimension info if we invisibly show them + // but it must have a current display style that would benefit + return rdisplayswap.test( jQuery.css( elem, "display" ) ) && + + // Support: Safari 8+ + // Table columns in Safari have non-zero offsetWidth & zero + // getBoundingClientRect().width unless display is changed. + // Support: IE <=11 only + // Running getBoundingClientRect on a disconnected node + // in IE throws an error. + ( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ? + swap( elem, cssShow, function() { + return getWidthOrHeight( elem, dimension, extra ); + } ) : + getWidthOrHeight( elem, dimension, extra ); + } + }, + + set: function( elem, value, extra ) { + var matches, + styles = getStyles( elem ), + + // Only read styles.position if the test has a chance to fail + // to avoid forcing a reflow. + scrollboxSizeBuggy = !support.scrollboxSize() && + styles.position === "absolute", + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-3991) + boxSizingNeeded = scrollboxSizeBuggy || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + subtract = extra ? + boxModelAdjustment( + elem, + dimension, + extra, + isBorderBox, + styles + ) : + 0; + + // Account for unreliable border-box dimensions by comparing offset* to computed and + // faking a content-box to get border and padding (gh-3699) + if ( isBorderBox && scrollboxSizeBuggy ) { + subtract -= Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + parseFloat( styles[ dimension ] ) - + boxModelAdjustment( elem, dimension, "border", false, styles ) - + 0.5 + ); + } + + // Convert to pixels if value adjustment is needed + if ( subtract && ( matches = rcssNum.exec( value ) ) && + ( matches[ 3 ] || "px" ) !== "px" ) { + + elem.style[ dimension ] = value; + value = jQuery.css( elem, dimension ); + } + + return setPositiveNumber( elem, value, subtract ); + } + }; +} ); + +jQuery.cssHooks.marginLeft = addGetHookIf( support.reliableMarginLeft, + function( elem, computed ) { + if ( computed ) { + return ( parseFloat( curCSS( elem, "marginLeft" ) ) || + elem.getBoundingClientRect().left - + swap( elem, { marginLeft: 0 }, function() { + return elem.getBoundingClientRect().left; + } ) + ) + "px"; + } + } +); + +// These hooks are used by animate to expand properties +jQuery.each( { + margin: "", + padding: "", + border: "Width" +}, function( prefix, suffix ) { + jQuery.cssHooks[ prefix + suffix ] = { + expand: function( value ) { + var i = 0, + expanded = {}, + + // Assumes a single number if not a string + parts = typeof value === "string" ? value.split( " " ) : [ value ]; + + for ( ; i < 4; i++ ) { + expanded[ prefix + cssExpand[ i ] + suffix ] = + parts[ i ] || parts[ i - 2 ] || parts[ 0 ]; + } + + return expanded; + } + }; + + if ( prefix !== "margin" ) { + jQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber; + } +} ); + +jQuery.fn.extend( { + css: function( name, value ) { + return access( this, function( elem, name, value ) { + var styles, len, + map = {}, + i = 0; + + if ( Array.isArray( name ) ) { + styles = getStyles( elem ); + len = name.length; + + for ( ; i < len; i++ ) { + map[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles ); + } + + return map; + } + + return value !== undefined ? + jQuery.style( elem, name, value ) : + jQuery.css( elem, name ); + }, name, value, arguments.length > 1 ); + } +} ); + + +function Tween( elem, options, prop, end, easing ) { + return new Tween.prototype.init( elem, options, prop, end, easing ); +} +jQuery.Tween = Tween; + +Tween.prototype = { + constructor: Tween, + init: function( elem, options, prop, end, easing, unit ) { + this.elem = elem; + this.prop = prop; + this.easing = easing || jQuery.easing._default; + this.options = options; + this.start = this.now = this.cur(); + this.end = end; + this.unit = unit || ( jQuery.cssNumber[ prop ] ? "" : "px" ); + }, + cur: function() { + var hooks = Tween.propHooks[ this.prop ]; + + return hooks && hooks.get ? + hooks.get( this ) : + Tween.propHooks._default.get( this ); + }, + run: function( percent ) { + var eased, + hooks = Tween.propHooks[ this.prop ]; + + if ( this.options.duration ) { + this.pos = eased = jQuery.easing[ this.easing ]( + percent, this.options.duration * percent, 0, 1, this.options.duration + ); + } else { + this.pos = eased = percent; + } + this.now = ( this.end - this.start ) * eased + this.start; + + if ( this.options.step ) { + this.options.step.call( this.elem, this.now, this ); + } + + if ( hooks && hooks.set ) { + hooks.set( this ); + } else { + Tween.propHooks._default.set( this ); + } + return this; + } +}; + +Tween.prototype.init.prototype = Tween.prototype; + +Tween.propHooks = { + _default: { + get: function( tween ) { + var result; + + // Use a property on the element directly when it is not a DOM element, + // or when there is no matching style property that exists. + if ( tween.elem.nodeType !== 1 || + tween.elem[ tween.prop ] != null && tween.elem.style[ tween.prop ] == null ) { + return tween.elem[ tween.prop ]; + } + + // Passing an empty string as a 3rd parameter to .css will automatically + // attempt a parseFloat and fallback to a string if the parse fails. + // Simple values such as "10px" are parsed to Float; + // complex values such as "rotate(1rad)" are returned as-is. + result = jQuery.css( tween.elem, tween.prop, "" ); + + // Empty strings, null, undefined and "auto" are converted to 0. + return !result || result === "auto" ? 0 : result; + }, + set: function( tween ) { + + // Use step hook for back compat. + // Use cssHook if its there. + // Use .style if available and use plain properties where available. + if ( jQuery.fx.step[ tween.prop ] ) { + jQuery.fx.step[ tween.prop ]( tween ); + } else if ( tween.elem.nodeType === 1 && ( + jQuery.cssHooks[ tween.prop ] || + tween.elem.style[ finalPropName( tween.prop ) ] != null ) ) { + jQuery.style( tween.elem, tween.prop, tween.now + tween.unit ); + } else { + tween.elem[ tween.prop ] = tween.now; + } + } + } +}; + +// Support: IE <=9 only +// Panic based approach to setting things on disconnected nodes +Tween.propHooks.scrollTop = Tween.propHooks.scrollLeft = { + set: function( tween ) { + if ( tween.elem.nodeType && tween.elem.parentNode ) { + tween.elem[ tween.prop ] = tween.now; + } + } +}; + +jQuery.easing = { + linear: function( p ) { + return p; + }, + swing: function( p ) { + return 0.5 - Math.cos( p * Math.PI ) / 2; + }, + _default: "swing" +}; + +jQuery.fx = Tween.prototype.init; + +// Back compat <1.8 extension point +jQuery.fx.step = {}; + + + + +var + fxNow, inProgress, + rfxtypes = /^(?:toggle|show|hide)$/, + rrun = /queueHooks$/; + +function schedule() { + if ( inProgress ) { + if ( document.hidden === false && window.requestAnimationFrame ) { + window.requestAnimationFrame( schedule ); + } else { + window.setTimeout( schedule, jQuery.fx.interval ); + } + + jQuery.fx.tick(); + } +} + +// Animations created synchronously will run synchronously +function createFxNow() { + window.setTimeout( function() { + fxNow = undefined; + } ); + return ( fxNow = Date.now() ); +} + +// Generate parameters to create a standard animation +function genFx( type, includeWidth ) { + var which, + i = 0, + attrs = { height: type }; + + // If we include width, step value is 1 to do all cssExpand values, + // otherwise step value is 2 to skip over Left and Right + includeWidth = includeWidth ? 1 : 0; + for ( ; i < 4; i += 2 - includeWidth ) { + which = cssExpand[ i ]; + attrs[ "margin" + which ] = attrs[ "padding" + which ] = type; + } + + if ( includeWidth ) { + attrs.opacity = attrs.width = type; + } + + return attrs; +} + +function createTween( value, prop, animation ) { + var tween, + collection = ( Animation.tweeners[ prop ] || [] ).concat( Animation.tweeners[ "*" ] ), + index = 0, + length = collection.length; + for ( ; index < length; index++ ) { + if ( ( tween = collection[ index ].call( animation, prop, value ) ) ) { + + // We're done with this property + return tween; + } + } +} + +function defaultPrefilter( elem, props, opts ) { + var prop, value, toggle, hooks, oldfire, propTween, restoreDisplay, display, + isBox = "width" in props || "height" in props, + anim = this, + orig = {}, + style = elem.style, + hidden = elem.nodeType && isHiddenWithinTree( elem ), + dataShow = dataPriv.get( elem, "fxshow" ); + + // Queue-skipping animations hijack the fx hooks + if ( !opts.queue ) { + hooks = jQuery._queueHooks( elem, "fx" ); + if ( hooks.unqueued == null ) { + hooks.unqueued = 0; + oldfire = hooks.empty.fire; + hooks.empty.fire = function() { + if ( !hooks.unqueued ) { + oldfire(); + } + }; + } + hooks.unqueued++; + + anim.always( function() { + + // Ensure the complete handler is called before this completes + anim.always( function() { + hooks.unqueued--; + if ( !jQuery.queue( elem, "fx" ).length ) { + hooks.empty.fire(); + } + } ); + } ); + } + + // Detect show/hide animations + for ( prop in props ) { + value = props[ prop ]; + if ( rfxtypes.test( value ) ) { + delete props[ prop ]; + toggle = toggle || value === "toggle"; + if ( value === ( hidden ? "hide" : "show" ) ) { + + // Pretend to be hidden if this is a "show" and + // there is still data from a stopped show/hide + if ( value === "show" && dataShow && dataShow[ prop ] !== undefined ) { + hidden = true; + + // Ignore all other no-op show/hide data + } else { + continue; + } + } + orig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop ); + } + } + + // Bail out if this is a no-op like .hide().hide() + propTween = !jQuery.isEmptyObject( props ); + if ( !propTween && jQuery.isEmptyObject( orig ) ) { + return; + } + + // Restrict "overflow" and "display" styles during box animations + if ( isBox && elem.nodeType === 1 ) { + + // Support: IE <=9 - 11, Edge 12 - 15 + // Record all 3 overflow attributes because IE does not infer the shorthand + // from identically-valued overflowX and overflowY and Edge just mirrors + // the overflowX value there. + opts.overflow = [ style.overflow, style.overflowX, style.overflowY ]; + + // Identify a display type, preferring old show/hide data over the CSS cascade + restoreDisplay = dataShow && dataShow.display; + if ( restoreDisplay == null ) { + restoreDisplay = dataPriv.get( elem, "display" ); + } + display = jQuery.css( elem, "display" ); + if ( display === "none" ) { + if ( restoreDisplay ) { + display = restoreDisplay; + } else { + + // Get nonempty value(s) by temporarily forcing visibility + showHide( [ elem ], true ); + restoreDisplay = elem.style.display || restoreDisplay; + display = jQuery.css( elem, "display" ); + showHide( [ elem ] ); + } + } + + // Animate inline elements as inline-block + if ( display === "inline" || display === "inline-block" && restoreDisplay != null ) { + if ( jQuery.css( elem, "float" ) === "none" ) { + + // Restore the original display value at the end of pure show/hide animations + if ( !propTween ) { + anim.done( function() { + style.display = restoreDisplay; + } ); + if ( restoreDisplay == null ) { + display = style.display; + restoreDisplay = display === "none" ? "" : display; + } + } + style.display = "inline-block"; + } + } + } + + if ( opts.overflow ) { + style.overflow = "hidden"; + anim.always( function() { + style.overflow = opts.overflow[ 0 ]; + style.overflowX = opts.overflow[ 1 ]; + style.overflowY = opts.overflow[ 2 ]; + } ); + } + + // Implement show/hide animations + propTween = false; + for ( prop in orig ) { + + // General show/hide setup for this element animation + if ( !propTween ) { + if ( dataShow ) { + if ( "hidden" in dataShow ) { + hidden = dataShow.hidden; + } + } else { + dataShow = dataPriv.access( elem, "fxshow", { display: restoreDisplay } ); + } + + // Store hidden/visible for toggle so `.stop().toggle()` "reverses" + if ( toggle ) { + dataShow.hidden = !hidden; + } + + // Show elements before animating them + if ( hidden ) { + showHide( [ elem ], true ); + } + + /* eslint-disable no-loop-func */ + + anim.done( function() { + + /* eslint-enable no-loop-func */ + + // The final step of a "hide" animation is actually hiding the element + if ( !hidden ) { + showHide( [ elem ] ); + } + dataPriv.remove( elem, "fxshow" ); + for ( prop in orig ) { + jQuery.style( elem, prop, orig[ prop ] ); + } + } ); + } + + // Per-property setup + propTween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim ); + if ( !( prop in dataShow ) ) { + dataShow[ prop ] = propTween.start; + if ( hidden ) { + propTween.end = propTween.start; + propTween.start = 0; + } + } + } +} + +function propFilter( props, specialEasing ) { + var index, name, easing, value, hooks; + + // camelCase, specialEasing and expand cssHook pass + for ( index in props ) { + name = camelCase( index ); + easing = specialEasing[ name ]; + value = props[ index ]; + if ( Array.isArray( value ) ) { + easing = value[ 1 ]; + value = props[ index ] = value[ 0 ]; + } + + if ( index !== name ) { + props[ name ] = value; + delete props[ index ]; + } + + hooks = jQuery.cssHooks[ name ]; + if ( hooks && "expand" in hooks ) { + value = hooks.expand( value ); + delete props[ name ]; + + // Not quite $.extend, this won't overwrite existing keys. + // Reusing 'index' because we have the correct "name" + for ( index in value ) { + if ( !( index in props ) ) { + props[ index ] = value[ index ]; + specialEasing[ index ] = easing; + } + } + } else { + specialEasing[ name ] = easing; + } + } +} + +function Animation( elem, properties, options ) { + var result, + stopped, + index = 0, + length = Animation.prefilters.length, + deferred = jQuery.Deferred().always( function() { + + // Don't match elem in the :animated selector + delete tick.elem; + } ), + tick = function() { + if ( stopped ) { + return false; + } + var currentTime = fxNow || createFxNow(), + remaining = Math.max( 0, animation.startTime + animation.duration - currentTime ), + + // Support: Android 2.3 only + // Archaic crash bug won't allow us to use `1 - ( 0.5 || 0 )` (#12497) + temp = remaining / animation.duration || 0, + percent = 1 - temp, + index = 0, + length = animation.tweens.length; + + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( percent ); + } + + deferred.notifyWith( elem, [ animation, percent, remaining ] ); + + // If there's more to do, yield + if ( percent < 1 && length ) { + return remaining; + } + + // If this was an empty animation, synthesize a final progress notification + if ( !length ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + } + + // Resolve the animation and report its conclusion + deferred.resolveWith( elem, [ animation ] ); + return false; + }, + animation = deferred.promise( { + elem: elem, + props: jQuery.extend( {}, properties ), + opts: jQuery.extend( true, { + specialEasing: {}, + easing: jQuery.easing._default + }, options ), + originalProperties: properties, + originalOptions: options, + startTime: fxNow || createFxNow(), + duration: options.duration, + tweens: [], + createTween: function( prop, end ) { + var tween = jQuery.Tween( elem, animation.opts, prop, end, + animation.opts.specialEasing[ prop ] || animation.opts.easing ); + animation.tweens.push( tween ); + return tween; + }, + stop: function( gotoEnd ) { + var index = 0, + + // If we are going to the end, we want to run all the tweens + // otherwise we skip this part + length = gotoEnd ? animation.tweens.length : 0; + if ( stopped ) { + return this; + } + stopped = true; + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( 1 ); + } + + // Resolve when we played the last frame; otherwise, reject + if ( gotoEnd ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + deferred.resolveWith( elem, [ animation, gotoEnd ] ); + } else { + deferred.rejectWith( elem, [ animation, gotoEnd ] ); + } + return this; + } + } ), + props = animation.props; + + propFilter( props, animation.opts.specialEasing ); + + for ( ; index < length; index++ ) { + result = Animation.prefilters[ index ].call( animation, elem, props, animation.opts ); + if ( result ) { + if ( isFunction( result.stop ) ) { + jQuery._queueHooks( animation.elem, animation.opts.queue ).stop = + result.stop.bind( result ); + } + return result; + } + } + + jQuery.map( props, createTween, animation ); + + if ( isFunction( animation.opts.start ) ) { + animation.opts.start.call( elem, animation ); + } + + // Attach callbacks from options + animation + .progress( animation.opts.progress ) + .done( animation.opts.done, animation.opts.complete ) + .fail( animation.opts.fail ) + .always( animation.opts.always ); + + jQuery.fx.timer( + jQuery.extend( tick, { + elem: elem, + anim: animation, + queue: animation.opts.queue + } ) + ); + + return animation; +} + +jQuery.Animation = jQuery.extend( Animation, { + + tweeners: { + "*": [ function( prop, value ) { + var tween = this.createTween( prop, value ); + adjustCSS( tween.elem, prop, rcssNum.exec( value ), tween ); + return tween; + } ] + }, + + tweener: function( props, callback ) { + if ( isFunction( props ) ) { + callback = props; + props = [ "*" ]; + } else { + props = props.match( rnothtmlwhite ); + } + + var prop, + index = 0, + length = props.length; + + for ( ; index < length; index++ ) { + prop = props[ index ]; + Animation.tweeners[ prop ] = Animation.tweeners[ prop ] || []; + Animation.tweeners[ prop ].unshift( callback ); + } + }, + + prefilters: [ defaultPrefilter ], + + prefilter: function( callback, prepend ) { + if ( prepend ) { + Animation.prefilters.unshift( callback ); + } else { + Animation.prefilters.push( callback ); + } + } +} ); + +jQuery.speed = function( speed, easing, fn ) { + var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : { + complete: fn || !fn && easing || + isFunction( speed ) && speed, + duration: speed, + easing: fn && easing || easing && !isFunction( easing ) && easing + }; + + // Go to the end state if fx are off + if ( jQuery.fx.off ) { + opt.duration = 0; + + } else { + if ( typeof opt.duration !== "number" ) { + if ( opt.duration in jQuery.fx.speeds ) { + opt.duration = jQuery.fx.speeds[ opt.duration ]; + + } else { + opt.duration = jQuery.fx.speeds._default; + } + } + } + + // Normalize opt.queue - true/undefined/null -> "fx" + if ( opt.queue == null || opt.queue === true ) { + opt.queue = "fx"; + } + + // Queueing + opt.old = opt.complete; + + opt.complete = function() { + if ( isFunction( opt.old ) ) { + opt.old.call( this ); + } + + if ( opt.queue ) { + jQuery.dequeue( this, opt.queue ); + } + }; + + return opt; +}; + +jQuery.fn.extend( { + fadeTo: function( speed, to, easing, callback ) { + + // Show any hidden elements after setting opacity to 0 + return this.filter( isHiddenWithinTree ).css( "opacity", 0 ).show() + + // Animate to the value specified + .end().animate( { opacity: to }, speed, easing, callback ); + }, + animate: function( prop, speed, easing, callback ) { + var empty = jQuery.isEmptyObject( prop ), + optall = jQuery.speed( speed, easing, callback ), + doAnimation = function() { + + // Operate on a copy of prop so per-property easing won't be lost + var anim = Animation( this, jQuery.extend( {}, prop ), optall ); + + // Empty animations, or finishing resolves immediately + if ( empty || dataPriv.get( this, "finish" ) ) { + anim.stop( true ); + } + }; + doAnimation.finish = doAnimation; + + return empty || optall.queue === false ? + this.each( doAnimation ) : + this.queue( optall.queue, doAnimation ); + }, + stop: function( type, clearQueue, gotoEnd ) { + var stopQueue = function( hooks ) { + var stop = hooks.stop; + delete hooks.stop; + stop( gotoEnd ); + }; + + if ( typeof type !== "string" ) { + gotoEnd = clearQueue; + clearQueue = type; + type = undefined; + } + if ( clearQueue ) { + this.queue( type || "fx", [] ); + } + + return this.each( function() { + var dequeue = true, + index = type != null && type + "queueHooks", + timers = jQuery.timers, + data = dataPriv.get( this ); + + if ( index ) { + if ( data[ index ] && data[ index ].stop ) { + stopQueue( data[ index ] ); + } + } else { + for ( index in data ) { + if ( data[ index ] && data[ index ].stop && rrun.test( index ) ) { + stopQueue( data[ index ] ); + } + } + } + + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && + ( type == null || timers[ index ].queue === type ) ) { + + timers[ index ].anim.stop( gotoEnd ); + dequeue = false; + timers.splice( index, 1 ); + } + } + + // Start the next in the queue if the last step wasn't forced. + // Timers currently will call their complete callbacks, which + // will dequeue but only if they were gotoEnd. + if ( dequeue || !gotoEnd ) { + jQuery.dequeue( this, type ); + } + } ); + }, + finish: function( type ) { + if ( type !== false ) { + type = type || "fx"; + } + return this.each( function() { + var index, + data = dataPriv.get( this ), + queue = data[ type + "queue" ], + hooks = data[ type + "queueHooks" ], + timers = jQuery.timers, + length = queue ? queue.length : 0; + + // Enable finishing flag on private data + data.finish = true; + + // Empty the queue first + jQuery.queue( this, type, [] ); + + if ( hooks && hooks.stop ) { + hooks.stop.call( this, true ); + } + + // Look for any active animations, and finish them + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && timers[ index ].queue === type ) { + timers[ index ].anim.stop( true ); + timers.splice( index, 1 ); + } + } + + // Look for any animations in the old queue and finish them + for ( index = 0; index < length; index++ ) { + if ( queue[ index ] && queue[ index ].finish ) { + queue[ index ].finish.call( this ); + } + } + + // Turn off finishing flag + delete data.finish; + } ); + } +} ); + +jQuery.each( [ "toggle", "show", "hide" ], function( _i, name ) { + var cssFn = jQuery.fn[ name ]; + jQuery.fn[ name ] = function( speed, easing, callback ) { + return speed == null || typeof speed === "boolean" ? + cssFn.apply( this, arguments ) : + this.animate( genFx( name, true ), speed, easing, callback ); + }; +} ); + +// Generate shortcuts for custom animations +jQuery.each( { + slideDown: genFx( "show" ), + slideUp: genFx( "hide" ), + slideToggle: genFx( "toggle" ), + fadeIn: { opacity: "show" }, + fadeOut: { opacity: "hide" }, + fadeToggle: { opacity: "toggle" } +}, function( name, props ) { + jQuery.fn[ name ] = function( speed, easing, callback ) { + return this.animate( props, speed, easing, callback ); + }; +} ); + +jQuery.timers = []; +jQuery.fx.tick = function() { + var timer, + i = 0, + timers = jQuery.timers; + + fxNow = Date.now(); + + for ( ; i < timers.length; i++ ) { + timer = timers[ i ]; + + // Run the timer and safely remove it when done (allowing for external removal) + if ( !timer() && timers[ i ] === timer ) { + timers.splice( i--, 1 ); + } + } + + if ( !timers.length ) { + jQuery.fx.stop(); + } + fxNow = undefined; +}; + +jQuery.fx.timer = function( timer ) { + jQuery.timers.push( timer ); + jQuery.fx.start(); +}; + +jQuery.fx.interval = 13; +jQuery.fx.start = function() { + if ( inProgress ) { + return; + } + + inProgress = true; + schedule(); +}; + +jQuery.fx.stop = function() { + inProgress = null; +}; + +jQuery.fx.speeds = { + slow: 600, + fast: 200, + + // Default speed + _default: 400 +}; + + +// Based off of the plugin by Clint Helfers, with permission. +// https://web.archive.org/web/20100324014747/http://blindsignals.com/index.php/2009/07/jquery-delay/ +jQuery.fn.delay = function( time, type ) { + time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time; + type = type || "fx"; + + return this.queue( type, function( next, hooks ) { + var timeout = window.setTimeout( next, time ); + hooks.stop = function() { + window.clearTimeout( timeout ); + }; + } ); +}; + + +( function() { + var input = document.createElement( "input" ), + select = document.createElement( "select" ), + opt = select.appendChild( document.createElement( "option" ) ); + + input.type = "checkbox"; + + // Support: Android <=4.3 only + // Default value for a checkbox should be "on" + support.checkOn = input.value !== ""; + + // Support: IE <=11 only + // Must access selectedIndex to make default options select + support.optSelected = opt.selected; + + // Support: IE <=11 only + // An input loses its value after becoming a radio + input = document.createElement( "input" ); + input.value = "t"; + input.type = "radio"; + support.radioValue = input.value === "t"; +} )(); + + +var boolHook, + attrHandle = jQuery.expr.attrHandle; + +jQuery.fn.extend( { + attr: function( name, value ) { + return access( this, jQuery.attr, name, value, arguments.length > 1 ); + }, + + removeAttr: function( name ) { + return this.each( function() { + jQuery.removeAttr( this, name ); + } ); + } +} ); + +jQuery.extend( { + attr: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set attributes on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + // Fallback to prop when attributes are not supported + if ( typeof elem.getAttribute === "undefined" ) { + return jQuery.prop( elem, name, value ); + } + + // Attribute hooks are determined by the lowercase version + // Grab necessary hook if one is defined + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + hooks = jQuery.attrHooks[ name.toLowerCase() ] || + ( jQuery.expr.match.bool.test( name ) ? boolHook : undefined ); + } + + if ( value !== undefined ) { + if ( value === null ) { + jQuery.removeAttr( elem, name ); + return; + } + + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + elem.setAttribute( name, value + "" ); + return value; + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + ret = jQuery.find.attr( elem, name ); + + // Non-existent attributes return null, we normalize to undefined + return ret == null ? undefined : ret; + }, + + attrHooks: { + type: { + set: function( elem, value ) { + if ( !support.radioValue && value === "radio" && + nodeName( elem, "input" ) ) { + var val = elem.value; + elem.setAttribute( "type", value ); + if ( val ) { + elem.value = val; + } + return value; + } + } + } + }, + + removeAttr: function( elem, value ) { + var name, + i = 0, + + // Attribute names can contain non-HTML whitespace characters + // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2 + attrNames = value && value.match( rnothtmlwhite ); + + if ( attrNames && elem.nodeType === 1 ) { + while ( ( name = attrNames[ i++ ] ) ) { + elem.removeAttribute( name ); + } + } + } +} ); + +// Hooks for boolean attributes +boolHook = { + set: function( elem, value, name ) { + if ( value === false ) { + + // Remove boolean attributes when set to false + jQuery.removeAttr( elem, name ); + } else { + elem.setAttribute( name, name ); + } + return name; + } +}; + +jQuery.each( jQuery.expr.match.bool.source.match( /\w+/g ), function( _i, name ) { + var getter = attrHandle[ name ] || jQuery.find.attr; + + attrHandle[ name ] = function( elem, name, isXML ) { + var ret, handle, + lowercaseName = name.toLowerCase(); + + if ( !isXML ) { + + // Avoid an infinite loop by temporarily removing this function from the getter + handle = attrHandle[ lowercaseName ]; + attrHandle[ lowercaseName ] = ret; + ret = getter( elem, name, isXML ) != null ? + lowercaseName : + null; + attrHandle[ lowercaseName ] = handle; + } + return ret; + }; +} ); + + + + +var rfocusable = /^(?:input|select|textarea|button)$/i, + rclickable = /^(?:a|area)$/i; + +jQuery.fn.extend( { + prop: function( name, value ) { + return access( this, jQuery.prop, name, value, arguments.length > 1 ); + }, + + removeProp: function( name ) { + return this.each( function() { + delete this[ jQuery.propFix[ name ] || name ]; + } ); + } +} ); + +jQuery.extend( { + prop: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set properties on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + + // Fix name and attach hooks + name = jQuery.propFix[ name ] || name; + hooks = jQuery.propHooks[ name ]; + } + + if ( value !== undefined ) { + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + return ( elem[ name ] = value ); + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + return elem[ name ]; + }, + + propHooks: { + tabIndex: { + get: function( elem ) { + + // Support: IE <=9 - 11 only + // elem.tabIndex doesn't always return the + // correct value when it hasn't been explicitly set + // https://web.archive.org/web/20141116233347/http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/ + // Use proper attribute retrieval(#12072) + var tabindex = jQuery.find.attr( elem, "tabindex" ); + + if ( tabindex ) { + return parseInt( tabindex, 10 ); + } + + if ( + rfocusable.test( elem.nodeName ) || + rclickable.test( elem.nodeName ) && + elem.href + ) { + return 0; + } + + return -1; + } + } + }, + + propFix: { + "for": "htmlFor", + "class": "className" + } +} ); + +// Support: IE <=11 only +// Accessing the selectedIndex property +// forces the browser to respect setting selected +// on the option +// The getter ensures a default option is selected +// when in an optgroup +// eslint rule "no-unused-expressions" is disabled for this code +// since it considers such accessions noop +if ( !support.optSelected ) { + jQuery.propHooks.selected = { + get: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent && parent.parentNode ) { + parent.parentNode.selectedIndex; + } + return null; + }, + set: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent ) { + parent.selectedIndex; + + if ( parent.parentNode ) { + parent.parentNode.selectedIndex; + } + } + } + }; +} + +jQuery.each( [ + "tabIndex", + "readOnly", + "maxLength", + "cellSpacing", + "cellPadding", + "rowSpan", + "colSpan", + "useMap", + "frameBorder", + "contentEditable" +], function() { + jQuery.propFix[ this.toLowerCase() ] = this; +} ); + + + + + // Strip and collapse whitespace according to HTML spec + // https://infra.spec.whatwg.org/#strip-and-collapse-ascii-whitespace + function stripAndCollapse( value ) { + var tokens = value.match( rnothtmlwhite ) || []; + return tokens.join( " " ); + } + + +function getClass( elem ) { + return elem.getAttribute && elem.getAttribute( "class" ) || ""; +} + +function classesToArray( value ) { + if ( Array.isArray( value ) ) { + return value; + } + if ( typeof value === "string" ) { + return value.match( rnothtmlwhite ) || []; + } + return []; +} + +jQuery.fn.extend( { + addClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).addClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + if ( cur.indexOf( " " + clazz + " " ) < 0 ) { + cur += clazz + " "; + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + removeClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).removeClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + if ( !arguments.length ) { + return this.attr( "class", "" ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + + // This expression is here for better compressibility (see addClass) + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + + // Remove *all* instances + while ( cur.indexOf( " " + clazz + " " ) > -1 ) { + cur = cur.replace( " " + clazz + " ", " " ); + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + toggleClass: function( value, stateVal ) { + var type = typeof value, + isValidValue = type === "string" || Array.isArray( value ); + + if ( typeof stateVal === "boolean" && isValidValue ) { + return stateVal ? this.addClass( value ) : this.removeClass( value ); + } + + if ( isFunction( value ) ) { + return this.each( function( i ) { + jQuery( this ).toggleClass( + value.call( this, i, getClass( this ), stateVal ), + stateVal + ); + } ); + } + + return this.each( function() { + var className, i, self, classNames; + + if ( isValidValue ) { + + // Toggle individual class names + i = 0; + self = jQuery( this ); + classNames = classesToArray( value ); + + while ( ( className = classNames[ i++ ] ) ) { + + // Check each className given, space separated list + if ( self.hasClass( className ) ) { + self.removeClass( className ); + } else { + self.addClass( className ); + } + } + + // Toggle whole class name + } else if ( value === undefined || type === "boolean" ) { + className = getClass( this ); + if ( className ) { + + // Store className if set + dataPriv.set( this, "__className__", className ); + } + + // If the element has a class name or if we're passed `false`, + // then remove the whole classname (if there was one, the above saved it). + // Otherwise bring back whatever was previously saved (if anything), + // falling back to the empty string if nothing was stored. + if ( this.setAttribute ) { + this.setAttribute( "class", + className || value === false ? + "" : + dataPriv.get( this, "__className__" ) || "" + ); + } + } + } ); + }, + + hasClass: function( selector ) { + var className, elem, + i = 0; + + className = " " + selector + " "; + while ( ( elem = this[ i++ ] ) ) { + if ( elem.nodeType === 1 && + ( " " + stripAndCollapse( getClass( elem ) ) + " " ).indexOf( className ) > -1 ) { + return true; + } + } + + return false; + } +} ); + + + + +var rreturn = /\r/g; + +jQuery.fn.extend( { + val: function( value ) { + var hooks, ret, valueIsFunction, + elem = this[ 0 ]; + + if ( !arguments.length ) { + if ( elem ) { + hooks = jQuery.valHooks[ elem.type ] || + jQuery.valHooks[ elem.nodeName.toLowerCase() ]; + + if ( hooks && + "get" in hooks && + ( ret = hooks.get( elem, "value" ) ) !== undefined + ) { + return ret; + } + + ret = elem.value; + + // Handle most common string cases + if ( typeof ret === "string" ) { + return ret.replace( rreturn, "" ); + } + + // Handle cases where value is null/undef or number + return ret == null ? "" : ret; + } + + return; + } + + valueIsFunction = isFunction( value ); + + return this.each( function( i ) { + var val; + + if ( this.nodeType !== 1 ) { + return; + } + + if ( valueIsFunction ) { + val = value.call( this, i, jQuery( this ).val() ); + } else { + val = value; + } + + // Treat null/undefined as ""; convert numbers to string + if ( val == null ) { + val = ""; + + } else if ( typeof val === "number" ) { + val += ""; + + } else if ( Array.isArray( val ) ) { + val = jQuery.map( val, function( value ) { + return value == null ? "" : value + ""; + } ); + } + + hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ]; + + // If set returns undefined, fall back to normal setting + if ( !hooks || !( "set" in hooks ) || hooks.set( this, val, "value" ) === undefined ) { + this.value = val; + } + } ); + } +} ); + +jQuery.extend( { + valHooks: { + option: { + get: function( elem ) { + + var val = jQuery.find.attr( elem, "value" ); + return val != null ? + val : + + // Support: IE <=10 - 11 only + // option.text throws exceptions (#14686, #14858) + // Strip and collapse whitespace + // https://html.spec.whatwg.org/#strip-and-collapse-whitespace + stripAndCollapse( jQuery.text( elem ) ); + } + }, + select: { + get: function( elem ) { + var value, option, i, + options = elem.options, + index = elem.selectedIndex, + one = elem.type === "select-one", + values = one ? null : [], + max = one ? index + 1 : options.length; + + if ( index < 0 ) { + i = max; + + } else { + i = one ? index : 0; + } + + // Loop through all the selected options + for ( ; i < max; i++ ) { + option = options[ i ]; + + // Support: IE <=9 only + // IE8-9 doesn't update selected after form reset (#2551) + if ( ( option.selected || i === index ) && + + // Don't return options that are disabled or in a disabled optgroup + !option.disabled && + ( !option.parentNode.disabled || + !nodeName( option.parentNode, "optgroup" ) ) ) { + + // Get the specific value for the option + value = jQuery( option ).val(); + + // We don't need an array for one selects + if ( one ) { + return value; + } + + // Multi-Selects return an array + values.push( value ); + } + } + + return values; + }, + + set: function( elem, value ) { + var optionSet, option, + options = elem.options, + values = jQuery.makeArray( value ), + i = options.length; + + while ( i-- ) { + option = options[ i ]; + + /* eslint-disable no-cond-assign */ + + if ( option.selected = + jQuery.inArray( jQuery.valHooks.option.get( option ), values ) > -1 + ) { + optionSet = true; + } + + /* eslint-enable no-cond-assign */ + } + + // Force browsers to behave consistently when non-matching value is set + if ( !optionSet ) { + elem.selectedIndex = -1; + } + return values; + } + } + } +} ); + +// Radios and checkboxes getter/setter +jQuery.each( [ "radio", "checkbox" ], function() { + jQuery.valHooks[ this ] = { + set: function( elem, value ) { + if ( Array.isArray( value ) ) { + return ( elem.checked = jQuery.inArray( jQuery( elem ).val(), value ) > -1 ); + } + } + }; + if ( !support.checkOn ) { + jQuery.valHooks[ this ].get = function( elem ) { + return elem.getAttribute( "value" ) === null ? "on" : elem.value; + }; + } +} ); + + + + +// Return jQuery for attributes-only inclusion + + +support.focusin = "onfocusin" in window; + + +var rfocusMorph = /^(?:focusinfocus|focusoutblur)$/, + stopPropagationCallback = function( e ) { + e.stopPropagation(); + }; + +jQuery.extend( jQuery.event, { + + trigger: function( event, data, elem, onlyHandlers ) { + + var i, cur, tmp, bubbleType, ontype, handle, special, lastElement, + eventPath = [ elem || document ], + type = hasOwn.call( event, "type" ) ? event.type : event, + namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split( "." ) : []; + + cur = lastElement = tmp = elem = elem || document; + + // Don't do events on text and comment nodes + if ( elem.nodeType === 3 || elem.nodeType === 8 ) { + return; + } + + // focus/blur morphs to focusin/out; ensure we're not firing them right now + if ( rfocusMorph.test( type + jQuery.event.triggered ) ) { + return; + } + + if ( type.indexOf( "." ) > -1 ) { + + // Namespaced trigger; create a regexp to match event type in handle() + namespaces = type.split( "." ); + type = namespaces.shift(); + namespaces.sort(); + } + ontype = type.indexOf( ":" ) < 0 && "on" + type; + + // Caller can pass in a jQuery.Event object, Object, or just an event type string + event = event[ jQuery.expando ] ? + event : + new jQuery.Event( type, typeof event === "object" && event ); + + // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true) + event.isTrigger = onlyHandlers ? 2 : 3; + event.namespace = namespaces.join( "." ); + event.rnamespace = event.namespace ? + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ) : + null; + + // Clean up the event in case it is being reused + event.result = undefined; + if ( !event.target ) { + event.target = elem; + } + + // Clone any incoming data and prepend the event, creating the handler arg list + data = data == null ? + [ event ] : + jQuery.makeArray( data, [ event ] ); + + // Allow special events to draw outside the lines + special = jQuery.event.special[ type ] || {}; + if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) { + return; + } + + // Determine event propagation path in advance, per W3C events spec (#9951) + // Bubble up to document, then to window; watch for a global ownerDocument var (#9724) + if ( !onlyHandlers && !special.noBubble && !isWindow( elem ) ) { + + bubbleType = special.delegateType || type; + if ( !rfocusMorph.test( bubbleType + type ) ) { + cur = cur.parentNode; + } + for ( ; cur; cur = cur.parentNode ) { + eventPath.push( cur ); + tmp = cur; + } + + // Only add window if we got to document (e.g., not plain obj or detached DOM) + if ( tmp === ( elem.ownerDocument || document ) ) { + eventPath.push( tmp.defaultView || tmp.parentWindow || window ); + } + } + + // Fire handlers on the event path + i = 0; + while ( ( cur = eventPath[ i++ ] ) && !event.isPropagationStopped() ) { + lastElement = cur; + event.type = i > 1 ? + bubbleType : + special.bindType || type; + + // jQuery handler + handle = ( + dataPriv.get( cur, "events" ) || Object.create( null ) + )[ event.type ] && + dataPriv.get( cur, "handle" ); + if ( handle ) { + handle.apply( cur, data ); + } + + // Native handler + handle = ontype && cur[ ontype ]; + if ( handle && handle.apply && acceptData( cur ) ) { + event.result = handle.apply( cur, data ); + if ( event.result === false ) { + event.preventDefault(); + } + } + } + event.type = type; + + // If nobody prevented the default action, do it now + if ( !onlyHandlers && !event.isDefaultPrevented() ) { + + if ( ( !special._default || + special._default.apply( eventPath.pop(), data ) === false ) && + acceptData( elem ) ) { + + // Call a native DOM method on the target with the same name as the event. + // Don't do default actions on window, that's where global variables be (#6170) + if ( ontype && isFunction( elem[ type ] ) && !isWindow( elem ) ) { + + // Don't re-trigger an onFOO event when we call its FOO() method + tmp = elem[ ontype ]; + + if ( tmp ) { + elem[ ontype ] = null; + } + + // Prevent re-triggering of the same event, since we already bubbled it above + jQuery.event.triggered = type; + + if ( event.isPropagationStopped() ) { + lastElement.addEventListener( type, stopPropagationCallback ); + } + + elem[ type ](); + + if ( event.isPropagationStopped() ) { + lastElement.removeEventListener( type, stopPropagationCallback ); + } + + jQuery.event.triggered = undefined; + + if ( tmp ) { + elem[ ontype ] = tmp; + } + } + } + } + + return event.result; + }, + + // Piggyback on a donor event to simulate a different one + // Used only for `focus(in | out)` events + simulate: function( type, elem, event ) { + var e = jQuery.extend( + new jQuery.Event(), + event, + { + type: type, + isSimulated: true + } + ); + + jQuery.event.trigger( e, null, elem ); + } + +} ); + +jQuery.fn.extend( { + + trigger: function( type, data ) { + return this.each( function() { + jQuery.event.trigger( type, data, this ); + } ); + }, + triggerHandler: function( type, data ) { + var elem = this[ 0 ]; + if ( elem ) { + return jQuery.event.trigger( type, data, elem, true ); + } + } +} ); + + +// Support: Firefox <=44 +// Firefox doesn't have focus(in | out) events +// Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787 +// +// Support: Chrome <=48 - 49, Safari <=9.0 - 9.1 +// focus(in | out) events fire after focus & blur events, +// which is spec violation - http://www.w3.org/TR/DOM-Level-3-Events/#events-focusevent-event-order +// Related ticket - https://bugs.chromium.org/p/chromium/issues/detail?id=449857 +if ( !support.focusin ) { + jQuery.each( { focus: "focusin", blur: "focusout" }, function( orig, fix ) { + + // Attach a single capturing handler on the document while someone wants focusin/focusout + var handler = function( event ) { + jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ) ); + }; + + jQuery.event.special[ fix ] = { + setup: function() { + + // Handle: regular nodes (via `this.ownerDocument`), window + // (via `this.document`) & document (via `this`). + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ); + + if ( !attaches ) { + doc.addEventListener( orig, handler, true ); + } + dataPriv.access( doc, fix, ( attaches || 0 ) + 1 ); + }, + teardown: function() { + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ) - 1; + + if ( !attaches ) { + doc.removeEventListener( orig, handler, true ); + dataPriv.remove( doc, fix ); + + } else { + dataPriv.access( doc, fix, attaches ); + } + } + }; + } ); +} +var location = window.location; + +var nonce = { guid: Date.now() }; + +var rquery = ( /\?/ ); + + + +// Cross-browser xml parsing +jQuery.parseXML = function( data ) { + var xml; + if ( !data || typeof data !== "string" ) { + return null; + } + + // Support: IE 9 - 11 only + // IE throws on parseFromString with invalid input. + try { + xml = ( new window.DOMParser() ).parseFromString( data, "text/xml" ); + } catch ( e ) { + xml = undefined; + } + + if ( !xml || xml.getElementsByTagName( "parsererror" ).length ) { + jQuery.error( "Invalid XML: " + data ); + } + return xml; +}; + + +var + rbracket = /\[\]$/, + rCRLF = /\r?\n/g, + rsubmitterTypes = /^(?:submit|button|image|reset|file)$/i, + rsubmittable = /^(?:input|select|textarea|keygen)/i; + +function buildParams( prefix, obj, traditional, add ) { + var name; + + if ( Array.isArray( obj ) ) { + + // Serialize array item. + jQuery.each( obj, function( i, v ) { + if ( traditional || rbracket.test( prefix ) ) { + + // Treat each array item as a scalar. + add( prefix, v ); + + } else { + + // Item is non-scalar (array or object), encode its numeric index. + buildParams( + prefix + "[" + ( typeof v === "object" && v != null ? i : "" ) + "]", + v, + traditional, + add + ); + } + } ); + + } else if ( !traditional && toType( obj ) === "object" ) { + + // Serialize object item. + for ( name in obj ) { + buildParams( prefix + "[" + name + "]", obj[ name ], traditional, add ); + } + + } else { + + // Serialize scalar item. + add( prefix, obj ); + } +} + +// Serialize an array of form elements or a set of +// key/values into a query string +jQuery.param = function( a, traditional ) { + var prefix, + s = [], + add = function( key, valueOrFunction ) { + + // If value is a function, invoke it and use its return value + var value = isFunction( valueOrFunction ) ? + valueOrFunction() : + valueOrFunction; + + s[ s.length ] = encodeURIComponent( key ) + "=" + + encodeURIComponent( value == null ? "" : value ); + }; + + if ( a == null ) { + return ""; + } + + // If an array was passed in, assume that it is an array of form elements. + if ( Array.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) { + + // Serialize the form elements + jQuery.each( a, function() { + add( this.name, this.value ); + } ); + + } else { + + // If traditional, encode the "old" way (the way 1.3.2 or older + // did it), otherwise encode params recursively. + for ( prefix in a ) { + buildParams( prefix, a[ prefix ], traditional, add ); + } + } + + // Return the resulting serialization + return s.join( "&" ); +}; + +jQuery.fn.extend( { + serialize: function() { + return jQuery.param( this.serializeArray() ); + }, + serializeArray: function() { + return this.map( function() { + + // Can add propHook for "elements" to filter or add form elements + var elements = jQuery.prop( this, "elements" ); + return elements ? jQuery.makeArray( elements ) : this; + } ) + .filter( function() { + var type = this.type; + + // Use .is( ":disabled" ) so that fieldset[disabled] works + return this.name && !jQuery( this ).is( ":disabled" ) && + rsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) && + ( this.checked || !rcheckableType.test( type ) ); + } ) + .map( function( _i, elem ) { + var val = jQuery( this ).val(); + + if ( val == null ) { + return null; + } + + if ( Array.isArray( val ) ) { + return jQuery.map( val, function( val ) { + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ); + } + + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ).get(); + } +} ); + + +var + r20 = /%20/g, + rhash = /#.*$/, + rantiCache = /([?&])_=[^&]*/, + rheaders = /^(.*?):[ \t]*([^\r\n]*)$/mg, + + // #7653, #8125, #8152: local protocol detection + rlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/, + rnoContent = /^(?:GET|HEAD)$/, + rprotocol = /^\/\//, + + /* Prefilters + * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example) + * 2) These are called: + * - BEFORE asking for a transport + * - AFTER param serialization (s.data is a string if s.processData is true) + * 3) key is the dataType + * 4) the catchall symbol "*" can be used + * 5) execution will start with transport dataType and THEN continue down to "*" if needed + */ + prefilters = {}, + + /* Transports bindings + * 1) key is the dataType + * 2) the catchall symbol "*" can be used + * 3) selection will start with transport dataType and THEN go to "*" if needed + */ + transports = {}, + + // Avoid comment-prolog char sequence (#10098); must appease lint and evade compression + allTypes = "*/".concat( "*" ), + + // Anchor tag for parsing the document origin + originAnchor = document.createElement( "a" ); + originAnchor.href = location.href; + +// Base "constructor" for jQuery.ajaxPrefilter and jQuery.ajaxTransport +function addToPrefiltersOrTransports( structure ) { + + // dataTypeExpression is optional and defaults to "*" + return function( dataTypeExpression, func ) { + + if ( typeof dataTypeExpression !== "string" ) { + func = dataTypeExpression; + dataTypeExpression = "*"; + } + + var dataType, + i = 0, + dataTypes = dataTypeExpression.toLowerCase().match( rnothtmlwhite ) || []; + + if ( isFunction( func ) ) { + + // For each dataType in the dataTypeExpression + while ( ( dataType = dataTypes[ i++ ] ) ) { + + // Prepend if requested + if ( dataType[ 0 ] === "+" ) { + dataType = dataType.slice( 1 ) || "*"; + ( structure[ dataType ] = structure[ dataType ] || [] ).unshift( func ); + + // Otherwise append + } else { + ( structure[ dataType ] = structure[ dataType ] || [] ).push( func ); + } + } + } + }; +} + +// Base inspection function for prefilters and transports +function inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR ) { + + var inspected = {}, + seekingTransport = ( structure === transports ); + + function inspect( dataType ) { + var selected; + inspected[ dataType ] = true; + jQuery.each( structure[ dataType ] || [], function( _, prefilterOrFactory ) { + var dataTypeOrTransport = prefilterOrFactory( options, originalOptions, jqXHR ); + if ( typeof dataTypeOrTransport === "string" && + !seekingTransport && !inspected[ dataTypeOrTransport ] ) { + + options.dataTypes.unshift( dataTypeOrTransport ); + inspect( dataTypeOrTransport ); + return false; + } else if ( seekingTransport ) { + return !( selected = dataTypeOrTransport ); + } + } ); + return selected; + } + + return inspect( options.dataTypes[ 0 ] ) || !inspected[ "*" ] && inspect( "*" ); +} + +// A special extend for ajax options +// that takes "flat" options (not to be deep extended) +// Fixes #9887 +function ajaxExtend( target, src ) { + var key, deep, + flatOptions = jQuery.ajaxSettings.flatOptions || {}; + + for ( key in src ) { + if ( src[ key ] !== undefined ) { + ( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ]; + } + } + if ( deep ) { + jQuery.extend( true, target, deep ); + } + + return target; +} + +/* Handles responses to an ajax request: + * - finds the right dataType (mediates between content-type and expected dataType) + * - returns the corresponding response + */ +function ajaxHandleResponses( s, jqXHR, responses ) { + + var ct, type, finalDataType, firstDataType, + contents = s.contents, + dataTypes = s.dataTypes; + + // Remove auto dataType and get content-type in the process + while ( dataTypes[ 0 ] === "*" ) { + dataTypes.shift(); + if ( ct === undefined ) { + ct = s.mimeType || jqXHR.getResponseHeader( "Content-Type" ); + } + } + + // Check if we're dealing with a known content-type + if ( ct ) { + for ( type in contents ) { + if ( contents[ type ] && contents[ type ].test( ct ) ) { + dataTypes.unshift( type ); + break; + } + } + } + + // Check to see if we have a response for the expected dataType + if ( dataTypes[ 0 ] in responses ) { + finalDataType = dataTypes[ 0 ]; + } else { + + // Try convertible dataTypes + for ( type in responses ) { + if ( !dataTypes[ 0 ] || s.converters[ type + " " + dataTypes[ 0 ] ] ) { + finalDataType = type; + break; + } + if ( !firstDataType ) { + firstDataType = type; + } + } + + // Or just use first one + finalDataType = finalDataType || firstDataType; + } + + // If we found a dataType + // We add the dataType to the list if needed + // and return the corresponding response + if ( finalDataType ) { + if ( finalDataType !== dataTypes[ 0 ] ) { + dataTypes.unshift( finalDataType ); + } + return responses[ finalDataType ]; + } +} + +/* Chain conversions given the request and the original response + * Also sets the responseXXX fields on the jqXHR instance + */ +function ajaxConvert( s, response, jqXHR, isSuccess ) { + var conv2, current, conv, tmp, prev, + converters = {}, + + // Work with a copy of dataTypes in case we need to modify it for conversion + dataTypes = s.dataTypes.slice(); + + // Create converters map with lowercased keys + if ( dataTypes[ 1 ] ) { + for ( conv in s.converters ) { + converters[ conv.toLowerCase() ] = s.converters[ conv ]; + } + } + + current = dataTypes.shift(); + + // Convert to each sequential dataType + while ( current ) { + + if ( s.responseFields[ current ] ) { + jqXHR[ s.responseFields[ current ] ] = response; + } + + // Apply the dataFilter if provided + if ( !prev && isSuccess && s.dataFilter ) { + response = s.dataFilter( response, s.dataType ); + } + + prev = current; + current = dataTypes.shift(); + + if ( current ) { + + // There's only work to do if current dataType is non-auto + if ( current === "*" ) { + + current = prev; + + // Convert response if prev dataType is non-auto and differs from current + } else if ( prev !== "*" && prev !== current ) { + + // Seek a direct converter + conv = converters[ prev + " " + current ] || converters[ "* " + current ]; + + // If none found, seek a pair + if ( !conv ) { + for ( conv2 in converters ) { + + // If conv2 outputs current + tmp = conv2.split( " " ); + if ( tmp[ 1 ] === current ) { + + // If prev can be converted to accepted input + conv = converters[ prev + " " + tmp[ 0 ] ] || + converters[ "* " + tmp[ 0 ] ]; + if ( conv ) { + + // Condense equivalence converters + if ( conv === true ) { + conv = converters[ conv2 ]; + + // Otherwise, insert the intermediate dataType + } else if ( converters[ conv2 ] !== true ) { + current = tmp[ 0 ]; + dataTypes.unshift( tmp[ 1 ] ); + } + break; + } + } + } + } + + // Apply converter (if not an equivalence) + if ( conv !== true ) { + + // Unless errors are allowed to bubble, catch and return them + if ( conv && s.throws ) { + response = conv( response ); + } else { + try { + response = conv( response ); + } catch ( e ) { + return { + state: "parsererror", + error: conv ? e : "No conversion from " + prev + " to " + current + }; + } + } + } + } + } + } + + return { state: "success", data: response }; +} + +jQuery.extend( { + + // Counter for holding the number of active queries + active: 0, + + // Last-Modified header cache for next request + lastModified: {}, + etag: {}, + + ajaxSettings: { + url: location.href, + type: "GET", + isLocal: rlocalProtocol.test( location.protocol ), + global: true, + processData: true, + async: true, + contentType: "application/x-www-form-urlencoded; charset=UTF-8", + + /* + timeout: 0, + data: null, + dataType: null, + username: null, + password: null, + cache: null, + throws: false, + traditional: false, + headers: {}, + */ + + accepts: { + "*": allTypes, + text: "text/plain", + html: "text/html", + xml: "application/xml, text/xml", + json: "application/json, text/javascript" + }, + + contents: { + xml: /\bxml\b/, + html: /\bhtml/, + json: /\bjson\b/ + }, + + responseFields: { + xml: "responseXML", + text: "responseText", + json: "responseJSON" + }, + + // Data converters + // Keys separate source (or catchall "*") and destination types with a single space + converters: { + + // Convert anything to text + "* text": String, + + // Text to html (true = no transformation) + "text html": true, + + // Evaluate text as a json expression + "text json": JSON.parse, + + // Parse text as xml + "text xml": jQuery.parseXML + }, + + // For options that shouldn't be deep extended: + // you can add your own custom options here if + // and when you create one that shouldn't be + // deep extended (see ajaxExtend) + flatOptions: { + url: true, + context: true + } + }, + + // Creates a full fledged settings object into target + // with both ajaxSettings and settings fields. + // If target is omitted, writes into ajaxSettings. + ajaxSetup: function( target, settings ) { + return settings ? + + // Building a settings object + ajaxExtend( ajaxExtend( target, jQuery.ajaxSettings ), settings ) : + + // Extending ajaxSettings + ajaxExtend( jQuery.ajaxSettings, target ); + }, + + ajaxPrefilter: addToPrefiltersOrTransports( prefilters ), + ajaxTransport: addToPrefiltersOrTransports( transports ), + + // Main method + ajax: function( url, options ) { + + // If url is an object, simulate pre-1.5 signature + if ( typeof url === "object" ) { + options = url; + url = undefined; + } + + // Force options to be an object + options = options || {}; + + var transport, + + // URL without anti-cache param + cacheURL, + + // Response headers + responseHeadersString, + responseHeaders, + + // timeout handle + timeoutTimer, + + // Url cleanup var + urlAnchor, + + // Request state (becomes false upon send and true upon completion) + completed, + + // To know if global events are to be dispatched + fireGlobals, + + // Loop variable + i, + + // uncached part of the url + uncached, + + // Create the final options object + s = jQuery.ajaxSetup( {}, options ), + + // Callbacks context + callbackContext = s.context || s, + + // Context for global events is callbackContext if it is a DOM node or jQuery collection + globalEventContext = s.context && + ( callbackContext.nodeType || callbackContext.jquery ) ? + jQuery( callbackContext ) : + jQuery.event, + + // Deferreds + deferred = jQuery.Deferred(), + completeDeferred = jQuery.Callbacks( "once memory" ), + + // Status-dependent callbacks + statusCode = s.statusCode || {}, + + // Headers (they are sent all at once) + requestHeaders = {}, + requestHeadersNames = {}, + + // Default abort message + strAbort = "canceled", + + // Fake xhr + jqXHR = { + readyState: 0, + + // Builds headers hashtable if needed + getResponseHeader: function( key ) { + var match; + if ( completed ) { + if ( !responseHeaders ) { + responseHeaders = {}; + while ( ( match = rheaders.exec( responseHeadersString ) ) ) { + responseHeaders[ match[ 1 ].toLowerCase() + " " ] = + ( responseHeaders[ match[ 1 ].toLowerCase() + " " ] || [] ) + .concat( match[ 2 ] ); + } + } + match = responseHeaders[ key.toLowerCase() + " " ]; + } + return match == null ? null : match.join( ", " ); + }, + + // Raw string + getAllResponseHeaders: function() { + return completed ? responseHeadersString : null; + }, + + // Caches the header + setRequestHeader: function( name, value ) { + if ( completed == null ) { + name = requestHeadersNames[ name.toLowerCase() ] = + requestHeadersNames[ name.toLowerCase() ] || name; + requestHeaders[ name ] = value; + } + return this; + }, + + // Overrides response content-type header + overrideMimeType: function( type ) { + if ( completed == null ) { + s.mimeType = type; + } + return this; + }, + + // Status-dependent callbacks + statusCode: function( map ) { + var code; + if ( map ) { + if ( completed ) { + + // Execute the appropriate callbacks + jqXHR.always( map[ jqXHR.status ] ); + } else { + + // Lazy-add the new callbacks in a way that preserves old ones + for ( code in map ) { + statusCode[ code ] = [ statusCode[ code ], map[ code ] ]; + } + } + } + return this; + }, + + // Cancel the request + abort: function( statusText ) { + var finalText = statusText || strAbort; + if ( transport ) { + transport.abort( finalText ); + } + done( 0, finalText ); + return this; + } + }; + + // Attach deferreds + deferred.promise( jqXHR ); + + // Add protocol if not provided (prefilters might expect it) + // Handle falsy url in the settings object (#10093: consistency with old signature) + // We also use the url parameter if available + s.url = ( ( url || s.url || location.href ) + "" ) + .replace( rprotocol, location.protocol + "//" ); + + // Alias method option to type as per ticket #12004 + s.type = options.method || options.type || s.method || s.type; + + // Extract dataTypes list + s.dataTypes = ( s.dataType || "*" ).toLowerCase().match( rnothtmlwhite ) || [ "" ]; + + // A cross-domain request is in order when the origin doesn't match the current origin. + if ( s.crossDomain == null ) { + urlAnchor = document.createElement( "a" ); + + // Support: IE <=8 - 11, Edge 12 - 15 + // IE throws exception on accessing the href property if url is malformed, + // e.g. http://example.com:80x/ + try { + urlAnchor.href = s.url; + + // Support: IE <=8 - 11 only + // Anchor's host property isn't correctly set when s.url is relative + urlAnchor.href = urlAnchor.href; + s.crossDomain = originAnchor.protocol + "//" + originAnchor.host !== + urlAnchor.protocol + "//" + urlAnchor.host; + } catch ( e ) { + + // If there is an error parsing the URL, assume it is crossDomain, + // it can be rejected by the transport if it is invalid + s.crossDomain = true; + } + } + + // Convert data if not already a string + if ( s.data && s.processData && typeof s.data !== "string" ) { + s.data = jQuery.param( s.data, s.traditional ); + } + + // Apply prefilters + inspectPrefiltersOrTransports( prefilters, s, options, jqXHR ); + + // If request was aborted inside a prefilter, stop there + if ( completed ) { + return jqXHR; + } + + // We can fire global events as of now if asked to + // Don't fire events if jQuery.event is undefined in an AMD-usage scenario (#15118) + fireGlobals = jQuery.event && s.global; + + // Watch for a new set of requests + if ( fireGlobals && jQuery.active++ === 0 ) { + jQuery.event.trigger( "ajaxStart" ); + } + + // Uppercase the type + s.type = s.type.toUpperCase(); + + // Determine if request has content + s.hasContent = !rnoContent.test( s.type ); + + // Save the URL in case we're toying with the If-Modified-Since + // and/or If-None-Match header later on + // Remove hash to simplify url manipulation + cacheURL = s.url.replace( rhash, "" ); + + // More options handling for requests with no content + if ( !s.hasContent ) { + + // Remember the hash so we can put it back + uncached = s.url.slice( cacheURL.length ); + + // If data is available and should be processed, append data to url + if ( s.data && ( s.processData || typeof s.data === "string" ) ) { + cacheURL += ( rquery.test( cacheURL ) ? "&" : "?" ) + s.data; + + // #9682: remove data so that it's not used in an eventual retry + delete s.data; + } + + // Add or update anti-cache param if needed + if ( s.cache === false ) { + cacheURL = cacheURL.replace( rantiCache, "$1" ); + uncached = ( rquery.test( cacheURL ) ? "&" : "?" ) + "_=" + ( nonce.guid++ ) + + uncached; + } + + // Put hash and anti-cache on the URL that will be requested (gh-1732) + s.url = cacheURL + uncached; + + // Change '%20' to '+' if this is encoded form body content (gh-2658) + } else if ( s.data && s.processData && + ( s.contentType || "" ).indexOf( "application/x-www-form-urlencoded" ) === 0 ) { + s.data = s.data.replace( r20, "+" ); + } + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + if ( jQuery.lastModified[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ cacheURL ] ); + } + if ( jQuery.etag[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ cacheURL ] ); + } + } + + // Set the correct header, if data is being sent + if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) { + jqXHR.setRequestHeader( "Content-Type", s.contentType ); + } + + // Set the Accepts header for the server, depending on the dataType + jqXHR.setRequestHeader( + "Accept", + s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[ 0 ] ] ? + s.accepts[ s.dataTypes[ 0 ] ] + + ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) : + s.accepts[ "*" ] + ); + + // Check for headers option + for ( i in s.headers ) { + jqXHR.setRequestHeader( i, s.headers[ i ] ); + } + + // Allow custom headers/mimetypes and early abort + if ( s.beforeSend && + ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || completed ) ) { + + // Abort if not done already and return + return jqXHR.abort(); + } + + // Aborting is no longer a cancellation + strAbort = "abort"; + + // Install callbacks on deferreds + completeDeferred.add( s.complete ); + jqXHR.done( s.success ); + jqXHR.fail( s.error ); + + // Get transport + transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR ); + + // If no transport, we auto-abort + if ( !transport ) { + done( -1, "No Transport" ); + } else { + jqXHR.readyState = 1; + + // Send global event + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] ); + } + + // If request was aborted inside ajaxSend, stop there + if ( completed ) { + return jqXHR; + } + + // Timeout + if ( s.async && s.timeout > 0 ) { + timeoutTimer = window.setTimeout( function() { + jqXHR.abort( "timeout" ); + }, s.timeout ); + } + + try { + completed = false; + transport.send( requestHeaders, done ); + } catch ( e ) { + + // Rethrow post-completion exceptions + if ( completed ) { + throw e; + } + + // Propagate others as results + done( -1, e ); + } + } + + // Callback for when everything is done + function done( status, nativeStatusText, responses, headers ) { + var isSuccess, success, error, response, modified, + statusText = nativeStatusText; + + // Ignore repeat invocations + if ( completed ) { + return; + } + + completed = true; + + // Clear timeout if it exists + if ( timeoutTimer ) { + window.clearTimeout( timeoutTimer ); + } + + // Dereference transport for early garbage collection + // (no matter how long the jqXHR object will be used) + transport = undefined; + + // Cache response headers + responseHeadersString = headers || ""; + + // Set readyState + jqXHR.readyState = status > 0 ? 4 : 0; + + // Determine if successful + isSuccess = status >= 200 && status < 300 || status === 304; + + // Get response data + if ( responses ) { + response = ajaxHandleResponses( s, jqXHR, responses ); + } + + // Use a noop converter for missing script + if ( !isSuccess && jQuery.inArray( "script", s.dataTypes ) > -1 ) { + s.converters[ "text script" ] = function() {}; + } + + // Convert no matter what (that way responseXXX fields are always set) + response = ajaxConvert( s, response, jqXHR, isSuccess ); + + // If successful, handle type chaining + if ( isSuccess ) { + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + modified = jqXHR.getResponseHeader( "Last-Modified" ); + if ( modified ) { + jQuery.lastModified[ cacheURL ] = modified; + } + modified = jqXHR.getResponseHeader( "etag" ); + if ( modified ) { + jQuery.etag[ cacheURL ] = modified; + } + } + + // if no content + if ( status === 204 || s.type === "HEAD" ) { + statusText = "nocontent"; + + // if not modified + } else if ( status === 304 ) { + statusText = "notmodified"; + + // If we have data, let's convert it + } else { + statusText = response.state; + success = response.data; + error = response.error; + isSuccess = !error; + } + } else { + + // Extract error from statusText and normalize for non-aborts + error = statusText; + if ( status || !statusText ) { + statusText = "error"; + if ( status < 0 ) { + status = 0; + } + } + } + + // Set data for the fake xhr object + jqXHR.status = status; + jqXHR.statusText = ( nativeStatusText || statusText ) + ""; + + // Success/Error + if ( isSuccess ) { + deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] ); + } else { + deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] ); + } + + // Status-dependent callbacks + jqXHR.statusCode( statusCode ); + statusCode = undefined; + + if ( fireGlobals ) { + globalEventContext.trigger( isSuccess ? "ajaxSuccess" : "ajaxError", + [ jqXHR, s, isSuccess ? success : error ] ); + } + + // Complete + completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] ); + + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] ); + + // Handle the global AJAX counter + if ( !( --jQuery.active ) ) { + jQuery.event.trigger( "ajaxStop" ); + } + } + } + + return jqXHR; + }, + + getJSON: function( url, data, callback ) { + return jQuery.get( url, data, callback, "json" ); + }, + + getScript: function( url, callback ) { + return jQuery.get( url, undefined, callback, "script" ); + } +} ); + +jQuery.each( [ "get", "post" ], function( _i, method ) { + jQuery[ method ] = function( url, data, callback, type ) { + + // Shift arguments if data argument was omitted + if ( isFunction( data ) ) { + type = type || callback; + callback = data; + data = undefined; + } + + // The url can be an options object (which then must have .url) + return jQuery.ajax( jQuery.extend( { + url: url, + type: method, + dataType: type, + data: data, + success: callback + }, jQuery.isPlainObject( url ) && url ) ); + }; +} ); + +jQuery.ajaxPrefilter( function( s ) { + var i; + for ( i in s.headers ) { + if ( i.toLowerCase() === "content-type" ) { + s.contentType = s.headers[ i ] || ""; + } + } +} ); + + +jQuery._evalUrl = function( url, options, doc ) { + return jQuery.ajax( { + url: url, + + // Make this explicit, since user can override this through ajaxSetup (#11264) + type: "GET", + dataType: "script", + cache: true, + async: false, + global: false, + + // Only evaluate the response if it is successful (gh-4126) + // dataFilter is not invoked for failure responses, so using it instead + // of the default converter is kludgy but it works. + converters: { + "text script": function() {} + }, + dataFilter: function( response ) { + jQuery.globalEval( response, options, doc ); + } + } ); +}; + + +jQuery.fn.extend( { + wrapAll: function( html ) { + var wrap; + + if ( this[ 0 ] ) { + if ( isFunction( html ) ) { + html = html.call( this[ 0 ] ); + } + + // The elements to wrap the target around + wrap = jQuery( html, this[ 0 ].ownerDocument ).eq( 0 ).clone( true ); + + if ( this[ 0 ].parentNode ) { + wrap.insertBefore( this[ 0 ] ); + } + + wrap.map( function() { + var elem = this; + + while ( elem.firstElementChild ) { + elem = elem.firstElementChild; + } + + return elem; + } ).append( this ); + } + + return this; + }, + + wrapInner: function( html ) { + if ( isFunction( html ) ) { + return this.each( function( i ) { + jQuery( this ).wrapInner( html.call( this, i ) ); + } ); + } + + return this.each( function() { + var self = jQuery( this ), + contents = self.contents(); + + if ( contents.length ) { + contents.wrapAll( html ); + + } else { + self.append( html ); + } + } ); + }, + + wrap: function( html ) { + var htmlIsFunction = isFunction( html ); + + return this.each( function( i ) { + jQuery( this ).wrapAll( htmlIsFunction ? html.call( this, i ) : html ); + } ); + }, + + unwrap: function( selector ) { + this.parent( selector ).not( "body" ).each( function() { + jQuery( this ).replaceWith( this.childNodes ); + } ); + return this; + } +} ); + + +jQuery.expr.pseudos.hidden = function( elem ) { + return !jQuery.expr.pseudos.visible( elem ); +}; +jQuery.expr.pseudos.visible = function( elem ) { + return !!( elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length ); +}; + + + + +jQuery.ajaxSettings.xhr = function() { + try { + return new window.XMLHttpRequest(); + } catch ( e ) {} +}; + +var xhrSuccessStatus = { + + // File protocol always yields status code 0, assume 200 + 0: 200, + + // Support: IE <=9 only + // #1450: sometimes IE returns 1223 when it should be 204 + 1223: 204 + }, + xhrSupported = jQuery.ajaxSettings.xhr(); + +support.cors = !!xhrSupported && ( "withCredentials" in xhrSupported ); +support.ajax = xhrSupported = !!xhrSupported; + +jQuery.ajaxTransport( function( options ) { + var callback, errorCallback; + + // Cross domain only allowed if supported through XMLHttpRequest + if ( support.cors || xhrSupported && !options.crossDomain ) { + return { + send: function( headers, complete ) { + var i, + xhr = options.xhr(); + + xhr.open( + options.type, + options.url, + options.async, + options.username, + options.password + ); + + // Apply custom fields if provided + if ( options.xhrFields ) { + for ( i in options.xhrFields ) { + xhr[ i ] = options.xhrFields[ i ]; + } + } + + // Override mime type if needed + if ( options.mimeType && xhr.overrideMimeType ) { + xhr.overrideMimeType( options.mimeType ); + } + + // X-Requested-With header + // For cross-domain requests, seeing as conditions for a preflight are + // akin to a jigsaw puzzle, we simply never set it to be sure. + // (it can always be set on a per-request basis or even using ajaxSetup) + // For same-domain requests, won't change header if already provided. + if ( !options.crossDomain && !headers[ "X-Requested-With" ] ) { + headers[ "X-Requested-With" ] = "XMLHttpRequest"; + } + + // Set headers + for ( i in headers ) { + xhr.setRequestHeader( i, headers[ i ] ); + } + + // Callback + callback = function( type ) { + return function() { + if ( callback ) { + callback = errorCallback = xhr.onload = + xhr.onerror = xhr.onabort = xhr.ontimeout = + xhr.onreadystatechange = null; + + if ( type === "abort" ) { + xhr.abort(); + } else if ( type === "error" ) { + + // Support: IE <=9 only + // On a manual native abort, IE9 throws + // errors on any property access that is not readyState + if ( typeof xhr.status !== "number" ) { + complete( 0, "error" ); + } else { + complete( + + // File: protocol always yields status 0; see #8605, #14207 + xhr.status, + xhr.statusText + ); + } + } else { + complete( + xhrSuccessStatus[ xhr.status ] || xhr.status, + xhr.statusText, + + // Support: IE <=9 only + // IE9 has no XHR2 but throws on binary (trac-11426) + // For XHR2 non-text, let the caller handle it (gh-2498) + ( xhr.responseType || "text" ) !== "text" || + typeof xhr.responseText !== "string" ? + { binary: xhr.response } : + { text: xhr.responseText }, + xhr.getAllResponseHeaders() + ); + } + } + }; + }; + + // Listen to events + xhr.onload = callback(); + errorCallback = xhr.onerror = xhr.ontimeout = callback( "error" ); + + // Support: IE 9 only + // Use onreadystatechange to replace onabort + // to handle uncaught aborts + if ( xhr.onabort !== undefined ) { + xhr.onabort = errorCallback; + } else { + xhr.onreadystatechange = function() { + + // Check readyState before timeout as it changes + if ( xhr.readyState === 4 ) { + + // Allow onerror to be called first, + // but that will not handle a native abort + // Also, save errorCallback to a variable + // as xhr.onerror cannot be accessed + window.setTimeout( function() { + if ( callback ) { + errorCallback(); + } + } ); + } + }; + } + + // Create the abort callback + callback = callback( "abort" ); + + try { + + // Do send the request (this may raise an exception) + xhr.send( options.hasContent && options.data || null ); + } catch ( e ) { + + // #14683: Only rethrow if this hasn't been notified as an error yet + if ( callback ) { + throw e; + } + } + }, + + abort: function() { + if ( callback ) { + callback(); + } + } + }; + } +} ); + + + + +// Prevent auto-execution of scripts when no explicit dataType was provided (See gh-2432) +jQuery.ajaxPrefilter( function( s ) { + if ( s.crossDomain ) { + s.contents.script = false; + } +} ); + +// Install script dataType +jQuery.ajaxSetup( { + accepts: { + script: "text/javascript, application/javascript, " + + "application/ecmascript, application/x-ecmascript" + }, + contents: { + script: /\b(?:java|ecma)script\b/ + }, + converters: { + "text script": function( text ) { + jQuery.globalEval( text ); + return text; + } + } +} ); + +// Handle cache's special case and crossDomain +jQuery.ajaxPrefilter( "script", function( s ) { + if ( s.cache === undefined ) { + s.cache = false; + } + if ( s.crossDomain ) { + s.type = "GET"; + } +} ); + +// Bind script tag hack transport +jQuery.ajaxTransport( "script", function( s ) { + + // This transport only deals with cross domain or forced-by-attrs requests + if ( s.crossDomain || s.scriptAttrs ) { + var script, callback; + return { + send: function( _, complete ) { + script = jQuery( "\r\n"; + +// inject VBScript +document.write(IEBinaryToArray_ByteStr_Script); + +global.JSZipUtils._getBinaryFromXHR = function (xhr) { + var binary = xhr.responseBody; + var byteMapping = {}; + for ( var i = 0; i < 256; i++ ) { + for ( var j = 0; j < 256; j++ ) { + byteMapping[ String.fromCharCode( i + (j << 8) ) ] = + String.fromCharCode(i) + String.fromCharCode(j); + } + } + var rawBytes = IEBinaryToArray_ByteStr(binary); + var lastChr = IEBinaryToArray_ByteStr_Last(binary); + return rawBytes.replace(/[\s\S]/g, function( match ) { + return byteMapping[match]; + }) + lastChr; +}; + +// enforcing Stuk's coding style +// vim: set shiftwidth=4 softtabstop=4: + +},{}]},{},[1]) +; diff --git a/9.3.3/api/jquery/jszip-utils/dist/jszip-utils-ie.min.js b/9.3.3/api/jquery/jszip-utils/dist/jszip-utils-ie.min.js new file mode 100644 index 000000000..93d8bc8ef --- /dev/null +++ b/9.3.3/api/jquery/jszip-utils/dist/jszip-utils-ie.min.js @@ -0,0 +1,10 @@ +/*! + +JSZipUtils - A collection of cross-browser utilities to go along with JSZip. + + +(c) 2014 Stuart Knightley, David Duponchel +Dual licenced under the MIT license or GPLv3. See https://raw.github.com/Stuk/jszip-utils/master/LICENSE.markdown. + +*/ +!function a(b,c,d){function e(g,h){if(!c[g]){if(!b[g]){var i="function"==typeof require&&require;if(!h&&i)return i(g,!0);if(f)return f(g,!0);throw new Error("Cannot find module '"+g+"'")}var j=c[g]={exports:{}};b[g][0].call(j.exports,function(a){var c=b[g][1][a];return e(c?c:a)},j,j.exports,a,b,c,d)}return c[g].exports}for(var f="function"==typeof require&&require,g=0;g\r\n";document.write(b),a.JSZipUtils._getBinaryFromXHR=function(a){for(var b=a.responseBody,c={},d=0;256>d;d++)for(var e=0;256>e;e++)c[String.fromCharCode(d+(e<<8))]=String.fromCharCode(d)+String.fromCharCode(e);var f=IEBinaryToArray_ByteStr(b),g=IEBinaryToArray_ByteStr_Last(b);return f.replace(/[\s\S]/g,function(a){return c[a]})+g}},{}]},{},[1]); diff --git a/9.3.3/api/jquery/jszip-utils/dist/jszip-utils.js b/9.3.3/api/jquery/jszip-utils/dist/jszip-utils.js new file mode 100644 index 000000000..775895ec9 --- /dev/null +++ b/9.3.3/api/jquery/jszip-utils/dist/jszip-utils.js @@ -0,0 +1,118 @@ +/*! + +JSZipUtils - A collection of cross-browser utilities to go along with JSZip. + + +(c) 2014 Stuart Knightley, David Duponchel +Dual licenced under the MIT license or GPLv3. See https://raw.github.com/Stuk/jszip-utils/master/LICENSE.markdown. + +*/ +!function(e){"object"==typeof exports?module.exports=e():"function"==typeof define&&define.amd?define(e):"undefined"!=typeof window?window.JSZipUtils=e():"undefined"!=typeof global?global.JSZipUtils=e():"undefined"!=typeof self&&(self.JSZipUtils=e())}(function(){var define,module,exports;return (function e(t,n,r){function s(o,u){if(!n[o]){if(!t[o]){var a=typeof require=="function"&&require;if(!u&&a)return a(o,!0);if(i)return i(o,!0);throw new Error("Cannot find module '"+o+"'")}var f=n[o]={exports:{}};t[o][0].call(f.exports,function(e){var n=t[o][1][e];return s(n?n:e)},f,f.exports,e,t,n,r)}return n[o].exports}var i=typeof require=="function"&&require;for(var o=0;o + +(c) 2014 Stuart Knightley, David Duponchel +Dual licenced under the MIT license or GPLv3. See https://raw.github.com/Stuk/jszip-utils/master/LICENSE.markdown. + +*/ +!function(a){"object"==typeof exports?module.exports=a():"function"==typeof define&&define.amd?define(a):"undefined"!=typeof window?window.JSZipUtils=a():"undefined"!=typeof global?global.JSZipUtils=a():"undefined"!=typeof self&&(self.JSZipUtils=a())}(function(){return function a(b,c,d){function e(g,h){if(!c[g]){if(!b[g]){var i="function"==typeof require&&require;if(!h&&i)return i(g,!0);if(f)return f(g,!0);throw new Error("Cannot find module '"+g+"'")}var j=c[g]={exports:{}};b[g][0].call(j.exports,function(a){var c=b[g][1][a];return e(c?c:a)},j,j.exports,a,b,c,d)}return c[g].exports}for(var f="function"==typeof require&&require,g=0;g + +(c) 2009-2016 Stuart Knightley +Dual licenced under the MIT license or GPLv3. See https://raw.github.com/Stuk/jszip/master/LICENSE.markdown. + +JSZip uses the library pako released under the MIT license : +https://github.com/nodeca/pako/blob/master/LICENSE +*/ + +(function(f){if(typeof exports==="object"&&typeof module!=="undefined"){module.exports=f()}else if(typeof define==="function"&&define.amd){define([],f)}else{var g;if(typeof window!=="undefined"){g=window}else if(typeof global!=="undefined"){g=global}else if(typeof self!=="undefined"){g=self}else{g=this}g.JSZip = f()}})(function(){var define,module,exports;return (function e(t,n,r){function s(o,u){if(!n[o]){if(!t[o]){var a=typeof require=="function"&&require;if(!u&&a)return a(o,!0);if(i)return i(o,!0);var f=new Error("Cannot find module '"+o+"'");throw f.code="MODULE_NOT_FOUND",f}var l=n[o]={exports:{}};t[o][0].call(l.exports,function(e){var n=t[o][1][e];return s(n?n:e)},l,l.exports,e,t,n,r)}return n[o].exports}var i=typeof require=="function"&&require;for(var o=0;o> 2; + enc2 = ((chr1 & 3) << 4) | (chr2 >> 4); + enc3 = remainingBytes > 1 ? (((chr2 & 15) << 2) | (chr3 >> 6)) : 64; + enc4 = remainingBytes > 2 ? (chr3 & 63) : 64; + + output.push(_keyStr.charAt(enc1) + _keyStr.charAt(enc2) + _keyStr.charAt(enc3) + _keyStr.charAt(enc4)); + + } + + return output.join(""); +}; + +// public method for decoding +exports.decode = function(input) { + var chr1, chr2, chr3; + var enc1, enc2, enc3, enc4; + var i = 0, resultIndex = 0; + + var dataUrlPrefix = "data:"; + + if (input.substr(0, dataUrlPrefix.length) === dataUrlPrefix) { + // This is a common error: people give a data url + // (data:image/png;base64,iVBOR...) with a {base64: true} and + // wonders why things don't work. + // We can detect that the string input looks like a data url but we + // *can't* be sure it is one: removing everything up to the comma would + // be too dangerous. + throw new Error("Invalid base64 input, it looks like a data url."); + } + + input = input.replace(/[^A-Za-z0-9\+\/\=]/g, ""); + + var totalLength = input.length * 3 / 4; + if(input.charAt(input.length - 1) === _keyStr.charAt(64)) { + totalLength--; + } + if(input.charAt(input.length - 2) === _keyStr.charAt(64)) { + totalLength--; + } + if (totalLength % 1 !== 0) { + // totalLength is not an integer, the length does not match a valid + // base64 content. That can happen if: + // - the input is not a base64 content + // - the input is *almost* a base64 content, with a extra chars at the + // beginning or at the end + // - the input uses a base64 variant (base64url for example) + throw new Error("Invalid base64 input, bad content length."); + } + var output; + if (support.uint8array) { + output = new Uint8Array(totalLength|0); + } else { + output = new Array(totalLength|0); + } + + while (i < input.length) { + + enc1 = _keyStr.indexOf(input.charAt(i++)); + enc2 = _keyStr.indexOf(input.charAt(i++)); + enc3 = _keyStr.indexOf(input.charAt(i++)); + enc4 = _keyStr.indexOf(input.charAt(i++)); + + chr1 = (enc1 << 2) | (enc2 >> 4); + chr2 = ((enc2 & 15) << 4) | (enc3 >> 2); + chr3 = ((enc3 & 3) << 6) | enc4; + + output[resultIndex++] = chr1; + + if (enc3 !== 64) { + output[resultIndex++] = chr2; + } + if (enc4 !== 64) { + output[resultIndex++] = chr3; + } + + } + + return output; +}; + +},{"./support":30,"./utils":32}],2:[function(require,module,exports){ +'use strict'; + +var external = require("./external"); +var DataWorker = require('./stream/DataWorker'); +var Crc32Probe = require('./stream/Crc32Probe'); +var DataLengthProbe = require('./stream/DataLengthProbe'); + +/** + * Represent a compressed object, with everything needed to decompress it. + * @constructor + * @param {number} compressedSize the size of the data compressed. + * @param {number} uncompressedSize the size of the data after decompression. + * @param {number} crc32 the crc32 of the decompressed file. + * @param {object} compression the type of compression, see lib/compressions.js. + * @param {String|ArrayBuffer|Uint8Array|Buffer} data the compressed data. + */ +function CompressedObject(compressedSize, uncompressedSize, crc32, compression, data) { + this.compressedSize = compressedSize; + this.uncompressedSize = uncompressedSize; + this.crc32 = crc32; + this.compression = compression; + this.compressedContent = data; +} + +CompressedObject.prototype = { + /** + * Create a worker to get the uncompressed content. + * @return {GenericWorker} the worker. + */ + getContentWorker: function () { + var worker = new DataWorker(external.Promise.resolve(this.compressedContent)) + .pipe(this.compression.uncompressWorker()) + .pipe(new DataLengthProbe("data_length")); + + var that = this; + worker.on("end", function () { + if (this.streamInfo['data_length'] !== that.uncompressedSize) { + throw new Error("Bug : uncompressed data size mismatch"); + } + }); + return worker; + }, + /** + * Create a worker to get the compressed content. + * @return {GenericWorker} the worker. + */ + getCompressedWorker: function () { + return new DataWorker(external.Promise.resolve(this.compressedContent)) + .withStreamInfo("compressedSize", this.compressedSize) + .withStreamInfo("uncompressedSize", this.uncompressedSize) + .withStreamInfo("crc32", this.crc32) + .withStreamInfo("compression", this.compression) + ; + } +}; + +/** + * Chain the given worker with other workers to compress the content with the + * given compression. + * @param {GenericWorker} uncompressedWorker the worker to pipe. + * @param {Object} compression the compression object. + * @param {Object} compressionOptions the options to use when compressing. + * @return {GenericWorker} the new worker compressing the content. + */ +CompressedObject.createWorkerFrom = function (uncompressedWorker, compression, compressionOptions) { + return uncompressedWorker + .pipe(new Crc32Probe()) + .pipe(new DataLengthProbe("uncompressedSize")) + .pipe(compression.compressWorker(compressionOptions)) + .pipe(new DataLengthProbe("compressedSize")) + .withStreamInfo("compression", compression); +}; + +module.exports = CompressedObject; + +},{"./external":6,"./stream/Crc32Probe":25,"./stream/DataLengthProbe":26,"./stream/DataWorker":27}],3:[function(require,module,exports){ +'use strict'; + +var GenericWorker = require("./stream/GenericWorker"); + +exports.STORE = { + magic: "\x00\x00", + compressWorker : function (compressionOptions) { + return new GenericWorker("STORE compression"); + }, + uncompressWorker : function () { + return new GenericWorker("STORE decompression"); + } +}; +exports.DEFLATE = require('./flate'); + +},{"./flate":7,"./stream/GenericWorker":28}],4:[function(require,module,exports){ +'use strict'; + +var utils = require('./utils'); + +/** + * The following functions come from pako, from pako/lib/zlib/crc32.js + * released under the MIT license, see pako https://github.com/nodeca/pako/ + */ + +// Use ordinary array, since untyped makes no boost here +function makeTable() { + var c, table = []; + + for(var n =0; n < 256; n++){ + c = n; + for(var k =0; k < 8; k++){ + c = ((c&1) ? (0xEDB88320 ^ (c >>> 1)) : (c >>> 1)); + } + table[n] = c; + } + + return table; +} + +// Create table on load. Just 255 signed longs. Not a problem. +var crcTable = makeTable(); + + +function crc32(crc, buf, len, pos) { + var t = crcTable, end = pos + len; + + crc = crc ^ (-1); + + for (var i = pos; i < end; i++ ) { + crc = (crc >>> 8) ^ t[(crc ^ buf[i]) & 0xFF]; + } + + return (crc ^ (-1)); // >>> 0; +} + +// That's all for the pako functions. + +/** + * Compute the crc32 of a string. + * This is almost the same as the function crc32, but for strings. Using the + * same function for the two use cases leads to horrible performances. + * @param {Number} crc the starting value of the crc. + * @param {String} str the string to use. + * @param {Number} len the length of the string. + * @param {Number} pos the starting position for the crc32 computation. + * @return {Number} the computed crc32. + */ +function crc32str(crc, str, len, pos) { + var t = crcTable, end = pos + len; + + crc = crc ^ (-1); + + for (var i = pos; i < end; i++ ) { + crc = (crc >>> 8) ^ t[(crc ^ str.charCodeAt(i)) & 0xFF]; + } + + return (crc ^ (-1)); // >>> 0; +} + +module.exports = function crc32wrapper(input, crc) { + if (typeof input === "undefined" || !input.length) { + return 0; + } + + var isArray = utils.getTypeOf(input) !== "string"; + + if(isArray) { + return crc32(crc|0, input, input.length, 0); + } else { + return crc32str(crc|0, input, input.length, 0); + } +}; + +},{"./utils":32}],5:[function(require,module,exports){ +'use strict'; +exports.base64 = false; +exports.binary = false; +exports.dir = false; +exports.createFolders = true; +exports.date = null; +exports.compression = null; +exports.compressionOptions = null; +exports.comment = null; +exports.unixPermissions = null; +exports.dosPermissions = null; + +},{}],6:[function(require,module,exports){ +/* global Promise */ +'use strict'; + +// load the global object first: +// - it should be better integrated in the system (unhandledRejection in node) +// - the environment may have a custom Promise implementation (see zone.js) +var ES6Promise = null; +if (typeof Promise !== "undefined") { + ES6Promise = Promise; +} else { + ES6Promise = require("lie"); +} + +/** + * Let the user use/change some implementations. + */ +module.exports = { + Promise: ES6Promise +}; + +},{"lie":37}],7:[function(require,module,exports){ +'use strict'; +var USE_TYPEDARRAY = (typeof Uint8Array !== 'undefined') && (typeof Uint16Array !== 'undefined') && (typeof Uint32Array !== 'undefined'); + +var pako = require("pako"); +var utils = require("./utils"); +var GenericWorker = require("./stream/GenericWorker"); + +var ARRAY_TYPE = USE_TYPEDARRAY ? "uint8array" : "array"; + +exports.magic = "\x08\x00"; + +/** + * Create a worker that uses pako to inflate/deflate. + * @constructor + * @param {String} action the name of the pako function to call : either "Deflate" or "Inflate". + * @param {Object} options the options to use when (de)compressing. + */ +function FlateWorker(action, options) { + GenericWorker.call(this, "FlateWorker/" + action); + + this._pako = null; + this._pakoAction = action; + this._pakoOptions = options; + // the `meta` object from the last chunk received + // this allow this worker to pass around metadata + this.meta = {}; +} + +utils.inherits(FlateWorker, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +FlateWorker.prototype.processChunk = function (chunk) { + this.meta = chunk.meta; + if (this._pako === null) { + this._createPako(); + } + this._pako.push(utils.transformTo(ARRAY_TYPE, chunk.data), false); +}; + +/** + * @see GenericWorker.flush + */ +FlateWorker.prototype.flush = function () { + GenericWorker.prototype.flush.call(this); + if (this._pako === null) { + this._createPako(); + } + this._pako.push([], true); +}; +/** + * @see GenericWorker.cleanUp + */ +FlateWorker.prototype.cleanUp = function () { + GenericWorker.prototype.cleanUp.call(this); + this._pako = null; +}; + +/** + * Create the _pako object. + * TODO: lazy-loading this object isn't the best solution but it's the + * quickest. The best solution is to lazy-load the worker list. See also the + * issue #446. + */ +FlateWorker.prototype._createPako = function () { + this._pako = new pako[this._pakoAction]({ + raw: true, + level: this._pakoOptions.level || -1 // default compression + }); + var self = this; + this._pako.onData = function(data) { + self.push({ + data : data, + meta : self.meta + }); + }; +}; + +exports.compressWorker = function (compressionOptions) { + return new FlateWorker("Deflate", compressionOptions); +}; +exports.uncompressWorker = function () { + return new FlateWorker("Inflate", {}); +}; + +},{"./stream/GenericWorker":28,"./utils":32,"pako":38}],8:[function(require,module,exports){ +'use strict'; + +var utils = require('../utils'); +var GenericWorker = require('../stream/GenericWorker'); +var utf8 = require('../utf8'); +var crc32 = require('../crc32'); +var signature = require('../signature'); + +/** + * Transform an integer into a string in hexadecimal. + * @private + * @param {number} dec the number to convert. + * @param {number} bytes the number of bytes to generate. + * @returns {string} the result. + */ +var decToHex = function(dec, bytes) { + var hex = "", i; + for (i = 0; i < bytes; i++) { + hex += String.fromCharCode(dec & 0xff); + dec = dec >>> 8; + } + return hex; +}; + +/** + * Generate the UNIX part of the external file attributes. + * @param {Object} unixPermissions the unix permissions or null. + * @param {Boolean} isDir true if the entry is a directory, false otherwise. + * @return {Number} a 32 bit integer. + * + * adapted from http://unix.stackexchange.com/questions/14705/the-zip-formats-external-file-attribute : + * + * TTTTsstrwxrwxrwx0000000000ADVSHR + * ^^^^____________________________ file type, see zipinfo.c (UNX_*) + * ^^^_________________________ setuid, setgid, sticky + * ^^^^^^^^^________________ permissions + * ^^^^^^^^^^______ not used ? + * ^^^^^^ DOS attribute bits : Archive, Directory, Volume label, System file, Hidden, Read only + */ +var generateUnixExternalFileAttr = function (unixPermissions, isDir) { + + var result = unixPermissions; + if (!unixPermissions) { + // I can't use octal values in strict mode, hence the hexa. + // 040775 => 0x41fd + // 0100664 => 0x81b4 + result = isDir ? 0x41fd : 0x81b4; + } + return (result & 0xFFFF) << 16; +}; + +/** + * Generate the DOS part of the external file attributes. + * @param {Object} dosPermissions the dos permissions or null. + * @param {Boolean} isDir true if the entry is a directory, false otherwise. + * @return {Number} a 32 bit integer. + * + * Bit 0 Read-Only + * Bit 1 Hidden + * Bit 2 System + * Bit 3 Volume Label + * Bit 4 Directory + * Bit 5 Archive + */ +var generateDosExternalFileAttr = function (dosPermissions, isDir) { + + // the dir flag is already set for compatibility + return (dosPermissions || 0) & 0x3F; +}; + +/** + * Generate the various parts used in the construction of the final zip file. + * @param {Object} streamInfo the hash with information about the compressed file. + * @param {Boolean} streamedContent is the content streamed ? + * @param {Boolean} streamingEnded is the stream finished ? + * @param {number} offset the current offset from the start of the zip file. + * @param {String} platform let's pretend we are this platform (change platform dependents fields) + * @param {Function} encodeFileName the function to encode the file name / comment. + * @return {Object} the zip parts. + */ +var generateZipParts = function(streamInfo, streamedContent, streamingEnded, offset, platform, encodeFileName) { + var file = streamInfo['file'], + compression = streamInfo['compression'], + useCustomEncoding = encodeFileName !== utf8.utf8encode, + encodedFileName = utils.transformTo("string", encodeFileName(file.name)), + utfEncodedFileName = utils.transformTo("string", utf8.utf8encode(file.name)), + comment = file.comment, + encodedComment = utils.transformTo("string", encodeFileName(comment)), + utfEncodedComment = utils.transformTo("string", utf8.utf8encode(comment)), + useUTF8ForFileName = utfEncodedFileName.length !== file.name.length, + useUTF8ForComment = utfEncodedComment.length !== comment.length, + dosTime, + dosDate, + extraFields = "", + unicodePathExtraField = "", + unicodeCommentExtraField = "", + dir = file.dir, + date = file.date; + + + var dataInfo = { + crc32 : 0, + compressedSize : 0, + uncompressedSize : 0 + }; + + // if the content is streamed, the sizes/crc32 are only available AFTER + // the end of the stream. + if (!streamedContent || streamingEnded) { + dataInfo.crc32 = streamInfo['crc32']; + dataInfo.compressedSize = streamInfo['compressedSize']; + dataInfo.uncompressedSize = streamInfo['uncompressedSize']; + } + + var bitflag = 0; + if (streamedContent) { + // Bit 3: the sizes/crc32 are set to zero in the local header. + // The correct values are put in the data descriptor immediately + // following the compressed data. + bitflag |= 0x0008; + } + if (!useCustomEncoding && (useUTF8ForFileName || useUTF8ForComment)) { + // Bit 11: Language encoding flag (EFS). + bitflag |= 0x0800; + } + + + var extFileAttr = 0; + var versionMadeBy = 0; + if (dir) { + // dos or unix, we set the dos dir flag + extFileAttr |= 0x00010; + } + if(platform === "UNIX") { + versionMadeBy = 0x031E; // UNIX, version 3.0 + extFileAttr |= generateUnixExternalFileAttr(file.unixPermissions, dir); + } else { // DOS or other, fallback to DOS + versionMadeBy = 0x0014; // DOS, version 2.0 + extFileAttr |= generateDosExternalFileAttr(file.dosPermissions, dir); + } + + // date + // @see http://www.delorie.com/djgpp/doc/rbinter/it/52/13.html + // @see http://www.delorie.com/djgpp/doc/rbinter/it/65/16.html + // @see http://www.delorie.com/djgpp/doc/rbinter/it/66/16.html + + dosTime = date.getUTCHours(); + dosTime = dosTime << 6; + dosTime = dosTime | date.getUTCMinutes(); + dosTime = dosTime << 5; + dosTime = dosTime | date.getUTCSeconds() / 2; + + dosDate = date.getUTCFullYear() - 1980; + dosDate = dosDate << 4; + dosDate = dosDate | (date.getUTCMonth() + 1); + dosDate = dosDate << 5; + dosDate = dosDate | date.getUTCDate(); + + if (useUTF8ForFileName) { + // set the unicode path extra field. unzip needs at least one extra + // field to correctly handle unicode path, so using the path is as good + // as any other information. This could improve the situation with + // other archive managers too. + // This field is usually used without the utf8 flag, with a non + // unicode path in the header (winrar, winzip). This helps (a bit) + // with the messy Windows' default compressed folders feature but + // breaks on p7zip which doesn't seek the unicode path extra field. + // So for now, UTF-8 everywhere ! + unicodePathExtraField = + // Version + decToHex(1, 1) + + // NameCRC32 + decToHex(crc32(encodedFileName), 4) + + // UnicodeName + utfEncodedFileName; + + extraFields += + // Info-ZIP Unicode Path Extra Field + "\x75\x70" + + // size + decToHex(unicodePathExtraField.length, 2) + + // content + unicodePathExtraField; + } + + if(useUTF8ForComment) { + + unicodeCommentExtraField = + // Version + decToHex(1, 1) + + // CommentCRC32 + decToHex(crc32(encodedComment), 4) + + // UnicodeName + utfEncodedComment; + + extraFields += + // Info-ZIP Unicode Path Extra Field + "\x75\x63" + + // size + decToHex(unicodeCommentExtraField.length, 2) + + // content + unicodeCommentExtraField; + } + + var header = ""; + + // version needed to extract + header += "\x0A\x00"; + // general purpose bit flag + header += decToHex(bitflag, 2); + // compression method + header += compression.magic; + // last mod file time + header += decToHex(dosTime, 2); + // last mod file date + header += decToHex(dosDate, 2); + // crc-32 + header += decToHex(dataInfo.crc32, 4); + // compressed size + header += decToHex(dataInfo.compressedSize, 4); + // uncompressed size + header += decToHex(dataInfo.uncompressedSize, 4); + // file name length + header += decToHex(encodedFileName.length, 2); + // extra field length + header += decToHex(extraFields.length, 2); + + + var fileRecord = signature.LOCAL_FILE_HEADER + header + encodedFileName + extraFields; + + var dirRecord = signature.CENTRAL_FILE_HEADER + + // version made by (00: DOS) + decToHex(versionMadeBy, 2) + + // file header (common to file and central directory) + header + + // file comment length + decToHex(encodedComment.length, 2) + + // disk number start + "\x00\x00" + + // internal file attributes TODO + "\x00\x00" + + // external file attributes + decToHex(extFileAttr, 4) + + // relative offset of local header + decToHex(offset, 4) + + // file name + encodedFileName + + // extra field + extraFields + + // file comment + encodedComment; + + return { + fileRecord: fileRecord, + dirRecord: dirRecord + }; +}; + +/** + * Generate the EOCD record. + * @param {Number} entriesCount the number of entries in the zip file. + * @param {Number} centralDirLength the length (in bytes) of the central dir. + * @param {Number} localDirLength the length (in bytes) of the local dir. + * @param {String} comment the zip file comment as a binary string. + * @param {Function} encodeFileName the function to encode the comment. + * @return {String} the EOCD record. + */ +var generateCentralDirectoryEnd = function (entriesCount, centralDirLength, localDirLength, comment, encodeFileName) { + var dirEnd = ""; + var encodedComment = utils.transformTo("string", encodeFileName(comment)); + + // end of central dir signature + dirEnd = signature.CENTRAL_DIRECTORY_END + + // number of this disk + "\x00\x00" + + // number of the disk with the start of the central directory + "\x00\x00" + + // total number of entries in the central directory on this disk + decToHex(entriesCount, 2) + + // total number of entries in the central directory + decToHex(entriesCount, 2) + + // size of the central directory 4 bytes + decToHex(centralDirLength, 4) + + // offset of start of central directory with respect to the starting disk number + decToHex(localDirLength, 4) + + // .ZIP file comment length + decToHex(encodedComment.length, 2) + + // .ZIP file comment + encodedComment; + + return dirEnd; +}; + +/** + * Generate data descriptors for a file entry. + * @param {Object} streamInfo the hash generated by a worker, containing information + * on the file entry. + * @return {String} the data descriptors. + */ +var generateDataDescriptors = function (streamInfo) { + var descriptor = ""; + descriptor = signature.DATA_DESCRIPTOR + + // crc-32 4 bytes + decToHex(streamInfo['crc32'], 4) + + // compressed size 4 bytes + decToHex(streamInfo['compressedSize'], 4) + + // uncompressed size 4 bytes + decToHex(streamInfo['uncompressedSize'], 4); + + return descriptor; +}; + + +/** + * A worker to concatenate other workers to create a zip file. + * @param {Boolean} streamFiles `true` to stream the content of the files, + * `false` to accumulate it. + * @param {String} comment the comment to use. + * @param {String} platform the platform to use, "UNIX" or "DOS". + * @param {Function} encodeFileName the function to encode file names and comments. + */ +function ZipFileWorker(streamFiles, comment, platform, encodeFileName) { + GenericWorker.call(this, "ZipFileWorker"); + // The number of bytes written so far. This doesn't count accumulated chunks. + this.bytesWritten = 0; + // The comment of the zip file + this.zipComment = comment; + // The platform "generating" the zip file. + this.zipPlatform = platform; + // the function to encode file names and comments. + this.encodeFileName = encodeFileName; + // Should we stream the content of the files ? + this.streamFiles = streamFiles; + // If `streamFiles` is false, we will need to accumulate the content of the + // files to calculate sizes / crc32 (and write them *before* the content). + // This boolean indicates if we are accumulating chunks (it will change a lot + // during the lifetime of this worker). + this.accumulate = false; + // The buffer receiving chunks when accumulating content. + this.contentBuffer = []; + // The list of generated directory records. + this.dirRecords = []; + // The offset (in bytes) from the beginning of the zip file for the current source. + this.currentSourceOffset = 0; + // The total number of entries in this zip file. + this.entriesCount = 0; + // the name of the file currently being added, null when handling the end of the zip file. + // Used for the emitted metadata. + this.currentFile = null; + + + + this._sources = []; +} +utils.inherits(ZipFileWorker, GenericWorker); + +/** + * @see GenericWorker.push + */ +ZipFileWorker.prototype.push = function (chunk) { + + var currentFilePercent = chunk.meta.percent || 0; + var entriesCount = this.entriesCount; + var remainingFiles = this._sources.length; + + if(this.accumulate) { + this.contentBuffer.push(chunk); + } else { + this.bytesWritten += chunk.data.length; + + GenericWorker.prototype.push.call(this, { + data : chunk.data, + meta : { + currentFile : this.currentFile, + percent : entriesCount ? (currentFilePercent + 100 * (entriesCount - remainingFiles - 1)) / entriesCount : 100 + } + }); + } +}; + +/** + * The worker started a new source (an other worker). + * @param {Object} streamInfo the streamInfo object from the new source. + */ +ZipFileWorker.prototype.openedSource = function (streamInfo) { + this.currentSourceOffset = this.bytesWritten; + this.currentFile = streamInfo['file'].name; + + var streamedContent = this.streamFiles && !streamInfo['file'].dir; + + // don't stream folders (because they don't have any content) + if(streamedContent) { + var record = generateZipParts(streamInfo, streamedContent, false, this.currentSourceOffset, this.zipPlatform, this.encodeFileName); + this.push({ + data : record.fileRecord, + meta : {percent:0} + }); + } else { + // we need to wait for the whole file before pushing anything + this.accumulate = true; + } +}; + +/** + * The worker finished a source (an other worker). + * @param {Object} streamInfo the streamInfo object from the finished source. + */ +ZipFileWorker.prototype.closedSource = function (streamInfo) { + this.accumulate = false; + var streamedContent = this.streamFiles && !streamInfo['file'].dir; + var record = generateZipParts(streamInfo, streamedContent, true, this.currentSourceOffset, this.zipPlatform, this.encodeFileName); + + this.dirRecords.push(record.dirRecord); + if(streamedContent) { + // after the streamed file, we put data descriptors + this.push({ + data : generateDataDescriptors(streamInfo), + meta : {percent:100} + }); + } else { + // the content wasn't streamed, we need to push everything now + // first the file record, then the content + this.push({ + data : record.fileRecord, + meta : {percent:0} + }); + while(this.contentBuffer.length) { + this.push(this.contentBuffer.shift()); + } + } + this.currentFile = null; +}; + +/** + * @see GenericWorker.flush + */ +ZipFileWorker.prototype.flush = function () { + + var localDirLength = this.bytesWritten; + for(var i = 0; i < this.dirRecords.length; i++) { + this.push({ + data : this.dirRecords[i], + meta : {percent:100} + }); + } + var centralDirLength = this.bytesWritten - localDirLength; + + var dirEnd = generateCentralDirectoryEnd(this.dirRecords.length, centralDirLength, localDirLength, this.zipComment, this.encodeFileName); + + this.push({ + data : dirEnd, + meta : {percent:100} + }); +}; + +/** + * Prepare the next source to be read. + */ +ZipFileWorker.prototype.prepareNextSource = function () { + this.previous = this._sources.shift(); + this.openedSource(this.previous.streamInfo); + if (this.isPaused) { + this.previous.pause(); + } else { + this.previous.resume(); + } +}; + +/** + * @see GenericWorker.registerPrevious + */ +ZipFileWorker.prototype.registerPrevious = function (previous) { + this._sources.push(previous); + var self = this; + + previous.on('data', function (chunk) { + self.processChunk(chunk); + }); + previous.on('end', function () { + self.closedSource(self.previous.streamInfo); + if(self._sources.length) { + self.prepareNextSource(); + } else { + self.end(); + } + }); + previous.on('error', function (e) { + self.error(e); + }); + return this; +}; + +/** + * @see GenericWorker.resume + */ +ZipFileWorker.prototype.resume = function () { + if(!GenericWorker.prototype.resume.call(this)) { + return false; + } + + if (!this.previous && this._sources.length) { + this.prepareNextSource(); + return true; + } + if (!this.previous && !this._sources.length && !this.generatedError) { + this.end(); + return true; + } +}; + +/** + * @see GenericWorker.error + */ +ZipFileWorker.prototype.error = function (e) { + var sources = this._sources; + if(!GenericWorker.prototype.error.call(this, e)) { + return false; + } + for(var i = 0; i < sources.length; i++) { + try { + sources[i].error(e); + } catch(e) { + // the `error` exploded, nothing to do + } + } + return true; +}; + +/** + * @see GenericWorker.lock + */ +ZipFileWorker.prototype.lock = function () { + GenericWorker.prototype.lock.call(this); + var sources = this._sources; + for(var i = 0; i < sources.length; i++) { + sources[i].lock(); + } +}; + +module.exports = ZipFileWorker; + +},{"../crc32":4,"../signature":23,"../stream/GenericWorker":28,"../utf8":31,"../utils":32}],9:[function(require,module,exports){ +'use strict'; + +var compressions = require('../compressions'); +var ZipFileWorker = require('./ZipFileWorker'); + +/** + * Find the compression to use. + * @param {String} fileCompression the compression defined at the file level, if any. + * @param {String} zipCompression the compression defined at the load() level. + * @return {Object} the compression object to use. + */ +var getCompression = function (fileCompression, zipCompression) { + + var compressionName = fileCompression || zipCompression; + var compression = compressions[compressionName]; + if (!compression) { + throw new Error(compressionName + " is not a valid compression method !"); + } + return compression; +}; + +/** + * Create a worker to generate a zip file. + * @param {JSZip} zip the JSZip instance at the right root level. + * @param {Object} options to generate the zip file. + * @param {String} comment the comment to use. + */ +exports.generateWorker = function (zip, options, comment) { + + var zipFileWorker = new ZipFileWorker(options.streamFiles, comment, options.platform, options.encodeFileName); + var entriesCount = 0; + try { + + zip.forEach(function (relativePath, file) { + entriesCount++; + var compression = getCompression(file.options.compression, options.compression); + var compressionOptions = file.options.compressionOptions || options.compressionOptions || {}; + var dir = file.dir, date = file.date; + + file._compressWorker(compression, compressionOptions) + .withStreamInfo("file", { + name : relativePath, + dir : dir, + date : date, + comment : file.comment || "", + unixPermissions : file.unixPermissions, + dosPermissions : file.dosPermissions + }) + .pipe(zipFileWorker); + }); + zipFileWorker.entriesCount = entriesCount; + } catch (e) { + zipFileWorker.error(e); + } + + return zipFileWorker; +}; + +},{"../compressions":3,"./ZipFileWorker":8}],10:[function(require,module,exports){ +'use strict'; + +/** + * Representation a of zip file in js + * @constructor + */ +function JSZip() { + // if this constructor is used without `new`, it adds `new` before itself: + if(!(this instanceof JSZip)) { + return new JSZip(); + } + + if(arguments.length) { + throw new Error("The constructor with parameters has been removed in JSZip 3.0, please check the upgrade guide."); + } + + // object containing the files : + // { + // "folder/" : {...}, + // "folder/data.txt" : {...} + // } + // NOTE: we use a null prototype because we do not + // want filenames like "toString" coming from a zip file + // to overwrite methods and attributes in a normal Object. + this.files = Object.create(null); + + this.comment = null; + + // Where we are in the hierarchy + this.root = ""; + this.clone = function() { + var newObj = new JSZip(); + for (var i in this) { + if (typeof this[i] !== "function") { + newObj[i] = this[i]; + } + } + return newObj; + }; +} +JSZip.prototype = require('./object'); +JSZip.prototype.loadAsync = require('./load'); +JSZip.support = require('./support'); +JSZip.defaults = require('./defaults'); + +// TODO find a better way to handle this version, +// a require('package.json').version doesn't work with webpack, see #327 +JSZip.version = "3.7.1"; + +JSZip.loadAsync = function (content, options) { + return new JSZip().loadAsync(content, options); +}; + +JSZip.external = require("./external"); +module.exports = JSZip; + +},{"./defaults":5,"./external":6,"./load":11,"./object":15,"./support":30}],11:[function(require,module,exports){ +'use strict'; +var utils = require('./utils'); +var external = require("./external"); +var utf8 = require('./utf8'); +var ZipEntries = require('./zipEntries'); +var Crc32Probe = require('./stream/Crc32Probe'); +var nodejsUtils = require("./nodejsUtils"); + +/** + * Check the CRC32 of an entry. + * @param {ZipEntry} zipEntry the zip entry to check. + * @return {Promise} the result. + */ +function checkEntryCRC32(zipEntry) { + return new external.Promise(function (resolve, reject) { + var worker = zipEntry.decompressed.getContentWorker().pipe(new Crc32Probe()); + worker.on("error", function (e) { + reject(e); + }) + .on("end", function () { + if (worker.streamInfo.crc32 !== zipEntry.decompressed.crc32) { + reject(new Error("Corrupted zip : CRC32 mismatch")); + } else { + resolve(); + } + }) + .resume(); + }); +} + +module.exports = function (data, options) { + var zip = this; + options = utils.extend(options || {}, { + base64: false, + checkCRC32: false, + optimizedBinaryString: false, + createFolders: false, + decodeFileName: utf8.utf8decode + }); + + if (nodejsUtils.isNode && nodejsUtils.isStream(data)) { + return external.Promise.reject(new Error("JSZip can't accept a stream when loading a zip file.")); + } + + return utils.prepareContent("the loaded zip file", data, true, options.optimizedBinaryString, options.base64) + .then(function (data) { + var zipEntries = new ZipEntries(options); + zipEntries.load(data); + return zipEntries; + }).then(function checkCRC32(zipEntries) { + var promises = [external.Promise.resolve(zipEntries)]; + var files = zipEntries.files; + if (options.checkCRC32) { + for (var i = 0; i < files.length; i++) { + promises.push(checkEntryCRC32(files[i])); + } + } + return external.Promise.all(promises); + }).then(function addFiles(results) { + var zipEntries = results.shift(); + var files = zipEntries.files; + for (var i = 0; i < files.length; i++) { + var input = files[i]; + zip.file(input.fileNameStr, input.decompressed, { + binary: true, + optimizedBinaryString: true, + date: input.date, + dir: input.dir, + comment: input.fileCommentStr.length ? input.fileCommentStr : null, + unixPermissions: input.unixPermissions, + dosPermissions: input.dosPermissions, + createFolders: options.createFolders + }); + } + if (zipEntries.zipComment.length) { + zip.comment = zipEntries.zipComment; + } + + return zip; + }); +}; + +},{"./external":6,"./nodejsUtils":14,"./stream/Crc32Probe":25,"./utf8":31,"./utils":32,"./zipEntries":33}],12:[function(require,module,exports){ +"use strict"; + +var utils = require('../utils'); +var GenericWorker = require('../stream/GenericWorker'); + +/** + * A worker that use a nodejs stream as source. + * @constructor + * @param {String} filename the name of the file entry for this stream. + * @param {Readable} stream the nodejs stream. + */ +function NodejsStreamInputAdapter(filename, stream) { + GenericWorker.call(this, "Nodejs stream input adapter for " + filename); + this._upstreamEnded = false; + this._bindStream(stream); +} + +utils.inherits(NodejsStreamInputAdapter, GenericWorker); + +/** + * Prepare the stream and bind the callbacks on it. + * Do this ASAP on node 0.10 ! A lazy binding doesn't always work. + * @param {Stream} stream the nodejs stream to use. + */ +NodejsStreamInputAdapter.prototype._bindStream = function (stream) { + var self = this; + this._stream = stream; + stream.pause(); + stream + .on("data", function (chunk) { + self.push({ + data: chunk, + meta : { + percent : 0 + } + }); + }) + .on("error", function (e) { + if(self.isPaused) { + this.generatedError = e; + } else { + self.error(e); + } + }) + .on("end", function () { + if(self.isPaused) { + self._upstreamEnded = true; + } else { + self.end(); + } + }); +}; +NodejsStreamInputAdapter.prototype.pause = function () { + if(!GenericWorker.prototype.pause.call(this)) { + return false; + } + this._stream.pause(); + return true; +}; +NodejsStreamInputAdapter.prototype.resume = function () { + if(!GenericWorker.prototype.resume.call(this)) { + return false; + } + + if(this._upstreamEnded) { + this.end(); + } else { + this._stream.resume(); + } + + return true; +}; + +module.exports = NodejsStreamInputAdapter; + +},{"../stream/GenericWorker":28,"../utils":32}],13:[function(require,module,exports){ +'use strict'; + +var Readable = require('readable-stream').Readable; + +var utils = require('../utils'); +utils.inherits(NodejsStreamOutputAdapter, Readable); + +/** +* A nodejs stream using a worker as source. +* @see the SourceWrapper in http://nodejs.org/api/stream.html +* @constructor +* @param {StreamHelper} helper the helper wrapping the worker +* @param {Object} options the nodejs stream options +* @param {Function} updateCb the update callback. +*/ +function NodejsStreamOutputAdapter(helper, options, updateCb) { + Readable.call(this, options); + this._helper = helper; + + var self = this; + helper.on("data", function (data, meta) { + if (!self.push(data)) { + self._helper.pause(); + } + if(updateCb) { + updateCb(meta); + } + }) + .on("error", function(e) { + self.emit('error', e); + }) + .on("end", function () { + self.push(null); + }); +} + + +NodejsStreamOutputAdapter.prototype._read = function() { + this._helper.resume(); +}; + +module.exports = NodejsStreamOutputAdapter; + +},{"../utils":32,"readable-stream":16}],14:[function(require,module,exports){ +'use strict'; + +module.exports = { + /** + * True if this is running in Nodejs, will be undefined in a browser. + * In a browser, browserify won't include this file and the whole module + * will be resolved an empty object. + */ + isNode : typeof Buffer !== "undefined", + /** + * Create a new nodejs Buffer from an existing content. + * @param {Object} data the data to pass to the constructor. + * @param {String} encoding the encoding to use. + * @return {Buffer} a new Buffer. + */ + newBufferFrom: function(data, encoding) { + if (Buffer.from && Buffer.from !== Uint8Array.from) { + return Buffer.from(data, encoding); + } else { + if (typeof data === "number") { + // Safeguard for old Node.js versions. On newer versions, + // Buffer.from(number) / Buffer(number, encoding) already throw. + throw new Error("The \"data\" argument must not be a number"); + } + return new Buffer(data, encoding); + } + }, + /** + * Create a new nodejs Buffer with the specified size. + * @param {Integer} size the size of the buffer. + * @return {Buffer} a new Buffer. + */ + allocBuffer: function (size) { + if (Buffer.alloc) { + return Buffer.alloc(size); + } else { + var buf = new Buffer(size); + buf.fill(0); + return buf; + } + }, + /** + * Find out if an object is a Buffer. + * @param {Object} b the object to test. + * @return {Boolean} true if the object is a Buffer, false otherwise. + */ + isBuffer : function(b){ + return Buffer.isBuffer(b); + }, + + isStream : function (obj) { + return obj && + typeof obj.on === "function" && + typeof obj.pause === "function" && + typeof obj.resume === "function"; + } +}; + +},{}],15:[function(require,module,exports){ +'use strict'; +var utf8 = require('./utf8'); +var utils = require('./utils'); +var GenericWorker = require('./stream/GenericWorker'); +var StreamHelper = require('./stream/StreamHelper'); +var defaults = require('./defaults'); +var CompressedObject = require('./compressedObject'); +var ZipObject = require('./zipObject'); +var generate = require("./generate"); +var nodejsUtils = require("./nodejsUtils"); +var NodejsStreamInputAdapter = require("./nodejs/NodejsStreamInputAdapter"); + + +/** + * Add a file in the current folder. + * @private + * @param {string} name the name of the file + * @param {String|ArrayBuffer|Uint8Array|Buffer} data the data of the file + * @param {Object} originalOptions the options of the file + * @return {Object} the new file. + */ +var fileAdd = function(name, data, originalOptions) { + // be sure sub folders exist + var dataType = utils.getTypeOf(data), + parent; + + + /* + * Correct options. + */ + + var o = utils.extend(originalOptions || {}, defaults); + o.date = o.date || new Date(); + if (o.compression !== null) { + o.compression = o.compression.toUpperCase(); + } + + if (typeof o.unixPermissions === "string") { + o.unixPermissions = parseInt(o.unixPermissions, 8); + } + + // UNX_IFDIR 0040000 see zipinfo.c + if (o.unixPermissions && (o.unixPermissions & 0x4000)) { + o.dir = true; + } + // Bit 4 Directory + if (o.dosPermissions && (o.dosPermissions & 0x0010)) { + o.dir = true; + } + + if (o.dir) { + name = forceTrailingSlash(name); + } + if (o.createFolders && (parent = parentFolder(name))) { + folderAdd.call(this, parent, true); + } + + var isUnicodeString = dataType === "string" && o.binary === false && o.base64 === false; + if (!originalOptions || typeof originalOptions.binary === "undefined") { + o.binary = !isUnicodeString; + } + + + var isCompressedEmpty = (data instanceof CompressedObject) && data.uncompressedSize === 0; + + if (isCompressedEmpty || o.dir || !data || data.length === 0) { + o.base64 = false; + o.binary = true; + data = ""; + o.compression = "STORE"; + dataType = "string"; + } + + /* + * Convert content to fit. + */ + + var zipObjectContent = null; + if (data instanceof CompressedObject || data instanceof GenericWorker) { + zipObjectContent = data; + } else if (nodejsUtils.isNode && nodejsUtils.isStream(data)) { + zipObjectContent = new NodejsStreamInputAdapter(name, data); + } else { + zipObjectContent = utils.prepareContent(name, data, o.binary, o.optimizedBinaryString, o.base64); + } + + var object = new ZipObject(name, zipObjectContent, o); + this.files[name] = object; + /* + TODO: we can't throw an exception because we have async promises + (we can have a promise of a Date() for example) but returning a + promise is useless because file(name, data) returns the JSZip + object for chaining. Should we break that to allow the user + to catch the error ? + + return external.Promise.resolve(zipObjectContent) + .then(function () { + return object; + }); + */ +}; + +/** + * Find the parent folder of the path. + * @private + * @param {string} path the path to use + * @return {string} the parent folder, or "" + */ +var parentFolder = function (path) { + if (path.slice(-1) === '/') { + path = path.substring(0, path.length - 1); + } + var lastSlash = path.lastIndexOf('/'); + return (lastSlash > 0) ? path.substring(0, lastSlash) : ""; +}; + +/** + * Returns the path with a slash at the end. + * @private + * @param {String} path the path to check. + * @return {String} the path with a trailing slash. + */ +var forceTrailingSlash = function(path) { + // Check the name ends with a / + if (path.slice(-1) !== "/") { + path += "/"; // IE doesn't like substr(-1) + } + return path; +}; + +/** + * Add a (sub) folder in the current folder. + * @private + * @param {string} name the folder's name + * @param {boolean=} [createFolders] If true, automatically create sub + * folders. Defaults to false. + * @return {Object} the new folder. + */ +var folderAdd = function(name, createFolders) { + createFolders = (typeof createFolders !== 'undefined') ? createFolders : defaults.createFolders; + + name = forceTrailingSlash(name); + + // Does this folder already exist? + if (!this.files[name]) { + fileAdd.call(this, name, null, { + dir: true, + createFolders: createFolders + }); + } + return this.files[name]; +}; + +/** +* Cross-window, cross-Node-context regular expression detection +* @param {Object} object Anything +* @return {Boolean} true if the object is a regular expression, +* false otherwise +*/ +function isRegExp(object) { + return Object.prototype.toString.call(object) === "[object RegExp]"; +} + +// return the actual prototype of JSZip +var out = { + /** + * @see loadAsync + */ + load: function() { + throw new Error("This method has been removed in JSZip 3.0, please check the upgrade guide."); + }, + + + /** + * Call a callback function for each entry at this folder level. + * @param {Function} cb the callback function: + * function (relativePath, file) {...} + * It takes 2 arguments : the relative path and the file. + */ + forEach: function(cb) { + var filename, relativePath, file; + /* jshint ignore:start */ + // ignore warning about unwanted properties because this.files is a null prototype object + for (filename in this.files) { + file = this.files[filename]; + relativePath = filename.slice(this.root.length, filename.length); + if (relativePath && filename.slice(0, this.root.length) === this.root) { // the file is in the current root + cb(relativePath, file); // TODO reverse the parameters ? need to be clean AND consistent with the filter search fn... + } + } + /* jshint ignore:end */ + }, + + /** + * Filter nested files/folders with the specified function. + * @param {Function} search the predicate to use : + * function (relativePath, file) {...} + * It takes 2 arguments : the relative path and the file. + * @return {Array} An array of matching elements. + */ + filter: function(search) { + var result = []; + this.forEach(function (relativePath, entry) { + if (search(relativePath, entry)) { // the file matches the function + result.push(entry); + } + + }); + return result; + }, + + /** + * Add a file to the zip file, or search a file. + * @param {string|RegExp} name The name of the file to add (if data is defined), + * the name of the file to find (if no data) or a regex to match files. + * @param {String|ArrayBuffer|Uint8Array|Buffer} data The file data, either raw or base64 encoded + * @param {Object} o File options + * @return {JSZip|Object|Array} this JSZip object (when adding a file), + * a file (when searching by string) or an array of files (when searching by regex). + */ + file: function(name, data, o) { + if (arguments.length === 1) { + if (isRegExp(name)) { + var regexp = name; + return this.filter(function(relativePath, file) { + return !file.dir && regexp.test(relativePath); + }); + } + else { // text + var obj = this.files[this.root + name]; + if (obj && !obj.dir) { + return obj; + } else { + return null; + } + } + } + else { // more than one argument : we have data ! + name = this.root + name; + fileAdd.call(this, name, data, o); + } + return this; + }, + + /** + * Add a directory to the zip file, or search. + * @param {String|RegExp} arg The name of the directory to add, or a regex to search folders. + * @return {JSZip} an object with the new directory as the root, or an array containing matching folders. + */ + folder: function(arg) { + if (!arg) { + return this; + } + + if (isRegExp(arg)) { + return this.filter(function(relativePath, file) { + return file.dir && arg.test(relativePath); + }); + } + + // else, name is a new folder + var name = this.root + arg; + var newFolder = folderAdd.call(this, name); + + // Allow chaining by returning a new object with this folder as the root + var ret = this.clone(); + ret.root = newFolder.name; + return ret; + }, + + /** + * Delete a file, or a directory and all sub-files, from the zip + * @param {string} name the name of the file to delete + * @return {JSZip} this JSZip object + */ + remove: function(name) { + name = this.root + name; + var file = this.files[name]; + if (!file) { + // Look for any folders + if (name.slice(-1) !== "/") { + name += "/"; + } + file = this.files[name]; + } + + if (file && !file.dir) { + // file + delete this.files[name]; + } else { + // maybe a folder, delete recursively + var kids = this.filter(function(relativePath, file) { + return file.name.slice(0, name.length) === name; + }); + for (var i = 0; i < kids.length; i++) { + delete this.files[kids[i].name]; + } + } + + return this; + }, + + /** + * Generate the complete zip file + * @param {Object} options the options to generate the zip file : + * - compression, "STORE" by default. + * - type, "base64" by default. Values are : string, base64, uint8array, arraybuffer, blob. + * @return {String|Uint8Array|ArrayBuffer|Buffer|Blob} the zip file + */ + generate: function(options) { + throw new Error("This method has been removed in JSZip 3.0, please check the upgrade guide."); + }, + + /** + * Generate the complete zip file as an internal stream. + * @param {Object} options the options to generate the zip file : + * - compression, "STORE" by default. + * - type, "base64" by default. Values are : string, base64, uint8array, arraybuffer, blob. + * @return {StreamHelper} the streamed zip file. + */ + generateInternalStream: function(options) { + var worker, opts = {}; + try { + opts = utils.extend(options || {}, { + streamFiles: false, + compression: "STORE", + compressionOptions : null, + type: "", + platform: "DOS", + comment: null, + mimeType: 'application/zip', + encodeFileName: utf8.utf8encode + }); + + opts.type = opts.type.toLowerCase(); + opts.compression = opts.compression.toUpperCase(); + + // "binarystring" is preferred but the internals use "string". + if(opts.type === "binarystring") { + opts.type = "string"; + } + + if (!opts.type) { + throw new Error("No output type specified."); + } + + utils.checkSupport(opts.type); + + // accept nodejs `process.platform` + if( + opts.platform === 'darwin' || + opts.platform === 'freebsd' || + opts.platform === 'linux' || + opts.platform === 'sunos' + ) { + opts.platform = "UNIX"; + } + if (opts.platform === 'win32') { + opts.platform = "DOS"; + } + + var comment = opts.comment || this.comment || ""; + worker = generate.generateWorker(this, opts, comment); + } catch (e) { + worker = new GenericWorker("error"); + worker.error(e); + } + return new StreamHelper(worker, opts.type || "string", opts.mimeType); + }, + /** + * Generate the complete zip file asynchronously. + * @see generateInternalStream + */ + generateAsync: function(options, onUpdate) { + return this.generateInternalStream(options).accumulate(onUpdate); + }, + /** + * Generate the complete zip file asynchronously. + * @see generateInternalStream + */ + generateNodeStream: function(options, onUpdate) { + options = options || {}; + if (!options.type) { + options.type = "nodebuffer"; + } + return this.generateInternalStream(options).toNodejsStream(onUpdate); + } +}; +module.exports = out; + +},{"./compressedObject":2,"./defaults":5,"./generate":9,"./nodejs/NodejsStreamInputAdapter":12,"./nodejsUtils":14,"./stream/GenericWorker":28,"./stream/StreamHelper":29,"./utf8":31,"./utils":32,"./zipObject":35}],16:[function(require,module,exports){ +/* + * This file is used by module bundlers (browserify/webpack/etc) when + * including a stream implementation. We use "readable-stream" to get a + * consistent behavior between nodejs versions but bundlers often have a shim + * for "stream". Using this shim greatly improve the compatibility and greatly + * reduce the final size of the bundle (only one stream implementation, not + * two). + */ +module.exports = require("stream"); + +},{"stream":undefined}],17:[function(require,module,exports){ +'use strict'; +var DataReader = require('./DataReader'); +var utils = require('../utils'); + +function ArrayReader(data) { + DataReader.call(this, data); + for(var i = 0; i < this.data.length; i++) { + data[i] = data[i] & 0xFF; + } +} +utils.inherits(ArrayReader, DataReader); +/** + * @see DataReader.byteAt + */ +ArrayReader.prototype.byteAt = function(i) { + return this.data[this.zero + i]; +}; +/** + * @see DataReader.lastIndexOfSignature + */ +ArrayReader.prototype.lastIndexOfSignature = function(sig) { + var sig0 = sig.charCodeAt(0), + sig1 = sig.charCodeAt(1), + sig2 = sig.charCodeAt(2), + sig3 = sig.charCodeAt(3); + for (var i = this.length - 4; i >= 0; --i) { + if (this.data[i] === sig0 && this.data[i + 1] === sig1 && this.data[i + 2] === sig2 && this.data[i + 3] === sig3) { + return i - this.zero; + } + } + + return -1; +}; +/** + * @see DataReader.readAndCheckSignature + */ +ArrayReader.prototype.readAndCheckSignature = function (sig) { + var sig0 = sig.charCodeAt(0), + sig1 = sig.charCodeAt(1), + sig2 = sig.charCodeAt(2), + sig3 = sig.charCodeAt(3), + data = this.readData(4); + return sig0 === data[0] && sig1 === data[1] && sig2 === data[2] && sig3 === data[3]; +}; +/** + * @see DataReader.readData + */ +ArrayReader.prototype.readData = function(size) { + this.checkOffset(size); + if(size === 0) { + return []; + } + var result = this.data.slice(this.zero + this.index, this.zero + this.index + size); + this.index += size; + return result; +}; +module.exports = ArrayReader; + +},{"../utils":32,"./DataReader":18}],18:[function(require,module,exports){ +'use strict'; +var utils = require('../utils'); + +function DataReader(data) { + this.data = data; // type : see implementation + this.length = data.length; + this.index = 0; + this.zero = 0; +} +DataReader.prototype = { + /** + * Check that the offset will not go too far. + * @param {string} offset the additional offset to check. + * @throws {Error} an Error if the offset is out of bounds. + */ + checkOffset: function(offset) { + this.checkIndex(this.index + offset); + }, + /** + * Check that the specified index will not be too far. + * @param {string} newIndex the index to check. + * @throws {Error} an Error if the index is out of bounds. + */ + checkIndex: function(newIndex) { + if (this.length < this.zero + newIndex || newIndex < 0) { + throw new Error("End of data reached (data length = " + this.length + ", asked index = " + (newIndex) + "). Corrupted zip ?"); + } + }, + /** + * Change the index. + * @param {number} newIndex The new index. + * @throws {Error} if the new index is out of the data. + */ + setIndex: function(newIndex) { + this.checkIndex(newIndex); + this.index = newIndex; + }, + /** + * Skip the next n bytes. + * @param {number} n the number of bytes to skip. + * @throws {Error} if the new index is out of the data. + */ + skip: function(n) { + this.setIndex(this.index + n); + }, + /** + * Get the byte at the specified index. + * @param {number} i the index to use. + * @return {number} a byte. + */ + byteAt: function(i) { + // see implementations + }, + /** + * Get the next number with a given byte size. + * @param {number} size the number of bytes to read. + * @return {number} the corresponding number. + */ + readInt: function(size) { + var result = 0, + i; + this.checkOffset(size); + for (i = this.index + size - 1; i >= this.index; i--) { + result = (result << 8) + this.byteAt(i); + } + this.index += size; + return result; + }, + /** + * Get the next string with a given byte size. + * @param {number} size the number of bytes to read. + * @return {string} the corresponding string. + */ + readString: function(size) { + return utils.transformTo("string", this.readData(size)); + }, + /** + * Get raw data without conversion, bytes. + * @param {number} size the number of bytes to read. + * @return {Object} the raw data, implementation specific. + */ + readData: function(size) { + // see implementations + }, + /** + * Find the last occurrence of a zip signature (4 bytes). + * @param {string} sig the signature to find. + * @return {number} the index of the last occurrence, -1 if not found. + */ + lastIndexOfSignature: function(sig) { + // see implementations + }, + /** + * Read the signature (4 bytes) at the current position and compare it with sig. + * @param {string} sig the expected signature + * @return {boolean} true if the signature matches, false otherwise. + */ + readAndCheckSignature: function(sig) { + // see implementations + }, + /** + * Get the next date. + * @return {Date} the date. + */ + readDate: function() { + var dostime = this.readInt(4); + return new Date(Date.UTC( + ((dostime >> 25) & 0x7f) + 1980, // year + ((dostime >> 21) & 0x0f) - 1, // month + (dostime >> 16) & 0x1f, // day + (dostime >> 11) & 0x1f, // hour + (dostime >> 5) & 0x3f, // minute + (dostime & 0x1f) << 1)); // second + } +}; +module.exports = DataReader; + +},{"../utils":32}],19:[function(require,module,exports){ +'use strict'; +var Uint8ArrayReader = require('./Uint8ArrayReader'); +var utils = require('../utils'); + +function NodeBufferReader(data) { + Uint8ArrayReader.call(this, data); +} +utils.inherits(NodeBufferReader, Uint8ArrayReader); + +/** + * @see DataReader.readData + */ +NodeBufferReader.prototype.readData = function(size) { + this.checkOffset(size); + var result = this.data.slice(this.zero + this.index, this.zero + this.index + size); + this.index += size; + return result; +}; +module.exports = NodeBufferReader; + +},{"../utils":32,"./Uint8ArrayReader":21}],20:[function(require,module,exports){ +'use strict'; +var DataReader = require('./DataReader'); +var utils = require('../utils'); + +function StringReader(data) { + DataReader.call(this, data); +} +utils.inherits(StringReader, DataReader); +/** + * @see DataReader.byteAt + */ +StringReader.prototype.byteAt = function(i) { + return this.data.charCodeAt(this.zero + i); +}; +/** + * @see DataReader.lastIndexOfSignature + */ +StringReader.prototype.lastIndexOfSignature = function(sig) { + return this.data.lastIndexOf(sig) - this.zero; +}; +/** + * @see DataReader.readAndCheckSignature + */ +StringReader.prototype.readAndCheckSignature = function (sig) { + var data = this.readData(4); + return sig === data; +}; +/** + * @see DataReader.readData + */ +StringReader.prototype.readData = function(size) { + this.checkOffset(size); + // this will work because the constructor applied the "& 0xff" mask. + var result = this.data.slice(this.zero + this.index, this.zero + this.index + size); + this.index += size; + return result; +}; +module.exports = StringReader; + +},{"../utils":32,"./DataReader":18}],21:[function(require,module,exports){ +'use strict'; +var ArrayReader = require('./ArrayReader'); +var utils = require('../utils'); + +function Uint8ArrayReader(data) { + ArrayReader.call(this, data); +} +utils.inherits(Uint8ArrayReader, ArrayReader); +/** + * @see DataReader.readData + */ +Uint8ArrayReader.prototype.readData = function(size) { + this.checkOffset(size); + if(size === 0) { + // in IE10, when using subarray(idx, idx), we get the array [0x00] instead of []. + return new Uint8Array(0); + } + var result = this.data.subarray(this.zero + this.index, this.zero + this.index + size); + this.index += size; + return result; +}; +module.exports = Uint8ArrayReader; + +},{"../utils":32,"./ArrayReader":17}],22:[function(require,module,exports){ +'use strict'; + +var utils = require('../utils'); +var support = require('../support'); +var ArrayReader = require('./ArrayReader'); +var StringReader = require('./StringReader'); +var NodeBufferReader = require('./NodeBufferReader'); +var Uint8ArrayReader = require('./Uint8ArrayReader'); + +/** + * Create a reader adapted to the data. + * @param {String|ArrayBuffer|Uint8Array|Buffer} data the data to read. + * @return {DataReader} the data reader. + */ +module.exports = function (data) { + var type = utils.getTypeOf(data); + utils.checkSupport(type); + if (type === "string" && !support.uint8array) { + return new StringReader(data); + } + if (type === "nodebuffer") { + return new NodeBufferReader(data); + } + if (support.uint8array) { + return new Uint8ArrayReader(utils.transformTo("uint8array", data)); + } + return new ArrayReader(utils.transformTo("array", data)); +}; + +},{"../support":30,"../utils":32,"./ArrayReader":17,"./NodeBufferReader":19,"./StringReader":20,"./Uint8ArrayReader":21}],23:[function(require,module,exports){ +'use strict'; +exports.LOCAL_FILE_HEADER = "PK\x03\x04"; +exports.CENTRAL_FILE_HEADER = "PK\x01\x02"; +exports.CENTRAL_DIRECTORY_END = "PK\x05\x06"; +exports.ZIP64_CENTRAL_DIRECTORY_LOCATOR = "PK\x06\x07"; +exports.ZIP64_CENTRAL_DIRECTORY_END = "PK\x06\x06"; +exports.DATA_DESCRIPTOR = "PK\x07\x08"; + +},{}],24:[function(require,module,exports){ +'use strict'; + +var GenericWorker = require('./GenericWorker'); +var utils = require('../utils'); + +/** + * A worker which convert chunks to a specified type. + * @constructor + * @param {String} destType the destination type. + */ +function ConvertWorker(destType) { + GenericWorker.call(this, "ConvertWorker to " + destType); + this.destType = destType; +} +utils.inherits(ConvertWorker, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +ConvertWorker.prototype.processChunk = function (chunk) { + this.push({ + data : utils.transformTo(this.destType, chunk.data), + meta : chunk.meta + }); +}; +module.exports = ConvertWorker; + +},{"../utils":32,"./GenericWorker":28}],25:[function(require,module,exports){ +'use strict'; + +var GenericWorker = require('./GenericWorker'); +var crc32 = require('../crc32'); +var utils = require('../utils'); + +/** + * A worker which calculate the crc32 of the data flowing through. + * @constructor + */ +function Crc32Probe() { + GenericWorker.call(this, "Crc32Probe"); + this.withStreamInfo("crc32", 0); +} +utils.inherits(Crc32Probe, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +Crc32Probe.prototype.processChunk = function (chunk) { + this.streamInfo.crc32 = crc32(chunk.data, this.streamInfo.crc32 || 0); + this.push(chunk); +}; +module.exports = Crc32Probe; + +},{"../crc32":4,"../utils":32,"./GenericWorker":28}],26:[function(require,module,exports){ +'use strict'; + +var utils = require('../utils'); +var GenericWorker = require('./GenericWorker'); + +/** + * A worker which calculate the total length of the data flowing through. + * @constructor + * @param {String} propName the name used to expose the length + */ +function DataLengthProbe(propName) { + GenericWorker.call(this, "DataLengthProbe for " + propName); + this.propName = propName; + this.withStreamInfo(propName, 0); +} +utils.inherits(DataLengthProbe, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +DataLengthProbe.prototype.processChunk = function (chunk) { + if(chunk) { + var length = this.streamInfo[this.propName] || 0; + this.streamInfo[this.propName] = length + chunk.data.length; + } + GenericWorker.prototype.processChunk.call(this, chunk); +}; +module.exports = DataLengthProbe; + + +},{"../utils":32,"./GenericWorker":28}],27:[function(require,module,exports){ +'use strict'; + +var utils = require('../utils'); +var GenericWorker = require('./GenericWorker'); + +// the size of the generated chunks +// TODO expose this as a public variable +var DEFAULT_BLOCK_SIZE = 16 * 1024; + +/** + * A worker that reads a content and emits chunks. + * @constructor + * @param {Promise} dataP the promise of the data to split + */ +function DataWorker(dataP) { + GenericWorker.call(this, "DataWorker"); + var self = this; + this.dataIsReady = false; + this.index = 0; + this.max = 0; + this.data = null; + this.type = ""; + + this._tickScheduled = false; + + dataP.then(function (data) { + self.dataIsReady = true; + self.data = data; + self.max = data && data.length || 0; + self.type = utils.getTypeOf(data); + if(!self.isPaused) { + self._tickAndRepeat(); + } + }, function (e) { + self.error(e); + }); +} + +utils.inherits(DataWorker, GenericWorker); + +/** + * @see GenericWorker.cleanUp + */ +DataWorker.prototype.cleanUp = function () { + GenericWorker.prototype.cleanUp.call(this); + this.data = null; +}; + +/** + * @see GenericWorker.resume + */ +DataWorker.prototype.resume = function () { + if(!GenericWorker.prototype.resume.call(this)) { + return false; + } + + if (!this._tickScheduled && this.dataIsReady) { + this._tickScheduled = true; + utils.delay(this._tickAndRepeat, [], this); + } + return true; +}; + +/** + * Trigger a tick a schedule an other call to this function. + */ +DataWorker.prototype._tickAndRepeat = function() { + this._tickScheduled = false; + if(this.isPaused || this.isFinished) { + return; + } + this._tick(); + if(!this.isFinished) { + utils.delay(this._tickAndRepeat, [], this); + this._tickScheduled = true; + } +}; + +/** + * Read and push a chunk. + */ +DataWorker.prototype._tick = function() { + + if(this.isPaused || this.isFinished) { + return false; + } + + var size = DEFAULT_BLOCK_SIZE; + var data = null, nextIndex = Math.min(this.max, this.index + size); + if (this.index >= this.max) { + // EOF + return this.end(); + } else { + switch(this.type) { + case "string": + data = this.data.substring(this.index, nextIndex); + break; + case "uint8array": + data = this.data.subarray(this.index, nextIndex); + break; + case "array": + case "nodebuffer": + data = this.data.slice(this.index, nextIndex); + break; + } + this.index = nextIndex; + return this.push({ + data : data, + meta : { + percent : this.max ? this.index / this.max * 100 : 0 + } + }); + } +}; + +module.exports = DataWorker; + +},{"../utils":32,"./GenericWorker":28}],28:[function(require,module,exports){ +'use strict'; + +/** + * A worker that does nothing but passing chunks to the next one. This is like + * a nodejs stream but with some differences. On the good side : + * - it works on IE 6-9 without any issue / polyfill + * - it weights less than the full dependencies bundled with browserify + * - it forwards errors (no need to declare an error handler EVERYWHERE) + * + * A chunk is an object with 2 attributes : `meta` and `data`. The former is an + * object containing anything (`percent` for example), see each worker for more + * details. The latter is the real data (String, Uint8Array, etc). + * + * @constructor + * @param {String} name the name of the stream (mainly used for debugging purposes) + */ +function GenericWorker(name) { + // the name of the worker + this.name = name || "default"; + // an object containing metadata about the workers chain + this.streamInfo = {}; + // an error which happened when the worker was paused + this.generatedError = null; + // an object containing metadata to be merged by this worker into the general metadata + this.extraStreamInfo = {}; + // true if the stream is paused (and should not do anything), false otherwise + this.isPaused = true; + // true if the stream is finished (and should not do anything), false otherwise + this.isFinished = false; + // true if the stream is locked to prevent further structure updates (pipe), false otherwise + this.isLocked = false; + // the event listeners + this._listeners = { + 'data':[], + 'end':[], + 'error':[] + }; + // the previous worker, if any + this.previous = null; +} + +GenericWorker.prototype = { + /** + * Push a chunk to the next workers. + * @param {Object} chunk the chunk to push + */ + push : function (chunk) { + this.emit("data", chunk); + }, + /** + * End the stream. + * @return {Boolean} true if this call ended the worker, false otherwise. + */ + end : function () { + if (this.isFinished) { + return false; + } + + this.flush(); + try { + this.emit("end"); + this.cleanUp(); + this.isFinished = true; + } catch (e) { + this.emit("error", e); + } + return true; + }, + /** + * End the stream with an error. + * @param {Error} e the error which caused the premature end. + * @return {Boolean} true if this call ended the worker with an error, false otherwise. + */ + error : function (e) { + if (this.isFinished) { + return false; + } + + if(this.isPaused) { + this.generatedError = e; + } else { + this.isFinished = true; + + this.emit("error", e); + + // in the workers chain exploded in the middle of the chain, + // the error event will go downward but we also need to notify + // workers upward that there has been an error. + if(this.previous) { + this.previous.error(e); + } + + this.cleanUp(); + } + return true; + }, + /** + * Add a callback on an event. + * @param {String} name the name of the event (data, end, error) + * @param {Function} listener the function to call when the event is triggered + * @return {GenericWorker} the current object for chainability + */ + on : function (name, listener) { + this._listeners[name].push(listener); + return this; + }, + /** + * Clean any references when a worker is ending. + */ + cleanUp : function () { + this.streamInfo = this.generatedError = this.extraStreamInfo = null; + this._listeners = []; + }, + /** + * Trigger an event. This will call registered callback with the provided arg. + * @param {String} name the name of the event (data, end, error) + * @param {Object} arg the argument to call the callback with. + */ + emit : function (name, arg) { + if (this._listeners[name]) { + for(var i = 0; i < this._listeners[name].length; i++) { + this._listeners[name][i].call(this, arg); + } + } + }, + /** + * Chain a worker with an other. + * @param {Worker} next the worker receiving events from the current one. + * @return {worker} the next worker for chainability + */ + pipe : function (next) { + return next.registerPrevious(this); + }, + /** + * Same as `pipe` in the other direction. + * Using an API with `pipe(next)` is very easy. + * Implementing the API with the point of view of the next one registering + * a source is easier, see the ZipFileWorker. + * @param {Worker} previous the previous worker, sending events to this one + * @return {Worker} the current worker for chainability + */ + registerPrevious : function (previous) { + if (this.isLocked) { + throw new Error("The stream '" + this + "' has already been used."); + } + + // sharing the streamInfo... + this.streamInfo = previous.streamInfo; + // ... and adding our own bits + this.mergeStreamInfo(); + this.previous = previous; + var self = this; + previous.on('data', function (chunk) { + self.processChunk(chunk); + }); + previous.on('end', function () { + self.end(); + }); + previous.on('error', function (e) { + self.error(e); + }); + return this; + }, + /** + * Pause the stream so it doesn't send events anymore. + * @return {Boolean} true if this call paused the worker, false otherwise. + */ + pause : function () { + if(this.isPaused || this.isFinished) { + return false; + } + this.isPaused = true; + + if(this.previous) { + this.previous.pause(); + } + return true; + }, + /** + * Resume a paused stream. + * @return {Boolean} true if this call resumed the worker, false otherwise. + */ + resume : function () { + if(!this.isPaused || this.isFinished) { + return false; + } + this.isPaused = false; + + // if true, the worker tried to resume but failed + var withError = false; + if(this.generatedError) { + this.error(this.generatedError); + withError = true; + } + if(this.previous) { + this.previous.resume(); + } + + return !withError; + }, + /** + * Flush any remaining bytes as the stream is ending. + */ + flush : function () {}, + /** + * Process a chunk. This is usually the method overridden. + * @param {Object} chunk the chunk to process. + */ + processChunk : function(chunk) { + this.push(chunk); + }, + /** + * Add a key/value to be added in the workers chain streamInfo once activated. + * @param {String} key the key to use + * @param {Object} value the associated value + * @return {Worker} the current worker for chainability + */ + withStreamInfo : function (key, value) { + this.extraStreamInfo[key] = value; + this.mergeStreamInfo(); + return this; + }, + /** + * Merge this worker's streamInfo into the chain's streamInfo. + */ + mergeStreamInfo : function () { + for(var key in this.extraStreamInfo) { + if (!this.extraStreamInfo.hasOwnProperty(key)) { + continue; + } + this.streamInfo[key] = this.extraStreamInfo[key]; + } + }, + + /** + * Lock the stream to prevent further updates on the workers chain. + * After calling this method, all calls to pipe will fail. + */ + lock: function () { + if (this.isLocked) { + throw new Error("The stream '" + this + "' has already been used."); + } + this.isLocked = true; + if (this.previous) { + this.previous.lock(); + } + }, + + /** + * + * Pretty print the workers chain. + */ + toString : function () { + var me = "Worker " + this.name; + if (this.previous) { + return this.previous + " -> " + me; + } else { + return me; + } + } +}; + +module.exports = GenericWorker; + +},{}],29:[function(require,module,exports){ +'use strict'; + +var utils = require('../utils'); +var ConvertWorker = require('./ConvertWorker'); +var GenericWorker = require('./GenericWorker'); +var base64 = require('../base64'); +var support = require("../support"); +var external = require("../external"); + +var NodejsStreamOutputAdapter = null; +if (support.nodestream) { + try { + NodejsStreamOutputAdapter = require('../nodejs/NodejsStreamOutputAdapter'); + } catch(e) {} +} + +/** + * Apply the final transformation of the data. If the user wants a Blob for + * example, it's easier to work with an U8intArray and finally do the + * ArrayBuffer/Blob conversion. + * @param {String} type the name of the final type + * @param {String|Uint8Array|Buffer} content the content to transform + * @param {String} mimeType the mime type of the content, if applicable. + * @return {String|Uint8Array|ArrayBuffer|Buffer|Blob} the content in the right format. + */ +function transformZipOutput(type, content, mimeType) { + switch(type) { + case "blob" : + return utils.newBlob(utils.transformTo("arraybuffer", content), mimeType); + case "base64" : + return base64.encode(content); + default : + return utils.transformTo(type, content); + } +} + +/** + * Concatenate an array of data of the given type. + * @param {String} type the type of the data in the given array. + * @param {Array} dataArray the array containing the data chunks to concatenate + * @return {String|Uint8Array|Buffer} the concatenated data + * @throws Error if the asked type is unsupported + */ +function concat (type, dataArray) { + var i, index = 0, res = null, totalLength = 0; + for(i = 0; i < dataArray.length; i++) { + totalLength += dataArray[i].length; + } + switch(type) { + case "string": + return dataArray.join(""); + case "array": + return Array.prototype.concat.apply([], dataArray); + case "uint8array": + res = new Uint8Array(totalLength); + for(i = 0; i < dataArray.length; i++) { + res.set(dataArray[i], index); + index += dataArray[i].length; + } + return res; + case "nodebuffer": + return Buffer.concat(dataArray); + default: + throw new Error("concat : unsupported type '" + type + "'"); + } +} + +/** + * Listen a StreamHelper, accumulate its content and concatenate it into a + * complete block. + * @param {StreamHelper} helper the helper to use. + * @param {Function} updateCallback a callback called on each update. Called + * with one arg : + * - the metadata linked to the update received. + * @return Promise the promise for the accumulation. + */ +function accumulate(helper, updateCallback) { + return new external.Promise(function (resolve, reject){ + var dataArray = []; + var chunkType = helper._internalType, + resultType = helper._outputType, + mimeType = helper._mimeType; + helper + .on('data', function (data, meta) { + dataArray.push(data); + if(updateCallback) { + updateCallback(meta); + } + }) + .on('error', function(err) { + dataArray = []; + reject(err); + }) + .on('end', function (){ + try { + var result = transformZipOutput(resultType, concat(chunkType, dataArray), mimeType); + resolve(result); + } catch (e) { + reject(e); + } + dataArray = []; + }) + .resume(); + }); +} + +/** + * An helper to easily use workers outside of JSZip. + * @constructor + * @param {Worker} worker the worker to wrap + * @param {String} outputType the type of data expected by the use + * @param {String} mimeType the mime type of the content, if applicable. + */ +function StreamHelper(worker, outputType, mimeType) { + var internalType = outputType; + switch(outputType) { + case "blob": + case "arraybuffer": + internalType = "uint8array"; + break; + case "base64": + internalType = "string"; + break; + } + + try { + // the type used internally + this._internalType = internalType; + // the type used to output results + this._outputType = outputType; + // the mime type + this._mimeType = mimeType; + utils.checkSupport(internalType); + this._worker = worker.pipe(new ConvertWorker(internalType)); + // the last workers can be rewired without issues but we need to + // prevent any updates on previous workers. + worker.lock(); + } catch(e) { + this._worker = new GenericWorker("error"); + this._worker.error(e); + } +} + +StreamHelper.prototype = { + /** + * Listen a StreamHelper, accumulate its content and concatenate it into a + * complete block. + * @param {Function} updateCb the update callback. + * @return Promise the promise for the accumulation. + */ + accumulate : function (updateCb) { + return accumulate(this, updateCb); + }, + /** + * Add a listener on an event triggered on a stream. + * @param {String} evt the name of the event + * @param {Function} fn the listener + * @return {StreamHelper} the current helper. + */ + on : function (evt, fn) { + var self = this; + + if(evt === "data") { + this._worker.on(evt, function (chunk) { + fn.call(self, chunk.data, chunk.meta); + }); + } else { + this._worker.on(evt, function () { + utils.delay(fn, arguments, self); + }); + } + return this; + }, + /** + * Resume the flow of chunks. + * @return {StreamHelper} the current helper. + */ + resume : function () { + utils.delay(this._worker.resume, [], this._worker); + return this; + }, + /** + * Pause the flow of chunks. + * @return {StreamHelper} the current helper. + */ + pause : function () { + this._worker.pause(); + return this; + }, + /** + * Return a nodejs stream for this helper. + * @param {Function} updateCb the update callback. + * @return {NodejsStreamOutputAdapter} the nodejs stream. + */ + toNodejsStream : function (updateCb) { + utils.checkSupport("nodestream"); + if (this._outputType !== "nodebuffer") { + // an object stream containing blob/arraybuffer/uint8array/string + // is strange and I don't know if it would be useful. + // I you find this comment and have a good usecase, please open a + // bug report ! + throw new Error(this._outputType + " is not supported by this method"); + } + + return new NodejsStreamOutputAdapter(this, { + objectMode : this._outputType !== "nodebuffer" + }, updateCb); + } +}; + + +module.exports = StreamHelper; + +},{"../base64":1,"../external":6,"../nodejs/NodejsStreamOutputAdapter":13,"../support":30,"../utils":32,"./ConvertWorker":24,"./GenericWorker":28}],30:[function(require,module,exports){ +'use strict'; + +exports.base64 = true; +exports.array = true; +exports.string = true; +exports.arraybuffer = typeof ArrayBuffer !== "undefined" && typeof Uint8Array !== "undefined"; +exports.nodebuffer = typeof Buffer !== "undefined"; +// contains true if JSZip can read/generate Uint8Array, false otherwise. +exports.uint8array = typeof Uint8Array !== "undefined"; + +if (typeof ArrayBuffer === "undefined") { + exports.blob = false; +} +else { + var buffer = new ArrayBuffer(0); + try { + exports.blob = new Blob([buffer], { + type: "application/zip" + }).size === 0; + } + catch (e) { + try { + var Builder = self.BlobBuilder || self.WebKitBlobBuilder || self.MozBlobBuilder || self.MSBlobBuilder; + var builder = new Builder(); + builder.append(buffer); + exports.blob = builder.getBlob('application/zip').size === 0; + } + catch (e) { + exports.blob = false; + } + } +} + +try { + exports.nodestream = !!require('readable-stream').Readable; +} catch(e) { + exports.nodestream = false; +} + +},{"readable-stream":16}],31:[function(require,module,exports){ +'use strict'; + +var utils = require('./utils'); +var support = require('./support'); +var nodejsUtils = require('./nodejsUtils'); +var GenericWorker = require('./stream/GenericWorker'); + +/** + * The following functions come from pako, from pako/lib/utils/strings + * released under the MIT license, see pako https://github.com/nodeca/pako/ + */ + +// Table with utf8 lengths (calculated by first byte of sequence) +// Note, that 5 & 6-byte values and some 4-byte values can not be represented in JS, +// because max possible codepoint is 0x10ffff +var _utf8len = new Array(256); +for (var i=0; i<256; i++) { + _utf8len[i] = (i >= 252 ? 6 : i >= 248 ? 5 : i >= 240 ? 4 : i >= 224 ? 3 : i >= 192 ? 2 : 1); +} +_utf8len[254]=_utf8len[254]=1; // Invalid sequence start + +// convert string to array (typed, when possible) +var string2buf = function (str) { + var buf, c, c2, m_pos, i, str_len = str.length, buf_len = 0; + + // count binary size + for (m_pos = 0; m_pos < str_len; m_pos++) { + c = str.charCodeAt(m_pos); + if ((c & 0xfc00) === 0xd800 && (m_pos+1 < str_len)) { + c2 = str.charCodeAt(m_pos+1); + if ((c2 & 0xfc00) === 0xdc00) { + c = 0x10000 + ((c - 0xd800) << 10) + (c2 - 0xdc00); + m_pos++; + } + } + buf_len += c < 0x80 ? 1 : c < 0x800 ? 2 : c < 0x10000 ? 3 : 4; + } + + // allocate buffer + if (support.uint8array) { + buf = new Uint8Array(buf_len); + } else { + buf = new Array(buf_len); + } + + // convert + for (i=0, m_pos = 0; i < buf_len; m_pos++) { + c = str.charCodeAt(m_pos); + if ((c & 0xfc00) === 0xd800 && (m_pos+1 < str_len)) { + c2 = str.charCodeAt(m_pos+1); + if ((c2 & 0xfc00) === 0xdc00) { + c = 0x10000 + ((c - 0xd800) << 10) + (c2 - 0xdc00); + m_pos++; + } + } + if (c < 0x80) { + /* one byte */ + buf[i++] = c; + } else if (c < 0x800) { + /* two bytes */ + buf[i++] = 0xC0 | (c >>> 6); + buf[i++] = 0x80 | (c & 0x3f); + } else if (c < 0x10000) { + /* three bytes */ + buf[i++] = 0xE0 | (c >>> 12); + buf[i++] = 0x80 | (c >>> 6 & 0x3f); + buf[i++] = 0x80 | (c & 0x3f); + } else { + /* four bytes */ + buf[i++] = 0xf0 | (c >>> 18); + buf[i++] = 0x80 | (c >>> 12 & 0x3f); + buf[i++] = 0x80 | (c >>> 6 & 0x3f); + buf[i++] = 0x80 | (c & 0x3f); + } + } + + return buf; +}; + +// Calculate max possible position in utf8 buffer, +// that will not break sequence. If that's not possible +// - (very small limits) return max size as is. +// +// buf[] - utf8 bytes array +// max - length limit (mandatory); +var utf8border = function(buf, max) { + var pos; + + max = max || buf.length; + if (max > buf.length) { max = buf.length; } + + // go back from last position, until start of sequence found + pos = max-1; + while (pos >= 0 && (buf[pos] & 0xC0) === 0x80) { pos--; } + + // Fuckup - very small and broken sequence, + // return max, because we should return something anyway. + if (pos < 0) { return max; } + + // If we came to start of buffer - that means vuffer is too small, + // return max too. + if (pos === 0) { return max; } + + return (pos + _utf8len[buf[pos]] > max) ? pos : max; +}; + +// convert array to string +var buf2string = function (buf) { + var str, i, out, c, c_len; + var len = buf.length; + + // Reserve max possible length (2 words per char) + // NB: by unknown reasons, Array is significantly faster for + // String.fromCharCode.apply than Uint16Array. + var utf16buf = new Array(len*2); + + for (out=0, i=0; i 4) { utf16buf[out++] = 0xfffd; i += c_len-1; continue; } + + // apply mask on first byte + c &= c_len === 2 ? 0x1f : c_len === 3 ? 0x0f : 0x07; + // join the rest + while (c_len > 1 && i < len) { + c = (c << 6) | (buf[i++] & 0x3f); + c_len--; + } + + // terminated by end of string? + if (c_len > 1) { utf16buf[out++] = 0xfffd; continue; } + + if (c < 0x10000) { + utf16buf[out++] = c; + } else { + c -= 0x10000; + utf16buf[out++] = 0xd800 | ((c >> 10) & 0x3ff); + utf16buf[out++] = 0xdc00 | (c & 0x3ff); + } + } + + // shrinkBuf(utf16buf, out) + if (utf16buf.length !== out) { + if(utf16buf.subarray) { + utf16buf = utf16buf.subarray(0, out); + } else { + utf16buf.length = out; + } + } + + // return String.fromCharCode.apply(null, utf16buf); + return utils.applyFromCharCode(utf16buf); +}; + + +// That's all for the pako functions. + + +/** + * Transform a javascript string into an array (typed if possible) of bytes, + * UTF-8 encoded. + * @param {String} str the string to encode + * @return {Array|Uint8Array|Buffer} the UTF-8 encoded string. + */ +exports.utf8encode = function utf8encode(str) { + if (support.nodebuffer) { + return nodejsUtils.newBufferFrom(str, "utf-8"); + } + + return string2buf(str); +}; + + +/** + * Transform a bytes array (or a representation) representing an UTF-8 encoded + * string into a javascript string. + * @param {Array|Uint8Array|Buffer} buf the data de decode + * @return {String} the decoded string. + */ +exports.utf8decode = function utf8decode(buf) { + if (support.nodebuffer) { + return utils.transformTo("nodebuffer", buf).toString("utf-8"); + } + + buf = utils.transformTo(support.uint8array ? "uint8array" : "array", buf); + + return buf2string(buf); +}; + +/** + * A worker to decode utf8 encoded binary chunks into string chunks. + * @constructor + */ +function Utf8DecodeWorker() { + GenericWorker.call(this, "utf-8 decode"); + // the last bytes if a chunk didn't end with a complete codepoint. + this.leftOver = null; +} +utils.inherits(Utf8DecodeWorker, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +Utf8DecodeWorker.prototype.processChunk = function (chunk) { + + var data = utils.transformTo(support.uint8array ? "uint8array" : "array", chunk.data); + + // 1st step, re-use what's left of the previous chunk + if (this.leftOver && this.leftOver.length) { + if(support.uint8array) { + var previousData = data; + data = new Uint8Array(previousData.length + this.leftOver.length); + data.set(this.leftOver, 0); + data.set(previousData, this.leftOver.length); + } else { + data = this.leftOver.concat(data); + } + this.leftOver = null; + } + + var nextBoundary = utf8border(data); + var usableData = data; + if (nextBoundary !== data.length) { + if (support.uint8array) { + usableData = data.subarray(0, nextBoundary); + this.leftOver = data.subarray(nextBoundary, data.length); + } else { + usableData = data.slice(0, nextBoundary); + this.leftOver = data.slice(nextBoundary, data.length); + } + } + + this.push({ + data : exports.utf8decode(usableData), + meta : chunk.meta + }); +}; + +/** + * @see GenericWorker.flush + */ +Utf8DecodeWorker.prototype.flush = function () { + if(this.leftOver && this.leftOver.length) { + this.push({ + data : exports.utf8decode(this.leftOver), + meta : {} + }); + this.leftOver = null; + } +}; +exports.Utf8DecodeWorker = Utf8DecodeWorker; + +/** + * A worker to endcode string chunks into utf8 encoded binary chunks. + * @constructor + */ +function Utf8EncodeWorker() { + GenericWorker.call(this, "utf-8 encode"); +} +utils.inherits(Utf8EncodeWorker, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +Utf8EncodeWorker.prototype.processChunk = function (chunk) { + this.push({ + data : exports.utf8encode(chunk.data), + meta : chunk.meta + }); +}; +exports.Utf8EncodeWorker = Utf8EncodeWorker; + +},{"./nodejsUtils":14,"./stream/GenericWorker":28,"./support":30,"./utils":32}],32:[function(require,module,exports){ +'use strict'; + +var support = require('./support'); +var base64 = require('./base64'); +var nodejsUtils = require('./nodejsUtils'); +var setImmediate = require('set-immediate-shim'); +var external = require("./external"); + + +/** + * Convert a string that pass as a "binary string": it should represent a byte + * array but may have > 255 char codes. Be sure to take only the first byte + * and returns the byte array. + * @param {String} str the string to transform. + * @return {Array|Uint8Array} the string in a binary format. + */ +function string2binary(str) { + var result = null; + if (support.uint8array) { + result = new Uint8Array(str.length); + } else { + result = new Array(str.length); + } + return stringToArrayLike(str, result); +} + +/** + * Create a new blob with the given content and the given type. + * @param {String|ArrayBuffer} part the content to put in the blob. DO NOT use + * an Uint8Array because the stock browser of android 4 won't accept it (it + * will be silently converted to a string, "[object Uint8Array]"). + * + * Use only ONE part to build the blob to avoid a memory leak in IE11 / Edge: + * when a large amount of Array is used to create the Blob, the amount of + * memory consumed is nearly 100 times the original data amount. + * + * @param {String} type the mime type of the blob. + * @return {Blob} the created blob. + */ +exports.newBlob = function(part, type) { + exports.checkSupport("blob"); + + try { + // Blob constructor + return new Blob([part], { + type: type + }); + } + catch (e) { + + try { + // deprecated, browser only, old way + var Builder = self.BlobBuilder || self.WebKitBlobBuilder || self.MozBlobBuilder || self.MSBlobBuilder; + var builder = new Builder(); + builder.append(part); + return builder.getBlob(type); + } + catch (e) { + + // well, fuck ?! + throw new Error("Bug : can't construct the Blob."); + } + } + + +}; +/** + * The identity function. + * @param {Object} input the input. + * @return {Object} the same input. + */ +function identity(input) { + return input; +} + +/** + * Fill in an array with a string. + * @param {String} str the string to use. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} array the array to fill in (will be mutated). + * @return {Array|ArrayBuffer|Uint8Array|Buffer} the updated array. + */ +function stringToArrayLike(str, array) { + for (var i = 0; i < str.length; ++i) { + array[i] = str.charCodeAt(i) & 0xFF; + } + return array; +} + +/** + * An helper for the function arrayLikeToString. + * This contains static information and functions that + * can be optimized by the browser JIT compiler. + */ +var arrayToStringHelper = { + /** + * Transform an array of int into a string, chunk by chunk. + * See the performances notes on arrayLikeToString. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} array the array to transform. + * @param {String} type the type of the array. + * @param {Integer} chunk the chunk size. + * @return {String} the resulting string. + * @throws Error if the chunk is too big for the stack. + */ + stringifyByChunk: function(array, type, chunk) { + var result = [], k = 0, len = array.length; + // shortcut + if (len <= chunk) { + return String.fromCharCode.apply(null, array); + } + while (k < len) { + if (type === "array" || type === "nodebuffer") { + result.push(String.fromCharCode.apply(null, array.slice(k, Math.min(k + chunk, len)))); + } + else { + result.push(String.fromCharCode.apply(null, array.subarray(k, Math.min(k + chunk, len)))); + } + k += chunk; + } + return result.join(""); + }, + /** + * Call String.fromCharCode on every item in the array. + * This is the naive implementation, which generate A LOT of intermediate string. + * This should be used when everything else fail. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} array the array to transform. + * @return {String} the result. + */ + stringifyByChar: function(array){ + var resultStr = ""; + for(var i = 0; i < array.length; i++) { + resultStr += String.fromCharCode(array[i]); + } + return resultStr; + }, + applyCanBeUsed : { + /** + * true if the browser accepts to use String.fromCharCode on Uint8Array + */ + uint8array : (function () { + try { + return support.uint8array && String.fromCharCode.apply(null, new Uint8Array(1)).length === 1; + } catch (e) { + return false; + } + })(), + /** + * true if the browser accepts to use String.fromCharCode on nodejs Buffer. + */ + nodebuffer : (function () { + try { + return support.nodebuffer && String.fromCharCode.apply(null, nodejsUtils.allocBuffer(1)).length === 1; + } catch (e) { + return false; + } + })() + } +}; + +/** + * Transform an array-like object to a string. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} array the array to transform. + * @return {String} the result. + */ +function arrayLikeToString(array) { + // Performances notes : + // -------------------- + // String.fromCharCode.apply(null, array) is the fastest, see + // see http://jsperf.com/converting-a-uint8array-to-a-string/2 + // but the stack is limited (and we can get huge arrays !). + // + // result += String.fromCharCode(array[i]); generate too many strings ! + // + // This code is inspired by http://jsperf.com/arraybuffer-to-string-apply-performance/2 + // TODO : we now have workers that split the work. Do we still need that ? + var chunk = 65536, + type = exports.getTypeOf(array), + canUseApply = true; + if (type === "uint8array") { + canUseApply = arrayToStringHelper.applyCanBeUsed.uint8array; + } else if (type === "nodebuffer") { + canUseApply = arrayToStringHelper.applyCanBeUsed.nodebuffer; + } + + if (canUseApply) { + while (chunk > 1) { + try { + return arrayToStringHelper.stringifyByChunk(array, type, chunk); + } catch (e) { + chunk = Math.floor(chunk / 2); + } + } + } + + // no apply or chunk error : slow and painful algorithm + // default browser on android 4.* + return arrayToStringHelper.stringifyByChar(array); +} + +exports.applyFromCharCode = arrayLikeToString; + + +/** + * Copy the data from an array-like to an other array-like. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} arrayFrom the origin array. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} arrayTo the destination array which will be mutated. + * @return {Array|ArrayBuffer|Uint8Array|Buffer} the updated destination array. + */ +function arrayLikeToArrayLike(arrayFrom, arrayTo) { + for (var i = 0; i < arrayFrom.length; i++) { + arrayTo[i] = arrayFrom[i]; + } + return arrayTo; +} + +// a matrix containing functions to transform everything into everything. +var transform = {}; + +// string to ? +transform["string"] = { + "string": identity, + "array": function(input) { + return stringToArrayLike(input, new Array(input.length)); + }, + "arraybuffer": function(input) { + return transform["string"]["uint8array"](input).buffer; + }, + "uint8array": function(input) { + return stringToArrayLike(input, new Uint8Array(input.length)); + }, + "nodebuffer": function(input) { + return stringToArrayLike(input, nodejsUtils.allocBuffer(input.length)); + } +}; + +// array to ? +transform["array"] = { + "string": arrayLikeToString, + "array": identity, + "arraybuffer": function(input) { + return (new Uint8Array(input)).buffer; + }, + "uint8array": function(input) { + return new Uint8Array(input); + }, + "nodebuffer": function(input) { + return nodejsUtils.newBufferFrom(input); + } +}; + +// arraybuffer to ? +transform["arraybuffer"] = { + "string": function(input) { + return arrayLikeToString(new Uint8Array(input)); + }, + "array": function(input) { + return arrayLikeToArrayLike(new Uint8Array(input), new Array(input.byteLength)); + }, + "arraybuffer": identity, + "uint8array": function(input) { + return new Uint8Array(input); + }, + "nodebuffer": function(input) { + return nodejsUtils.newBufferFrom(new Uint8Array(input)); + } +}; + +// uint8array to ? +transform["uint8array"] = { + "string": arrayLikeToString, + "array": function(input) { + return arrayLikeToArrayLike(input, new Array(input.length)); + }, + "arraybuffer": function(input) { + return input.buffer; + }, + "uint8array": identity, + "nodebuffer": function(input) { + return nodejsUtils.newBufferFrom(input); + } +}; + +// nodebuffer to ? +transform["nodebuffer"] = { + "string": arrayLikeToString, + "array": function(input) { + return arrayLikeToArrayLike(input, new Array(input.length)); + }, + "arraybuffer": function(input) { + return transform["nodebuffer"]["uint8array"](input).buffer; + }, + "uint8array": function(input) { + return arrayLikeToArrayLike(input, new Uint8Array(input.length)); + }, + "nodebuffer": identity +}; + +/** + * Transform an input into any type. + * The supported output type are : string, array, uint8array, arraybuffer, nodebuffer. + * If no output type is specified, the unmodified input will be returned. + * @param {String} outputType the output type. + * @param {String|Array|ArrayBuffer|Uint8Array|Buffer} input the input to convert. + * @throws {Error} an Error if the browser doesn't support the requested output type. + */ +exports.transformTo = function(outputType, input) { + if (!input) { + // undefined, null, etc + // an empty string won't harm. + input = ""; + } + if (!outputType) { + return input; + } + exports.checkSupport(outputType); + var inputType = exports.getTypeOf(input); + var result = transform[inputType][outputType](input); + return result; +}; + +/** + * Return the type of the input. + * The type will be in a format valid for JSZip.utils.transformTo : string, array, uint8array, arraybuffer. + * @param {Object} input the input to identify. + * @return {String} the (lowercase) type of the input. + */ +exports.getTypeOf = function(input) { + if (typeof input === "string") { + return "string"; + } + if (Object.prototype.toString.call(input) === "[object Array]") { + return "array"; + } + if (support.nodebuffer && nodejsUtils.isBuffer(input)) { + return "nodebuffer"; + } + if (support.uint8array && input instanceof Uint8Array) { + return "uint8array"; + } + if (support.arraybuffer && input instanceof ArrayBuffer) { + return "arraybuffer"; + } +}; + +/** + * Throw an exception if the type is not supported. + * @param {String} type the type to check. + * @throws {Error} an Error if the browser doesn't support the requested type. + */ +exports.checkSupport = function(type) { + var supported = support[type.toLowerCase()]; + if (!supported) { + throw new Error(type + " is not supported by this platform"); + } +}; + +exports.MAX_VALUE_16BITS = 65535; +exports.MAX_VALUE_32BITS = -1; // well, "\xFF\xFF\xFF\xFF\xFF\xFF\xFF\xFF" is parsed as -1 + +/** + * Prettify a string read as binary. + * @param {string} str the string to prettify. + * @return {string} a pretty string. + */ +exports.pretty = function(str) { + var res = '', + code, i; + for (i = 0; i < (str || "").length; i++) { + code = str.charCodeAt(i); + res += '\\x' + (code < 16 ? "0" : "") + code.toString(16).toUpperCase(); + } + return res; +}; + +/** + * Defer the call of a function. + * @param {Function} callback the function to call asynchronously. + * @param {Array} args the arguments to give to the callback. + */ +exports.delay = function(callback, args, self) { + setImmediate(function () { + callback.apply(self || null, args || []); + }); +}; + +/** + * Extends a prototype with an other, without calling a constructor with + * side effects. Inspired by nodejs' `utils.inherits` + * @param {Function} ctor the constructor to augment + * @param {Function} superCtor the parent constructor to use + */ +exports.inherits = function (ctor, superCtor) { + var Obj = function() {}; + Obj.prototype = superCtor.prototype; + ctor.prototype = new Obj(); +}; + +/** + * Merge the objects passed as parameters into a new one. + * @private + * @param {...Object} var_args All objects to merge. + * @return {Object} a new object with the data of the others. + */ +exports.extend = function() { + var result = {}, i, attr; + for (i = 0; i < arguments.length; i++) { // arguments is not enumerable in some browsers + for (attr in arguments[i]) { + if (arguments[i].hasOwnProperty(attr) && typeof result[attr] === "undefined") { + result[attr] = arguments[i][attr]; + } + } + } + return result; +}; + +/** + * Transform arbitrary content into a Promise. + * @param {String} name a name for the content being processed. + * @param {Object} inputData the content to process. + * @param {Boolean} isBinary true if the content is not an unicode string + * @param {Boolean} isOptimizedBinaryString true if the string content only has one byte per character. + * @param {Boolean} isBase64 true if the string content is encoded with base64. + * @return {Promise} a promise in a format usable by JSZip. + */ +exports.prepareContent = function(name, inputData, isBinary, isOptimizedBinaryString, isBase64) { + + // if inputData is already a promise, this flatten it. + var promise = external.Promise.resolve(inputData).then(function(data) { + + + var isBlob = support.blob && (data instanceof Blob || ['[object File]', '[object Blob]'].indexOf(Object.prototype.toString.call(data)) !== -1); + + if (isBlob && typeof FileReader !== "undefined") { + return new external.Promise(function (resolve, reject) { + var reader = new FileReader(); + + reader.onload = function(e) { + resolve(e.target.result); + }; + reader.onerror = function(e) { + reject(e.target.error); + }; + reader.readAsArrayBuffer(data); + }); + } else { + return data; + } + }); + + return promise.then(function(data) { + var dataType = exports.getTypeOf(data); + + if (!dataType) { + return external.Promise.reject( + new Error("Can't read the data of '" + name + "'. Is it " + + "in a supported JavaScript type (String, Blob, ArrayBuffer, etc) ?") + ); + } + // special case : it's way easier to work with Uint8Array than with ArrayBuffer + if (dataType === "arraybuffer") { + data = exports.transformTo("uint8array", data); + } else if (dataType === "string") { + if (isBase64) { + data = base64.decode(data); + } + else if (isBinary) { + // optimizedBinaryString === true means that the file has already been filtered with a 0xFF mask + if (isOptimizedBinaryString !== true) { + // this is a string, not in a base64 format. + // Be sure that this is a correct "binary string" + data = string2binary(data); + } + } + } + return data; + }); +}; + +},{"./base64":1,"./external":6,"./nodejsUtils":14,"./support":30,"set-immediate-shim":54}],33:[function(require,module,exports){ +'use strict'; +var readerFor = require('./reader/readerFor'); +var utils = require('./utils'); +var sig = require('./signature'); +var ZipEntry = require('./zipEntry'); +var utf8 = require('./utf8'); +var support = require('./support'); +// class ZipEntries {{{ +/** + * All the entries in the zip file. + * @constructor + * @param {Object} loadOptions Options for loading the stream. + */ +function ZipEntries(loadOptions) { + this.files = []; + this.loadOptions = loadOptions; +} +ZipEntries.prototype = { + /** + * Check that the reader is on the specified signature. + * @param {string} expectedSignature the expected signature. + * @throws {Error} if it is an other signature. + */ + checkSignature: function(expectedSignature) { + if (!this.reader.readAndCheckSignature(expectedSignature)) { + this.reader.index -= 4; + var signature = this.reader.readString(4); + throw new Error("Corrupted zip or bug: unexpected signature " + "(" + utils.pretty(signature) + ", expected " + utils.pretty(expectedSignature) + ")"); + } + }, + /** + * Check if the given signature is at the given index. + * @param {number} askedIndex the index to check. + * @param {string} expectedSignature the signature to expect. + * @return {boolean} true if the signature is here, false otherwise. + */ + isSignature: function(askedIndex, expectedSignature) { + var currentIndex = this.reader.index; + this.reader.setIndex(askedIndex); + var signature = this.reader.readString(4); + var result = signature === expectedSignature; + this.reader.setIndex(currentIndex); + return result; + }, + /** + * Read the end of the central directory. + */ + readBlockEndOfCentral: function() { + this.diskNumber = this.reader.readInt(2); + this.diskWithCentralDirStart = this.reader.readInt(2); + this.centralDirRecordsOnThisDisk = this.reader.readInt(2); + this.centralDirRecords = this.reader.readInt(2); + this.centralDirSize = this.reader.readInt(4); + this.centralDirOffset = this.reader.readInt(4); + + this.zipCommentLength = this.reader.readInt(2); + // warning : the encoding depends of the system locale + // On a linux machine with LANG=en_US.utf8, this field is utf8 encoded. + // On a windows machine, this field is encoded with the localized windows code page. + var zipComment = this.reader.readData(this.zipCommentLength); + var decodeParamType = support.uint8array ? "uint8array" : "array"; + // To get consistent behavior with the generation part, we will assume that + // this is utf8 encoded unless specified otherwise. + var decodeContent = utils.transformTo(decodeParamType, zipComment); + this.zipComment = this.loadOptions.decodeFileName(decodeContent); + }, + /** + * Read the end of the Zip 64 central directory. + * Not merged with the method readEndOfCentral : + * The end of central can coexist with its Zip64 brother, + * I don't want to read the wrong number of bytes ! + */ + readBlockZip64EndOfCentral: function() { + this.zip64EndOfCentralSize = this.reader.readInt(8); + this.reader.skip(4); + // this.versionMadeBy = this.reader.readString(2); + // this.versionNeeded = this.reader.readInt(2); + this.diskNumber = this.reader.readInt(4); + this.diskWithCentralDirStart = this.reader.readInt(4); + this.centralDirRecordsOnThisDisk = this.reader.readInt(8); + this.centralDirRecords = this.reader.readInt(8); + this.centralDirSize = this.reader.readInt(8); + this.centralDirOffset = this.reader.readInt(8); + + this.zip64ExtensibleData = {}; + var extraDataSize = this.zip64EndOfCentralSize - 44, + index = 0, + extraFieldId, + extraFieldLength, + extraFieldValue; + while (index < extraDataSize) { + extraFieldId = this.reader.readInt(2); + extraFieldLength = this.reader.readInt(4); + extraFieldValue = this.reader.readData(extraFieldLength); + this.zip64ExtensibleData[extraFieldId] = { + id: extraFieldId, + length: extraFieldLength, + value: extraFieldValue + }; + } + }, + /** + * Read the end of the Zip 64 central directory locator. + */ + readBlockZip64EndOfCentralLocator: function() { + this.diskWithZip64CentralDirStart = this.reader.readInt(4); + this.relativeOffsetEndOfZip64CentralDir = this.reader.readInt(8); + this.disksCount = this.reader.readInt(4); + if (this.disksCount > 1) { + throw new Error("Multi-volumes zip are not supported"); + } + }, + /** + * Read the local files, based on the offset read in the central part. + */ + readLocalFiles: function() { + var i, file; + for (i = 0; i < this.files.length; i++) { + file = this.files[i]; + this.reader.setIndex(file.localHeaderOffset); + this.checkSignature(sig.LOCAL_FILE_HEADER); + file.readLocalPart(this.reader); + file.handleUTF8(); + file.processAttributes(); + } + }, + /** + * Read the central directory. + */ + readCentralDir: function() { + var file; + + this.reader.setIndex(this.centralDirOffset); + while (this.reader.readAndCheckSignature(sig.CENTRAL_FILE_HEADER)) { + file = new ZipEntry({ + zip64: this.zip64 + }, this.loadOptions); + file.readCentralPart(this.reader); + this.files.push(file); + } + + if (this.centralDirRecords !== this.files.length) { + if (this.centralDirRecords !== 0 && this.files.length === 0) { + // We expected some records but couldn't find ANY. + // This is really suspicious, as if something went wrong. + throw new Error("Corrupted zip or bug: expected " + this.centralDirRecords + " records in central dir, got " + this.files.length); + } else { + // We found some records but not all. + // Something is wrong but we got something for the user: no error here. + // console.warn("expected", this.centralDirRecords, "records in central dir, got", this.files.length); + } + } + }, + /** + * Read the end of central directory. + */ + readEndOfCentral: function() { + var offset = this.reader.lastIndexOfSignature(sig.CENTRAL_DIRECTORY_END); + if (offset < 0) { + // Check if the content is a truncated zip or complete garbage. + // A "LOCAL_FILE_HEADER" is not required at the beginning (auto + // extractible zip for example) but it can give a good hint. + // If an ajax request was used without responseType, we will also + // get unreadable data. + var isGarbage = !this.isSignature(0, sig.LOCAL_FILE_HEADER); + + if (isGarbage) { + throw new Error("Can't find end of central directory : is this a zip file ? " + + "If it is, see https://stuk.github.io/jszip/documentation/howto/read_zip.html"); + } else { + throw new Error("Corrupted zip: can't find end of central directory"); + } + + } + this.reader.setIndex(offset); + var endOfCentralDirOffset = offset; + this.checkSignature(sig.CENTRAL_DIRECTORY_END); + this.readBlockEndOfCentral(); + + + /* extract from the zip spec : + 4) If one of the fields in the end of central directory + record is too small to hold required data, the field + should be set to -1 (0xFFFF or 0xFFFFFFFF) and the + ZIP64 format record should be created. + 5) The end of central directory record and the + Zip64 end of central directory locator record must + reside on the same disk when splitting or spanning + an archive. + */ + if (this.diskNumber === utils.MAX_VALUE_16BITS || this.diskWithCentralDirStart === utils.MAX_VALUE_16BITS || this.centralDirRecordsOnThisDisk === utils.MAX_VALUE_16BITS || this.centralDirRecords === utils.MAX_VALUE_16BITS || this.centralDirSize === utils.MAX_VALUE_32BITS || this.centralDirOffset === utils.MAX_VALUE_32BITS) { + this.zip64 = true; + + /* + Warning : the zip64 extension is supported, but ONLY if the 64bits integer read from + the zip file can fit into a 32bits integer. This cannot be solved : JavaScript represents + all numbers as 64-bit double precision IEEE 754 floating point numbers. + So, we have 53bits for integers and bitwise operations treat everything as 32bits. + see https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Operators/Bitwise_Operators + and http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-262.pdf section 8.5 + */ + + // should look for a zip64 EOCD locator + offset = this.reader.lastIndexOfSignature(sig.ZIP64_CENTRAL_DIRECTORY_LOCATOR); + if (offset < 0) { + throw new Error("Corrupted zip: can't find the ZIP64 end of central directory locator"); + } + this.reader.setIndex(offset); + this.checkSignature(sig.ZIP64_CENTRAL_DIRECTORY_LOCATOR); + this.readBlockZip64EndOfCentralLocator(); + + // now the zip64 EOCD record + if (!this.isSignature(this.relativeOffsetEndOfZip64CentralDir, sig.ZIP64_CENTRAL_DIRECTORY_END)) { + // console.warn("ZIP64 end of central directory not where expected."); + this.relativeOffsetEndOfZip64CentralDir = this.reader.lastIndexOfSignature(sig.ZIP64_CENTRAL_DIRECTORY_END); + if (this.relativeOffsetEndOfZip64CentralDir < 0) { + throw new Error("Corrupted zip: can't find the ZIP64 end of central directory"); + } + } + this.reader.setIndex(this.relativeOffsetEndOfZip64CentralDir); + this.checkSignature(sig.ZIP64_CENTRAL_DIRECTORY_END); + this.readBlockZip64EndOfCentral(); + } + + var expectedEndOfCentralDirOffset = this.centralDirOffset + this.centralDirSize; + if (this.zip64) { + expectedEndOfCentralDirOffset += 20; // end of central dir 64 locator + expectedEndOfCentralDirOffset += 12 /* should not include the leading 12 bytes */ + this.zip64EndOfCentralSize; + } + + var extraBytes = endOfCentralDirOffset - expectedEndOfCentralDirOffset; + + if (extraBytes > 0) { + // console.warn(extraBytes, "extra bytes at beginning or within zipfile"); + if (this.isSignature(endOfCentralDirOffset, sig.CENTRAL_FILE_HEADER)) { + // The offsets seem wrong, but we have something at the specified offset. + // So… we keep it. + } else { + // the offset is wrong, update the "zero" of the reader + // this happens if data has been prepended (crx files for example) + this.reader.zero = extraBytes; + } + } else if (extraBytes < 0) { + throw new Error("Corrupted zip: missing " + Math.abs(extraBytes) + " bytes."); + } + }, + prepareReader: function(data) { + this.reader = readerFor(data); + }, + /** + * Read a zip file and create ZipEntries. + * @param {String|ArrayBuffer|Uint8Array|Buffer} data the binary string representing a zip file. + */ + load: function(data) { + this.prepareReader(data); + this.readEndOfCentral(); + this.readCentralDir(); + this.readLocalFiles(); + } +}; +// }}} end of ZipEntries +module.exports = ZipEntries; + +},{"./reader/readerFor":22,"./signature":23,"./support":30,"./utf8":31,"./utils":32,"./zipEntry":34}],34:[function(require,module,exports){ +'use strict'; +var readerFor = require('./reader/readerFor'); +var utils = require('./utils'); +var CompressedObject = require('./compressedObject'); +var crc32fn = require('./crc32'); +var utf8 = require('./utf8'); +var compressions = require('./compressions'); +var support = require('./support'); + +var MADE_BY_DOS = 0x00; +var MADE_BY_UNIX = 0x03; + +/** + * Find a compression registered in JSZip. + * @param {string} compressionMethod the method magic to find. + * @return {Object|null} the JSZip compression object, null if none found. + */ +var findCompression = function(compressionMethod) { + for (var method in compressions) { + if (!compressions.hasOwnProperty(method)) { + continue; + } + if (compressions[method].magic === compressionMethod) { + return compressions[method]; + } + } + return null; +}; + +// class ZipEntry {{{ +/** + * An entry in the zip file. + * @constructor + * @param {Object} options Options of the current file. + * @param {Object} loadOptions Options for loading the stream. + */ +function ZipEntry(options, loadOptions) { + this.options = options; + this.loadOptions = loadOptions; +} +ZipEntry.prototype = { + /** + * say if the file is encrypted. + * @return {boolean} true if the file is encrypted, false otherwise. + */ + isEncrypted: function() { + // bit 1 is set + return (this.bitFlag & 0x0001) === 0x0001; + }, + /** + * say if the file has utf-8 filename/comment. + * @return {boolean} true if the filename/comment is in utf-8, false otherwise. + */ + useUTF8: function() { + // bit 11 is set + return (this.bitFlag & 0x0800) === 0x0800; + }, + /** + * Read the local part of a zip file and add the info in this object. + * @param {DataReader} reader the reader to use. + */ + readLocalPart: function(reader) { + var compression, localExtraFieldsLength; + + // we already know everything from the central dir ! + // If the central dir data are false, we are doomed. + // On the bright side, the local part is scary : zip64, data descriptors, both, etc. + // The less data we get here, the more reliable this should be. + // Let's skip the whole header and dash to the data ! + reader.skip(22); + // in some zip created on windows, the filename stored in the central dir contains \ instead of /. + // Strangely, the filename here is OK. + // I would love to treat these zip files as corrupted (see http://www.info-zip.org/FAQ.html#backslashes + // or APPNOTE#4.4.17.1, "All slashes MUST be forward slashes '/'") but there are a lot of bad zip generators... + // Search "unzip mismatching "local" filename continuing with "central" filename version" on + // the internet. + // + // I think I see the logic here : the central directory is used to display + // content and the local directory is used to extract the files. Mixing / and \ + // may be used to display \ to windows users and use / when extracting the files. + // Unfortunately, this lead also to some issues : http://seclists.org/fulldisclosure/2009/Sep/394 + this.fileNameLength = reader.readInt(2); + localExtraFieldsLength = reader.readInt(2); // can't be sure this will be the same as the central dir + // the fileName is stored as binary data, the handleUTF8 method will take care of the encoding. + this.fileName = reader.readData(this.fileNameLength); + reader.skip(localExtraFieldsLength); + + if (this.compressedSize === -1 || this.uncompressedSize === -1) { + throw new Error("Bug or corrupted zip : didn't get enough information from the central directory " + "(compressedSize === -1 || uncompressedSize === -1)"); + } + + compression = findCompression(this.compressionMethod); + if (compression === null) { // no compression found + throw new Error("Corrupted zip : compression " + utils.pretty(this.compressionMethod) + " unknown (inner file : " + utils.transformTo("string", this.fileName) + ")"); + } + this.decompressed = new CompressedObject(this.compressedSize, this.uncompressedSize, this.crc32, compression, reader.readData(this.compressedSize)); + }, + + /** + * Read the central part of a zip file and add the info in this object. + * @param {DataReader} reader the reader to use. + */ + readCentralPart: function(reader) { + this.versionMadeBy = reader.readInt(2); + reader.skip(2); + // this.versionNeeded = reader.readInt(2); + this.bitFlag = reader.readInt(2); + this.compressionMethod = reader.readString(2); + this.date = reader.readDate(); + this.crc32 = reader.readInt(4); + this.compressedSize = reader.readInt(4); + this.uncompressedSize = reader.readInt(4); + var fileNameLength = reader.readInt(2); + this.extraFieldsLength = reader.readInt(2); + this.fileCommentLength = reader.readInt(2); + this.diskNumberStart = reader.readInt(2); + this.internalFileAttributes = reader.readInt(2); + this.externalFileAttributes = reader.readInt(4); + this.localHeaderOffset = reader.readInt(4); + + if (this.isEncrypted()) { + throw new Error("Encrypted zip are not supported"); + } + + // will be read in the local part, see the comments there + reader.skip(fileNameLength); + this.readExtraFields(reader); + this.parseZIP64ExtraField(reader); + this.fileComment = reader.readData(this.fileCommentLength); + }, + + /** + * Parse the external file attributes and get the unix/dos permissions. + */ + processAttributes: function () { + this.unixPermissions = null; + this.dosPermissions = null; + var madeBy = this.versionMadeBy >> 8; + + // Check if we have the DOS directory flag set. + // We look for it in the DOS and UNIX permissions + // but some unknown platform could set it as a compatibility flag. + this.dir = this.externalFileAttributes & 0x0010 ? true : false; + + if(madeBy === MADE_BY_DOS) { + // first 6 bits (0 to 5) + this.dosPermissions = this.externalFileAttributes & 0x3F; + } + + if(madeBy === MADE_BY_UNIX) { + this.unixPermissions = (this.externalFileAttributes >> 16) & 0xFFFF; + // the octal permissions are in (this.unixPermissions & 0x01FF).toString(8); + } + + // fail safe : if the name ends with a / it probably means a folder + if (!this.dir && this.fileNameStr.slice(-1) === '/') { + this.dir = true; + } + }, + + /** + * Parse the ZIP64 extra field and merge the info in the current ZipEntry. + * @param {DataReader} reader the reader to use. + */ + parseZIP64ExtraField: function(reader) { + + if (!this.extraFields[0x0001]) { + return; + } + + // should be something, preparing the extra reader + var extraReader = readerFor(this.extraFields[0x0001].value); + + // I really hope that these 64bits integer can fit in 32 bits integer, because js + // won't let us have more. + if (this.uncompressedSize === utils.MAX_VALUE_32BITS) { + this.uncompressedSize = extraReader.readInt(8); + } + if (this.compressedSize === utils.MAX_VALUE_32BITS) { + this.compressedSize = extraReader.readInt(8); + } + if (this.localHeaderOffset === utils.MAX_VALUE_32BITS) { + this.localHeaderOffset = extraReader.readInt(8); + } + if (this.diskNumberStart === utils.MAX_VALUE_32BITS) { + this.diskNumberStart = extraReader.readInt(4); + } + }, + /** + * Read the central part of a zip file and add the info in this object. + * @param {DataReader} reader the reader to use. + */ + readExtraFields: function(reader) { + var end = reader.index + this.extraFieldsLength, + extraFieldId, + extraFieldLength, + extraFieldValue; + + if (!this.extraFields) { + this.extraFields = {}; + } + + while (reader.index + 4 < end) { + extraFieldId = reader.readInt(2); + extraFieldLength = reader.readInt(2); + extraFieldValue = reader.readData(extraFieldLength); + + this.extraFields[extraFieldId] = { + id: extraFieldId, + length: extraFieldLength, + value: extraFieldValue + }; + } + + reader.setIndex(end); + }, + /** + * Apply an UTF8 transformation if needed. + */ + handleUTF8: function() { + var decodeParamType = support.uint8array ? "uint8array" : "array"; + if (this.useUTF8()) { + this.fileNameStr = utf8.utf8decode(this.fileName); + this.fileCommentStr = utf8.utf8decode(this.fileComment); + } else { + var upath = this.findExtraFieldUnicodePath(); + if (upath !== null) { + this.fileNameStr = upath; + } else { + // ASCII text or unsupported code page + var fileNameByteArray = utils.transformTo(decodeParamType, this.fileName); + this.fileNameStr = this.loadOptions.decodeFileName(fileNameByteArray); + } + + var ucomment = this.findExtraFieldUnicodeComment(); + if (ucomment !== null) { + this.fileCommentStr = ucomment; + } else { + // ASCII text or unsupported code page + var commentByteArray = utils.transformTo(decodeParamType, this.fileComment); + this.fileCommentStr = this.loadOptions.decodeFileName(commentByteArray); + } + } + }, + + /** + * Find the unicode path declared in the extra field, if any. + * @return {String} the unicode path, null otherwise. + */ + findExtraFieldUnicodePath: function() { + var upathField = this.extraFields[0x7075]; + if (upathField) { + var extraReader = readerFor(upathField.value); + + // wrong version + if (extraReader.readInt(1) !== 1) { + return null; + } + + // the crc of the filename changed, this field is out of date. + if (crc32fn(this.fileName) !== extraReader.readInt(4)) { + return null; + } + + return utf8.utf8decode(extraReader.readData(upathField.length - 5)); + } + return null; + }, + + /** + * Find the unicode comment declared in the extra field, if any. + * @return {String} the unicode comment, null otherwise. + */ + findExtraFieldUnicodeComment: function() { + var ucommentField = this.extraFields[0x6375]; + if (ucommentField) { + var extraReader = readerFor(ucommentField.value); + + // wrong version + if (extraReader.readInt(1) !== 1) { + return null; + } + + // the crc of the comment changed, this field is out of date. + if (crc32fn(this.fileComment) !== extraReader.readInt(4)) { + return null; + } + + return utf8.utf8decode(extraReader.readData(ucommentField.length - 5)); + } + return null; + } +}; +module.exports = ZipEntry; + +},{"./compressedObject":2,"./compressions":3,"./crc32":4,"./reader/readerFor":22,"./support":30,"./utf8":31,"./utils":32}],35:[function(require,module,exports){ +'use strict'; + +var StreamHelper = require('./stream/StreamHelper'); +var DataWorker = require('./stream/DataWorker'); +var utf8 = require('./utf8'); +var CompressedObject = require('./compressedObject'); +var GenericWorker = require('./stream/GenericWorker'); + +/** + * A simple object representing a file in the zip file. + * @constructor + * @param {string} name the name of the file + * @param {String|ArrayBuffer|Uint8Array|Buffer} data the data + * @param {Object} options the options of the file + */ +var ZipObject = function(name, data, options) { + this.name = name; + this.dir = options.dir; + this.date = options.date; + this.comment = options.comment; + this.unixPermissions = options.unixPermissions; + this.dosPermissions = options.dosPermissions; + + this._data = data; + this._dataBinary = options.binary; + // keep only the compression + this.options = { + compression : options.compression, + compressionOptions : options.compressionOptions + }; +}; + +ZipObject.prototype = { + /** + * Create an internal stream for the content of this object. + * @param {String} type the type of each chunk. + * @return StreamHelper the stream. + */ + internalStream: function (type) { + var result = null, outputType = "string"; + try { + if (!type) { + throw new Error("No output type specified."); + } + outputType = type.toLowerCase(); + var askUnicodeString = outputType === "string" || outputType === "text"; + if (outputType === "binarystring" || outputType === "text") { + outputType = "string"; + } + result = this._decompressWorker(); + + var isUnicodeString = !this._dataBinary; + + if (isUnicodeString && !askUnicodeString) { + result = result.pipe(new utf8.Utf8EncodeWorker()); + } + if (!isUnicodeString && askUnicodeString) { + result = result.pipe(new utf8.Utf8DecodeWorker()); + } + } catch (e) { + result = new GenericWorker("error"); + result.error(e); + } + + return new StreamHelper(result, outputType, ""); + }, + + /** + * Prepare the content in the asked type. + * @param {String} type the type of the result. + * @param {Function} onUpdate a function to call on each internal update. + * @return Promise the promise of the result. + */ + async: function (type, onUpdate) { + return this.internalStream(type).accumulate(onUpdate); + }, + + /** + * Prepare the content as a nodejs stream. + * @param {String} type the type of each chunk. + * @param {Function} onUpdate a function to call on each internal update. + * @return Stream the stream. + */ + nodeStream: function (type, onUpdate) { + return this.internalStream(type || "nodebuffer").toNodejsStream(onUpdate); + }, + + /** + * Return a worker for the compressed content. + * @private + * @param {Object} compression the compression object to use. + * @param {Object} compressionOptions the options to use when compressing. + * @return Worker the worker. + */ + _compressWorker: function (compression, compressionOptions) { + if ( + this._data instanceof CompressedObject && + this._data.compression.magic === compression.magic + ) { + return this._data.getCompressedWorker(); + } else { + var result = this._decompressWorker(); + if(!this._dataBinary) { + result = result.pipe(new utf8.Utf8EncodeWorker()); + } + return CompressedObject.createWorkerFrom(result, compression, compressionOptions); + } + }, + /** + * Return a worker for the decompressed content. + * @private + * @return Worker the worker. + */ + _decompressWorker : function () { + if (this._data instanceof CompressedObject) { + return this._data.getContentWorker(); + } else if (this._data instanceof GenericWorker) { + return this._data; + } else { + return new DataWorker(this._data); + } + } +}; + +var removedMethods = ["asText", "asBinary", "asNodeBuffer", "asUint8Array", "asArrayBuffer"]; +var removedFn = function () { + throw new Error("This method has been removed in JSZip 3.0, please check the upgrade guide."); +}; + +for(var i = 0; i < removedMethods.length; i++) { + ZipObject.prototype[removedMethods[i]] = removedFn; +} +module.exports = ZipObject; + +},{"./compressedObject":2,"./stream/DataWorker":27,"./stream/GenericWorker":28,"./stream/StreamHelper":29,"./utf8":31}],36:[function(require,module,exports){ +(function (global){ +'use strict'; +var Mutation = global.MutationObserver || global.WebKitMutationObserver; + +var scheduleDrain; + +{ + if (Mutation) { + var called = 0; + var observer = new Mutation(nextTick); + var element = global.document.createTextNode(''); + observer.observe(element, { + characterData: true + }); + scheduleDrain = function () { + element.data = (called = ++called % 2); + }; + } else if (!global.setImmediate && typeof global.MessageChannel !== 'undefined') { + var channel = new global.MessageChannel(); + channel.port1.onmessage = nextTick; + scheduleDrain = function () { + channel.port2.postMessage(0); + }; + } else if ('document' in global && 'onreadystatechange' in global.document.createElement('script')) { + scheduleDrain = function () { + + // Create a + + + + + +
+ +

index.html

+
+ + diff --git a/9.3.3/api/overview-tree.html b/9.3.3/api/overview-tree.html new file mode 100644 index 000000000..1b57b6f76 --- /dev/null +++ b/9.3.3/api/overview-tree.html @@ -0,0 +1,328 @@ + + + + + +Class Hierarchy (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For All Packages

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+ +
+
+

Interface Hierarchy

+ +
+
+
+
+ +
+ + diff --git a/9.3.3/api/package-search-index.js b/9.3.3/api/package-search-index.js new file mode 100644 index 000000000..8bc0d5cef --- /dev/null +++ b/9.3.3/api/package-search-index.js @@ -0,0 +1 @@ +packageSearchIndex = [{"l":"All Packages","url":"allpackages-index.html"},{"l":"com.bmuschko.gradle.docker"},{"l":"com.bmuschko.gradle.docker.domain"},{"l":"com.bmuschko.gradle.docker.internal"},{"l":"com.bmuschko.gradle.docker.internal.services"},{"l":"com.bmuschko.gradle.docker.tasks"},{"l":"com.bmuschko.gradle.docker.tasks.container"},{"l":"com.bmuschko.gradle.docker.tasks.image"},{"l":"com.bmuschko.gradle.docker.tasks.network"}] \ No newline at end of file diff --git a/9.3.3/api/package-search-index.zip b/9.3.3/api/package-search-index.zip new file mode 100644 index 000000000..c9b1aa311 Binary files /dev/null and b/9.3.3/api/package-search-index.zip differ diff --git a/9.3.3/api/resources/glass.png b/9.3.3/api/resources/glass.png new file mode 100644 index 000000000..a7f591f46 Binary files /dev/null and b/9.3.3/api/resources/glass.png differ diff --git a/9.3.3/api/resources/x.png b/9.3.3/api/resources/x.png new file mode 100644 index 000000000..30548a756 Binary files /dev/null and b/9.3.3/api/resources/x.png differ diff --git a/9.3.3/api/script.js b/9.3.3/api/script.js new file mode 100644 index 000000000..7dc93c48e --- /dev/null +++ b/9.3.3/api/script.js @@ -0,0 +1,149 @@ +/* + * Copyright (c) 2013, 2018, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +var moduleSearchIndex; +var packageSearchIndex; +var typeSearchIndex; +var memberSearchIndex; +var tagSearchIndex; +function loadScripts(doc, tag) { + createElem(doc, tag, 'jquery/jszip/dist/jszip.js'); + createElem(doc, tag, 'jquery/jszip-utils/dist/jszip-utils.js'); + if (window.navigator.userAgent.indexOf('MSIE ') > 0 || window.navigator.userAgent.indexOf('Trident/') > 0 || + window.navigator.userAgent.indexOf('Edge/') > 0) { + createElem(doc, tag, 'jquery/jszip-utils/dist/jszip-utils-ie.js'); + } + createElem(doc, tag, 'search.js'); + + $.get(pathtoroot + "module-search-index.zip") + .done(function() { + JSZipUtils.getBinaryContent(pathtoroot + "module-search-index.zip", function(e, data) { + JSZip.loadAsync(data).then(function(zip){ + zip.file("module-search-index.json").async("text").then(function(content){ + moduleSearchIndex = JSON.parse(content); + }); + }); + }); + }); + $.get(pathtoroot + "package-search-index.zip") + .done(function() { + JSZipUtils.getBinaryContent(pathtoroot + "package-search-index.zip", function(e, data) { + JSZip.loadAsync(data).then(function(zip){ + zip.file("package-search-index.json").async("text").then(function(content){ + packageSearchIndex = JSON.parse(content); + }); + }); + }); + }); + $.get(pathtoroot + "type-search-index.zip") + .done(function() { + JSZipUtils.getBinaryContent(pathtoroot + "type-search-index.zip", function(e, data) { + JSZip.loadAsync(data).then(function(zip){ + zip.file("type-search-index.json").async("text").then(function(content){ + typeSearchIndex = JSON.parse(content); + }); + }); + }); + }); + $.get(pathtoroot + "member-search-index.zip") + .done(function() { + JSZipUtils.getBinaryContent(pathtoroot + "member-search-index.zip", function(e, data) { + JSZip.loadAsync(data).then(function(zip){ + zip.file("member-search-index.json").async("text").then(function(content){ + memberSearchIndex = JSON.parse(content); + }); + }); + }); + }); + $.get(pathtoroot + "tag-search-index.zip") + .done(function() { + JSZipUtils.getBinaryContent(pathtoroot + "tag-search-index.zip", function(e, data) { + JSZip.loadAsync(data).then(function(zip){ + zip.file("tag-search-index.json").async("text").then(function(content){ + tagSearchIndex = JSON.parse(content); + }); + }); + }); + }); + if (!moduleSearchIndex) { + createElem(doc, tag, 'module-search-index.js'); + } + if (!packageSearchIndex) { + createElem(doc, tag, 'package-search-index.js'); + } + if (!typeSearchIndex) { + createElem(doc, tag, 'type-search-index.js'); + } + if (!memberSearchIndex) { + createElem(doc, tag, 'member-search-index.js'); + } + if (!tagSearchIndex) { + createElem(doc, tag, 'tag-search-index.js'); + } + $(window).resize(function() { + $('.navPadding').css('padding-top', $('.fixedNav').css("height")); + }); +} + +function createElem(doc, tag, path) { + var script = doc.createElement(tag); + var scriptElement = doc.getElementsByTagName(tag)[0]; + script.src = pathtoroot + path; + scriptElement.parentNode.insertBefore(script, scriptElement); +} + +function show(type) { + count = 0; + for (var key in data) { + var row = document.getElementById(key); + if ((data[key] & type) !== 0) { + row.style.display = ''; + row.className = (count++ % 2) ? rowColor : altColor; + } + else + row.style.display = 'none'; + } + updateTabs(type); +} + +function updateTabs(type) { + for (var value in tabs) { + var sNode = document.getElementById(tabs[value][0]); + var spanNode = sNode.firstChild; + if (value == type) { + sNode.className = activeTableTab; + spanNode.innerHTML = tabs[value][1]; + } + else { + sNode.className = tableTab; + spanNode.innerHTML = "" + tabs[value][1] + ""; + } + } +} + +function updateModuleFrame(pFrame, cFrame) { + top.packageFrame.location = pFrame; + top.classFrame.location = cFrame; +} diff --git a/9.3.3/api/search.js b/9.3.3/api/search.js new file mode 100644 index 000000000..8492271e7 --- /dev/null +++ b/9.3.3/api/search.js @@ -0,0 +1,326 @@ +/* + * Copyright (c) 2015, 2018, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +var noResult = {l: "No results found"}; +var catModules = "Modules"; +var catPackages = "Packages"; +var catTypes = "Types"; +var catMembers = "Members"; +var catSearchTags = "SearchTags"; +var highlight = "$&"; +var camelCaseRegexp = ""; +var secondaryMatcher = ""; +function getHighlightedText(item) { + var ccMatcher = new RegExp(camelCaseRegexp); + var label = item.replace(ccMatcher, highlight); + if (label === item) { + label = item.replace(secondaryMatcher, highlight); + } + return label; +} +function getURLPrefix(ui) { + var urlPrefix=""; + if (useModuleDirectories) { + var slash = "/"; + if (ui.item.category === catModules) { + return ui.item.l + slash; + } else if (ui.item.category === catPackages && ui.item.m) { + return ui.item.m + slash; + } else if ((ui.item.category === catTypes && ui.item.p) || ui.item.category === catMembers) { + $.each(packageSearchIndex, function(index, item) { + if (item.m && ui.item.p == item.l) { + urlPrefix = item.m + slash; + } + }); + return urlPrefix; + } else { + return urlPrefix; + } + } + return urlPrefix; +} +var watermark = 'Search'; +$(function() { + $("#search").val(''); + $("#search").prop("disabled", false); + $("#reset").prop("disabled", false); + $("#search").val(watermark).addClass('watermark'); + $("#search").blur(function() { + if ($(this).val().length == 0) { + $(this).val(watermark).addClass('watermark'); + } + }); + $("#search").on('click keydown', function() { + if ($(this).val() == watermark) { + $(this).val('').removeClass('watermark'); + } + }); + $("#reset").click(function() { + $("#search").val(''); + $("#search").focus(); + }); + $("#search").focus(); + $("#search")[0].setSelectionRange(0, 0); +}); +$.widget("custom.catcomplete", $.ui.autocomplete, { + _create: function() { + this._super(); + this.widget().menu("option", "items", "> :not(.ui-autocomplete-category)"); + }, + _renderMenu: function(ul, items) { + var rMenu = this, + currentCategory = ""; + rMenu.menu.bindings = $(); + $.each(items, function(index, item) { + var li; + if (item.l !== noResult.l && item.category !== currentCategory) { + ul.append("
  • " + item.category + "
    • "); + currentCategory = item.category; + } + li = rMenu._renderItemData(ul, item); + if (item.category) { + li.attr("aria-label", item.category + " : " + item.l); + li.attr("class", "resultItem"); + } else { + li.attr("aria-label", item.l); + li.attr("class", "resultItem"); + } + }); + }, + _renderItem: function(ul, item) { + var label = ""; + if (item.category === catModules) { + label = getHighlightedText(item.l); + } else if (item.category === catPackages) { + label = (item.m) + ? getHighlightedText(item.m + "/" + item.l) + : getHighlightedText(item.l); + } else if (item.category === catTypes) { + label = (item.p) + ? getHighlightedText(item.p + "." + item.l) + : getHighlightedText(item.l); + } else if (item.category === catMembers) { + label = getHighlightedText(item.p + "." + (item.c + "." + item.l)); + } else if (item.category === catSearchTags) { + label = getHighlightedText(item.l); + } else { + label = item.l; + } + var li = $("
  • ").appendTo(ul); + var div = $("
    ").appendTo(li); + if (item.category === catSearchTags) { + if (item.d) { + div.html(label + " (" + item.h + ")
    " + + item.d + "
    "); + } else { + div.html(label + " (" + item.h + ")"); + } + } else { + div.html(label); + } + return li; + } +}); +$(function() { + $("#search").catcomplete({ + minLength: 1, + delay: 100, + source: function(request, response) { + var result = new Array(); + var presult = new Array(); + var tresult = new Array(); + var mresult = new Array(); + var tgresult = new Array(); + var secondaryresult = new Array(); + var displayCount = 0; + var exactMatcher = new RegExp("^" + $.ui.autocomplete.escapeRegex(request.term) + "$", "i"); + camelCaseRegexp = ($.ui.autocomplete.escapeRegex(request.term)).split(/(?=[A-Z])/).join("([a-z0-9_$]*?)"); + var camelCaseMatcher = new RegExp("^" + camelCaseRegexp); + secondaryMatcher = new RegExp($.ui.autocomplete.escapeRegex(request.term), "i"); + + // Return the nested innermost name from the specified object + function nestedName(e) { + return e.l.substring(e.l.lastIndexOf(".") + 1); + } + + function concatResults(a1, a2) { + a1 = a1.concat(a2); + a2.length = 0; + return a1; + } + + if (moduleSearchIndex) { + var mdleCount = 0; + $.each(moduleSearchIndex, function(index, item) { + item.category = catModules; + if (exactMatcher.test(item.l)) { + result.push(item); + mdleCount++; + } else if (camelCaseMatcher.test(item.l)) { + result.push(item); + } else if (secondaryMatcher.test(item.l)) { + secondaryresult.push(item); + } + }); + displayCount = mdleCount; + result = concatResults(result, secondaryresult); + } + if (packageSearchIndex) { + var pCount = 0; + var pkg = ""; + $.each(packageSearchIndex, function(index, item) { + item.category = catPackages; + pkg = (item.m) + ? (item.m + "/" + item.l) + : item.l; + if (exactMatcher.test(item.l)) { + presult.push(item); + pCount++; + } else if (camelCaseMatcher.test(pkg)) { + presult.push(item); + } else if (secondaryMatcher.test(pkg)) { + secondaryresult.push(item); + } + }); + result = result.concat(concatResults(presult, secondaryresult)); + displayCount = (pCount > displayCount) ? pCount : displayCount; + } + if (typeSearchIndex) { + var tCount = 0; + $.each(typeSearchIndex, function(index, item) { + item.category = catTypes; + var s = nestedName(item); + if (exactMatcher.test(s)) { + tresult.push(item); + tCount++; + } else if (camelCaseMatcher.test(s)) { + tresult.push(item); + } else if (secondaryMatcher.test(item.p + "." + item.l)) { + secondaryresult.push(item); + } + }); + result = result.concat(concatResults(tresult, secondaryresult)); + displayCount = (tCount > displayCount) ? tCount : displayCount; + } + if (memberSearchIndex) { + var mCount = 0; + $.each(memberSearchIndex, function(index, item) { + item.category = catMembers; + var s = nestedName(item); + if (exactMatcher.test(s)) { + mresult.push(item); + mCount++; + } else if (camelCaseMatcher.test(s)) { + mresult.push(item); + } else if (secondaryMatcher.test(item.c + "." + item.l)) { + secondaryresult.push(item); + } + }); + result = result.concat(concatResults(mresult, secondaryresult)); + displayCount = (mCount > displayCount) ? mCount : displayCount; + } + if (tagSearchIndex) { + var tgCount = 0; + $.each(tagSearchIndex, function(index, item) { + item.category = catSearchTags; + if (exactMatcher.test(item.l)) { + tgresult.push(item); + tgCount++; + } else if (secondaryMatcher.test(item.l)) { + secondaryresult.push(item); + } + }); + result = result.concat(concatResults(tgresult, secondaryresult)); + displayCount = (tgCount > displayCount) ? tgCount : displayCount; + } + displayCount = (displayCount > 500) ? displayCount : 500; + var counter = function() { + var count = {Modules: 0, Packages: 0, Types: 0, Members: 0, SearchTags: 0}; + var f = function(item) { + count[item.category] += 1; + return (count[item.category] <= displayCount); + }; + return f; + }(); + response(result.filter(counter)); + }, + response: function(event, ui) { + if (!ui.content.length) { + ui.content.push(noResult); + } else { + $("#search").empty(); + } + }, + autoFocus: true, + position: { + collision: "flip" + }, + select: function(event, ui) { + if (ui.item.l !== noResult.l) { + var url = getURLPrefix(ui); + if (ui.item.category === catModules) { + if (useModuleDirectories) { + url += "module-summary.html"; + } else { + url = ui.item.l + "-summary.html"; + } + } else if (ui.item.category === catPackages) { + if (ui.item.url) { + url = ui.item.url; + } else { + url += ui.item.l.replace(/\./g, '/') + "/package-summary.html"; + } + } else if (ui.item.category === catTypes) { + if (ui.item.url) { + url = ui.item.url; + } else if (ui.item.p === "") { + url += ui.item.l + ".html"; + } else { + url += ui.item.p.replace(/\./g, '/') + "/" + ui.item.l + ".html"; + } + } else if (ui.item.category === catMembers) { + if (ui.item.p === "") { + url += ui.item.c + ".html" + "#"; + } else { + url += ui.item.p.replace(/\./g, '/') + "/" + ui.item.c + ".html" + "#"; + } + if (ui.item.url) { + url += ui.item.url; + } else { + url += ui.item.l; + } + } else if (ui.item.category === catSearchTags) { + url += ui.item.u; + } + if (top !== window) { + parent.classFrame.location = pathtoroot + url; + } else { + window.location.href = pathtoroot + url; + } + $("#search").focus(); + } + } + }); +}); diff --git a/9.3.3/api/serialized-form.html b/9.3.3/api/serialized-form.html new file mode 100644 index 000000000..b06f947ae --- /dev/null +++ b/9.3.3/api/serialized-form.html @@ -0,0 +1,208 @@ + + + + + +Serialized Form (gradle-docker-plugin 9.3.3 API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Serialized Form

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/9.3.3/api/stylesheet.css b/9.3.3/api/stylesheet.css new file mode 100644 index 000000000..de945eda2 --- /dev/null +++ b/9.3.3/api/stylesheet.css @@ -0,0 +1,910 @@ +/* + * Javadoc style sheet + */ + +@import url('resources/fonts/dejavu.css'); + +/* + * Styles for individual HTML elements. + * + * These are styles that are specific to individual HTML elements. Changing them affects the style of a particular + * HTML element throughout the page. + */ + +body { + background-color:#ffffff; + color:#353833; + font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:14px; + margin:0; + padding:0; + height:100%; + width:100%; +} +iframe { + margin:0; + padding:0; + height:100%; + width:100%; + overflow-y:scroll; + border:none; +} +a:link, a:visited { + text-decoration:none; + color:#4A6782; +} +a[href]:hover, a[href]:focus { + text-decoration:none; + color:#bb7a2a; +} +a[name] { + color:#353833; +} +a[name]:before, a[name]:target, a[id]:before, a[id]:target { + content:""; + display:inline-block; + position:relative; + padding-top:129px; + margin-top:-129px; +} +pre { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; +} +h1 { + font-size:20px; +} +h2 { + font-size:18px; +} +h3 { + font-size:16px; + font-style:italic; +} +h4 { + font-size:13px; +} +h5 { + font-size:12px; +} +h6 { + font-size:11px; +} +ul { + list-style-type:disc; +} +code, tt { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; + margin-top:8px; + line-height:1.4em; +} +dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; +} +table tr td dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + vertical-align:top; + padding-top:4px; +} +sup { + font-size:8px; +} + +/* + * Styles for HTML generated by javadoc. + * + * These are style classes that are used by the standard doclet to generate HTML documentation. + */ + +/* + * Styles for document title and copyright. + */ +.clear { + clear:both; + height:0px; + overflow:hidden; +} +.aboutLanguage { + float:right; + padding:0px 21px; + font-size:11px; + z-index:200; + margin-top:-9px; +} +.legalCopy { + margin-left:.5em; +} +.bar a, .bar a:link, .bar a:visited, .bar a:active { + color:#FFFFFF; + text-decoration:none; +} +.bar a:hover, .bar a:focus { + color:#bb7a2a; +} +.tab { + background-color:#0066FF; + color:#ffffff; + padding:8px; + width:5em; + font-weight:bold; +} +/* + * Styles for navigation bar. + */ +.bar { + background-color:#4D7A97; + color:#FFFFFF; + padding:.8em .5em .4em .8em; + height:auto;/*height:1.8em;*/ + font-size:11px; + margin:0; +} +.navPadding { + padding-top: 107px; +} +.fixedNav { + position:fixed; + width:100%; + z-index:999; + background-color:#ffffff; +} +.topNav { + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.bottomNav { + margin-top:10px; + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.subNav { + background-color:#dee3e9; + float:left; + width:100%; + overflow:hidden; + font-size:12px; +} +.subNav div { + clear:left; + float:left; + padding:0 0 5px 6px; + text-transform:uppercase; +} +ul.navList, ul.subNavList { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.navList li{ + list-style:none; + float:left; + padding: 5px 6px; + text-transform:uppercase; +} +ul.navListSearch { + float:right; + margin:0 0 0 0; + padding:0; +} +ul.navListSearch li { + list-style:none; + float:right; + padding: 5px 6px; + text-transform:uppercase; +} +ul.navListSearch li label { + position:relative; + right:-16px; +} +ul.subNavList li { + list-style:none; + float:left; +} +.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { + color:#FFFFFF; + text-decoration:none; + text-transform:uppercase; +} +.topNav a:hover, .bottomNav a:hover { + text-decoration:none; + color:#bb7a2a; + text-transform:uppercase; +} +.navBarCell1Rev { + background-color:#F8981D; + color:#253441; + margin: auto 5px; +} +.skipNav { + position:absolute; + top:auto; + left:-9999px; + overflow:hidden; +} +/* + * Styles for page header and footer. + */ +.header, .footer { + clear:both; + margin:0 20px; + padding:5px 0 0 0; +} +.indexNav { + position:relative; + font-size:12px; + background-color:#dee3e9; +} +.indexNav ul { + margin-top:0; + padding:5px; +} +.indexNav ul li { + display:inline; + list-style-type:none; + padding-right:10px; + text-transform:uppercase; +} +.indexNav h1 { + font-size:13px; +} +.title { + color:#2c4557; + margin:10px 0; +} +.subTitle { + margin:5px 0 0 0; +} +.header ul { + margin:0 0 15px 0; + padding:0; +} +.footer ul { + margin:20px 0 5px 0; +} +.header ul li, .footer ul li { + list-style:none; + font-size:13px; +} +/* + * Styles for headings. + */ +div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList ul.blockList li.blockList h3 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList li.blockList h3 { + padding:0; + margin:15px 0; +} +ul.blockList li.blockList h2 { + padding:0px 0 20px 0; +} +/* + * Styles for page layout containers. + */ +.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer, +.allClassesContainer, .allPackagesContainer { + clear:both; + padding:10px 20px; + position:relative; +} +.indexContainer { + margin:10px; + position:relative; + font-size:12px; +} +.indexContainer h2 { + font-size:13px; + padding:0 0 3px 0; +} +.indexContainer ul { + margin:0; + padding:0; +} +.indexContainer ul li { + list-style:none; + padding-top:2px; +} +.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt { + font-size:12px; + font-weight:bold; + margin:10px 0 0 0; + color:#4E4E4E; +} +.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { + margin:5px 0 10px 0px; + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} +.serializedFormContainer dl.nameValue dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +.serializedFormContainer dl.nameValue dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* + * Styles for lists. + */ +li.circle { + list-style:circle; +} +ul.horizontal li { + display:inline; + font-size:0.9em; +} +ul.inheritance { + margin:0; + padding:0; +} +ul.inheritance li { + display:inline; + list-style:none; +} +ul.inheritance li ul.inheritance { + margin-left:15px; + padding-left:15px; + padding-top:1px; +} +ul.blockList, ul.blockListLast { + margin:10px 0 10px 0; + padding:0; +} +ul.blockList li.blockList, ul.blockListLast li.blockList { + list-style:none; + margin-bottom:15px; + line-height:1.4; +} +ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList { + padding:0px 20px 5px 10px; + border:1px solid #ededed; + background-color:#f8f8f8; +} +ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList { + padding:0 0 5px 8px; + background-color:#ffffff; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockList { + margin-left:0; + padding-left:0; + padding-bottom:15px; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast { + list-style:none; + border-bottom:none; + padding-bottom:0; +} +table tr td dl, table tr td dl dt, table tr td dl dd { + margin-top:0; + margin-bottom:1px; +} +/* + * Styles for tables. + */ +.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary, +.requiresSummary, .packagesSummary, .providesSummary, .usesSummary { + width:100%; + border-spacing:0; + border-left:1px solid #EEE; + border-right:1px solid #EEE; + border-bottom:1px solid #EEE; +} +.overviewSummary, .memberSummary, .requiresSummary, .packagesSummary, .providesSummary, .usesSummary { + padding:0px; +} +.overviewSummary caption, .memberSummary caption, .typeSummary caption, +.useSummary caption, .constantsSummary caption, .deprecatedSummary caption, +.requiresSummary caption, .packagesSummary caption, .providesSummary caption, .usesSummary caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:#253441; + font-weight:bold; + clear:none; + overflow:hidden; + padding:0px; + padding-top:10px; + padding-left:1px; + margin:0px; + white-space:pre; +} +.constantsSummary caption a:link, .constantsSummary caption a:visited, +.useSummary caption a:link, .useSummary caption a:visited { + color:#1f389c; +} +.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link, +.deprecatedSummary caption a:link, +.requiresSummary caption a:link, .packagesSummary caption a:link, .providesSummary caption a:link, +.usesSummary caption a:link, +.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover, +.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover, +.requiresSummary caption a:hover, .packagesSummary caption a:hover, .providesSummary caption a:hover, +.usesSummary caption a:hover, +.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active, +.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active, +.requiresSummary caption a:active, .packagesSummary caption a:active, .providesSummary caption a:active, +.usesSummary caption a:active, +.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited, +.deprecatedSummary caption a:visited, +.requiresSummary caption a:visited, .packagesSummary caption a:visited, .providesSummary caption a:visited, +.usesSummary caption a:visited { + color:#FFFFFF; +} +.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span, +.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span, +.requiresSummary caption span, .packagesSummary caption span, .providesSummary caption span, +.usesSummary caption span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + padding-bottom:7px; + display:inline-block; + float:left; + background-color:#F8981D; + border: none; + height:16px; +} +.memberSummary caption span.activeTableTab span, .packagesSummary caption span.activeTableTab span, +.overviewSummary caption span.activeTableTab span, .typeSummary caption span.activeTableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#F8981D; + height:16px; +} +.memberSummary caption span.tableTab span, .packagesSummary caption span.tableTab span, +.overviewSummary caption span.tableTab span, .typeSummary caption span.tableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#4D7A97; + height:16px; +} +.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab, +.packagesSummary caption span.tableTab, .packagesSummary caption span.activeTableTab, +.overviewSummary caption span.tableTab, .overviewSummary caption span.activeTableTab, +.typeSummary caption span.tableTab, .typeSummary caption span.activeTableTab { + padding-top:0px; + padding-left:0px; + padding-right:0px; + background-image:none; + float:none; + display:inline; +} +.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd, +.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd, +.requiresSummary .tabEnd, .packagesSummary .tabEnd, .providesSummary .tabEnd, .usesSummary .tabEnd { + display:none; + width:5px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .activeTableTab .tabEnd, .packagesSummary .activeTableTab .tabEnd, +.overviewSummary .activeTableTab .tabEnd, .typeSummary .activeTableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .tableTab .tabEnd, .packagesSummary .tableTab .tabEnd, +.overviewSummary .tableTab .tabEnd, .typeSummary .tableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + background-color:#4D7A97; + float:left; +} +.rowColor th, .altColor th { + font-weight:normal; +} +.overviewSummary td, .memberSummary td, .typeSummary td, +.useSummary td, .constantsSummary td, .deprecatedSummary td, +.requiresSummary td, .packagesSummary td, .providesSummary td, .usesSummary td { + text-align:left; + padding:0px 0px 12px 10px; +} +th.colFirst, th.colSecond, th.colLast, th.colConstructorName, th.colDeprecatedItemName, .useSummary th, +.constantsSummary th, .packagesSummary th, td.colFirst, td.colSecond, td.colLast, .useSummary td, +.constantsSummary td { + vertical-align:top; + padding-right:0px; + padding-top:8px; + padding-bottom:3px; +} +th.colFirst, th.colSecond, th.colLast, th.colConstructorName, th.colDeprecatedItemName, .constantsSummary th, +.packagesSummary th { + background:#dee3e9; + text-align:left; + padding:8px 3px 3px 7px; +} +td.colFirst, th.colFirst { + font-size:13px; +} +td.colSecond, th.colSecond, td.colLast, th.colConstructorName, th.colDeprecatedItemName, th.colLast { + font-size:13px; +} +.constantsSummary th, .packagesSummary th { + font-size:13px; +} +.providesSummary th.colFirst, .providesSummary th.colLast, .providesSummary td.colFirst, +.providesSummary td.colLast { + white-space:normal; + font-size:13px; +} +.overviewSummary td.colFirst, .overviewSummary th.colFirst, +.requiresSummary td.colFirst, .requiresSummary th.colFirst, +.packagesSummary td.colFirst, .packagesSummary td.colSecond, .packagesSummary th.colFirst, .packagesSummary th, +.usesSummary td.colFirst, .usesSummary th.colFirst, +.providesSummary td.colFirst, .providesSummary th.colFirst, +.memberSummary td.colFirst, .memberSummary th.colFirst, +.memberSummary td.colSecond, .memberSummary th.colSecond, .memberSummary th.colConstructorName, +.typeSummary td.colFirst, .typeSummary th.colFirst { + vertical-align:top; +} +.packagesSummary th.colLast, .packagesSummary td.colLast { + white-space:normal; +} +td.colFirst a:link, td.colFirst a:visited, +td.colSecond a:link, td.colSecond a:visited, +th.colFirst a:link, th.colFirst a:visited, +th.colSecond a:link, th.colSecond a:visited, +th.colConstructorName a:link, th.colConstructorName a:visited, +th.colDeprecatedItemName a:link, th.colDeprecatedItemName a:visited, +.constantValuesContainer td a:link, .constantValuesContainer td a:visited, +.allClassesContainer td a:link, .allClassesContainer td a:visited, +.allPackagesContainer td a:link, .allPackagesContainer td a:visited { + font-weight:bold; +} +.tableSubHeadingColor { + background-color:#EEEEFF; +} +.altColor, .altColor th { + background-color:#FFFFFF; +} +.rowColor, .rowColor th { + background-color:#EEEEEF; +} +/* + * Styles for contents. + */ +.description pre { + margin-top:0; +} +.deprecatedContent { + margin:0; + padding:10px 0; +} +.docSummary { + padding:0; +} +ul.blockList ul.blockList ul.blockList li.blockList h3 { + font-style:normal; +} +div.block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} +td.colLast div { + padding-top:0px; +} +td.colLast a { + padding-bottom:3px; +} +/* + * Styles for formatting effect. + */ +.sourceLineNo { + color:green; + padding:0 30px 0 0; +} +h1.hidden { + visibility:hidden; + overflow:hidden; + font-size:10px; +} +.block { + display:block; + margin:3px 10px 2px 0px; + color:#474747; +} +.deprecatedLabel, .descfrmTypeLabel, .implementationLabel, .memberNameLabel, .memberNameLink, +.moduleLabelInPackage, .moduleLabelInType, .overrideSpecifyLabel, .packageLabelInType, +.packageHierarchyLabel, .paramLabel, .returnLabel, .seeLabel, .simpleTagLabel, +.throwsLabel, .typeNameLabel, .typeNameLink, .searchTagLink { + font-weight:bold; +} +.deprecationComment, .emphasizedPhrase, .interfaceName { + font-style:italic; +} +.deprecationBlock { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; + border-style:solid; + border-width:thin; + border-radius:10px; + padding:10px; + margin-bottom:10px; + margin-right:10px; + display:inline-block; +} +div.block div.deprecationComment, div.block div.block span.emphasizedPhrase, +div.block div.block span.interfaceName { + font-style:normal; +} +div.contentContainer ul.blockList li.blockList h2 { + padding-bottom:0px; +} +/* + * Styles for IFRAME. + */ +.mainContainer { + margin:0 auto; + padding:0; + height:100%; + width:100%; + position:fixed; + top:0; + left:0; +} +.leftContainer { + height:100%; + position:fixed; + width:320px; +} +.leftTop { + position:relative; + float:left; + width:315px; + top:0; + left:0; + height:30%; + border-right:6px solid #ccc; + border-bottom:6px solid #ccc; +} +.leftBottom { + position:relative; + float:left; + width:315px; + bottom:0; + left:0; + height:70%; + border-right:6px solid #ccc; + border-top:1px solid #000; +} +.rightContainer { + position:absolute; + left:320px; + top:0; + bottom:0; + height:100%; + right:0; + border-left:1px solid #000; +} +.rightIframe { + margin:0; + padding:0; + height:100%; + right:30px; + width:100%; + overflow:visible; + margin-bottom:30px; +} +/* + * Styles specific to HTML5 elements. + */ +main, nav, header, footer, section { + display:block; +} +/* + * Styles for javadoc search. + */ +.ui-autocomplete-category { + font-weight:bold; + font-size:15px; + padding:7px 0 7px 3px; + background-color:#4D7A97; + color:#FFFFFF; +} +.resultItem { + font-size:13px; +} +.ui-autocomplete { + max-height:85%; + max-width:65%; + overflow-y:scroll; + overflow-x:scroll; + white-space:nowrap; + box-shadow: 0 3px 6px rgba(0,0,0,0.16), 0 3px 6px rgba(0,0,0,0.23); +} +ul.ui-autocomplete { + position:fixed; + z-index:999999; + background-color: #FFFFFF; +} +ul.ui-autocomplete li { + float:left; + clear:both; + width:100%; +} +.resultHighlight { + font-weight:bold; +} +.ui-autocomplete .result-item { + font-size: inherit; +} +#search { + background-image:url('resources/glass.png'); + background-size:13px; + background-repeat:no-repeat; + background-position:2px 3px; + padding-left:20px; + position:relative; + right:-18px; +} +#reset { + background-color: rgb(255,255,255); + background-image:url('resources/x.png'); + background-position:center; + background-repeat:no-repeat; + background-size:12px; + border:0 none; + width:16px; + height:17px; + position:relative; + left:-4px; + top:-4px; + font-size:0px; +} +.watermark { + color:#545454; +} +.searchTagDescResult { + font-style:italic; + font-size:11px; +} +.searchTagHolderResult { + font-style:italic; + font-size:12px; +} +.searchTagResult:before, .searchTagResult:target { + color:red; +} +.moduleGraph span { + display:none; + position:absolute; +} +.moduleGraph:hover span { + display:block; + margin: -100px 0 0 100px; + z-index: 1; +} +.methodSignature { + white-space:normal; +} + +/* + * Styles for user-provided tables. + * + * borderless: + * No borders, vertical margins, styled caption. + * This style is provided for use with existing doc comments. + * In general, borderless tables should not be used for layout purposes. + * + * plain: + * Plain borders around table and cells, vertical margins, styled caption. + * Best for small tables or for complex tables for tables with cells that span + * rows and columns, when the "striped" style does not work well. + * + * striped: + * Borders around the table and vertical borders between cells, striped rows, + * vertical margins, styled caption. + * Best for tables that have a header row, and a body containing a series of simple rows. + */ + +table.borderless, +table.plain, +table.striped { + margin-top: 10px; + margin-bottom: 10px; +} +table.borderless > caption, +table.plain > caption, +table.striped > caption { + font-weight: bold; + font-size: smaller; +} +table.borderless th, table.borderless td, +table.plain th, table.plain td, +table.striped th, table.striped td { + padding: 2px 5px; +} +table.borderless, +table.borderless > thead > tr > th, table.borderless > tbody > tr > th, table.borderless > tr > th, +table.borderless > thead > tr > td, table.borderless > tbody > tr > td, table.borderless > tr > td { + border: none; +} +table.borderless > thead > tr, table.borderless > tbody > tr, table.borderless > tr { + background-color: transparent; +} +table.plain { + border-collapse: collapse; + border: 1px solid black; +} +table.plain > thead > tr, table.plain > tbody tr, table.plain > tr { + background-color: transparent; +} +table.plain > thead > tr > th, table.plain > tbody > tr > th, table.plain > tr > th, +table.plain > thead > tr > td, table.plain > tbody > tr > td, table.plain > tr > td { + border: 1px solid black; +} +table.striped { + border-collapse: collapse; + border: 1px solid black; +} +table.striped > thead { + background-color: #E3E3E3; +} +table.striped > thead > tr > th, table.striped > thead > tr > td { + border: 1px solid black; +} +table.striped > tbody > tr:nth-child(even) { + background-color: #EEE +} +table.striped > tbody > tr:nth-child(odd) { + background-color: #FFF +} +table.striped > tbody > tr > th, table.striped > tbody > tr > td { + border-left: 1px solid black; + border-right: 1px solid black; +} +table.striped > tbody > tr > th { + font-weight: normal; +} diff --git a/9.3.3/api/type-search-index.js b/9.3.3/api/type-search-index.js new file mode 100644 index 000000000..e31dc704d --- /dev/null +++ b/9.3.3/api/type-search-index.js @@ -0,0 +1 @@ +typeSearchIndex = [{"p":"com.bmuschko.gradle.docker.tasks","l":"AbstractDockerRemoteApiTask"},{"p":"com.bmuschko.gradle.docker.tasks.image","l":"Dockerfile.AddFileInstruction"},{"l":"All Classes","url":"allclasses-index.html"},{"p":"com.bmuschko.gradle.docker.tasks.image","l":"Dockerfile.ArgInstruction"},{"p":"com.bmuschko.gradle.docker.tasks.image","l":"Dockerfile.CommentInstruction"},{"p":"com.bmuschko.gradle.docker.tasks.network","l":"DockerCreateNetwork.Ipam.Config"},{"p":"com.bmuschko.gradle.docker.internal","l":"ConventionPluginHelper"},{"p":"com.bmuschko.gradle.docker.tasks.image","l":"Dockerfile.CopyFile"},{"p":"com.bmuschko.gradle.docker.tasks.image","l":"Dockerfile.CopyFileInstruction"},{"p":"com.bmuschko.gradle.docker.domain","l":"CopyFileToContainer"},{"p":"com.bmuschko.gradle.docker.internal","l":"CopyUtils"},{"p":"com.bmuschko.gradle.docker.tasks.image","l":"Dockerfile.DefaultCommandInstruction"},{"p":"com.bmuschko.gradle.docker.internal","l":"DefaultDockerConfigResolver"},{"p":"com.bmuschko.gradle.docker.internal","l":"DefaultDockerUrlValueSource"},{"p":"com.bmuschko.gradle.docker.tasks.image","l":"DockerBuildImage"},{"p":"com.bmuschko.gradle.docker.internal.services","l":"DockerClientService"},{"p":"com.bmuschko.gradle.docker.tasks.image","l":"DockerCommitImage"},{"p":"com.bmuschko.gradle.docker.internal","l":"DockerConfigResolver"},{"p":"com.bmuschko.gradle.docker","l":"DockerConventionJvmApplicationExtension"},{"p":"com.bmuschko.gradle.docker","l":"DockerConventionJvmApplicationPlugin"},{"p":"com.bmuschko.gradle.docker.tasks.container","l":"DockerCopyFileFromContainer"},{"p":"com.bmuschko.gradle.docker.tasks.container","l":"DockerCopyFileToContainer"},{"p":"com.bmuschko.gradle.docker.tasks.container","l":"DockerCreateContainer"},{"p":"com.bmuschko.gradle.docker.tasks.network","l":"DockerCreateNetwork"},{"p":"com.bmuschko.gradle.docker.tasks.container","l":"DockerExecContainer"},{"p":"com.bmuschko.gradle.docker.tasks.container","l":"DockerExistingContainer"},{"p":"com.bmuschko.gradle.docker.tasks.image","l":"DockerExistingImage"},{"p":"com.bmuschko.gradle.docker.tasks.network","l":"DockerExistingNetwork"},{"p":"com.bmuschko.gradle.docker","l":"DockerExtension"},{"p":"com.bmuschko.gradle.docker.tasks.image","l":"Dockerfile"},{"p":"com.bmuschko.gradle.docker.tasks","l":"DockerInfo"},{"p":"com.bmuschko.gradle.docker.tasks.container","l":"DockerInspectContainer"},{"p":"com.bmuschko.gradle.docker.tasks.container","l":"DockerInspectExecContainer"},{"p":"com.bmuschko.gradle.docker.tasks.image","l":"DockerInspectImage"},{"p":"com.bmuschko.gradle.docker.tasks.network","l":"DockerInspectNetwork"},{"p":"com.bmuschko.gradle.docker","l":"DockerJavaApplication"},{"p":"com.bmuschko.gradle.docker","l":"DockerJavaApplicationPlugin"},{"p":"com.bmuschko.gradle.docker.tasks.container","l":"DockerKillContainer"},{"p":"com.bmuschko.gradle.docker.tasks.image","l":"DockerListImages"},{"p":"com.bmuschko.gradle.docker.tasks.image","l":"DockerLoadImage"},{"p":"com.bmuschko.gradle.docker.tasks.container","l":"DockerLogsContainer"},{"p":"com.bmuschko.gradle.docker.tasks","l":"DockerOperation"},{"p":"com.bmuschko.gradle.docker.tasks.image","l":"DockerPullImage"},{"p":"com.bmuschko.gradle.docker.tasks.image","l":"DockerPushImage"},{"p":"com.bmuschko.gradle.docker","l":"DockerRegistryCredentials"},{"p":"com.bmuschko.gradle.docker","l":"DockerRemoteApiPlugin"},{"p":"com.bmuschko.gradle.docker.tasks.container","l":"DockerRemoveContainer"},{"p":"com.bmuschko.gradle.docker.tasks.image","l":"DockerRemoveImage"},{"p":"com.bmuschko.gradle.docker.tasks.network","l":"DockerRemoveNetwork"},{"p":"com.bmuschko.gradle.docker.tasks.container","l":"DockerRenameContainer"},{"p":"com.bmuschko.gradle.docker.tasks.container","l":"DockerRestartContainer"},{"p":"com.bmuschko.gradle.docker.tasks.image","l":"DockerSaveImage"},{"p":"com.bmuschko.gradle.docker","l":"DockerSpringBootApplication"},{"p":"com.bmuschko.gradle.docker","l":"DockerSpringBootApplicationPlugin"},{"p":"com.bmuschko.gradle.docker.tasks.container","l":"DockerStartContainer"},{"p":"com.bmuschko.gradle.docker.tasks.container","l":"DockerStopContainer"},{"p":"com.bmuschko.gradle.docker.tasks.image","l":"DockerTagImage"},{"p":"com.bmuschko.gradle.docker.tasks","l":"DockerVersion"},{"p":"com.bmuschko.gradle.docker.tasks.container","l":"DockerWaitContainer"},{"p":"com.bmuschko.gradle.docker.tasks.image","l":"Dockerfile.EntryPointInstruction"},{"p":"com.bmuschko.gradle.docker.tasks.image","l":"Dockerfile.EnvironmentVariableInstruction"},{"p":"com.bmuschko.gradle.docker.domain","l":"ExecProbe"},{"p":"com.bmuschko.gradle.docker.tasks.container","l":"DockerCreateContainer.ExposedPort"},{"p":"com.bmuschko.gradle.docker.tasks.image","l":"Dockerfile.ExposePortInstruction"},{"p":"com.bmuschko.gradle.docker.internal","l":"RegistryAuthLocator.Factory"},{"p":"com.bmuschko.gradle.docker.tasks.image","l":"Dockerfile.File"},{"p":"com.bmuschko.gradle.docker.tasks.image","l":"Dockerfile.FileInstruction"},{"p":"com.bmuschko.gradle.docker.tasks.image","l":"Dockerfile.From"},{"p":"com.bmuschko.gradle.docker.tasks.image","l":"Dockerfile.FromInstruction"},{"p":"com.bmuschko.gradle.docker.tasks.image","l":"Dockerfile.GenericInstruction"},{"p":"com.bmuschko.gradle.docker.tasks.container","l":"DockerCreateContainer.HealthCheckConfig"},{"p":"com.bmuschko.gradle.docker.tasks.container","l":"DockerCreateContainer.HostConfig"},{"p":"com.bmuschko.gradle.docker.tasks.image","l":"Dockerfile.Instruction"},{"p":"com.bmuschko.gradle.docker.internal","l":"IOUtils"},{"p":"com.bmuschko.gradle.docker.tasks.network","l":"DockerCreateNetwork.Ipam"},{"p":"com.bmuschko.gradle.docker.tasks.image","l":"Dockerfile.LabelInstruction"},{"p":"com.bmuschko.gradle.docker.domain","l":"LivenessProbe"},{"p":"com.bmuschko.gradle.docker.tasks.container","l":"DockerCreateContainer.HostConfig.LogConfig"},{"p":"com.bmuschko.gradle.docker.internal","l":"MainClassFinder.MainClass"},{"p":"com.bmuschko.gradle.docker.internal","l":"MainClassFinder.MainClassCallback"},{"p":"com.bmuschko.gradle.docker.internal","l":"MainClassFinder"},{"p":"com.bmuschko.gradle.docker.tasks.image","l":"Dockerfile.MapInstruction"},{"p":"com.bmuschko.gradle.docker.tasks.image","l":"Dockerfile.OnBuildInstruction"},{"p":"com.bmuschko.gradle.docker.internal","l":"OsUtils"},{"p":"com.bmuschko.gradle.docker.internal","l":"OutputCollector"},{"p":"com.bmuschko.gradle.docker.internal.services","l":"DockerClientService.Params"},{"p":"com.bmuschko.gradle.docker.internal","l":"RegistryAuthLocator"},{"p":"com.bmuschko.gradle.docker.tasks","l":"RegistryCredentialsAware"},{"p":"com.bmuschko.gradle.docker.internal","l":"RegularFileToStringTransformer"},{"p":"com.bmuschko.gradle.docker.tasks.image","l":"Dockerfile.RunCommandInstruction"},{"p":"com.bmuschko.gradle.docker.tasks.image","l":"Dockerfile.StringArrayInstruction"},{"p":"com.bmuschko.gradle.docker.tasks.image","l":"Dockerfile.StringCommandInstruction"},{"p":"com.bmuschko.gradle.docker.tasks.image","l":"Dockerfile.UserInstruction"},{"p":"com.bmuschko.gradle.docker.tasks.image","l":"Dockerfile.VolumeInstruction"},{"p":"com.bmuschko.gradle.docker.tasks.image","l":"Dockerfile.WorkDirInstruction"}] \ No newline at end of file diff --git a/9.3.3/api/type-search-index.zip b/9.3.3/api/type-search-index.zip new file mode 100644 index 000000000..66c65f20c Binary files /dev/null and b/9.3.3/api/type-search-index.zip differ diff --git a/9.3.3/dev-guide/10-about.html b/9.3.3/dev-guide/10-about.html new file mode 100644 index 000000000..cca1ea852 --- /dev/null +++ b/9.3.3/dev-guide/10-about.html @@ -0,0 +1,489 @@ + + + + + + + +Maintainers + + + + + + +
    +
    +

    1. Maintainers

    +
    +
    + +
    +
    +
    +
    +

    2. Contributing

    +
    +
    +

    Over the years, the plugin has tremendously grown in popularity. +Contributions from the community are very welcome. +Have a look at the {uri-github}/blob/master/.github/CONTRIBUTING.md[contribution guidelines] to get started.

    +
    +
    +
    +
    + + + + + \ No newline at end of file diff --git a/9.3.3/dev-guide/20-development.html b/9.3.3/dev-guide/20-development.html new file mode 100644 index 000000000..4e744cc3c --- /dev/null +++ b/9.3.3/dev-guide/20-development.html @@ -0,0 +1,476 @@ + + + + + + + +Development + + + + + + +
    +
    +

    1. Development

    +
    +
    +

    It is required to install and run Docker Community Edition (CE) on the machine running tests. Please refer to the installation manual for more information.

    +
    +
    +

    The following usage examples demonstrates running functional tests against the Docker instance:

    +
    +
    +
    +
    $ ./gradlew functionalTest
    +
    +
    +
    +
    +
    + + + + + \ No newline at end of file diff --git a/9.3.3/dev-guide/30-release-process.html b/9.3.3/dev-guide/30-release-process.html new file mode 100644 index 000000000..2673001c7 --- /dev/null +++ b/9.3.3/dev-guide/30-release-process.html @@ -0,0 +1,554 @@ + + + + + + + +Release Process + + + + + + +
    +
    +

    1. Release Process

    +
    +
    +

    This section describes the release process designed and implemented for this project. Its main purpose is to explain to developers and maintainers how to prepare and release a new version of the binaries and the documentation.

    +
    +
    +

    1.1. Tools

    +
    +

    The release process uses some external libraries and services described in detail below.

    +
    +
    +

    1.1.1. gradle-git

    +
    +

    The gradle-git plugin is used to automatically determine the project version. org.ajoberstar.release-opinion is applied in the main {uri-github}/blob/master/build.gradle#L14[build.gradle] and configured in {uri-github}/blob/master/buildSrc/src/main/kotlin/com/bmuschko/gradle/docker/ReleasePlugin.kt[ReleasePlugin.kt]. Please refer to the plugin documentation for more details.

    +
    +
    +
    +

    1.1.2. gradle-git-publish

    +
    +

    The gradle-git-publish Gradle plugin is used to publish the documentation to gh-pages branch. It is applied and configured in the {uri-github}/blob/master/buildSrc/src/main/kotlin/com/bmuschko/gradle/docker/DocumentationPlugin.kt[DocumentationPlugin.kt] file.

    +
    +
    +
    +

    1.1.3. GitHub Actions

    +
    +

    GitHub Actions service is used as our current CI/CD server. Build and deploy jobs are configured in the {uri-github}/blob/master/.github/workflows[.github/workflows] directory. Please refer its documentation for more details.

    +
    +
    +
    +

    1.1.4. Gradle Plugin Portal

    +
    +

    The Gradle Plugin Portal service is used to publish plugin versions. The Plugin Publishing Plugin uploads artifacts to a remote repository.

    +
    +
    +
    +
    +

    1.2. Workflow

    +
    +

    The release process is automated to some extent. The following steps describe the workflow.

    +
    +
    +
      +
    1. +

      Developer updates RELEASE_NOTES.md with new planned version.

      +
      2. +
    2. +

      Developer commits all changes in local working copy.

      +
      3. +
    3. +

      Developer triggers new version release using the following command: ./gradlew release -Prelease.stage=final -Prelease.scope=[SCOPE] where [SCOPE] can be one of major, minor or patch, and determines which part of the version string <major>.<minor>.<patch> will be incremented.

      +
      4. +
    4. +

      Gradle executes a build on developer’s machine which calculates new version string, creates new tag with it and pushes to the origin.

      +
      5. +
    5. +

      When Gradle build is finished, developer’s work is done and the rest of the release process is automated.

      +
      6. +
    6. +

      After push to the origin, GitHub Actions detects new tag and triggers a build.

      +
      7. +
    7. +

      Executes a release stage if the commit also points to a Git tag.

      +
      8. +
    8. +

      This stage assembles plugin binaries (with new version) and uploads them to Bintray (credentials are stored as encrypted secrets in GitHub). Furthermore, the API docs and the user guide are published to gh-pages branch (the access token is stored as secure variable).

      +
      9. +
    +
    +
    +
    + +
    + +
    +
    +
    +
    +
    + + + + + \ No newline at end of file diff --git a/9.3.3/dev-guide/index.html b/9.3.3/dev-guide/index.html new file mode 100644 index 000000000..9c3438c7b --- /dev/null +++ b/9.3.3/dev-guide/index.html @@ -0,0 +1,605 @@ + + + + + + + +Gradle Docker Plugin Developer Guide + + + + + + +
    +
    +

    1. Maintainers

    +
    +
    + +
    +
    +
    +
    +

    2. Contributing

    +
    +
    +

    Over the years, the plugin has tremendously grown in popularity. +Contributions from the community are very welcome. +Have a look at the contribution guidelines to get started.

    +
    +
    +
    +
    +

    3. Development

    +
    +
    +

    It is required to install and run Docker Community Edition (CE) on the machine running tests. Please refer to the installation manual for more information.

    +
    +
    +

    The following usage examples demonstrates running functional tests against the Docker instance:

    +
    +
    +
    +
    $ ./gradlew functionalTest
    +
    +
    +
    +
    +
    +

    4. Release Process

    +
    +
    +

    This section describes the release process designed and implemented for this project. Its main purpose is to explain to developers and maintainers how to prepare and release a new version of the binaries and the documentation.

    +
    +
    +

    4.1. Tools

    +
    +

    The release process uses some external libraries and services described in detail below.

    +
    +
    +

    4.1.1. gradle-git

    +
    +

    The gradle-git plugin is used to automatically determine the project version. org.ajoberstar.release-opinion is applied in the main build.gradle and configured in ReleasePlugin.kt. Please refer to the plugin documentation for more details.

    +
    +
    +
    +

    4.1.2. gradle-git-publish

    +
    +

    The gradle-git-publish Gradle plugin is used to publish the documentation to gh-pages branch. It is applied and configured in the DocumentationPlugin.kt file.

    +
    +
    +
    +

    4.1.3. GitHub Actions

    +
    +

    GitHub Actions service is used as our current CI/CD server. Build and deploy jobs are configured in the .github/workflows directory. Please refer its documentation for more details.

    +
    +
    +
    +

    4.1.4. Gradle Plugin Portal

    +
    +

    The Gradle Plugin Portal service is used to publish plugin versions. The Plugin Publishing Plugin uploads artifacts to a remote repository.

    +
    +
    +
    +
    +

    4.2. Workflow

    +
    +

    The release process is automated to some extent. The following steps describe the workflow.

    +
    +
    +
      +
    1. +

      Developer updates RELEASE_NOTES.md with new planned version.

      +
      2. +
    2. +

      Developer commits all changes in local working copy.

      +
      3. +
    3. +

      Developer triggers new version release using the following command: ./gradlew release -Prelease.stage=final -Prelease.scope=[SCOPE] where [SCOPE] can be one of major, minor or patch, and determines which part of the version string <major>.<minor>.<patch> will be incremented.

      +
      4. +
    4. +

      Gradle executes a build on developer’s machine which calculates new version string, creates new tag with it and pushes to the origin.

      +
      5. +
    5. +

      When Gradle build is finished, developer’s work is done and the rest of the release process is automated.

      +
      6. +
    6. +

      After push to the origin, GitHub Actions detects new tag and triggers a build.

      +
      7. +
    7. +

      Executes a release stage if the commit also points to a Git tag.

      +
      8. +
    8. +

      This stage assembles plugin binaries (with new version) and uploads them to Bintray (credentials are stored as encrypted secrets in GitHub). Furthermore, the API docs and the user guide are published to gh-pages branch (the access token is stored as secure variable).

      +
      9. +
    +
    +
    +
    + +
    + +
    +
    +
    +
    +
    + + + + + \ No newline at end of file diff --git a/9.3.3/user-guide/00-intro.html b/9.3.3/user-guide/00-intro.html new file mode 100644 index 000000000..efaa81f3a --- /dev/null +++ b/9.3.3/user-guide/00-intro.html @@ -0,0 +1,703 @@ + + + + + + + +Introduction + + + + + + +
    +
    +

    1. Introduction

    +
    +
    +

    Gradle plugin for managing Docker images and containers using via its +remote API. +The heavy lifting of communicating with the +Docker remote API is handled by the Docker Java library. +Please refer to the library’s documentation for more information on the supported Docker’s client API and Docker server version.

    +
    +
    + + + + + +
    + + +This plugin requires Gradle >= 7.4.0 to work properly. +
    +
    +
    +

    1.1. Benefits

    +
    +

    There are various benefits for using this plugin:

    +
    +
    +
      +
    1. +

      Seamless integration with the build tool Gradle and its DSL.

      +
      2. +
    2. +

      Handles complicated communication logic between Docker client and daemon under the covers.

      +
      3. +
    3. +

      Simplifies the definition of complex workflows.

      +
      4. +
    4. +

      Minimizes build script setup logic by providing sensible conventions for different use cases.

      +
      5. +
    +
    +
    +
    +

    1.2. Limitations

    +
    +

    The functionality of the plugin does not cover all possible use cases. +Be aware of the following limitations:

    +
    +
    +
      +
    • +

      A task type may not provide all possible options for the underlying Docker operation. +Open an issue if you feel like it should be supported.

      +
      • +
    • +

      You cannot build multi-container applications via Docker Compose. +The Avast Docker Compose plugin has proven to be a capable alternative.

      +
      • +
    • +

      Managing a Docker Swarm and/or Stack is not supported.

      +
      • +
    +
    +
    +
    +

    1.3. Further Readings

    +
    +

    Want to learn more about using this plugin in different contexts? The following blog posts should get you started.

    +
    +
    +
      +
    • +

      {uri-bmuschko-blog}/dockerized-spring-boot-app/[Docker with Gradle: Dockerizing a Spring Boot application]

      +
      • +
    • +

      {uri-bmuschko-blog}/docker-integration-testing/[Docker with Gradle: Integration testing using containers]

      +
      • +
    • +

      {uri-bmuschko-blog}/gradle-docker-convention-plugin/[Docker with Gradle: Writing a Node.js convention plugin]

      +
      • +
    • +

      {uri-bmuschko-blog}/gradle-docker-compose/[Docker with Gradle: Getting started with Docker Compose]

      +
      • +
    +
    +
    +
    +

    1.4. Provided Plugins

    +
    +

    The binary distribution is available on the Gradle plugin portal, and Maven Central. +It contains the following plugins:

    +
    + ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Plugin IdAutomatically appliesTypeDescription

    com.bmuschko.docker-remote-api

    -

    {uri-ghpages}/api/com/bmuschko/gradle/docker/DockerRemoteApiPlugin.html[DockerRemoteApiPlugin]

    Provides custom tasks for interacting with Docker via its remote API.

    com.bmuschko.docker-java-application

    com.bmuschko.docker-remote-api

    {uri-ghpages}/api/com/bmuschko/gradle/docker/DockerJavaApplicationPlugin.html[DockerJavaApplicationPlugin]

    Creates and pushes a Docker image for a Java application.

    com.bmuschko.docker-spring-boot-application

    com.bmuschko.docker-remote-api

    {uri-ghpages}/api/com/bmuschko/gradle/docker/DockerSpringBootApplicationPlugin.html[DockerSpringBootApplicationPlugin]

    Creates and pushes a Docker image for a Spring Boot application.

    +
    +

    Which plugin you chose in your project entirely depends on the use case you want to fulfill. Refer to the relevant portions of the user guide that describe the purpose and usage of each plugin in more detail.

    +
    +
    +
    +

    1.5. Getting Started

    +
    +

    The plugin can be applied with the buildscript syntax or the plugin DSL. +Let’s say you’d want to go with the plugin that provides the plain Docker operations for managing Docker images and containers. +See the Gradle user guide for more information on applying plugins.

    +
    +
    +

    1.5.1. Applying the Plugin Using the buildscript Syntax

    +
    +
    Groovy
    +
    +
    buildscript {
+    repositories {
+        gradlePluginPortal()
+    }
+    dependencies {
+        classpath 'com.bmuschko:gradle-docker-plugin:9.3.3'
+    }
+}
+
+apply plugin: 'com.bmuschko.docker-remote-api'
    +
    +
    +
    +
    Kotlin
    +
    +
    buildscript {
+    repositories {
+        gradlePluginPortal()
+    }
+    dependencies {
+        classpath("com.bmuschko:gradle-docker-plugin:9.3.3")
+    }
+}
+
+apply(plugin = "com.bmuschko.docker-remote-api")
    +
    +
    +
    +
    +

    1.5.2. Applying the Plugin Using the Plugin DSL

    +
    +
    Groovy
    +
    +
    plugins {
+    id 'com.bmuschko.docker-remote-api' version '9.3.3'
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    plugins {
+    id("com.bmuschko.docker-remote-api") version "9.3.3"
+}
    +
    +
    +
    +
    +

    1.5.3. Applying the Plugin From a Script Plugin

    +
    +

    Applying the plugin from a script plugin requires the use of the fully-qualified class name due to a bug in Gradle core. Be aware that the plugin DSL cannot be used to apply a binary plugin from a script plugin.

    +
    +
    + + + + + +
    + + +When used with the Kotlin DSL, it is recommended to move your implementation into the buildSrc project. +
    +
    +
    +
    gradle/docker.gradle
    +
    +
    buildscript {
+    repositories {
+        gradlePluginPortal()
+    }
+    dependencies {
+        classpath 'com.bmuschko:gradle-docker-plugin:9.3.3'
+    }
+}
+
+apply plugin: com.bmuschko.gradle.docker.DockerRemoteApiPlugin
    +
    +
    +
    +
    build.gradle
    +
    +
    apply from: 'gradle/docker.gradle'
    +
    +
    +
    +
    +
    +
    +
    + + + + + \ No newline at end of file diff --git a/9.3.3/user-guide/01-provided-plugins.html b/9.3.3/user-guide/01-provided-plugins.html new file mode 100644 index 000000000..7501a5ed0 --- /dev/null +++ b/9.3.3/user-guide/01-provided-plugins.html @@ -0,0 +1,506 @@ + + + + + + + +Provided Plugins + + + + + + +
    +
    +

    1. Provided Plugins

    +
    +

    The binary distribution is available on the Gradle plugin portal, and Maven Central. +It contains the following plugins:

    +
    + ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Plugin IdAutomatically appliesTypeDescription

    com.bmuschko.docker-remote-api

    -

    {uri-ghpages}/api/com/bmuschko/gradle/docker/DockerRemoteApiPlugin.html[DockerRemoteApiPlugin]

    Provides custom tasks for interacting with Docker via its remote API.

    com.bmuschko.docker-java-application

    com.bmuschko.docker-remote-api

    {uri-ghpages}/api/com/bmuschko/gradle/docker/DockerJavaApplicationPlugin.html[DockerJavaApplicationPlugin]

    Creates and pushes a Docker image for a Java application.

    com.bmuschko.docker-spring-boot-application

    com.bmuschko.docker-remote-api

    {uri-ghpages}/api/com/bmuschko/gradle/docker/DockerSpringBootApplicationPlugin.html[DockerSpringBootApplicationPlugin]

    Creates and pushes a Docker image for a Spring Boot application.

    +
    +

    Which plugin you chose in your project entirely depends on the use case you want to fulfill. Refer to the relevant portions of the user guide that describe the purpose and usage of each plugin in more detail.

    +
    +
    +
    + + + + + \ No newline at end of file diff --git a/9.3.3/user-guide/02-getting-started.html b/9.3.3/user-guide/02-getting-started.html new file mode 100644 index 000000000..556501d82 --- /dev/null +++ b/9.3.3/user-guide/02-getting-started.html @@ -0,0 +1,559 @@ + + + + + + + +Getting Started + + + + + + +
    +
    +

    1. Getting Started

    +
    +

    The plugin can be applied with the buildscript syntax or the plugin DSL. +Let’s say you’d want to go with the plugin that provides the plain Docker operations for managing Docker images and containers. +See the Gradle user guide for more information on applying plugins.

    +
    +
    +

    1.1. Applying the Plugin Using the buildscript Syntax

    +
    +
    Groovy
    +
    +
    buildscript {
+    repositories {
+        gradlePluginPortal()
+    }
+    dependencies {
+        classpath 'com.bmuschko:gradle-docker-plugin:9.3.3'
+    }
+}
+
+apply plugin: 'com.bmuschko.docker-remote-api'
    +
    +
    +
    +
    Kotlin
    +
    +
    buildscript {
+    repositories {
+        gradlePluginPortal()
+    }
+    dependencies {
+        classpath("com.bmuschko:gradle-docker-plugin:9.3.3")
+    }
+}
+
+apply(plugin = "com.bmuschko.docker-remote-api")
    +
    +
    +
    +
    +

    1.2. Applying the Plugin Using the Plugin DSL

    +
    +
    Groovy
    +
    +
    plugins {
+    id 'com.bmuschko.docker-remote-api' version '9.3.3'
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    plugins {
+    id("com.bmuschko.docker-remote-api") version "9.3.3"
+}
    +
    +
    +
    +
    +

    1.3. Applying the Plugin From a Script Plugin

    +
    +

    Applying the plugin from a script plugin requires the use of the fully-qualified class name due to a bug in Gradle core. Be aware that the plugin DSL cannot be used to apply a binary plugin from a script plugin.

    +
    +
    + + + + + +
    + + +When used with the Kotlin DSL, it is recommended to move your implementation into the buildSrc project. +
    +
    +
    +
    gradle/docker.gradle
    +
    +
    buildscript {
+    repositories {
+        gradlePluginPortal()
+    }
+    dependencies {
+        classpath 'com.bmuschko:gradle-docker-plugin:9.3.3'
+    }
+}
+
+apply plugin: com.bmuschko.gradle.docker.DockerRemoteApiPlugin
    +
    +
    +
    +
    build.gradle
    +
    +
    apply from: 'gradle/docker.gradle'
    +
    +
    +
    +
    +
    + + + + + \ No newline at end of file diff --git a/9.3.3/user-guide/10-remote-api-plugin.html b/9.3.3/user-guide/10-remote-api-plugin.html new file mode 100644 index 000000000..b54783c22 --- /dev/null +++ b/9.3.3/user-guide/10-remote-api-plugin.html @@ -0,0 +1,1480 @@ + + + + + + + +Remote API Plugin + + + + + + +
    +
    +

    1. Remote API Plugin

    +
    +
    +

    The plugin com.bmuschko.docker-remote-api allows for interacting with Docker via its remote API. +If no additional configuration has been provided by the build script, the plugin will try to resolve and use the credentials for registry authentication available from previous login operations (usually in $HOME/.docker/config.json). You can model any workflow imaginable by creating enhanced task of the custom task provided by the plugin.

    +
    +
    +

    1.1. Usage

    +
    +
    Groovy
    +
    +
    plugins {
+    id 'com.bmuschko.docker-remote-api' version '9.3.3'
+}
+
+// Import task types
+import com.bmuschko.gradle.docker.tasks.image.*
+
+// Use task types
+task buildMyAppImage(type: DockerBuildImage) {
+    inputDir = file('docker/myapp')
+    images.add('test/myapp:latest')
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    plugins {
+    id("com.bmuschko.docker-remote-api") version "9.3.3"
+}
+
+// Import task types
+import com.bmuschko.gradle.docker.tasks.image.*
+
+// Use task types
+tasks.create("buildMyAppImage", DockerBuildImage::class) {
+    inputDir.set(file("docker/myapp"))
+    images.add("test/myapp:latest")
+}
    +
    +
    +
    +

    The plugin automatically resolves the Docker Java library with the pre-configured version under the covers. +The only configuration you will have to provide in your build script is the repository hosting the library and its transitive dependencies. +One repository that hosts them all is Maven Central.

    +
    +
    +
    Groovy
    +
    +
    repositories {
+    mavenCentral()
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    repositories {
+    mavenCentral()
+}
    +
    +
    +
    +
    +

    1.2. Extension

    +
    +

    The plugin defines an extension with the namespace docker. +The following properties can be configured:

    +
    + ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Property nameTypeDefault valueDescription

    url

    Property<String>

    unix:///var/run/docker.sock (Unix), tcp://127.0.0.1:2375 (Windows)

    The server URL to connect to via Docker’s remote API.

    certPath

    DirectoryProperty

    Value of environment variable DOCKER_CERT_PATH if set

    The path to certificates for communicating with Docker over SSL.

    apiVersion

    Property<String>

    null

    The remote API version. For most cases this can be left null.

    +
    +

    Image pull or push operations against the public Docker Hub registry or a private registry may require authentication. By default, existing credentials are read from $HOME/.docker/config.json and reused for authentication purposes. You can overwrite those credentials with the help of the registryCredentials closure. The credentials provided in the extension automatically become available to all custom tasks that implement the interface {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/RegistryCredentialsAware.html[RegistryCredentialsAware].

    +
    + ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Property nameTypeDefault valueDescription

    url

    Property<String>

    https://index.docker.io/v1/

    The registry URL.

    username

    Property<String>

    null

    The registry username.

    password

    Property<String>

    null

    The registry password.

    email

    Property<String>

    null

    The registry email address.

    +
    +

    1.2.1. Working With a TLS-enabled Docker Instance

    +
    +

    Starting with Docker version 1.3, TLS is enabled by default. +Please consult the Docker documentation "Protect the Docker daemon socket" to set up your certificate. The following example demonstrates how to configure the plugin to use those certificates. +Additionally, this code snippet shows how to set the user credentials.

    +
    +
    +
    Groovy
    +
    +
    docker {
+    url = 'https://192.168.59.103:2376'
+    certPath = new File(System.properties['user.home'], '.boot2docker/certs/boot2docker-vm')
+
+    registryCredentials {
+        url = 'https://index.docker.io/v1/'
+        username = 'bmuschko'
+        password = 'pwd'
+        email = 'benjamin.muschko@gmail.com'
+    }
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    docker {
+    url.set("https://192.168.59.103:2376")
+    certPath.set(File(System.getProperty("user.home"), ".boot2docker/certs/boot2docker-vm"))
+
+    registryCredentials {
+        url.set("https://index.docker.io/v1/")
+        username.set("bmuschko")
+        password.set("pwd")
+        email.set("benjamin.muschko@gmail.com")
+    }
+}
    +
    +
    +
    +
    +

    1.2.2. Working With Google Cloud And Using a Key File

    +
    +
    Groovy
    +
    +
    docker {
+    registryCredentials {
+        url = 'https://gcr.io'
+        username = '_json_key'
+        password = file('keyfile.json').text
+    }
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    docker {
+    registryCredentials {
+        url.set("https://gcr.io")
+        username.set("_json_key")
+        password.set(file("keyfile.json").readText())
+    }
+}
    +
    +
    +
    +
    +

    1.2.3. Working With a Docker Instance Without TLS

    +
    +

    The following example assumes that you disabled TLS on your Docker instance. +You can do so by setting DOCKER_TLS=no in the file /var/lib/boot2docker/profile.

    +
    +
    +
    Groovy
    +
    +
    docker {
+    url = 'tcp://192.168.59.103:2375'
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    docker {
+    url.set("tcp://192.168.59.103:2375")
+}
    +
    +
    +
    +

    On Unix the Docker daemon listens by default on unix:///var/run/docker.sock.

    +
    +
    +

    On Windows the Docker daemon listens by default on npipe:////./pipe/docker_engine if this exists. +We fall back to tcp://127.0.0.1:2375 where the pipe does not exist.

    +
    +
    +
    +
    +

    1.3. Custom task types

    +
    +

    1.3.1. Misc

    +
    +

    The plugin provides the following general-purpose custom task types:

    +
    + ++++ + + + + + + + + + + + + + + + + + + + + +
    TypeDescription

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/DockerOperation.html[DockerOperation]

    Passes the raw docker-java client to the onNext closure if it’s defined.

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/DockerInfo.html[DockerInfo]

    Displays system-wide information.

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/DockerVersion.html[DockerVersion]

    Show the docker version information.

    +
    +
    +

    1.3.2. Images

    +
    +

    The plugin provides the following custom task types for managing images:

    +
    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeDescription

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.html[Dockerfile]

    Creates a Dockerfile based on the provided instructions.

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/image/DockerBuildImage.html[DockerBuildImage]

    Builds an image from a Dockerfile.

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/image/DockerCommitImage.html[DockerCommitImage]

    Creates a new image from a container’s changes.

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/image/DockerInspectImage.html[DockerInspectImage]

    Returns low-level information on the image.

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/image/DockerListImages.html[DockerListImages]

    Lists images in registry.

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/image/DockerPullImage.html[DockerPullImage]

    Pulls an image from the registry.

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/image/DockerPushImage.html[DockerPushImage]

    Pushes an image to a registry.

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/image/DockerRemoveImage.html[DockerRemoveImage]

    Removes an image from the filesystem.

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/image/DockerTagImage.html[DockerTagImage]

    Tags an image in registry.

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/image/DockerSaveImage.html[DockerSaveImage]

    Saves an image to file.

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/image/DockerLoadImage.html[DockerLoadImage]

    Loads an image from file.

    +
    +
    +

    1.3.3. Containers

    +
    +

    The plugin provides the following custom task types for managing containers:

    +
    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeDescription

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/container/DockerCopyFileToContainer.html[DockerCopyFileToContainer]

    Copies a path from the host into the container.

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/container/DockerCopyFileFromContainer.html[DockerCopyFileFromContainer]

    Copies a path from the container as a tar file on to the host.

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/container/DockerCreateContainer.html[DockerCreateContainer]

    Creates a container.

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/container/DockerInspectContainer.html[DockerInspectContainer]

    Returns low-level information on the container.

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/container/DockerKillContainer.html[DockerKillContainer]

    Kills the container for a given id.

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/container/DockerRemoveContainer.html[DockerRemoveContainer]

    Removes the container for a given id from the filesystem.

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/container/DockerRenameContainer.html[DockerRenameContainer]

    Rename a container.

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/container/DockerRestartContainer.html[DockerRestartContainer]

    Restarts the container for a given id.

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/container/DockerStartContainer.html[DockerStartContainer]

    Starts the container for a given id.

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/container/DockerStopContainer.html[DockerStopContainer]

    Stops the container for a given id.

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/container/DockerWaitContainer.html[DockerWaitContainer]

    Blocks until container for a given id stops.

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/container/DockerLogsContainer.html[DockerLogsContainer]

    Copies the container output to the Gradle process standard out/err.

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/container/DockerExecContainer.html[DockerExecContainer]

    Executes a command within a running container.

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/container/DockerInspectExecContainer.html[DockerInspectExecContainer]

    Inspects task executed inside container with DockerExecContainer command.

    +
    +
    +

    1.3.4. Networks

    +
    +

    The plugin provides the following custom task types for managing networks:

    +
    + ++++ + + + + + + + + + + + + + + + + + + + + +
    TypeDescription

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/network/DockerCreateNetwork.html[DockerCreateNetwork]

    Creates a network.

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/network/DockerInspectNetwork.html[DockerInspectNetwork]

    Returns low-level information on the network.

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/network/DockerRemoveNetwork.html[DockerRemoveNetwork]

    Removes the network.

    +
    +
    +
    +

    1.4. Reactive Streams

    +
    +

    As needed, we will implement reactive methods as described in reactive-streams. +We implement these here as optional closures for all tasks. +Currently the only supported methods are onError, onNext, onComplete. +Various examples on how to use these can be found in our {uri-github}/blob/master/src/functTest/groovy/com/bmuschko/gradle/docker/DockerReactiveMethodsFunctionalTest.groovy[reactive tests].

    +
    +
    +

    1.4.1. Reacting to an Error

    +
    +

    The onError closure is passed the exception that is thrown for you to handle. +If you silently ignore we will not throw the exception behind the scenes. +The below example is a common use-case that arises when someone wants to remove a container whether it exists or not but does not want to fail hard.

    +
    +
    +
    Groovy
    +
    +
    task removeContainer1(type: DockerRemoveContainer) {
+    targetContainerId 'container-that-does-not-exist'
+    onError { exception ->
+        // Ignore exception if container does not exist otherwise throw it
+        if (!exception.message.contains('No such container'))
+            throw exception
+    }
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    tasks.create("removeContainer1", DockerRemoveContainer::class) {
+    targetContainerId("container-that-does-not-exist")
+    onError {
+        // Ignore exception if container does not exist otherwise throw it
+        if (!this.message!!.contains("No such container"))
+            throw this
+    }
+}
    +
    +
    +
    +
    +

    1.4.2. Reacting to Data Returned by an Operation

    +
    +

    The onNext closure is passed the next iterative response upon execution. +For all other tasks we simply hand you back the object that is given to us by docker-java which is a pojo representation of the json handed back by docker. +Thus, and much like the onError closure, all delegation is now in your control. +Any properties/values expected to be set will not be done unless you do them.

    +
    +
    +

    Iterative tasks are things like DockerBuildImage, DockerLogsContainer, DockerListImages. +These tasks have output which can be iterated over. +The example below demonstrates how we iterate over each log message passing that to the closure for the user to work on.

    +
    +
    +
    Groovy
    +
    +
    task logContainer(type: DockerLogsContainer) {
+    targetContainerId 'container-that-does-exist'
+    follow = true
+    tailAll = true
+    onNext { message ->
+        // Each log message from the container will be passed as it's made available
+        logger.quiet message.toString()
+    }
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    tasks.create("logContainer", DockerLogsContainer::class) {
+    targetContainerId("container-that-does-not-exist")
+    follow.set(true)
+    tailAll.set(true)
+    onNext {
+        // Each log message from the container will be passed as it's made available
+        logger.quiet(this.toString())
+    }
+}
    +
    +
    +
    +
    +

    1.4.3. Reacting to the Completion of an Operation

    +
    +

    The onComplete closure is not passed anything upon execution. +It works in the same fashion that doLast does but is instead part of this task and thus executes before doLast does. +This closure executes only upon success. +The below example demonstrates how this works.

    +
    +
    +
    Groovy
    +
    +
    task removeContainer2(type: DockerRemoveContainer) {
+    targetContainerId 'container-that-does-exist'
+    onComplete {
+        println 'Executes first'
+    }
+    doLast {
+        println 'Executes second'
+    }
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    tasks.create("removeContainer2", DockerRemoveContainer::class) {
+    targetContainerId("container-that-does-exist")
+    onComplete {
+        println("Executes first")
+    }
+    doLast {
+        println("Executes second")
+    }
+}
    +
    +
    +
    +
    +
    +

    1.5. Examples

    +
    +

    The following usage examples demonstrate code for common use cases. +More scenarios can be found in the {uri-github}/blob/master/src/functTest/groovy/com/bmuschko/gradle/docker/DockerWorkflowFunctionalTest.groovy[functional tests].

    +
    +
    +

    1.5.1. Modifying Instructions of a Dockerfile Task

    +
    +

    Sometimes do you do not have any control over the creation of a Dockerfile task. +For example the Docker Java Application Plugin already adds a Dockerfile task with a set of sensible instructions. +You can still modify {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.html#getInstructions()[those instructions] if needed. +Let’s say you are dealing with the following Dockerfile definition.

    +
    +
    +
    Groovy
    +
    +
    tasks.create('createDockerfile', Dockerfile) {
+    from('openjdk:jre-alpine')
+    copyFile('my-app-1.0.jar', '/app/my-app-1.0.jar')
+    entryPoint('java')
+    defaultCommand('-jar', '/app/my-app-1.0.jar')
+    exposePort(8080)
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    tasks.create("createDockerfile", Dockerfile::class) {
+    from("openjdk:jre-alpine")
+    copyFile("my-app-1.0.jar", "/app/my-app-1.0.jar")
+    entryPoint("java")
+    defaultCommand("-jar", "/app/my-app-1.0.jar")
+    exposePort(8080)
+}
    +
    +
    +
    +

    Now, you may prefer a different base image than the one added by default. +The listing below demonstrates how to find it the FROM instruction and replace it with a different one.

    +
    +
    +
    Groovy
    +
    +
    createDockerfile {
+    List<Instruction> originalInstructions = new ArrayList<Instruction>(instructions.get())
+    int fromInstructionIndex = originalInstructions
+            .findIndexOf { it.keyword == FromInstruction.KEYWORD }
+    originalInstructions.remove(fromInstructionIndex)
+    FromInstruction baseImage = new FromInstruction(new From('openjdk:8-alpine'))
+    originalInstructions.add(0, baseImage)
+    instructions.set(originalInstructions)
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    tasks {
+    "createDockerfile"(Dockerfile::class) {
+        val originalInstructions = instructions.get().toMutableList()
+        val fromInstructionIndex = originalInstructions
+                .indexOfFirst { item -> item.keyword == FromInstruction.KEYWORD }
+        originalInstructions.removeAt(fromInstructionIndex)
+        val baseImage = FromInstruction(From("openjdk:8-alpine"))
+        originalInstructions.add(0, baseImage)
+        instructions.set(originalInstructions)
+    }
+}
    +
    +
    +
    +

    You can also add new instructions at a specific position in the existing list of instructions. +For example you may want to add a HEALTHCHECK to the end of the list.

    +
    +
    +
    Groovy
    +
    +
    createDockerfile {
+    instruction 'HEALTHCHECK CMD wget --quiet --tries=1 --spider http://localhost:8080/actuator/health || exit 1'
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    tasks {
+    "createDockerfile"(Dockerfile::class) {
+        instruction("HEALTHCHECK CMD wget --quiet --tries=1 --spider http://localhost:8080/actuator/health || exit 1")
+    }
+}
    +
    +
    +
    +
    +

    1.5.2. Creating a Dockerfile And Building an Image

    +
    +

    A Dockerfile can be created by the Dockerfile custom tasks. +The Dockerfile instructions need to be declare in the correct +order.

    +
    +
    +
    Groovy
    +
    +
    plugins {
+    id 'com.bmuschko.docker-remote-api' version '9.3.3'
+}
+
+import com.bmuschko.gradle.docker.tasks.image.Dockerfile
+import com.bmuschko.gradle.docker.tasks.image.DockerBuildImage
+
+task createDockerfile(type: Dockerfile) {
+    from 'ubuntu:12.04'
+    label(['maintainer': 'Benjamin Muschko "benjamin.muschko@gmail.com"'])
+}
+
+task buildImage(type: DockerBuildImage) {
+    dependsOn createDockerfile
+    images.add('bmuschko/myimage:latest')
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    plugins {
+    id("com.bmuschko.docker-remote-api") version "9.3.3"
+}
+
+import com.bmuschko.gradle.docker.tasks.image.Dockerfile
+import com.bmuschko.gradle.docker.tasks.image.DockerBuildImage
+
+val createDockerfile by tasks.creating(Dockerfile::class) {
+    from("ubuntu:12.04")
+    label(mapOf("maintainer" to "Benjamin Muschko 'benjamin.muschko@gmail.com'"))
+}
+
+tasks.create("buildImage", DockerBuildImage::class) {
+    dependsOn(createDockerfile)
+    images.add("bmuschko/myimage:latest")
+}
    +
    +
    +
    +
    +

    1.5.3. Executing Functional Tests Against a Running Container

    +
    +

    The following example code demonstrates how to build a Docker image from a Dockerfile, starts up a container for this image and exercises functional tests against the running container. +At the end of this operation, the container is stopped.

    +
    +
    +
    Groovy
    +
    +
    plugins {
+    id 'com.bmuschko.docker-remote-api' version '9.3.3'
+}
+
+import com.bmuschko.gradle.docker.tasks.container.*
+import com.bmuschko.gradle.docker.tasks.image.*
+
+task buildMyAppImage(type: DockerBuildImage) {
+    inputDir = file('docker/myapp')
+    images.add('test/myapp:latest')
+}
+
+task createMyAppContainer(type: DockerCreateContainer) {
+    dependsOn buildMyAppImage
+    targetImageId buildMyAppImage.getImageId()
+    hostConfig.portBindings = ['8080:8080']
+    hostConfig.autoRemove = true
+}
+
+task startMyAppContainer(type: DockerStartContainer) {
+    dependsOn createMyAppContainer
+    targetContainerId createMyAppContainer.getContainerId()
+}
+
+task stopMyAppContainer(type: DockerStopContainer) {
+    targetContainerId createMyAppContainer.getContainerId()
+}
+
+task functionalTestMyApp(type: Test) {
+    dependsOn startMyAppContainer
+    finalizedBy stopMyAppContainer
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    plugins {
+    id("com.bmuschko.docker-remote-api") version "9.3.3"
+}
+
+import com.bmuschko.gradle.docker.tasks.container.*
+import com.bmuschko.gradle.docker.tasks.image.*
+
+val buildMyAppImage by tasks.creating(DockerBuildImage::class) {
+    inputDir.set(file("docker/myapp"))
+    images.add("test/myapp:latest")
+}
+
+val createMyAppContainer by tasks.creating(DockerCreateContainer::class) {
+    dependsOn(buildMyAppImage)
+    targetImageId(buildMyAppImage.getImageId())
+    hostConfig.portBindings.set(listOf("8080:8080"))
+    hostConfig.autoRemove.set(true)
+}
+
+val startMyAppContainer by tasks.creating(DockerStartContainer::class) {
+    dependsOn(createMyAppContainer)
+    targetContainerId(createMyAppContainer.getContainerId())
+}
+
+val stopMyAppContainer by tasks.creating(DockerStopContainer::class) {
+    targetContainerId(createMyAppContainer.getContainerId())
+}
+
+tasks.create("functionalTestMyApp", Test::class) {
+    dependsOn(startMyAppContainer)
+    finalizedBy(stopMyAppContainer)
+}
    +
    +
    +
    +
    +

    1.5.4. Linking With Other Containers

    +
    +

    In many situations your container does not start without dependencies like database. +In that case you may wish using traditional linking:

    +
    +
    +
    Groovy
    +
    +
    plugins {
+    id 'com.bmuschko.docker-remote-api' version '9.3.3'
+}
+
+import com.bmuschko.gradle.docker.tasks.container.*
+import com.bmuschko.gradle.docker.tasks.image.*
+
+task buildMyAppImage(type: DockerBuildImage) {
+    inputDir = file('docker/myapp')
+    images.add('test/myapp')
+}
+
+task createDBContainer(type: DockerCreateContainer) {
+    targetImageId 'postgres:latest'
+    containerName = 'docker_auto'
+    hostConfig.autoRemove = true
+}
+
+task createMyAppContainer(type: DockerCreateContainer) {
+    dependsOn buildMyAppImage, createDBContainer
+    targetImageId buildMyAppImage.getImageId()
+    hostConfig.portBindings = ['8080:8080']
+    hostConfig.autoRemove = true
+    hostConfig.links = ["docker_auto:database"]
+
+    // If you use Systemd in containers you should also add lines. #320
+    hostConfig.binds = ['/sys/fs/cgroup': '/sys/fs/cgroup']
+    tty = true
+}
+
+task startMyAppContainer(type: DockerStartContainer) {
+    dependsOn createMyAppContainer
+    targetContainerId createMyAppContainer.getContainerId()
+}
+
+task stopMyAppContainer(type: DockerStopContainer) {
+    targetContainerId createMyAppContainer.getContainerId()
+}
+
+task functionalTestMyApp(type: Test) {
+    dependsOn startMyAppContainer
+    finalizedBy stopMyAppContainer
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    plugins {
+    id("com.bmuschko.docker-remote-api") version "9.3.3"
+}
+
+import com.bmuschko.gradle.docker.tasks.container.*
+import com.bmuschko.gradle.docker.tasks.image.*
+
+val buildMyAppImage by tasks.creating(DockerBuildImage::class) {
+    inputDir.set(file("docker/myapp"))
+    images.add("test/myapp")
+}
+
+val createDBContainer by tasks.creating(DockerCreateContainer::class) {
+    targetImageId("postgres:latest")
+    containerName.set("docker_auto")
+    hostConfig.autoRemove.set(true)
+}
+
+val createMyAppContainer by tasks.creating(DockerCreateContainer::class) {
+    dependsOn(buildMyAppImage, createDBContainer)
+    targetImageId(buildMyAppImage.getImageId())
+    hostConfig.portBindings.set(listOf("8080:8080"))
+    hostConfig.autoRemove.set(true)
+    hostConfig.links.set(listOf("docker_auto:database"))
+
+    // If you use Systemd in containers you should also add lines. #320
+    hostConfig.binds.set(mapOf("/sys/fs/cgroup" to "/sys/fs/cgroup"))
+    tty.set(true)
+}
+
+val startMyAppContainer by tasks.creating(DockerStartContainer::class) {
+    dependsOn(createMyAppContainer)
+    targetContainerId(createMyAppContainer.getContainerId())
+}
+
+val stopMyAppContainer by tasks.creating(DockerStopContainer::class) {
+    targetContainerId(createMyAppContainer.getContainerId())
+}
+
+tasks.create("functionalTestMyApp", Test::class) {
+    dependsOn(startMyAppContainer)
+    finalizedBy(stopMyAppContainer)
+}
    +
    +
    +
    +
    +

    1.5.5. Implementing Custom Docker Client Handling

    +
    +

    The plugin provides an opinionated set of custom tasks for the most common Docker operations. +Sometime the situation may arise that you want to have full control over what you want to call on the Docker client. +To do so you can implement your own custom task that extends from {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/AbstractDockerRemoteApiTask.html[AbstractDockerRemoteApiTask]. +The following example shows how to implement such a custom task:

    +
    +
    +
    Groovy
    +
    +
    class DockerImageIdForName extends AbstractDockerRemoteApiTask {
+    @Input
+    final Property<String> filteredImageName = project.objects.property(String)
+
+    @Internal
+    final Property<String> imageId = project.objects.property(String)
+
+    DockerImageIdForName() {
+        onNext({ image ->
+            imageId.set(image.id)
+        })
+    }
+
+    @Override
+    void runRemoteCommand() {
+        def images = dockerClient.listImagesCmd()
+            .withImageNameFilter(filteredImageName.get())
+            .exec()
+
+        for(image in images) {
+            nextHandler.execute(image)
+        }
+    }
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    open class DockerImageIdForName : AbstractDockerRemoteApiTask {
+    @Input
+    val filteredImageName : Property<String> = project.objects.property(String::class)
+
+    @Internal
+    val imageId : Property<String> = project.objects.property(String::class)
+
+    constructor() {
+        onNext(Action<Image> {
+            this.withGroovyBuilder {
+                imageId.set(getProperty("id") as String)
+            }
+        })
+    }
+
+    override fun runRemoteCommand() {
+        val images = getDockerClient().listImagesCmd()
+            .withImageNameFilter(filteredImageName.get())
+            .exec()
+
+        for(image in images) {
+            nextHandler.execute(image)
+        }
+    }
+}
    +
    +
    +
    +

    To use the custom task, simply create a task by type.

    +
    +
    +
    Groovy
    +
    +
    task imageIdForName(type: DockerImageIdForName) {
+    filteredImageName = 'alpine:3.4'
+}
+
+task printImageId {
+    dependsOn imageIdForName
+    doLast {
+        logger.quiet "Resolved image ID ${imageIdForName.imageId.get()} for name ${imageIdForName.filteredImageName.get()}"
+    }
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    val imageIdForName by tasks.creating(DockerImageIdForName::class) {
+    filteredImageName.set("alpine:3.4")
+}
+
+val printImageId by tasks.creating {
+    dependsOn(imageIdForName)
+    doLast {
+        logger.quiet("Resolved image ID ${imageIdForName.imageId.get()} for name ${imageIdForName.filteredImageName.get()}")
+    }
+}
    +
    +
    +
    +
    +
    +
    +
    + + + + + \ No newline at end of file diff --git a/9.3.3/user-guide/11-usage.html b/9.3.3/user-guide/11-usage.html new file mode 100644 index 000000000..48cbdbb08 --- /dev/null +++ b/9.3.3/user-guide/11-usage.html @@ -0,0 +1,518 @@ + + + + + + + +Usage + + + + + + +
    +
    +

    1. Usage

    +
    +
    Groovy
    +
    +
    plugins {
+    id 'com.bmuschko.docker-remote-api' version '9.3.3'
+}
+
+// Import task types
+import com.bmuschko.gradle.docker.tasks.image.*
+
+// Use task types
+task buildMyAppImage(type: DockerBuildImage) {
+    inputDir = file('docker/myapp')
+    images.add('test/myapp:latest')
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    plugins {
+    id("com.bmuschko.docker-remote-api") version "9.3.3"
+}
+
+// Import task types
+import com.bmuschko.gradle.docker.tasks.image.*
+
+// Use task types
+tasks.create("buildMyAppImage", DockerBuildImage::class) {
+    inputDir.set(file("docker/myapp"))
+    images.add("test/myapp:latest")
+}
    +
    +
    +
    +

    The plugin automatically resolves the Docker Java library with the pre-configured version under the covers. +The only configuration you will have to provide in your build script is the repository hosting the library and its transitive dependencies. +One repository that hosts them all is Maven Central.

    +
    +
    +
    Groovy
    +
    +
    repositories {
+    mavenCentral()
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    repositories {
+    mavenCentral()
+}
    +
    +
    +
    +
    + + + + + \ No newline at end of file diff --git a/9.3.3/user-guide/12-extension.html b/9.3.3/user-guide/12-extension.html new file mode 100644 index 000000000..759c81f63 --- /dev/null +++ b/9.3.3/user-guide/12-extension.html @@ -0,0 +1,645 @@ + + + + + + + +Extension + + + + + + +
    +
    +

    1. Extension

    +
    +

    The plugin defines an extension with the namespace docker. +The following properties can be configured:

    +
    + ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Property nameTypeDefault valueDescription

    url

    Property<String>

    unix:///var/run/docker.sock (Unix), tcp://127.0.0.1:2375 (Windows)

    The server URL to connect to via Docker’s remote API.

    certPath

    DirectoryProperty

    Value of environment variable DOCKER_CERT_PATH if set

    The path to certificates for communicating with Docker over SSL.

    apiVersion

    Property<String>

    null

    The remote API version. For most cases this can be left null.

    +
    +

    Image pull or push operations against the public Docker Hub registry or a private registry may require authentication. By default, existing credentials are read from $HOME/.docker/config.json and reused for authentication purposes. You can overwrite those credentials with the help of the registryCredentials closure. The credentials provided in the extension automatically become available to all custom tasks that implement the interface {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/RegistryCredentialsAware.html[RegistryCredentialsAware].

    +
    + ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Property nameTypeDefault valueDescription

    url

    Property<String>

    https://index.docker.io/v1/

    The registry URL.

    username

    Property<String>

    null

    The registry username.

    password

    Property<String>

    null

    The registry password.

    email

    Property<String>

    null

    The registry email address.

    +
    +

    1.1. Working With a TLS-enabled Docker Instance

    +
    +

    Starting with Docker version 1.3, TLS is enabled by default. +Please consult the Docker documentation "Protect the Docker daemon socket" to set up your certificate. The following example demonstrates how to configure the plugin to use those certificates. +Additionally, this code snippet shows how to set the user credentials.

    +
    +
    +
    Groovy
    +
    +
    docker {
+    url = 'https://192.168.59.103:2376'
+    certPath = new File(System.properties['user.home'], '.boot2docker/certs/boot2docker-vm')
+
+    registryCredentials {
+        url = 'https://index.docker.io/v1/'
+        username = 'bmuschko'
+        password = 'pwd'
+        email = 'benjamin.muschko@gmail.com'
+    }
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    docker {
+    url.set("https://192.168.59.103:2376")
+    certPath.set(File(System.getProperty("user.home"), ".boot2docker/certs/boot2docker-vm"))
+
+    registryCredentials {
+        url.set("https://index.docker.io/v1/")
+        username.set("bmuschko")
+        password.set("pwd")
+        email.set("benjamin.muschko@gmail.com")
+    }
+}
    +
    +
    +
    +
    +

    1.2. Working With Google Cloud And Using a Key File

    +
    +
    Groovy
    +
    +
    docker {
+    registryCredentials {
+        url = 'https://gcr.io'
+        username = '_json_key'
+        password = file('keyfile.json').text
+    }
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    docker {
+    registryCredentials {
+        url.set("https://gcr.io")
+        username.set("_json_key")
+        password.set(file("keyfile.json").readText())
+    }
+}
    +
    +
    +
    +
    +

    1.3. Working With a Docker Instance Without TLS

    +
    +

    The following example assumes that you disabled TLS on your Docker instance. +You can do so by setting DOCKER_TLS=no in the file /var/lib/boot2docker/profile.

    +
    +
    +
    Groovy
    +
    +
    docker {
+    url = 'tcp://192.168.59.103:2375'
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    docker {
+    url.set("tcp://192.168.59.103:2375")
+}
    +
    +
    +
    +

    On Unix the Docker daemon listens by default on unix:///var/run/docker.sock.

    +
    +
    +

    On Windows the Docker daemon listens by default on npipe:////./pipe/docker_engine if this exists. +We fall back to tcp://127.0.0.1:2375 where the pipe does not exist.

    +
    +
    +
    +
    + + + + + \ No newline at end of file diff --git a/9.3.3/user-guide/13-custom-task-types.html b/9.3.3/user-guide/13-custom-task-types.html new file mode 100644 index 000000000..185151994 --- /dev/null +++ b/9.3.3/user-guide/13-custom-task-types.html @@ -0,0 +1,667 @@ + + + + + + + +Custom task types + + + + + + +
    +
    +

    1. Custom task types

    +
    +

    1.1. Misc

    +
    +

    The plugin provides the following general-purpose custom task types:

    +
    + ++++ + + + + + + + + + + + + + + + + + + + + +
    TypeDescription

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/DockerOperation.html[DockerOperation]

    Passes the raw docker-java client to the onNext closure if it’s defined.

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/DockerInfo.html[DockerInfo]

    Displays system-wide information.

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/DockerVersion.html[DockerVersion]

    Show the docker version information.

    +
    +
    +

    1.2. Images

    +
    +

    The plugin provides the following custom task types for managing images:

    +
    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeDescription

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.html[Dockerfile]

    Creates a Dockerfile based on the provided instructions.

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/image/DockerBuildImage.html[DockerBuildImage]

    Builds an image from a Dockerfile.

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/image/DockerCommitImage.html[DockerCommitImage]

    Creates a new image from a container’s changes.

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/image/DockerInspectImage.html[DockerInspectImage]

    Returns low-level information on the image.

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/image/DockerListImages.html[DockerListImages]

    Lists images in registry.

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/image/DockerPullImage.html[DockerPullImage]

    Pulls an image from the registry.

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/image/DockerPushImage.html[DockerPushImage]

    Pushes an image to a registry.

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/image/DockerRemoveImage.html[DockerRemoveImage]

    Removes an image from the filesystem.

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/image/DockerTagImage.html[DockerTagImage]

    Tags an image in registry.

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/image/DockerSaveImage.html[DockerSaveImage]

    Saves an image to file.

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/image/DockerLoadImage.html[DockerLoadImage]

    Loads an image from file.

    +
    +
    +

    1.3. Containers

    +
    +

    The plugin provides the following custom task types for managing containers:

    +
    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeDescription

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/container/DockerCopyFileToContainer.html[DockerCopyFileToContainer]

    Copies a path from the host into the container.

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/container/DockerCopyFileFromContainer.html[DockerCopyFileFromContainer]

    Copies a path from the container as a tar file on to the host.

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/container/DockerCreateContainer.html[DockerCreateContainer]

    Creates a container.

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/container/DockerInspectContainer.html[DockerInspectContainer]

    Returns low-level information on the container.

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/container/DockerKillContainer.html[DockerKillContainer]

    Kills the container for a given id.

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/container/DockerRemoveContainer.html[DockerRemoveContainer]

    Removes the container for a given id from the filesystem.

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/container/DockerRenameContainer.html[DockerRenameContainer]

    Rename a container.

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/container/DockerRestartContainer.html[DockerRestartContainer]

    Restarts the container for a given id.

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/container/DockerStartContainer.html[DockerStartContainer]

    Starts the container for a given id.

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/container/DockerStopContainer.html[DockerStopContainer]

    Stops the container for a given id.

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/container/DockerWaitContainer.html[DockerWaitContainer]

    Blocks until container for a given id stops.

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/container/DockerLogsContainer.html[DockerLogsContainer]

    Copies the container output to the Gradle process standard out/err.

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/container/DockerExecContainer.html[DockerExecContainer]

    Executes a command within a running container.

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/container/DockerInspectExecContainer.html[DockerInspectExecContainer]

    Inspects task executed inside container with DockerExecContainer command.

    +
    +
    +

    1.4. Networks

    +
    +

    The plugin provides the following custom task types for managing networks:

    +
    + ++++ + + + + + + + + + + + + + + + + + + + + +
    TypeDescription

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/network/DockerCreateNetwork.html[DockerCreateNetwork]

    Creates a network.

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/network/DockerInspectNetwork.html[DockerInspectNetwork]

    Returns low-level information on the network.

    {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/network/DockerRemoveNetwork.html[DockerRemoveNetwork]

    Removes the network.

    +
    +
    +
    + + + + + \ No newline at end of file diff --git a/9.3.3/user-guide/14-reactive-streams.html b/9.3.3/user-guide/14-reactive-streams.html new file mode 100644 index 000000000..f003081e0 --- /dev/null +++ b/9.3.3/user-guide/14-reactive-streams.html @@ -0,0 +1,582 @@ + + + + + + + +Reactive Streams + + + + + + +
    +
    +

    1. Reactive Streams

    +
    +

    As needed, we will implement reactive methods as described in reactive-streams. +We implement these here as optional closures for all tasks. +Currently the only supported methods are onError, onNext, onComplete. +Various examples on how to use these can be found in our {uri-github}/blob/master/src/functTest/groovy/com/bmuschko/gradle/docker/DockerReactiveMethodsFunctionalTest.groovy[reactive tests].

    +
    +
    +

    1.1. Reacting to an Error

    +
    +

    The onError closure is passed the exception that is thrown for you to handle. +If you silently ignore we will not throw the exception behind the scenes. +The below example is a common use-case that arises when someone wants to remove a container whether it exists or not but does not want to fail hard.

    +
    +
    +
    Groovy
    +
    +
    task removeContainer1(type: DockerRemoveContainer) {
+    targetContainerId 'container-that-does-not-exist'
+    onError { exception ->
+        // Ignore exception if container does not exist otherwise throw it
+        if (!exception.message.contains('No such container'))
+            throw exception
+    }
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    tasks.create("removeContainer1", DockerRemoveContainer::class) {
+    targetContainerId("container-that-does-not-exist")
+    onError {
+        // Ignore exception if container does not exist otherwise throw it
+        if (!this.message!!.contains("No such container"))
+            throw this
+    }
+}
    +
    +
    +
    +
    +

    1.2. Reacting to Data Returned by an Operation

    +
    +

    The onNext closure is passed the next iterative response upon execution. +For all other tasks we simply hand you back the object that is given to us by docker-java which is a pojo representation of the json handed back by docker. +Thus, and much like the onError closure, all delegation is now in your control. +Any properties/values expected to be set will not be done unless you do them.

    +
    +
    +

    Iterative tasks are things like DockerBuildImage, DockerLogsContainer, DockerListImages. +These tasks have output which can be iterated over. +The example below demonstrates how we iterate over each log message passing that to the closure for the user to work on.

    +
    +
    +
    Groovy
    +
    +
    task logContainer(type: DockerLogsContainer) {
+    targetContainerId 'container-that-does-exist'
+    follow = true
+    tailAll = true
+    onNext { message ->
+        // Each log message from the container will be passed as it's made available
+        logger.quiet message.toString()
+    }
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    tasks.create("logContainer", DockerLogsContainer::class) {
+    targetContainerId("container-that-does-not-exist")
+    follow.set(true)
+    tailAll.set(true)
+    onNext {
+        // Each log message from the container will be passed as it's made available
+        logger.quiet(this.toString())
+    }
+}
    +
    +
    +
    +
    +

    1.3. Reacting to the Completion of an Operation

    +
    +

    The onComplete closure is not passed anything upon execution. +It works in the same fashion that doLast does but is instead part of this task and thus executes before doLast does. +This closure executes only upon success. +The below example demonstrates how this works.

    +
    +
    +
    Groovy
    +
    +
    task removeContainer2(type: DockerRemoveContainer) {
+    targetContainerId 'container-that-does-exist'
+    onComplete {
+        println 'Executes first'
+    }
+    doLast {
+        println 'Executes second'
+    }
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    tasks.create("removeContainer2", DockerRemoveContainer::class) {
+    targetContainerId("container-that-does-exist")
+    onComplete {
+        println("Executes first")
+    }
+    doLast {
+        println("Executes second")
+    }
+}
    +
    +
    +
    +
    +
    + + + + + \ No newline at end of file diff --git a/9.3.3/user-guide/15-examples.html b/9.3.3/user-guide/15-examples.html new file mode 100644 index 000000000..2041b36a8 --- /dev/null +++ b/9.3.3/user-guide/15-examples.html @@ -0,0 +1,891 @@ + + + + + + + +Examples + + + + + + +
    +
    +

    1. Examples

    +
    +

    The following usage examples demonstrate code for common use cases. +More scenarios can be found in the {uri-github}/blob/master/src/functTest/groovy/com/bmuschko/gradle/docker/DockerWorkflowFunctionalTest.groovy[functional tests].

    +
    +
    +

    1.1. Modifying Instructions of a Dockerfile Task

    +
    +

    Sometimes do you do not have any control over the creation of a Dockerfile task. +For example the Docker Java Application Plugin already adds a Dockerfile task with a set of sensible instructions. +You can still modify {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.html#getInstructions()[those instructions] if needed. +Let’s say you are dealing with the following Dockerfile definition.

    +
    +
    +
    Groovy
    +
    +
    tasks.create('createDockerfile', Dockerfile) {
+    from('openjdk:jre-alpine')
+    copyFile('my-app-1.0.jar', '/app/my-app-1.0.jar')
+    entryPoint('java')
+    defaultCommand('-jar', '/app/my-app-1.0.jar')
+    exposePort(8080)
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    tasks.create("createDockerfile", Dockerfile::class) {
+    from("openjdk:jre-alpine")
+    copyFile("my-app-1.0.jar", "/app/my-app-1.0.jar")
+    entryPoint("java")
+    defaultCommand("-jar", "/app/my-app-1.0.jar")
+    exposePort(8080)
+}
    +
    +
    +
    +

    Now, you may prefer a different base image than the one added by default. +The listing below demonstrates how to find it the FROM instruction and replace it with a different one.

    +
    +
    +
    Groovy
    +
    +
    createDockerfile {
+    List<Instruction> originalInstructions = new ArrayList<Instruction>(instructions.get())
+    int fromInstructionIndex = originalInstructions
+            .findIndexOf { it.keyword == FromInstruction.KEYWORD }
+    originalInstructions.remove(fromInstructionIndex)
+    FromInstruction baseImage = new FromInstruction(new From('openjdk:8-alpine'))
+    originalInstructions.add(0, baseImage)
+    instructions.set(originalInstructions)
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    tasks {
+    "createDockerfile"(Dockerfile::class) {
+        val originalInstructions = instructions.get().toMutableList()
+        val fromInstructionIndex = originalInstructions
+                .indexOfFirst { item -> item.keyword == FromInstruction.KEYWORD }
+        originalInstructions.removeAt(fromInstructionIndex)
+        val baseImage = FromInstruction(From("openjdk:8-alpine"))
+        originalInstructions.add(0, baseImage)
+        instructions.set(originalInstructions)
+    }
+}
    +
    +
    +
    +

    You can also add new instructions at a specific position in the existing list of instructions. +For example you may want to add a HEALTHCHECK to the end of the list.

    +
    +
    +
    Groovy
    +
    +
    createDockerfile {
+    instruction 'HEALTHCHECK CMD wget --quiet --tries=1 --spider http://localhost:8080/actuator/health || exit 1'
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    tasks {
+    "createDockerfile"(Dockerfile::class) {
+        instruction("HEALTHCHECK CMD wget --quiet --tries=1 --spider http://localhost:8080/actuator/health || exit 1")
+    }
+}
    +
    +
    +
    +
    +

    1.2. Creating a Dockerfile And Building an Image

    +
    +

    A Dockerfile can be created by the Dockerfile custom tasks. +The Dockerfile instructions need to be declare in the correct +order.

    +
    +
    +
    Groovy
    +
    +
    plugins {
+    id 'com.bmuschko.docker-remote-api' version '9.3.3'
+}
+
+import com.bmuschko.gradle.docker.tasks.image.Dockerfile
+import com.bmuschko.gradle.docker.tasks.image.DockerBuildImage
+
+task createDockerfile(type: Dockerfile) {
+    from 'ubuntu:12.04'
+    label(['maintainer': 'Benjamin Muschko "benjamin.muschko@gmail.com"'])
+}
+
+task buildImage(type: DockerBuildImage) {
+    dependsOn createDockerfile
+    images.add('bmuschko/myimage:latest')
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    plugins {
+    id("com.bmuschko.docker-remote-api") version "9.3.3"
+}
+
+import com.bmuschko.gradle.docker.tasks.image.Dockerfile
+import com.bmuschko.gradle.docker.tasks.image.DockerBuildImage
+
+val createDockerfile by tasks.creating(Dockerfile::class) {
+    from("ubuntu:12.04")
+    label(mapOf("maintainer" to "Benjamin Muschko 'benjamin.muschko@gmail.com'"))
+}
+
+tasks.create("buildImage", DockerBuildImage::class) {
+    dependsOn(createDockerfile)
+    images.add("bmuschko/myimage:latest")
+}
    +
    +
    +
    +
    +

    1.3. Executing Functional Tests Against a Running Container

    +
    +

    The following example code demonstrates how to build a Docker image from a Dockerfile, starts up a container for this image and exercises functional tests against the running container. +At the end of this operation, the container is stopped.

    +
    +
    +
    Groovy
    +
    +
    plugins {
+    id 'com.bmuschko.docker-remote-api' version '9.3.3'
+}
+
+import com.bmuschko.gradle.docker.tasks.container.*
+import com.bmuschko.gradle.docker.tasks.image.*
+
+task buildMyAppImage(type: DockerBuildImage) {
+    inputDir = file('docker/myapp')
+    images.add('test/myapp:latest')
+}
+
+task createMyAppContainer(type: DockerCreateContainer) {
+    dependsOn buildMyAppImage
+    targetImageId buildMyAppImage.getImageId()
+    hostConfig.portBindings = ['8080:8080']
+    hostConfig.autoRemove = true
+}
+
+task startMyAppContainer(type: DockerStartContainer) {
+    dependsOn createMyAppContainer
+    targetContainerId createMyAppContainer.getContainerId()
+}
+
+task stopMyAppContainer(type: DockerStopContainer) {
+    targetContainerId createMyAppContainer.getContainerId()
+}
+
+task functionalTestMyApp(type: Test) {
+    dependsOn startMyAppContainer
+    finalizedBy stopMyAppContainer
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    plugins {
+    id("com.bmuschko.docker-remote-api") version "9.3.3"
+}
+
+import com.bmuschko.gradle.docker.tasks.container.*
+import com.bmuschko.gradle.docker.tasks.image.*
+
+val buildMyAppImage by tasks.creating(DockerBuildImage::class) {
+    inputDir.set(file("docker/myapp"))
+    images.add("test/myapp:latest")
+}
+
+val createMyAppContainer by tasks.creating(DockerCreateContainer::class) {
+    dependsOn(buildMyAppImage)
+    targetImageId(buildMyAppImage.getImageId())
+    hostConfig.portBindings.set(listOf("8080:8080"))
+    hostConfig.autoRemove.set(true)
+}
+
+val startMyAppContainer by tasks.creating(DockerStartContainer::class) {
+    dependsOn(createMyAppContainer)
+    targetContainerId(createMyAppContainer.getContainerId())
+}
+
+val stopMyAppContainer by tasks.creating(DockerStopContainer::class) {
+    targetContainerId(createMyAppContainer.getContainerId())
+}
+
+tasks.create("functionalTestMyApp", Test::class) {
+    dependsOn(startMyAppContainer)
+    finalizedBy(stopMyAppContainer)
+}
    +
    +
    +
    +
    +

    1.4. Linking With Other Containers

    +
    +

    In many situations your container does not start without dependencies like database. +In that case you may wish using traditional linking:

    +
    +
    +
    Groovy
    +
    +
    plugins {
+    id 'com.bmuschko.docker-remote-api' version '9.3.3'
+}
+
+import com.bmuschko.gradle.docker.tasks.container.*
+import com.bmuschko.gradle.docker.tasks.image.*
+
+task buildMyAppImage(type: DockerBuildImage) {
+    inputDir = file('docker/myapp')
+    images.add('test/myapp')
+}
+
+task createDBContainer(type: DockerCreateContainer) {
+    targetImageId 'postgres:latest'
+    containerName = 'docker_auto'
+    hostConfig.autoRemove = true
+}
+
+task createMyAppContainer(type: DockerCreateContainer) {
+    dependsOn buildMyAppImage, createDBContainer
+    targetImageId buildMyAppImage.getImageId()
+    hostConfig.portBindings = ['8080:8080']
+    hostConfig.autoRemove = true
+    hostConfig.links = ["docker_auto:database"]
+
+    // If you use Systemd in containers you should also add lines. #320
+    hostConfig.binds = ['/sys/fs/cgroup': '/sys/fs/cgroup']
+    tty = true
+}
+
+task startMyAppContainer(type: DockerStartContainer) {
+    dependsOn createMyAppContainer
+    targetContainerId createMyAppContainer.getContainerId()
+}
+
+task stopMyAppContainer(type: DockerStopContainer) {
+    targetContainerId createMyAppContainer.getContainerId()
+}
+
+task functionalTestMyApp(type: Test) {
+    dependsOn startMyAppContainer
+    finalizedBy stopMyAppContainer
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    plugins {
+    id("com.bmuschko.docker-remote-api") version "9.3.3"
+}
+
+import com.bmuschko.gradle.docker.tasks.container.*
+import com.bmuschko.gradle.docker.tasks.image.*
+
+val buildMyAppImage by tasks.creating(DockerBuildImage::class) {
+    inputDir.set(file("docker/myapp"))
+    images.add("test/myapp")
+}
+
+val createDBContainer by tasks.creating(DockerCreateContainer::class) {
+    targetImageId("postgres:latest")
+    containerName.set("docker_auto")
+    hostConfig.autoRemove.set(true)
+}
+
+val createMyAppContainer by tasks.creating(DockerCreateContainer::class) {
+    dependsOn(buildMyAppImage, createDBContainer)
+    targetImageId(buildMyAppImage.getImageId())
+    hostConfig.portBindings.set(listOf("8080:8080"))
+    hostConfig.autoRemove.set(true)
+    hostConfig.links.set(listOf("docker_auto:database"))
+
+    // If you use Systemd in containers you should also add lines. #320
+    hostConfig.binds.set(mapOf("/sys/fs/cgroup" to "/sys/fs/cgroup"))
+    tty.set(true)
+}
+
+val startMyAppContainer by tasks.creating(DockerStartContainer::class) {
+    dependsOn(createMyAppContainer)
+    targetContainerId(createMyAppContainer.getContainerId())
+}
+
+val stopMyAppContainer by tasks.creating(DockerStopContainer::class) {
+    targetContainerId(createMyAppContainer.getContainerId())
+}
+
+tasks.create("functionalTestMyApp", Test::class) {
+    dependsOn(startMyAppContainer)
+    finalizedBy(stopMyAppContainer)
+}
    +
    +
    +
    +
    +

    1.5. Implementing Custom Docker Client Handling

    +
    +

    The plugin provides an opinionated set of custom tasks for the most common Docker operations. +Sometime the situation may arise that you want to have full control over what you want to call on the Docker client. +To do so you can implement your own custom task that extends from {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/AbstractDockerRemoteApiTask.html[AbstractDockerRemoteApiTask]. +The following example shows how to implement such a custom task:

    +
    +
    +
    Groovy
    +
    +
    class DockerImageIdForName extends AbstractDockerRemoteApiTask {
+    @Input
+    final Property<String> filteredImageName = project.objects.property(String)
+
+    @Internal
+    final Property<String> imageId = project.objects.property(String)
+
+    DockerImageIdForName() {
+        onNext({ image ->
+            imageId.set(image.id)
+        })
+    }
+
+    @Override
+    void runRemoteCommand() {
+        def images = dockerClient.listImagesCmd()
+            .withImageNameFilter(filteredImageName.get())
+            .exec()
+
+        for(image in images) {
+            nextHandler.execute(image)
+        }
+    }
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    open class DockerImageIdForName : AbstractDockerRemoteApiTask {
+    @Input
+    val filteredImageName : Property<String> = project.objects.property(String::class)
+
+    @Internal
+    val imageId : Property<String> = project.objects.property(String::class)
+
+    constructor() {
+        onNext(Action<Image> {
+            this.withGroovyBuilder {
+                imageId.set(getProperty("id") as String)
+            }
+        })
+    }
+
+    override fun runRemoteCommand() {
+        val images = getDockerClient().listImagesCmd()
+            .withImageNameFilter(filteredImageName.get())
+            .exec()
+
+        for(image in images) {
+            nextHandler.execute(image)
+        }
+    }
+}
    +
    +
    +
    +

    To use the custom task, simply create a task by type.

    +
    +
    +
    Groovy
    +
    +
    task imageIdForName(type: DockerImageIdForName) {
+    filteredImageName = 'alpine:3.4'
+}
+
+task printImageId {
+    dependsOn imageIdForName
+    doLast {
+        logger.quiet "Resolved image ID ${imageIdForName.imageId.get()} for name ${imageIdForName.filteredImageName.get()}"
+    }
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    val imageIdForName by tasks.creating(DockerImageIdForName::class) {
+    filteredImageName.set("alpine:3.4")
+}
+
+val printImageId by tasks.creating {
+    dependsOn(imageIdForName)
+    doLast {
+        logger.quiet("Resolved image ID ${imageIdForName.imageId.get()} for name ${imageIdForName.filteredImageName.get()}")
+    }
+}
    +
    +
    +
    +
    +
    + + + + + \ No newline at end of file diff --git a/9.3.3/user-guide/20-java-application-plugin.html b/9.3.3/user-guide/20-java-application-plugin.html new file mode 100644 index 000000000..9101fc0bf --- /dev/null +++ b/9.3.3/user-guide/20-java-application-plugin.html @@ -0,0 +1,779 @@ + + + + + + + +Java Application Plugin + + + + + + +
    +
    +

    1. Java Application Plugin

    +
    +
    +

    The plugin com.bmuschko.docker-java-application is a highly opinionated plugin for projects applying the {uri-gradle-docs}/userguide/java_plugin.html[Java plugin]. +Under the hood the plugin preconfigures tasks for creating and pushing Docker images for your Java application. +The default configuration is tweakable via an exposed extension.

    +
    +
    +

    1.1. Usage

    +
    +
    Groovy
    +
    +
    plugins {
+    id 'java'
+    id 'com.bmuschko.docker-java-application' version '9.3.3'
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    plugins {
+    java
+    id("com.bmuschko.docker-java-application") version "9.3.3"
+}
    +
    +
    +
    +
    +

    1.2. Extension

    +
    +

    The plugin defines an extension with the namespace javaApplication as a child of the docker namespace. By default, the main class will be configured automatically by looking for a class with a public static void main(String[]) method available in the classpath of the main source set.

    +
    +
    +

    The following properties can be configured:

    +
    + ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Property nameTypeDefault valueDescription

    baseImage

    Property<String>

    openjdk:11.0.16-jre-slim

    The Docker base image used for Java application.

    maintainer

    Property<String>

    Value of system property user.name

    The maintainer of the image.

    user

    Property<String>

    None

    The user name (or UID) and optionally the user group (or GID) to use as the default user and group to run the container.

    ports

    ListProperty<Integer>

    [8080]

    The Docker image exposed ports.

    images

    SetProperty<String>

    [<project.group>/<applicationName>:<project.version>]

    The images used for the build and push operation.

    jvmArgs

    ListProperty<String>

    []

    The JVM arguments passed to the java command.

    mainClassName

    Property<String>

    A unique main class +name discovered by scanning the classpath

    The main class name to use for starting the application. Setting an explicit value for this option is useful if your source code contains multiple main class files.

    args

    ListProperty<String>

    []

    The program arguments passed to the java command.

    +
    +
    Groovy
    +
    +
    docker {
+    javaApplication {
+        baseImage = 'dockerfile/java:openjdk-7-jre'
+        maintainer = 'Benjamin Muschko "benjamin.muschko@gmail.com"'
+        ports = [9090, 5701]
+        images = ['jettyapp:1.115', 'jettyapp:latest']
+        jvmArgs = ['-Xms256m', '-Xmx2048m']
+    }
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    docker {
+    javaApplication {
+        baseImage.set("dockerfile/java:openjdk-7-jre")
+        maintainer.set("Benjamin Muschko 'benjamin.muschko@gmail.com'")
+        ports.set(listOf(9090, 5701))
+        images.set(setOf("jettyapp:1.115", "jettyapp:latest"))
+        jvmArgs.set(listOf("-Xms256m", "-Xmx2048m"))
+    }
+}
    +
    +
    +
    +
    +

    1.3. Tasks

    +
    +

    The plugin provides a set of tasks for your project and preconfigures them with sensible defaults.

    +
    + ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Task nameDepends OnTypeDescription

    dockerSyncBuildContext

    classes

    TaskProvider<{uri-gradle-docs}/javadoc/org/gradle/api/tasks/Sync.html[Sync]>

    Copies the application files to a temporary directory for image creation.

    dockerCreateDockerfile

    dockerSyncBuildContext

    TaskProvider<{uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.html[Dockerfile]>

    Creates the Docker image for the Java application.

    dockerBuildImage

    dockerCreateDockerfile

    TaskProvider<{uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/image/DockerBuildImage.html[DockerBuildImage]>

    Builds the Docker image for the Java application.

    dockerPushImage

    dockerBuildImage

    TaskProvider<{uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/image/DockerPushImage.html[DockerPushImage]>

    Pushes created Docker image to the repository.

    +
    +
    +

    1.4. Generated Dockerfile

    +
    +

    The following Dockerfile shows the typical instructions generated by the plugin. It uses the default values defined by the extension. The resolved main class name is com.bmuschko.gradle.docker.application.JettyMain.

    +
    +
    +
    Dockerfile
    +
    +
    FROM openjdk:11-jre-slim
+LABEL maintainer=bmuschko
+WORKDIR /app
+COPY libs libs/
+COPY classes classes/
+ENTRYPOINT ["java", "-cp", "/app/resources:/app/classes:/app/libs/*", "com.bmuschko.gradle.docker.application.JettyMain"]
+EXPOSE 8080
    +
    +
    +
    +

    See additional examples for information on how to modify the Dockerfile instructions.

    +
    +
    +
    +

    1.5. Examples

    +
    +

    The following usage examples demonstrate code for common use cases. +More scenarios can be found in the {uri-github}/blob/master/src/functTest/groovy/com/bmuschko/gradle/docker/DockerJavaApplicationPluginFunctionalTest.groovy[functional tests].

    +
    +
    +

    1.5.1. Using the Plugin for an Application Run on Jetty

    +
    +
    Groovy
    +
    +
    plugins {
+    id 'java'
+    id 'com.bmuschko.docker-java-application' version '9.3.3'
+}
+
+version = '1.0'
+sourceCompatibility = 1.7
+
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+    implementation 'org.eclipse.jetty.aggregate:jetty-all:9.4.29.v20200521'
+}
+
+docker {
+    javaApplication {
+        maintainer = 'Jon Doe "jon.doe@gmail.com"'
+    }
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    plugins {
+    java
+    id("com.bmuschko.docker-java-application") version "9.3.3"
+}
+
+version = "1.0"
+
+java {
+    sourceCompatibility = JavaVersion.VERSION_1_7
+    targetCompatibility = JavaVersion.VERSION_1_7
+}
+
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+    implementation("org.eclipse.jetty.aggregate:jetty-all:9.4.29.v20200521")
+}
+
+docker {
+    javaApplication {
+        maintainer.set("Jon Doe 'jon.doe@gmail.com'")
+    }
+}
    +
    +
    +
    +
    +

    1.5.2. Additional Instructions in Dockerfile

    +
    +

    You can add additional instructions to the dockerfile using dockerDistTar and {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.html[Dockerfile task] DSL:

    +
    +
    +
    Groovy
    +
    +
    dockerCreateDockerfile {
+    instruction 'RUN ls -la'
+    environmentVariable 'JAVA_OPTS', '-XX:+UnlockExperimentalVMOptions -XX:+UseCGroupMemoryLimitForHeap'
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    tasks.named<Dockerfile>("dockerCreateDockerfile") {
+    instruction("RUN ls -la")
+    environmentVariable("JAVA_OPTS", "-XX:+UnlockExperimentalVMOptions -XX:+UseCGroupMemoryLimitForHeap")
+}
    +
    +
    +
    +

    Or you can use form

    +
    +
    +
    Groovy
    +
    +
    dockerCreateDockerfile.instructionsFromTemplate file('Dockerfile.tmpl')
    +
    +
    +
    +
    Kotlin
    +
    +
    tasks.named<Dockerfile>("dockerCreateDockerfile") {
+    instructionsFromTemplate(file("Dockerfile.tmpl"))
+}
    +
    +
    +
    +
    +
    +
    +
    + + + + + \ No newline at end of file diff --git a/9.3.3/user-guide/21-usage.html b/9.3.3/user-guide/21-usage.html new file mode 100644 index 000000000..e9c5d71d0 --- /dev/null +++ b/9.3.3/user-guide/21-usage.html @@ -0,0 +1,481 @@ + + + + + + + +Usage + + + + + + +
    +
    +

    1. Usage

    +
    +
    Groovy
    +
    +
    plugins {
+    id 'java'
+    id 'com.bmuschko.docker-java-application' version '9.3.3'
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    plugins {
+    java
+    id("com.bmuschko.docker-java-application") version "9.3.3"
+}
    +
    +
    +
    +
    + + + + + \ No newline at end of file diff --git a/9.3.3/user-guide/22-extension.html b/9.3.3/user-guide/22-extension.html new file mode 100644 index 000000000..d82cbf20d --- /dev/null +++ b/9.3.3/user-guide/22-extension.html @@ -0,0 +1,564 @@ + + + + + + + +Extension + + + + + + +
    +
    +

    1. Extension

    +
    +

    The plugin defines an extension with the namespace javaApplication as a child of the docker namespace. By default, the main class will be configured automatically by looking for a class with a public static void main(String[]) method available in the classpath of the main source set.

    +
    +
    +

    The following properties can be configured:

    +
    + ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Property nameTypeDefault valueDescription

    baseImage

    Property<String>

    openjdk:11.0.16-jre-slim

    The Docker base image used for Java application.

    maintainer

    Property<String>

    Value of system property user.name

    The maintainer of the image.

    user

    Property<String>

    None

    The user name (or UID) and optionally the user group (or GID) to use as the default user and group to run the container.

    ports

    ListProperty<Integer>

    [8080]

    The Docker image exposed ports.

    images

    SetProperty<String>

    [<project.group>/<applicationName>:<project.version>]

    The images used for the build and push operation.

    jvmArgs

    ListProperty<String>

    []

    The JVM arguments passed to the java command.

    mainClassName

    Property<String>

    A unique main class +name discovered by scanning the classpath

    The main class name to use for starting the application. Setting an explicit value for this option is useful if your source code contains multiple main class files.

    args

    ListProperty<String>

    []

    The program arguments passed to the java command.

    +
    +
    Groovy
    +
    +
    docker {
+    javaApplication {
+        baseImage = 'dockerfile/java:openjdk-7-jre'
+        maintainer = 'Benjamin Muschko "benjamin.muschko@gmail.com"'
+        ports = [9090, 5701]
+        images = ['jettyapp:1.115', 'jettyapp:latest']
+        jvmArgs = ['-Xms256m', '-Xmx2048m']
+    }
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    docker {
+    javaApplication {
+        baseImage.set("dockerfile/java:openjdk-7-jre")
+        maintainer.set("Benjamin Muschko 'benjamin.muschko@gmail.com'")
+        ports.set(listOf(9090, 5701))
+        images.set(setOf("jettyapp:1.115", "jettyapp:latest"))
+        jvmArgs.set(listOf("-Xms256m", "-Xmx2048m"))
+    }
+}
    +
    +
    +
    +
    + + + + + \ No newline at end of file diff --git a/9.3.3/user-guide/23-tasks.html b/9.3.3/user-guide/23-tasks.html new file mode 100644 index 000000000..97aac7a57 --- /dev/null +++ b/9.3.3/user-guide/23-tasks.html @@ -0,0 +1,508 @@ + + + + + + + +Tasks + + + + + + +
    +
    +

    1. Tasks

    +
    +

    The plugin provides a set of tasks for your project and preconfigures them with sensible defaults.

    +
    + ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Task nameDepends OnTypeDescription

    dockerSyncBuildContext

    classes

    TaskProvider<{uri-gradle-docs}/javadoc/org/gradle/api/tasks/Sync.html[Sync]>

    Copies the application files to a temporary directory for image creation.

    dockerCreateDockerfile

    dockerSyncBuildContext

    TaskProvider<{uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.html[Dockerfile]>

    Creates the Docker image for the Java application.

    dockerBuildImage

    dockerCreateDockerfile

    TaskProvider<{uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/image/DockerBuildImage.html[DockerBuildImage]>

    Builds the Docker image for the Java application.

    dockerPushImage

    dockerBuildImage

    TaskProvider<{uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/image/DockerPushImage.html[DockerPushImage]>

    Pushes created Docker image to the repository.

    +
    +
    + + + + + \ No newline at end of file diff --git a/9.3.3/user-guide/24-dockerfile.html b/9.3.3/user-guide/24-dockerfile.html new file mode 100644 index 000000000..93bd581cc --- /dev/null +++ b/9.3.3/user-guide/24-dockerfile.html @@ -0,0 +1,481 @@ + + + + + + + +Generated Dockerfile + + + + + + +
    +
    +

    1. Generated Dockerfile

    +
    +

    The following Dockerfile shows the typical instructions generated by the plugin. It uses the default values defined by the extension. The resolved main class name is com.bmuschko.gradle.docker.application.JettyMain.

    +
    +
    +
    Dockerfile
    +
    +
    FROM openjdk:11-jre-slim
+LABEL maintainer=bmuschko
+WORKDIR /app
+COPY libs libs/
+COPY classes classes/
+ENTRYPOINT ["java", "-cp", "/app/resources:/app/classes:/app/libs/*", "com.bmuschko.gradle.docker.application.JettyMain"]
+EXPOSE 8080
    +
    +
    +
    +

    See additional examples for information on how to modify the Dockerfile instructions.

    +
    +
    +
    + + + + + \ No newline at end of file diff --git a/9.3.3/user-guide/25-examples.html b/9.3.3/user-guide/25-examples.html new file mode 100644 index 000000000..69805dd47 --- /dev/null +++ b/9.3.3/user-guide/25-examples.html @@ -0,0 +1,567 @@ + + + + + + + +Examples + + + + + + +
    +
    +

    1. Examples

    +
    +

    The following usage examples demonstrate code for common use cases. +More scenarios can be found in the {uri-github}/blob/master/src/functTest/groovy/com/bmuschko/gradle/docker/DockerJavaApplicationPluginFunctionalTest.groovy[functional tests].

    +
    +
    +

    1.1. Using the Plugin for an Application Run on Jetty

    +
    +
    Groovy
    +
    +
    plugins {
+    id 'java'
+    id 'com.bmuschko.docker-java-application' version '9.3.3'
+}
+
+version = '1.0'
+sourceCompatibility = 1.7
+
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+    implementation 'org.eclipse.jetty.aggregate:jetty-all:9.4.29.v20200521'
+}
+
+docker {
+    javaApplication {
+        maintainer = 'Jon Doe "jon.doe@gmail.com"'
+    }
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    plugins {
+    java
+    id("com.bmuschko.docker-java-application") version "9.3.3"
+}
+
+version = "1.0"
+
+java {
+    sourceCompatibility = JavaVersion.VERSION_1_7
+    targetCompatibility = JavaVersion.VERSION_1_7
+}
+
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+    implementation("org.eclipse.jetty.aggregate:jetty-all:9.4.29.v20200521")
+}
+
+docker {
+    javaApplication {
+        maintainer.set("Jon Doe 'jon.doe@gmail.com'")
+    }
+}
    +
    +
    +
    +
    +

    1.2. Additional Instructions in Dockerfile

    +
    +

    You can add additional instructions to the dockerfile using dockerDistTar and {uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.html[Dockerfile task] DSL:

    +
    +
    +
    Groovy
    +
    +
    dockerCreateDockerfile {
+    instruction 'RUN ls -la'
+    environmentVariable 'JAVA_OPTS', '-XX:+UnlockExperimentalVMOptions -XX:+UseCGroupMemoryLimitForHeap'
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    tasks.named<Dockerfile>("dockerCreateDockerfile") {
+    instruction("RUN ls -la")
+    environmentVariable("JAVA_OPTS", "-XX:+UnlockExperimentalVMOptions -XX:+UseCGroupMemoryLimitForHeap")
+}
    +
    +
    +
    +

    Or you can use form

    +
    +
    +
    Groovy
    +
    +
    dockerCreateDockerfile.instructionsFromTemplate file('Dockerfile.tmpl')
    +
    +
    +
    +
    Kotlin
    +
    +
    tasks.named<Dockerfile>("dockerCreateDockerfile") {
+    instructionsFromTemplate(file("Dockerfile.tmpl"))
+}
    +
    +
    +
    +
    +
    + + + + + \ No newline at end of file diff --git a/9.3.3/user-guide/30-spring-boot-application-plugin.html b/9.3.3/user-guide/30-spring-boot-application-plugin.html new file mode 100644 index 000000000..80c298559 --- /dev/null +++ b/9.3.3/user-guide/30-spring-boot-application-plugin.html @@ -0,0 +1,808 @@ + + + + + + + +Spring Boot Application Plugin + + + + + + +
    +
    +

    1. Spring Boot Application Plugin

    +
    +
    +

    The plugin com.bmuschko.docker-spring-boot-application is a highly opinionated plugin for projects applying the Spring Boot plugin. +Under the hood the plugin preconfigures tasks for creating and pushing Docker images for your Spring Boot application. +The default configuration is tweakable via an exposed extension. The plugin reacts to either the java or war plugin.

    +
    +
    + + + + + +
    + + +The plugin only supports projects that use a 2.x version of the Spring Boot plugin. +
    +
    +
    +

    1.1. Usage

    +
    +
    Groovy
    +
    +
    plugins {
+    id 'java'
+    id 'org.springframework.boot' version '2.0.3.RELEASE'
+    id 'com.bmuschko.docker-spring-boot-application' version '9.3.3'
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    plugins {
+    java
+    id("org.springframework.boot") version "2.0.3.RELEASE"
+    id("com.bmuschko.docker-spring-boot-application") version "9.3.3"
+}
    +
    +
    +
    +
    +

    1.2. Extension

    +
    +

    The plugin defines an extension with the namespace springBootApplication as a child of the docker namespace. By default, the main class will be configured automatically by looking for a class with a public static void main(String[]) method available in the classpath of the main source set. The main class needs to use the org.springframework.boot.autoconfigure.SpringBootApplication annotation to be discoverable.

    +
    +
    +

    The following properties can be configured:

    +
    + ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Property nameTypeDefault valueDescription

    baseImage

    Property<String>

    openjdk:11.0.16-jre-slim

    The Docker base image used for the Spring Boot application.

    maintainer

    Property<String>

    Value of system property user.name

    The maintainer of the image.

    user

    Property<String>

    None

    The user name (or UID) and optionally the user group (or GID) to use as the default user and group to run the container.

    ports

    ListProperty<Integer>

    [8080]

    The Docker image exposed ports.

    images

    SetProperty<String>

    [<project.group>/<applicationName>:<project.version>]

    The images used for the build and push operation.

    jvmArgs

    ListProperty<String>

    []

    The JVM arguments passed to the java command.

    mainClassName

    Property<String>

    A unique main class name discovered by scanning the classpath

    The main class name to use for starting the application. Setting an explicit value for this option is useful if your source code contains multiple main class files.

    args

    ListProperty<String>

    []

    The program arguments passed to the java command.

    +
    +
    Groovy
    +
    +
    docker {
+    springBootApplication {
+        baseImage = 'openjdk:8-alpine'
+        ports = [9090, 8080]
+        images = ['awesome-spring-boot:1.115', 'awesome-spring-boot:latest']
+        jvmArgs = ['-Dspring.profiles.active=production', '-Xmx2048m']
+    }
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    docker {
+    springBootApplication {
+        baseImage.set("openjdk:8-alpine")
+        ports.set(listOf(9090, 8080))
+        images.set(setOf("awesome-spring-boot:1.115", "awesome-spring-boot:latest"))
+        jvmArgs.set(listOf("-Dspring.profiles.active=production", "-Xmx2048m"))
+    }
+}
    +
    +
    +
    +
    +

    1.3. Tasks

    +
    +

    The plugin provides a set of tasks for your project and preconfigures them with sensible defaults.

    +
    + ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Task nameDepends OnTypeDescription

    dockerSyncBuildContext

    classes

    TaskProvider<{uri-gradle-docs}/javadoc/org/gradle/api/tasks/Sync.html[Sync]>

    Copies the application files to a temporary directory for image creation.

    dockerCreateDockerfile

    dockerSyncBuildContext

    TaskProvider<{uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.html[Dockerfile]>

    Creates the Docker image for the Spring Boot application.

    dockerBuildImage

    dockerCreateDockerfile

    TaskProvider<{uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/image/DockerBuildImage.html[DockerBuildImage]>

    Builds the Docker image for the Spring Boot application.

    dockerPushImage

    dockerBuildImage

    TaskProvider<{uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/image/DockerPushImage.html[DockerPushImage]>

    Pushes created Docker image to the repository.

    +
    +
    +

    1.4. Generated Dockerfile

    +
    +

    The following Dockerfile shows the typical instructions generated by the plugin. It uses the default values defined by the extension. The resolved main class name is com.bmuschko.gradle.docker.springboot.Application.

    +
    +
    +
    Dockerfile
    +
    +
    FROM openjdk:11-jre-slim
+LABEL maintainer=bmuschko
+WORKDIR /app
+COPY libs libs/
+COPY classes classes/
+ENTRYPOINT ["java", "-cp", "/app/resources:/app/classes:/app/libs/*", "com.bmuschko.gradle.docker.springboot.Application"]
+EXPOSE 8080
    +
    +
    +
    +

    See additional examples for information on how to modify the Dockerfile instructions.

    +
    +
    +
    +

    1.5. Examples

    +
    +

    The following usage examples demonstrate code for common use cases. More scenarios can be found in the {uri-github}/blob/master/src/functTest/groovy/com/bmuschko/gradle/docker/DockerSpringBootApplicationPluginFunctionalTest.groovy[functional tests].

    +
    +
    +

    1.5.1. Using the Plugin For an Application Run on Tomcat

    +
    +

    The Spring Boot archive can be created as executable JAR or WAR file. If you are target environment is a Servlet Container or Application Server, the WAR file is likely the better option. To generate a WAR file, simply apply the war plugin and declare the appropriate container-related dependencies to run the application locally.

    +
    +
    +
    Groovy
    +
    +
    plugins {
+    id 'war'
+    id 'org.springframework.boot' version '2.0.3.RELEASE'
+    id 'io.spring.dependency-management' version '1.0.5.RELEASE'
+    id 'com.bmuschko.docker-spring-boot-application' version '9.3.3'
+}
+
+version = '1.0'
+sourceCompatibility = JavaVersion.VERSION_1_8
+targetCompatibility = JavaVersion.VERSION_1_8
+
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+    implementation 'org.springframework.boot:spring-boot-starter-web'
+    providedRuntime 'org.springframework.boot:spring-boot-starter-tomcat'
+    providedRuntime 'org.apache.tomcat.embed:tomcat-embed-jasper'
+}
+
+docker {
+    springBootApplication {
+        baseImage = 'openjdk:8-alpine'
+    }
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    plugins {
+    war
+    id("org.springframework.boot") version "2.0.3.RELEASE"
+    id("io.spring.dependency-management") version "1.0.5.RELEASE"
+    id("com.bmuschko.docker-spring-boot-application") version "9.3.3"
+}
+
+version = "1.0"
+
+java {
+    sourceCompatibility = JavaVersion.VERSION_1_8
+    targetCompatibility = JavaVersion.VERSION_1_8
+}
+
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+    implementation("org.springframework.boot:spring-boot-starter-web")
+    providedRuntime("org.springframework.boot:spring-boot-starter-tomcat")
+    providedRuntime("org.apache.tomcat.embed:tomcat-embed-jasper")
+}
+
+docker {
+    springBootApplication {
+        baseImage.set("openjdk:8-alpine")
+    }
+}
    +
    +
    +
    +
    +

    1.5.2. Providing Container Build-Time and Runtime Parameters

    +
    +

    It’s common practice to provide JVM parameters to a Spring Boot application running in a container. For example, you might want to provide memory parameters or set a specific Spring profile. There’s a two ways to achieve this. Each of them serve different use cases.

    +
    +
    +

    You may want to provide JVM parameters when you build the image with a Dockerfile. That’s likely the case if you don’t want to change the parameters later when running the image in a container. You can provide a list of JVM parameters that should be baked into image with the extension property jvmArgs.

    +
    +
    +

    Hard-coding a JVM parameter may not be the right solution to your problem. There are situations when you want to provide runtime behavior when starting the container. A typical example is a Spring profile that needs to be enabled depending on the environment you want to run.

    +
    +
    +

    If you are running the image with Docker, then you can just provide pre-built environment variables known to Spring Boot. Below, we are running an application with the prod profile.

    +
    +
    +
    +
    $ docker run -e "SPRING_PROFILES_ACTIVE=prod" -p 8080:8080 -t my-spring-boot-app:1.2.3
    +
    +
    +
    +

    You can achieve the same behavior in Kubernetes by defining an environment variable in your Pod or Deployment spec. The example below demonstrates the use of a Deployment.

    +
    +
    +
    deployment.yaml
    +
    +
    kind: Deployment
+apiVersion: apps/v1
+metadata:
+  name: my-spring-boot-app
+spec:
+  replicas: 3
+  selector:
+    matchLabels:
+      app: my-spring-boot-app
+  template:
+    metadata:
+      labels:
+        app: my-spring-boot-app
+    spec:
+      containers:
+        - name: my-spring-boot-app
+          image: my-spring-boot-app:1.2.3
+          env:
+          - name: SPRING_PROFILES_ACTIVE
+            value: prod
    +
    +
    +
    +
    +
    +
    +
    + + + + + \ No newline at end of file diff --git a/9.3.3/user-guide/31-usage.html b/9.3.3/user-guide/31-usage.html new file mode 100644 index 000000000..9ead528ed --- /dev/null +++ b/9.3.3/user-guide/31-usage.html @@ -0,0 +1,483 @@ + + + + + + + +Usage + + + + + + +
    +
    +

    1. Usage

    +
    +
    Groovy
    +
    +
    plugins {
+    id 'java'
+    id 'org.springframework.boot' version '2.0.3.RELEASE'
+    id 'com.bmuschko.docker-spring-boot-application' version '9.3.3'
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    plugins {
+    java
+    id("org.springframework.boot") version "2.0.3.RELEASE"
+    id("com.bmuschko.docker-spring-boot-application") version "9.3.3"
+}
    +
    +
    +
    +
    + + + + + \ No newline at end of file diff --git a/9.3.3/user-guide/32-extension.html b/9.3.3/user-guide/32-extension.html new file mode 100644 index 000000000..3e73487fd --- /dev/null +++ b/9.3.3/user-guide/32-extension.html @@ -0,0 +1,561 @@ + + + + + + + +Extension + + + + + + +
    +
    +

    1. Extension

    +
    +

    The plugin defines an extension with the namespace springBootApplication as a child of the docker namespace. By default, the main class will be configured automatically by looking for a class with a public static void main(String[]) method available in the classpath of the main source set. The main class needs to use the org.springframework.boot.autoconfigure.SpringBootApplication annotation to be discoverable.

    +
    +
    +

    The following properties can be configured:

    +
    + ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Property nameTypeDefault valueDescription

    baseImage

    Property<String>

    openjdk:11.0.16-jre-slim

    The Docker base image used for the Spring Boot application.

    maintainer

    Property<String>

    Value of system property user.name

    The maintainer of the image.

    user

    Property<String>

    None

    The user name (or UID) and optionally the user group (or GID) to use as the default user and group to run the container.

    ports

    ListProperty<Integer>

    [8080]

    The Docker image exposed ports.

    images

    SetProperty<String>

    [<project.group>/<applicationName>:<project.version>]

    The images used for the build and push operation.

    jvmArgs

    ListProperty<String>

    []

    The JVM arguments passed to the java command.

    mainClassName

    Property<String>

    A unique main class name discovered by scanning the classpath

    The main class name to use for starting the application. Setting an explicit value for this option is useful if your source code contains multiple main class files.

    args

    ListProperty<String>

    []

    The program arguments passed to the java command.

    +
    +
    Groovy
    +
    +
    docker {
+    springBootApplication {
+        baseImage = 'openjdk:8-alpine'
+        ports = [9090, 8080]
+        images = ['awesome-spring-boot:1.115', 'awesome-spring-boot:latest']
+        jvmArgs = ['-Dspring.profiles.active=production', '-Xmx2048m']
+    }
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    docker {
+    springBootApplication {
+        baseImage.set("openjdk:8-alpine")
+        ports.set(listOf(9090, 8080))
+        images.set(setOf("awesome-spring-boot:1.115", "awesome-spring-boot:latest"))
+        jvmArgs.set(listOf("-Dspring.profiles.active=production", "-Xmx2048m"))
+    }
+}
    +
    +
    +
    +
    + + + + + \ No newline at end of file diff --git a/9.3.3/user-guide/33-tasks.html b/9.3.3/user-guide/33-tasks.html new file mode 100644 index 000000000..8147ca3cc --- /dev/null +++ b/9.3.3/user-guide/33-tasks.html @@ -0,0 +1,508 @@ + + + + + + + +Tasks + + + + + + +
    +
    +

    1. Tasks

    +
    +

    The plugin provides a set of tasks for your project and preconfigures them with sensible defaults.

    +
    + ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Task nameDepends OnTypeDescription

    dockerSyncBuildContext

    classes

    TaskProvider<{uri-gradle-docs}/javadoc/org/gradle/api/tasks/Sync.html[Sync]>

    Copies the application files to a temporary directory for image creation.

    dockerCreateDockerfile

    dockerSyncBuildContext

    TaskProvider<{uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/image/Dockerfile.html[Dockerfile]>

    Creates the Docker image for the Spring Boot application.

    dockerBuildImage

    dockerCreateDockerfile

    TaskProvider<{uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/image/DockerBuildImage.html[DockerBuildImage]>

    Builds the Docker image for the Spring Boot application.

    dockerPushImage

    dockerBuildImage

    TaskProvider<{uri-ghpages}/api/com/bmuschko/gradle/docker/tasks/image/DockerPushImage.html[DockerPushImage]>

    Pushes created Docker image to the repository.

    +
    +
    + + + + + \ No newline at end of file diff --git a/9.3.3/user-guide/34-dockerfile.html b/9.3.3/user-guide/34-dockerfile.html new file mode 100644 index 000000000..30ef75700 --- /dev/null +++ b/9.3.3/user-guide/34-dockerfile.html @@ -0,0 +1,481 @@ + + + + + + + +Generated Dockerfile + + + + + + +
    +
    +

    1. Generated Dockerfile

    +
    +

    The following Dockerfile shows the typical instructions generated by the plugin. It uses the default values defined by the extension. The resolved main class name is com.bmuschko.gradle.docker.springboot.Application.

    +
    +
    +
    Dockerfile
    +
    +
    FROM openjdk:11-jre-slim
+LABEL maintainer=bmuschko
+WORKDIR /app
+COPY libs libs/
+COPY classes classes/
+ENTRYPOINT ["java", "-cp", "/app/resources:/app/classes:/app/libs/*", "com.bmuschko.gradle.docker.springboot.Application"]
+EXPOSE 8080
    +
    +
    +
    +

    See additional examples for information on how to modify the Dockerfile instructions.

    +
    +
    +
    + + + + + \ No newline at end of file diff --git a/9.3.3/user-guide/35-examples.html b/9.3.3/user-guide/35-examples.html new file mode 100644 index 000000000..3fd72c99f --- /dev/null +++ b/9.3.3/user-guide/35-examples.html @@ -0,0 +1,585 @@ + + + + + + + +Examples + + + + + + +
    +
    +

    1. Examples

    +
    +

    The following usage examples demonstrate code for common use cases. More scenarios can be found in the {uri-github}/blob/master/src/functTest/groovy/com/bmuschko/gradle/docker/DockerSpringBootApplicationPluginFunctionalTest.groovy[functional tests].

    +
    +
    +

    1.1. Using the Plugin For an Application Run on Tomcat

    +
    +

    The Spring Boot archive can be created as executable JAR or WAR file. If you are target environment is a Servlet Container or Application Server, the WAR file is likely the better option. To generate a WAR file, simply apply the war plugin and declare the appropriate container-related dependencies to run the application locally.

    +
    +
    +
    Groovy
    +
    +
    plugins {
+    id 'war'
+    id 'org.springframework.boot' version '2.0.3.RELEASE'
+    id 'io.spring.dependency-management' version '1.0.5.RELEASE'
+    id 'com.bmuschko.docker-spring-boot-application' version '9.3.3'
+}
+
+version = '1.0'
+sourceCompatibility = JavaVersion.VERSION_1_8
+targetCompatibility = JavaVersion.VERSION_1_8
+
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+    implementation 'org.springframework.boot:spring-boot-starter-web'
+    providedRuntime 'org.springframework.boot:spring-boot-starter-tomcat'
+    providedRuntime 'org.apache.tomcat.embed:tomcat-embed-jasper'
+}
+
+docker {
+    springBootApplication {
+        baseImage = 'openjdk:8-alpine'
+    }
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    plugins {
+    war
+    id("org.springframework.boot") version "2.0.3.RELEASE"
+    id("io.spring.dependency-management") version "1.0.5.RELEASE"
+    id("com.bmuschko.docker-spring-boot-application") version "9.3.3"
+}
+
+version = "1.0"
+
+java {
+    sourceCompatibility = JavaVersion.VERSION_1_8
+    targetCompatibility = JavaVersion.VERSION_1_8
+}
+
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+    implementation("org.springframework.boot:spring-boot-starter-web")
+    providedRuntime("org.springframework.boot:spring-boot-starter-tomcat")
+    providedRuntime("org.apache.tomcat.embed:tomcat-embed-jasper")
+}
+
+docker {
+    springBootApplication {
+        baseImage.set("openjdk:8-alpine")
+    }
+}
    +
    +
    +
    +
    +

    1.2. Providing Container Build-Time and Runtime Parameters

    +
    +

    It’s common practice to provide JVM parameters to a Spring Boot application running in a container. For example, you might want to provide memory parameters or set a specific Spring profile. There’s a two ways to achieve this. Each of them serve different use cases.

    +
    +
    +

    You may want to provide JVM parameters when you build the image with a Dockerfile. That’s likely the case if you don’t want to change the parameters later when running the image in a container. You can provide a list of JVM parameters that should be baked into image with the extension property jvmArgs.

    +
    +
    +

    Hard-coding a JVM parameter may not be the right solution to your problem. There are situations when you want to provide runtime behavior when starting the container. A typical example is a Spring profile that needs to be enabled depending on the environment you want to run.

    +
    +
    +

    If you are running the image with Docker, then you can just provide pre-built environment variables known to Spring Boot. Below, we are running an application with the prod profile.

    +
    +
    +
    +
    $ docker run -e "SPRING_PROFILES_ACTIVE=prod" -p 8080:8080 -t my-spring-boot-app:1.2.3
    +
    +
    +
    +

    You can achieve the same behavior in Kubernetes by defining an environment variable in your Pod or Deployment spec. The example below demonstrates the use of a Deployment.

    +
    +
    +
    deployment.yaml
    +
    +
    kind: Deployment
+apiVersion: apps/v1
+metadata:
+  name: my-spring-boot-app
+spec:
+  replicas: 3
+  selector:
+    matchLabels:
+      app: my-spring-boot-app
+  template:
+    metadata:
+      labels:
+        app: my-spring-boot-app
+    spec:
+      containers:
+        - name: my-spring-boot-app
+          image: my-spring-boot-app:1.2.3
+          env:
+          - name: SPRING_PROFILES_ACTIVE
+            value: prod
    +
    +
    +
    +
    +
    + + + + + \ No newline at end of file diff --git a/9.3.3/user-guide/40-changes.html b/9.3.3/user-guide/40-changes.html new file mode 100644 index 000000000..32feda7a4 --- /dev/null +++ b/9.3.3/user-guide/40-changes.html @@ -0,0 +1,2193 @@ + + + + + + + +Change Log + + + + + + +
    +
    +

    1. Change Log

    +
    +

    v9.3.3 (September 20, 2023)

    +
    +
      +
    • +

      Make DockerRemoteApi plugin configuration cache compatible for Gradle 8.1+ - {uri-github}/pull/1193[PR 1193]

      +
      • +
    +
    +

    v9.3.2 (July 31, 2023)

    +
    +
      +
    • +

      Fail build upon error with push operation - {uri-github}/pull/1183[PR 1183]

      +
      • +
    • +

      Upgrade Docker Java to 3.3.2 - {uri-github}/pull/1187[PR 1187]

      +
      • +
    • +

      Upgrade ASM to 9.5 - {uri-github}/pull/1188[PR 1188]

      +
      • +
    +
    +

    v9.3.1 (April 8, 2023)

    +
    +
      +
    • +

      Revert automatically setting JAVA_OPTS environment variable - {uri-github}/pull/1176[PR 1176]

      +
      • +
    +
    +

    v9.3.0 (March 20, 2023)

    +
    +
      +
    • +

      Introduce property for setting a USER instruction in convention plugin extension - {uri-github}/pull/1166[PR 1166]

      +
      • +
    • +

      Add JAVA_OPTS to entrypoint instruction - {uri-github}/pull/1167[PR 1167]

      +
      • +
    • +

      Allow for setting platform for Dockerfile task - {uri-github}/pull/1170[PR 1170]

      +
      • +
    • +

      Upgrade Docker Java to 3.3.0 - {uri-github}/pull/1171[PR 1171]

      +
      • +
    +
    +

    v9.2.1 (February 7, 2023)

    +
    +
      +
    • +

      Correct input annotation for imageFile property of DockerLoadImage task - {uri-github}/pull/1164[PR 1164]

      +
      • +
    • +

      Fix NullPointer on docker hosts with <none> tags in DockerSaveImage task - {uri-github}/pull/1163[PR 1163]

      +
      • +
    +
    +

    v9.2.0 (January 31, 2023)

    +
    +
      +
    • +

      Revert shading of Docker Java - {uri-github}/pull/1154[PR 1154]

      +
      • +
    • +

      Writer type is not compatible with configuration cache - {uri-github}/pull/1155[PR 1155]

      +
      • +
    • +

      Assign correct annotation for DockerCopyFileToContainer property - {uri-github}/pull/1156[PR 1156]

      +
      • +
    • +

      Deprecate withCommand methods for DockerExecContainer task - {uri-github}/pull/1161[PR 1161]

      +
      • +
    +
    +

    v9.1.0 (December 20, 2022)

    +
    +
      +
    • +

      Fix shading of Docker Java and its transitive dependencies - {uri-github}/pull/1144[PR 1144]

      +
      • +
    • +

      Upgrade to Docker Java to 3.2.14 - {uri-github}/pull/1142[PR 1142]

      +
      • +
    • +

      Don’t use set method to define task default property values - {uri-github}/pull/1124[PR 1124]

      +
      • +
    • +

      Convert production source code from Groovy to Java - {uri-github}/pull/1117[PR 1117]

      +
      • +
    +
    +

    v9.0.1 (November 16, 2022)

    +
    +
      +
    • +

      Correct links in user guide that point to outdated API docs - {uri-github}/pull/1122[PR 1122]

      +
      • +
    +
    +

    v9.0.0 (November 12, 2022)

    +
    +
      +
    • +

      Configuration cache support - {uri-github}/issues/1102[Issue 1102]

      +
      • +
    • +

      Support Java up to version 20 with latest ASM library - {uri-github}/pull/1107[PR 1107]

      +
      • +
    • +

      Introduce extension attribute for setting program arguments in convention plugins - {uri-github}/pull/1105[PR 1105]

      +
      • +
    • +

      Breaking Change! Expose repository and tag properties for DockerCommitImage task - {uri-github}/pull/1101[PR 1101]

      +
      • +
    • +

      Support auto-detection DOCKER_HOST on macOS Ventura with latest Docker Desktop - {uri-github}/pull/1111[PR 1111]

      +
      • +
    +
    +

    v8.1.0 (September 20, 2022)

    +
    +
      +
    • +

      Fix custom registry in logs for DockerPullImage and DockerPushImage tasks - {uri-github}/pull/1091[PR 1091]

      +
      • +
    • +

      Add "add" and "drop" host config capability to DockerCreateContainer task - {uri-github}/pull/1087[PR 1087]

      +
      • +
    • +

      Split end user and developer guides - {uri-github}/pull/1089[PR 1089]

      +
      • +
    +
    +

    v8.0.0 (August 9, 2022)

    +
    +
      +
    • +

      Make DockerSaveImage task out of date if the input state on the daemon changed - {uri-github}/pull/1073[PR 1073]

      +
      • +
    • +

      Proper handling of onNext callbacks in DockerLogsContainer task - {uri-github}/pull/1083[PR 1083]

      +
      • +
    • +

      Close InputStream to avoid too many file handles when searching for main class - {uri-github}/pull/1081[PR 1081]

      +
      • +
    • +

      Support multiple images for DockerSaveImage task - {uri-github}/pull/1069[PR 1069]

      +
      • +
    • +

      Add IPAM configuration for a network in DockerCreateNetwork task - {uri-github}/pull/1080[PR 1080]

      +
      • +
    • +

      Make DockerBuildImage task out-of-date if configured tags are missing - {uri-github}/pull/1072[PR 1072]

      +
      • +
    • +

      Add support for docker tmpfs mounts in DockerCreateContainer task - {uri-github}/pull/1036[PR 1036]

      +
      • +
    • +

      Upgrade to Gradle 7, use version catalog - {uri-github}/pull/1075[PR 1075]

      +
      • +
    • +

      Use a stable tag for OpenJDK base image - {uri-github}/pull/1074[PR 1074]

      +
      • +
    +
    +

    v7.4.0 (May 23, 2022)

    +
    +
      +
    • +

      Credentials in the config.json are overwritten by default (but unset) auth-config - {uri-github}/pull/1065[PR 1065]

      +
      • +
    • +

      DockerBuildImage task creates image ID file and parent directory if it doesn’t exist - {uri-github}/pull/1064[PR 1064]

      +
      • +
    +
    +

    v7.3.0 (March 1, 2022)

    +
    +
      +
    • +

      Upgrade to Docker Java 3.2.13 - {uri-github}/pull/1058[PR 1058]

      +
      • +
    • +

      Fix images property in DockerSpringBootApplication javadoc - {uri-github}/pull/1057[PR 1057]

      +
      • +
    • +

      Introduce memory property in DockerBuildImage custom task - {uri-github}/pull/1053[PR 1053]

      +
      • +
    +
    +

    v7.2.0 (January 6, 2022)

    +
    +
      +
    • +

      Upgrade to Docker Java 3.2.12 - {uri-github}/pull/1042[PR 1042]

      +
      • +
    • +

      Better transparency for the generated Dockerfile in user guide - {uri-github}/pull/1028[PR 1028]

      +
      • +
    +
    +

    v7.1.0 (June 28, 2021)

    +
    +
      +
    • +

      Upgrade to Docker Java 3.2.10 - {uri-github}/pull/1025[PR 1025]

      +
      • +
    • +

      Introduce platform parameter for build image task - {uri-github}/pull/1024[PR 1024]

      +
      • +
    • +

      Introduce platform parameter for create container task - {uri-github}/pull/1026[PR 1026]

      +
      • +
    +
    +

    v7.0.1 (June 9, 2021)

    +
    +
      +
    • +

      Reduce Docker Java dependency size - {uri-github}/pull/1016[PR 1016]

      +
      • +
    • +

      Bump ASM opcode version for JVM convention plugins - {uri-github}/pull/1012[PR 1012]

      +
      • +
    • +

      Improve Groovydoc documentation of Dockerfile task - {uri-github}/pull/1017[PR 1017]

      +
      • +
    +
    +

    v7.0.0 (May 2, 2021)

    +
    +
      +
    • +

      Breaking Change! Change source and target compatibility of plugin to Java 11

      +
      • +
    • +

      Breaking Change! Correct method signature of Dockerfile.addFile(Dockerfile.File file) - {uri-github}/issues/990[Issue 990]

      +
      • +
    • +

      Preserve documentation per version - {uri-github}/pull/998[PR 998]

      +
      • +
    • +

      Upgrade ASM for JDK 16 support - {uri-github}/pull/1002[PR 1002]

      +
      • +
    • +

      Breaking Change! Upgrade image to Java 11 for convention plugins - {uri-github}/pull/1006[PR 1005]

      +
      • +
    • +

      Breaking Change! Upgrade to Docker Java 3.2.8 - {uri-github}/pull/1006[PR 1005]

      +
      • +
    • +

      Breaking Change! Remove extra tasks - {uri-github}/pull/1004[PR 1004]

      +
      • +
    • +

      Publish plugin artifacts Gradle Plugin Portal instead of Bintray JCenter - {uri-github}/pull/1001[PR 1001]

      +
      • +
    • +

      Explicitly spell out fully qualified class references to inner classes Dockerfile.File and Dockerfile.CopyFile - {uri-github}/pull/997[PR 997]

      +
      • +
    +
    +

    v6.7.0 (January 10, 2021)

    +
    +
      +
    • +

      Turn on RegistryAuthLocator for Windows - {uri-github}/pull/974[PR 974]

      +
      • +
    • +

      Handle missing ServerURL from auth helper response - {uri-github}/pull/959[PR 959]

      +
      • +
    • +

      Add support for health check in DockerCreateContainer custom task - {uri-github}/pull/978[PR 978]

      +
      • +
    • +

      Deprecate extra tasks - {uri-github}/pull/981[PR 981]

      +
      • +
    • +

      Remove Netty exec factory support - {uri-github}/pull/963[PR 963]

      +
      • +
    +
    +

    v6.6.1 (July 29, 2020)

    +
    +
      +
    • +

      Mapping of DSL property images should propagate down to build and push task in convention plugins - {uri-github}/pull/956[PR 956]

      +
      • +
    +
    +

    v6.6.0 (July 16, 2020)

    +
    +
      +
    • +

      Use configuration avoidance API in convention plugins - {uri-github}/pull/940[PR 940]

      +
      • +
    • +

      Configured registry credentials in build script should take precedence over Docker credential helper - {uri-github}/pull/945[PR 945]

      +
      • +
    +
    +

    v6.5.0 (July 3, 2020)

    +
    +
      +
    • +

      Default to Docker Hub when no registry is explicitly given - {uri-github}/pull/942[PR 942]

      +
      • +
    • +

      Upgrade of Docker Java library to version 3.2.5 and default to communication transport to Apache HttpClient 5 - {uri-github}/pull/942[PR 942]

      +
      • +
    +
    +

    v6.4.0 (March 23, 2020)

    +
    +
      +
    • +

      Keep the network name and network ID separate in DockerCreateNetwork - {uri-github}/pull/920[PR 920]

      +
      • +
    • +

      Upgrade ASM dependency to Java 13/14-compatible version - {uri-github}/pull/929[PR 929]

      +
      • +
    +
    +

    v6.3.0 (March 14, 2020)

    +
    +
      +
    • +

      Retrieve all known credentials for DockerBuildImage custom task - {uri-github}/pull/913[PR 913]

      +
      • +
    • +

      Add support for setting custom workingDir in DockerExecContainer task - {uri-github}/pull/927[PR 927]

      +
      • +
    +
    +

    v6.2.0 (March 10, 2020)

    +
    +
      +
    • +

      Upgrade Docker Java to next minor version - {uri-github}/pull/925[PR 925]

      +
      • +
    • +

      Expose property for providing extra hosts - {uri-github}/pull/926[PR 926]

      +
      • +
    +
    +

    v6.1.4 (February 23, 2020)

    +
    +
      +
    • +

      Nested property FileInstruction.getFile() renders warning as it doesn’t provide input or output annotation - {uri-github}/issues/919[Issue 919]

      +
      • +
    +
    +

    v6.1.3 (January 26, 2020)

    +
    +
      +
    • +

      Credentials helper JSON output parsing falls back to default if it cannot be read properly - {uri-github}/pull/909[PR 909]

      +
      • +
    +
    +

    v6.1.2 (January 14, 2020)

    +
    +
      +
    • +

      Decode base64 auth header - {uri-github}/pull/902[PR 902]

      +
      • +
    +
    +

    v6.1.1 (December 12, 2019)

    +
    +
      +
    • +

      Add debug logging in Docker configuration parsing - {uri-github}/pull/898[PR 898]

      +
      • +
    +
    +

    v6.1.0 (December 12, 2019)

    +
    +
      +
    • +

      Allow configuring the main class name for convention plugins - {uri-github}/pull/892[PR 892]

      +
      • +
    • +

      Do not parse config file if it doesn’t exist - {uri-github}/issues/887[Issue 887]

      +
      • +
    +
    +

    v6.0.0 (November 16, 2019)

    +
    +
      +
    • +

      Breaking Change! Multi-tag support for push operation and convention plugins - {uri-github}/pull/867[PR 867]

      +
      • +
    • +

      Breaking Change! Renamed property tags to images for extensions DockerJavaApplication and DockerSpringBootApplication.

      +
      • +
    • +

      Breaking Change! Renamed property tag to image for custom tasks DockerBuildImage, DockerCommitImage, DockerPullImage, DockerSaveImage, DockerListImages,DockerCreateContainer.

      +
      • +
    • +

      Breaking Change! Removal of method DockerPullImage.getImageId(). Use DockerPullImage.getImage() instead.

      +
      • +
    • +

      Breaking Change! Host-related configuration properties in DockerCreateContainer have been moved to nested property for better maintainability - {uri-github}/pull/873[PR 873]

      +
      • +
    • +

      Add properties ipcMode and sysctls to DockerCreateContainer - {uri-github}/pull/862[PR 862]

      +
      • +
    • +

      Gradle 6.0 compatibility fixes - {uri-github}/pull/869[PR 869]

      +
      • +
    • +

      Improve DSL for configuring registry credentials for custom tasks - {uri-github}/pull/879[PR 879]

      +
      • +
    • +

      Plugin resolves and uses Docker credential helper - {uri-github}/pull/865[PR 865]

      +
      • +
    • +

      Upgrade of Docker Java library to version 3.1.5

      +
      • +
    +
    +

    v5.3.0 (October 30, 2019)

    +
    +
      +
    • +

      Expose project-prop/sys-prop/env-var to optionally use netty-exec-cmd-factory - {uri-github}/pull/876[PR 876]

      +
      • +
    +
    +

    v5.2.0 (October 5, 2019)

    +
    +
      +
    • +

      Potentially Breaking Change! Remove duplicated code in convention plugins - {uri-github}/pull/864[PR 864]

      +
      • +
    • +

      Restore compatibility with Gradle 5.1 as runtime version - {uri-github}/issue/866[Issue 866]

      +
      • +
    +
    +

    v5.1.0 (September 18, 2019)

    +
    +
      +
    • +

      Potentially Breaking Change! Remove remaining use of Application Plugin in convention plugins - {uri-github}/pull/852[PR 852]

      +
      • +
    +
    +

    v5.0.0 (August 13, 2019)

    +
    +
      +
    • +

      Breaking Change! Remove exec/cmd hooks in Docker application plugin - {uri-github}/pull/806[PR 806]

      +
      • +
    • +

      Breaking Change! API cleanup of Dockerfile task - {uri-github}/pull/812[PR 812]

      +
      • +
    • +

      Breaking Change! Removed ItemJoiner from public API - {uri-github}/pull/836[PR 836]

      +
      • +
    • +

      Respect symlinks in build context - {uri-github}/issue/837[Issue 837]

      +
      • +
    +
    +

    v4.10.0 (June 12, 2019)

    +
    +
      +
    • +

      Expose target property for BuildImageTask - {uri-github}/pull/813[PR 813]

      +
      • +
    • +

      Remove final from DockerBuildImage.labels property - {uri-github}/pull/823[PR 823]

      +
      • +
    • +

      Always set imageId within DockerBuildImage on success - {uri-github}/pull/819[PR 819]

      +
      • +
    +
    +

    v4.9.0 (May 25, 2019)

    +
    +
      +
    • +

      Avoid memory leakage by replacing addShutdownHook with Gradle.buildFinished - {uri-github}/pull/810[PR 810]

      +
      • +
    • +

      DockerBuildImage will print whole lines by collecting output and waiting for newline - {uri-github}/pull/799[PR 799]

      +
      • +
    • +

      DockerBuildImage reinstated ImageId output file and check in Docker registry - {uri-github}/pull/807[PR 807]

      +
      • +
    +
    +

    v4.8.1 (May 11, 2019)

    +
    +
      +
    • +

      Introduce maintainer property to extension of Spring Boot application plugin - {uri-github}/issues/779[Issue 779]

      +
      • +
    • +

      Breaking Change! Removed RepositoriesFallbackPlugin that was applied automatically - {uri-github}/issues/794[Issue 794]

      +
      • +
    • +

      Breaking Change! The Docker client in AbstractDockerRemoteApiTask is not inject into the method runRemoteCommand anymore - {uri-github}/issues/802[Issue 802]

      +
      • +
    +
    +

    v4.8.0 (April 22, 2019)

    +
    +
      +
    • +

      Expose extension property for configuring JVM arguments - {uri-github}/pull/790[PR 790]

      +
      • +
    +
    +

    v4.7.1 (April 13, 2019)

    +
    + +
    +

    v4.7.0 (April 9, 2019)

    +
    +
      +
    • +

      Tasks created by convention plugins should assign a task group - {uri-github}/issues/768[Issue 768]

      +
      • +
    • +

      Main class detection should work with a Kotlin-based application - {uri-github}/issues/766[Issue 766]

      +
      • +
    • +

      Fix gradle 5.x deprecation warnings - {uri-github}/issues/782[Issue 782]

      +
      • +
    • +

      Bump docker-java to 3.1.2 - {uri-github}/issues/787[Issue 787]

      +
      • +
    +
    +

    v4.6.2 (March 9, 2019)

    +
    +
      +
    • +

      Add shaded JAF dependency to simplify usage of plugin with Java 11 - {uri-github}/issues/764[Issue 764]

      +
      • +
    +
    +

    v4.6.1 (March 6, 2019)

    +
    +
      +
    • +

      Fix setting binds in DockerCreateContainer task - {uri-github}/issues/758[Issue 758]

      +
      • +
    +
    +

    v4.6.0 (March 3, 2019)

    +
    +
      +
    • +

      Breaking Change! Plugin declares and uses Docker Java as runtime library - {uri-github}/pull/751[PR 751]

      +
      • +
    • +

      Breaking Change! Custom task DockerClient has been renamed to DockerOperation to avoid conflicting Docker Java class name

      +
      • +
    • +

      Shade plugin dependencies except Docker Java - {uri-github}/pull/755[PR 755]

      +
      • +
    +
    +

    v4.5.0 (February 19, 2019)

    +
    +
      +
    • +

      Dockerfile.FileInstruction does not use flags if Dockerfile.File is passed in using a Provider - {uri-github}/pull/753[PR 753]

      +
      • +
    • +

      Inline main class finder and avoid explicit dependency on Spring Boot - {uri-github}/pull/752[PR 752]

      +
      • +
    +
    +

    v4.4.1 (February 5, 2019)

    +
    +
      +
    • +

      Cannot set publishAll property without error - {uri-github}/pull/742[PR 742]

      +
      • +
    +
    +

    v4.4.0 (January 31, 2019)

    +
    +
      +
    • +

      Breaking Change! Define image with more fine-grained image layers - {uri-github}/pull/736[PR 736]

      +
      • +
    • +

      Bump docker-java-shaded to latest version - {uri-github}/pull/729[PR 729]

      +
      • +
    • +

      Task DockerCreateContainer gained option groups - {uri-github}/pull/731[Pull Request 731]

      +
      • +
    +
    +

    v4.3.0 (January 12, 2019)

    +
    +
      +
    • +

      Breaking Change! The task DockerLoadImage should use Provider type for image file

      +
      • +
    • +

      Breaking Change! Use the default value $buildDir/docker for DockerBuildImage.inputDir to align with the default directory of the Dockerfile task

      +
      • +
    • +

      Breaking Change! Align task names in DockerJavaApplicationPlugin with the ones from the DockerSpringBootApplicationPlugin

      +
      • +
    • +

      Examples in user guide that demonstrate the creation of a custom Docker task and the modification of existing Dockerfile instructions

      +
      • +
    +
    +

    v4.2.0 (December 16, 2018)

    +
    +
      +
    • +

      Applying the Docker Spring Boot application plugin with the plugins DSL should not fail - {uri-github}/issues/702[Issue 702]

      +
      • +
    • +

      Breaking Change! Remove all deprecations - {uri-github}/issues/675[Issue 675]

      +
      +
        +
      • +

        Removed DockerCreateContainer.env, replaced by DockerCreateContainer.envVars

        +
        • +
      • +

        Removed DockerBuildImage.tag, replaced by DockerBuildImage.tags

        +
        • +
      • +

        Removed DockerExecContainer.cmd, replaced by DockerExecContainer.commands

        +
        • +
      • +

        Removed DockerExecContainer.execId, replaced by DockerExecContainer.execIds

        +
        • +
      +
      +
      • +
    • +

      DockerBuildImage.tags.add/addAll only work after using tags.set - {uri-github}/issues/712[Issue 712]

      +
      • +
    • +

      User guide sample on Docker links should not use doFirst - {uri-github}/issues/715[Issue 715]

      +
      • +
    • +

      DockerCommitImage task should not fail when accessing container ID property value - {uri-github}/issues/718[Issue 718]

      +
      • +
    +
    +

    v4.1.0 (November 29, 2018)

    +
    +
      +
    • +

      Ensure compatibility with Gradle 5.0 - {uri-github}/pull/693[Pull Request 709]

      +
      • +
    • +

      Breaking Change! The existing field timeout in custom tasks had to be renamed due to Gradle’s 5.0 built-in timeout feature

      +
      • +
    +
    +

    v4.0.5 (November 22, 2018)

    +
    +
      +
    • +

      Avoid the use of application plugin extension to ensure compatibility - {uri-github}/issues/706[Issue 706]

      +
      • +
    +
    +

    v4.0.4 (November 4, 2018)

    +
    +
      +
    • +

      Implementation to make DockerBuildImage task incremental and cacheable is not sufficient - {uri-github}/issues/697[Issue 697]

      +
      • +
    +
    +

    v4.0.3 (October 30, 2018)

    +
    +
      +
    • +

      Correctly handle the case where inputDir is not where dockerFile is located - {uri-github}/pull/693[Pull Request 693]

      +
      • +
    +
    +

    v4.0.2 (October 27, 2018)

    +
    +
      +
    • +

      Output file name containing the image ID created by DockerBuildImage should work on Windows - {uri-github}/pull/690[Pull Request 690]

      +
      • +
    +
    +

    v4.0.1 (October 20, 2018)

    +
    +
      +
    • +

      Returned image ID for a DockerBuildImage task should never be null - {uri-github}/pull/687[Pull Request 687]

      +
      • +
    +
    +

    v4.0.0 (October 12, 2018)

    +
    +
      +
    • +

      Breaking Change! Use Provider concept throughout to support lazy evaluation via public API - {uri-github}/pull/659[Pull Request 659]

      +
      • +
    • +

      Breaking Change! Consumers of this plugin will have to use Java 8 or higher - {uri-github}/pull/676[Pull Request 676]

      +
      • +
    • +

      Breaking Change! Removal of AbstractReactiveStreamsTask from inherited custom task hierarchy

      +
      • +
    • +

      NEW Add tested, multi-lingual user guide - {uri-github}/pull/677[Pull Request 677]

      +
      • +
    • +

      NEW Make DockerBuildImage task incremental and cacheable - {uri-github}/pull/672[Pull Request 672]

      +
      • +
    • +

      Introduce method for translating username/password into a PasswordCredentials - {uri-github}/pull/668[Pull Request 668]

      +
      • +
    • +

      Add @CompileStatic to much of the code base that can support it - {uri-github}/pull/676[Pull Request 676]

      +
      • +
    • +

      Use appropriate types for Groovy/Kotlin DSL interoperability for reactive streams functionality - {uri-github}/pull/678[Pull Request 678]

      +
      • +
    +
    +

    v3.6.2 (October 2, 2018)

    +
    +
      +
    • +

      DockerCreateContainer gained pid option - {uri-github}/pull/652[Pull Request 652]

      +
      • +
    • +

      Dockerfile validation takes into account comments - {uri-github}/issues/657[Issue 657]

      +
      • +
    • +

      Bump docker-java-shaded to rc-5 - {uri-github}/issues/660[Issue 660]

      +
      • +
    • +

      DockerBuildImage gained network option - {uri-github}/issues/608[Issue 608]

      +
      • +
    • +

      DockerCreateContainer gained autoRemove option - {uri-github}/issues/639[Issue 639]

      +
      • +
    +
    +

    v3.6.1 (August 21, 2018)

    +
    +
      +
    • +

      Task DockerClient, and the passed dockerClient object, is now cached by configuration - {uri-github}/pull/644[Pull Request 644]

      +
      • +
    • +

      Task DockerBuildImage gained option cacheFrom - {uri-github}/pull/646[Pull Request 646]

      +
      • +
    +
    +

    v3.6.0 (August 7, 2018)

    +
    +
      +
    • +

      Use smaller base images for convention plugins - {uri-github}/pull/636[Pull Request 636]

      +
      • +
    • +

      Fully deprecate MAINTAINER instruction and replace with LABEL - {uri-github}/pull/635[Pull Request 635]

      +
      • +
    • +

      Make Dockerfile task cacheable via Gradle build cache - {uri-github}/pull/641[Pull Request 641]

      +
      • +
    +
    +

    v3.5.0 (July 24, 2018)

    +
    +
      +
    • +

      Support for dockerizing Spring Boot applications - {uri-github}/pull/619[Pull Request 619]

      +
      • +
    • +

      Removed deprecated ResponseHandler - {uri-github}/pull/624[Pull Request 624]

      +
      • +
    • +

      Introduce user guide for more readable, maintainable documentation - {uri-github}/pull/630[Pull Request 630]

      +
      • +
    • +

      Upgrade to Gradle Wrapper 4.9

      +
      • +
    +
    +

    v3.4.4 (July 15, 2018)

    +
    +
      +
    • +

      Task DockerLivenessContainer had its polling logic reworked to be more failure proof.

      +
      • +
    +
    +

    v3.4.3 (July 8, 2018)

    +
    +
      +
    • +

      Task DockerCreateContainer has its method withEnvVars changed to accept a def, which in turn can be anything (String, Integer, Closure, etc) but will eventually have all its keys/values resolved to java strings. - {uri-github}/pull/616[Pull Request 617]

      +
      • +
    • +

      Task DockerLivenessContainer had minor verbiage changes to its output. - {uri-github}/pull/616[Pull Request 617]

      +
      • +
    • +

      Use -all wrapper to better integrate with IDE’s. - {uri-github}/pull/616[Pull Request 617]

      +
      • +
    +
    +

    v3.4.2 (July 7, 2018)

    +
    +
      +
    • +

      Shade cglib and its dependencies. - {uri-github}/pull/616[Pull Request 616]

      +
      • +
    • +

      Bump docker-java to 3.1.0-rc-3. - {uri-github}/pull/616[Pull Request 616]

      +
      • +
    +
    +

    v3.4.1 (July 3, 2018)

    +
    +
      +
    • +

      BUGFIX for task DockerCreateContainer where envs were not being properly honored. - {uri-github}/pull/614[Pull Request 614]

      +
      • +
    +
    +

    v3.4.0 (July 1, 2018)

    +
    +
      +
    • +

      Task Dockerfile now supports multi-stage builds - {uri-github}/pull/607[Pull Request 607]

      +
      • +
    • +

      When plugin is applied to sub-projects we will additionally search rootProject for repos to use - {uri-github}/pull/610[Pull Request 610]

      +
      • +
    • +

      Task DockerCreateContainer has deprecated env in favor of envVars which can ONLY be added to with a helper method withEnvVar that can be called N times for setting environment variables. - {uri-github}/pull/609[Pull Request 609]

      +
      • +
    • +

      Task DockerLivenessProbeContainer has been renamed to DockerLivenessContainer. It’s probe method has been renamed to livnessProbe. Task DockerExecStopContainer had its probe method renamed to execStopProbe. - {uri-github}/pull/611[Pull Request 611]

      +
      • +
    +
    +

    v3.3.6 (June 23, 2018)

    +
    +
      +
    • +

      Task DockerCopyFileToContainer can now copy N number of files via methods withFile and withTarFile. - {uri-github}/pull/605[Pull request 605]

      +
      • +
    +
    +

    v3.3.5 (June 17, 2018)

    +
    +
      +
    • +

      Fix bug within DockerExecContainer when exitCode can be null (default to 0 if so). - {uri-github}/pull/602[Pull request 602]

      +
      • +
    +
    +

    v3.3.4 (June 16, 2018)

    +
    +
      +
    • +

      Task DockerExecContainer gained ability to specify multiple execution commands to be run. - {uri-github}/pull/600[Pull request 600]

      +
      • +
    • +

      Various tasks had their progress logger output cleaned up. - {uri-github}/pull/601[Pull request 601]

      +
      • +
    +
    +

    v3.3.3 (June 8, 2018)

    +
    +
      +
    • +

      Explicitly call toString() on values in maps passed to Docker API. - {uri-github}/pull/595[Pull request 595]

      +
      • +
    • +

      Task DockerLivenessProbeContainer gained method lastInspection() which will return the last "docker inspect container" response AFTER execution has completed. - {uri-github}/pull/596[Pull request 596]

      +
      • +
    +
    +

    v3.3.2 (June 5, 2018)

    +
    +
      +
    • +

      Task DockerLivenessProbeContainer now has the probe option set to optional and if NOT defined will fallback to checking if container is in a running state. - {uri-github}/pull/594[Pull request 594]

      +
      • +
    +
    +

    v3.3.1 (June 2, 2018)

    +
    +
      +
    • +

      Various minor refactorings surrounding new task DockerExecStopContainer. - {uri-github}/pull/592[Pull request 592]

      +
      • +
    +
    +

    v3.3.0 (June 1, 2018)

    +
    +
      +
    • +

      Added task DockerClient to pass the raw docker-java client to the onNext closure if defined. - {uri-github}/pull/589[Pull request 589]

      +
      • +
    • +

      Task DockerCreateContainer will now log the containerName if set, which is the standard within this plugin, otherwise fallback to the just created containerId.

      +
      • +
    • +

      Task DockerExecContainer gained option successOnExitCodes to allow user to define a list of successful exit codes the exec is allowed to return and will fail if not in list. Default behavior is to do no check. - {uri-github}/pull/590[Pull request 590]

      +
      • +
    • +

      Added task DockerLivenessProbeContainer which will poll, for some defined amount of time, a running containers logs looking for a given message and fail if not found. - {uri-github}/pull/587[Pull request 587]

      +
      • +
    • +

      Added task DockerExecStopContainer to allow the user to execute an arbitrary cmd against a container, polling for it to enter a non-running state, and if that does not succeed in time issue stop request. - {uri-github}/pull/591[Pull request 591]

      +
      • +
    +
    +

    v3.2.9 (May 22, 2018)

    +
    +
      +
    • +

      Fixed a bug in task DockerCreateContainer where option cpuset is now renamed differently in docker-java. - {uri-github}/pull/585[Pull request 585]

      +
      • +
    +
    +

    v3.2.8 (April 30, 2018)

    +
    +
      +
    • +

      Task DockerExecContainer gained option user to specify a user/group. - {uri-github}/pull/574[Pull request 574]

      +
      • +
    • +

      Task DockerCreateContainer gained option ipV4Address to specify a specific ipv4 address to use. - {uri-github}/pull/449[Pull request 449]

      +
      • +
    • +

      Bump gradle to 4.7. - {uri-github}/pull/578[Pull request 578]

      +
      • +
    +
    +

    v3.2.7 (April 19, 2018)

    +
    +
      +
    • +

      Task DockerSaveImage gained option useCompression to optionally gzip the created tar. - {uri-github}/pull/565[Pull request 565]

      +
      • +
    • +

      Add javax.activation dependency for users who are working with jdk9+. - {uri-github}/pull/572[Pull request 572]

      +
      • +
    +
    +

    v3.2.6 (March 31, 2018)

    +
    +
      +
    • +

      Cache docker-java client instead of recreating for every request/task invocation. This is a somewhat big internal change but has a lot of consequences and so it was deserving of its own point release. - {uri-github}/pull/558[Pull request 558]

      +
      • +
    +
    +

    v3.2.5 (March 2, 2018)

    +
    +
      +
    • +

      Added macAddress option to task DockerCreateContainer - {uri-github}/pull/538[Pull request 538]

      +
      • +
    • +

      Initial work for codenarc analysis - {uri-github}/pull/537[Pull request 537]

      +
      • +
    • +

      Use of docker-java-shaded library in favor of docker-java proper to get around class-loading/clobbering issues - {uri-github}/pull/550[Pull request 550]

      +
      • +
    • +

      Honor DOCKER_CERT_PATH env var if present - {uri-github}/pull/549[Pull request 549]

      +
      • +
    • +

      Task DockerSaveImage will now create file for you should it not exist - {uri-github}/pull/552[Pull request 552]

      +
      • +
    • +

      Task DockerPushImage will now include tag info in logging if applicable - {uri-github}/pull/554[Pull request 554]

      +
      • +
    • +

      !!!!! BREAKING: Property inputStream of task DockerLoadImage has been changed from type InputStream to Closure<InputStream>. This was done to allow scripts/code/pipelines to delay getting the image and side-step this property getting configured during gradles config-phase. - {uri-github}/pull/552[Pull request 552]

      +
      • +
    +
    +

    v3.2.4 (February 5, 2018)

    +
    +
      +
    • +

      Use openjdk as a default image in DockerJavaApplicationPlugin - {uri-github}/pull/528[Pull request 528]

      +
      • +
    • +

      Add skipMaintainer to DockerJavaApplication - {uri-github}/pull/529[Pull request 529]

      +
      • +
    • +

      Can now define labels in DockerCreateContainer task - {uri-github}/pull/530[Pull request 530]

      +
      • +
    • +

      Added task DockerRenameContainer - {uri-github}/pull/533[Pull request 533]

      +
      • +
    +
    +

    v3.2.3 (January 26, 2018)

    +
    +
      +
    • +

      If DockerWaitHealthyContainer is run on an image which was not built with HEALTHCHECK than fallback to using generic status - {uri-github}/pull/520[Pull request 520]

      +
      • +
    +
    +

    v3.2.2 (January 17, 2018)

    +
    +
      +
    • +

      Bump gradle to 4.3.1 - {uri-github}/pull/500[Pull request 500]

      +
      • +
    • +

      Bug fix for {uri-github}/issues/490[Issue 490] wherein on* reactive-stream closures are evaluated with null exception when using gradle-4.3 - {uri-github}/commit/93b80f2bd18c4f04d0f58443b45c59cb58a54e77[Commit 93b80f]

      +
      • +
    • +

      Support for zero exposed ports in DockerJavaApplication - {uri-github}/pull/504[Pull request 504]

      +
      • +
    +
    +

    v3.2.1 (November 22, 2017)

    +
    +
      +
    • +

      Bump gradle to 4.2 - {uri-github}/pull/471[Pull request 471]

      +
      • +
    • +

      Fix setting shmSize when creating container - {uri-github}/pull/480[Pull request 480]

      +
      • +
    • +

      Add support for entrypoint on DockerCreateContainer - {uri-github}/pull/479[Pull request 479]

      +
      • +
    • +

      Bump verison of docker-java to 3.0.14 - {uri-github}/pull/482[Pull request 482]

      +
      • +
    • +

      Added DockerWaitHealthyContainer task - {uri-github}/pull/485[Pull request 485]

      +
      • +
    • +

      Use groovy join function in favor or jdk8 join function. - {uri-github}/pull/498[Pull request 498]

      +
      • +
    +
    +

    v3.2.0 (September 29, 2017)

    +
    +
      +
    • +

      Update createBind to use docker-java parse method - {uri-github}/pull/452[Pull request 452]

      +
      • +
    • +

      Allow Docker to cache app libraries dir when DockerJavaApplication plugin is used - {uri-github}/pull/459[Pull request 459]

      +
      • +
    +
    +

    v3.1.0 (August 21, 2017)

    +
    +
      +
    • +

      DockerListImages gained better support for filters - {uri-github}/pull/414[Pull request 414]

      +
      • +
    • +

      Use alpine:3.4 image in functional tests - {uri-github}/pull/416[Pull request 416]

      +
      • +
    • +

      DockerBuildImage and DockerCreateContainer gained optional argument shmSize - {uri-github}/pull/413[Pull request 413]

      +
      • +
    • +

      Added tasks DockerInspectNetwork, DockerCreateNetwork, and DockerRemoveNetwork - {uri-github}/pull/422[Pull request 422]

      +
      • +
    • +

      Add statically typed methods for configuring plugin with Kotlin - {uri-github}/pull/426[Pull request 426]

      +
      • +
    • +

      Fix Dockerfile task up-to-date logic - {uri-github}/pull/433[Pull request 433]

      +
      • +
    • +

      Multiple ENVs are not set the same way as single ENV instructions - {uri-github}/pull/415[Pull request 415]

      +
      • +
    • +

      DockerCreateContainer changed optional input networkMode to network to better align with docker standatds - {uri-github}/pull/440[Pull request 440]

      +
      • +
    • +

      The first instruction of a Dockerfile has to be FROM except for Docker versions later than 17.05 - {uri-github}/pull/435[Pull request 435]

      +
      • +
    • +

      Bump verison of docker-java to 3.0.13 - {uri-github}/commit/b2d93671ed0a0b7177a450d503c28eca6aa6795d[Commit b2d936]

      +
      • +
    +
    +

    v3.0.10 (July 7, 2017)

    +
    +
      +
    • +

      Bump verison of docker-java to 3.0.12 - {uri-github}/pull/408[Pull request 408]

      +
      • +
    • +

      Publish javadocs on new release - {uri-github}/pull/405[Pull request 405]

      +
      • +
    +
    +

    v3.0.9 (July 4, 2017)

    +
    +
      +
    • +

      Bump verison of docker-java to 3.0.11 - {uri-github}/pull/403[Pull request 403]

      +
      • +
    • +

      New release process - {uri-github}/pull/402[Pull request 402]

      +
      • +
    +
    +

    v3.0.8 (June 16, 2017)

    +
    +
      +
    • +

      Task DockerPullImage gained method getImageId() which returns the fully qualified imageId of the image that was just pulled - {uri-github}/pull/379[Pull request 379]

      +
      • +
    • +

      Task DockerBuildImage gained property tags which allows for multiple tags to be specified when building an image - {uri-github}/pull/380[Pull request 380]

      +
      • +
    • +

      Task DockerCreateContainer gained property networkAliases - {uri-github}/pull/384[Pull request 384]

      +
      • +
    +
    +

    v3.0.7 (May 17, 2017)

    +
    +
      +
    • +

      Invoke onNext closures call() method explicitly - {uri-github}/pull/368[Pull request 368]

      +
      • +
    • +

      Adds new task DockerInspectExecContainer which allows to inspect exec instance - {uri-github}/pull/362[Pull request 362]

      +
      • +
    • +

      `functionalTest’s can now run against a native docker instance - {uri-github}/pull/369[Pull request 369]

      +
      • +
    • +

      DockerLogsContainer now preserves leading space - {uri-github}/pull/370[Pull request 370]

      +
      • +
    • +

      Allow customization of app plugin entrypoint/cmd instructions - {uri-github}/pull/359[Pull request 359]

      +
      • +
    • +

      Task Dockerfile will no longer be forced as UP-TO-DATE, instead the onus will be put on developers to code this should they want this functionality. - {uri-github}/issues/357[Issue 357]

      +
      • +
    • +

      Now that functionalTest’s work natively, and in CI, add the test `started, passed and failed logging messages so as to make it absolutely clear to users what is being run vs having no output at all. - {uri-github}/pull/373[Pull request 373]

      +
      • +
    • +

      Bump docker-java to v`3.0.10` - {uri-github}/pull/378[Pull request 378]

      +
      • +
    +
    +

    v3.0.6 (March 2, 2017)

    +
    +
      +
    • +

      Bump vof docker-java to 3.0.7 - {uri-github}/pull/331[Pull request 331]

      +
      • +
    • +

      Add support for label parameter on docker image creation - {uri-github}/pull/332[Pull request 332]

      +
      • +
    +
    +

    v3.0.5 (December 27, 2016)

    +
    +
      +
    • +

      Support multiple variables per singled ENV cmd - {uri-github}/pull/311[Pull request 311]

      +
      • +
    • +

      Implement a sane default docker URL based on environment - {uri-github}/pull/313[Pull request 313]

      +
      • +
    • +

      Implement reactive-stream methods onNext and onComplete for all tasks - {uri-github}/pull/307[Pull request 307]

      +
      • +
    +
    +

    v3.0.4 (December 1, 2016)

    +
    +
      +
    • +

      Implement reactive-stream method onError for all tasks - {uri-github}/pull/302[Pull request 302]

      +
      • +
    • +

      Bump docker-java to 3.0.6 - {uri-github}/pull/279[Pull request 279]

      +
      • +
    +
    +

    v3.0.3 (September 6, 2016)

    +
    +
      +
    • +

      Print error messages received from docker engine when build fails - {uri-github}/pull/265[Pull request 265]

      +
      • +
    • +

      Bump docker-java to 3.0.5 - {uri-github}/pull/263[Pull request 263]

      +
      • +
    • +

      Add support for force removal on DockerRemoveImage - {uri-github}/pull/266[Pull request 266]

      +
      • +
    • +

      Various fixes and cleanups as well default to alpine image for all functional tests - {uri-github}/pull/269[Pull request 269]

      +
      • +
    • +

      Added editorconfig file with some basic defaults - {uri-github}/pull/270[Pull request 270]

      +
      • +
    +
    +

    v3.0.2 (August 14, 2016)

    +
    +
      +
    • +

      Add support for build-time variables in DockerBuildImage task - {uri-github}/pull/240[Pull request 240]

      +
      • +
    • +

      Fix incorrect docker-java method name in DockerCreateContainer task - {uri-github}/pull/242[Pull request 242]

      +
      • +
    • +

      Can define devices on DockerCreateContainer task - {uri-github}/pull/245[Pull request 245]

      +
      • +
    • +

      Can now supply multiple ports when working with docker-java-application - {uri-github}/pull/254[Pull request 254]

      +
      • +
    • +

      Bump docker-java to 3.0.2 - {uri-github}/pull/259[Pull request 259]

      +
      • +
    • +

      If buildscript repos are required make sure they are added after evaluation - {uri-github}/pull/260[Pull request 260]

      +
      • +
    +
    +

    v3.0.1 (July 6, 2016)

    +
    +
      +
    • +

      Simplify Gradle TestKit usage - {uri-github}/pull/225[Pull request 225]

      +
      • +
    • +

      Ensure tlsVerify is set in addition to certPath for DockerClientConfig setup - {uri-github}/pull/230[Pull request 230]

      +
      • +
    • +

      Upgrade to Gradle 2.14.

      +
      • +
    +
    +

    v3.0.0 (June 5, 2016)

    +
    +
      +
    • +

      Task DockerLogsContainer gained attribute sink - {uri-github}/pull/203[Pull request 203]

      +
      • +
    • +

      Task DockerBuildImage will no longer insert extra newline as part of build output - {uri-github}/pull/206[Pull request 206]

      +
      • +
    • +

      Upgrade to docker-java 3.0.0 - {uri-github}/pull/217[Pull request 217]

      +
      • +
    • +

      Fallback to buildscript.repositories for internal dependency resolution if no repositories were defined - {uri-github}/pull/218[Pull request 218]

      +
      • +
    • +

      Added task DockerExecContainer - {uri-github}/pull/221[Pull request 221]

      +
      • +
    • +

      Added task DockerCopyFileToContainer - {uri-github}/pull/222[Pull request 222]

      +
      • +
    • +

      Task DockerCreateContainer gained attribute restartPolicy - {uri-github}/pull/224[Pull request 224]

      +
      • +
    • +

      Remove use of Gradle internal methods.

      +
      • +
    • +

      Added ISSUES.md file.

      +
      • +
    • +

      Upgrade to Gradle 2.13.

      +
      • +
    +
    +

    v2.6.8 (April 10, 2016)

    +
    +
      +
    • +

      Added task DockerLogsContainer - {uri-github}/pull/181[Pull request 181]

      +
      • +
    • +

      Bump docker-java to v2.3.3 - {uri-github}/pull/183[Pull request 183]

      +
      • +
    • +

      Bug fix when not checking if parent dir already exists before creating with DockerCopyFileToContainer - {uri-github}/pull/186[Pull request 186]

      +
      • +
    • +

      DockerWaitContainer now produces exitCode - {uri-github}/pull/189[Pull request 189]

      +
      • +
    • +

      apiVersion can now be set on DockerExtension and overriden on all tasks - {uri-github}/pull/182[Pull request 182]

      +
      • +
    • +

      Internal fix where task variables had to be defined - {uri-github}/pull/194[Pull request 194]

      +
      • +
    +
    +

    v2.6.7 (March 10, 2016)

    +
    +
      +
    • +

      Upgrade to Gradle 2.11.

      +
      • +
    • +

      Bug fix when copying single file from container and hostPath is set to directory for DockerCopyFileFromContainer - {uri-github}/pull/163[Pull request 163]

      +
      • +
    • +

      Step reports are now printed to stdout by default for DockerBuildImage - {uri-github}/pull/145[Pull request 145]

      +
      • +
    • +

      UP-TO-DATE functionality has been removed from DockerBuildImage as there were too many corner cases to account for - {uri-github}/pull/172[Pull request 172]

      +
      • +
    +
    +

    v2.6.6 (February 27, 2016)

    +
    +
      +
    • +

      Added docker step reports for DockerBuildImage - {uri-github}/pull/145[Pull request 145]

      +
      • +
    • +

      Added onlyIf check for DockerBuildImage - {uri-github}/pull/139[Pull request 139]

      +
      • +
    • +

      Added method logConfig for DockerCreateContainer - {uri-github}/pull/157[Pull request 157]

      +
      • +
    • +

      Various commands can now be passed closures for Dockerfile - {uri-github}/pull/155[Pull request 155]

      +
      • +
    • +

      Fix implementation of exposedPorts for DockerCreateContainer - {uri-github}/pull/140[Pull request 140]

      +
      • +
    • +

      Upgrade to Docker Java 2.2.2 - {uri-github}/pull/158[Pull request 158].

      +
      • +
    +
    +

    v2.6.5 (January 16, 2016)

    +
    +
      +
    • +

      Fix implementation of DockerCopyFileFromContainer - {uri-github}/pull/135[Pull request 135].

      +
      • +
    • +

      Add networkMode property to DockerCreateContainer - {uri-github}/pull/114[Pull request 114].

      +
      • +
    • +

      Upgrade to Docker Java 2.1.4 - {uri-github}/issues/138[Issue 138].

      +
      • +
    +
    +

    v2.6.4 (December 24, 2015)

    +
    +
      +
    • +

      Expose privileged property on DockerCreateContainer - {uri-github}/pull/130[Pull request 130].

      +
      • +
    +
    +

    v2.6.3 (December 23, 2015)

    +
    +
      +
    • +

      Expose force and removeVolumes properties on DockerRemoveContainer - {uri-github}/pull/129[Pull request 129].

      +
      • +
    +
    +

    v2.6.2 (December 22, 2015)

    +
    +
      +
    • +

      Expose support for LogDriver on DockerCreateContainer - {uri-github}/pull/118[Pull request 118].

      +
      • +
    • +

      Upgrade to Docker Java 2.1.2.

      +
      • +
    +
    +

    v2.6.1 (September 21, 2015)

    +
    +
      +
    • +

      Correct the withVolumesFrom call on DockerCreateContainer task which needs to get a VolumesFrom[] array as the parameter - {uri-github}/pull/102[Pull request 102].

      +
      • +
    • +

      Upgrade to Docker Java 2.1.1 - {uri-github}/pull/109[Pull request 109].

      +
      • +
    +
    +

    v2.6 (August 30, 2015)

    +
    +
      +
    • +

      Upgrade to Docker Java 2.1.0 - {uri-github}/pull/92[Pull request 92]. +Note: The Docker Java API changed vastly with v2.0.0. The tasks DockerBuildImage, DockerPullImage and +DockerPushImage do not provide a response handler anymore. This is a breaking change. Future versions of the plugin +might open up the response handling again in some way.

      +
      • +
    • +

      DockerListImages with filter call a wrong function from ListImagesCmdImpl.java - {uri-github}/issues/105[Issue 105].

      +
      • +
    +
    +

    v2.5.2 (August 15, 2015)

    +
    +
      +
    • +

      Fix listImages task throwing GroovyCastException - {uri-github}/issues/96[Issue 96].

      +
      • +
    • +

      Add support for publishAll in DockerCreateContainer - {uri-github}/pull/94[Pull request 94].

      +
      • +
    • +

      Add optional dockerFile option to the DockerBuildImage task - {uri-github}/pull/47[Pull request 47].

      +
      • +
    +
    +

    v2.5.1 (July 29, 2015)

    +
    +
      +
    • +

      Adds Dockerfile support for the LABEL instruction - {uri-github}/pull/86[Pull request 86].

      +
      • +
    • +

      Usage of docker-java library v1.4.0. Underlying API does not provide +setting port bindings for task DockerStartContainer anymore. Needs to be set on DockerCreateContainer.

      +
      • +
    +
    +

    v2.5 (July 18, 2015)

    +
    +
      +
    • +

      Expose response handler for DockerListImages task - v[Issue 75].

      +
      • +
    • +

      Pass in credentials when building an image - {uri-github}/issues/76[Issue 76].

      +
      • +
    +
    +

    v2.4.1 (July 4, 2015)

    +
    +
      +
    • +

      Add extraHosts property to task DockerCreateContainer - {uri-github}/pull/79[Pull request 79].

      +
      • +
    • +

      Add pull property to task DockerBuildImage - {uri-github}/pull/78[Pull request 78].

      +
      • +
    +
    +

    v2.4 (May 16, 2015)

    +
    +
      +
    • +

      Added missing support for properties portBindings and cpuset in CreateContainer - {uri-github}/pull/66[Pull request 66].

      +
      • +
    • +

      Expose response handlers so users can inject custom handling logic - {uri-github}/issues/65[Issue 65].

      +
      • +
    • +

      Upgrade to Gradle 2.4 including all compatible plugins and libraries.

      +
      • +
    +
    +

    v2.3.1 (April 25, 2015)

    +
    +
      +
    • +

      Added support for Binds when creating containers - {uri-github}/pull/54[Pull request 54].

      +
      • +
    • +

      Added task for copying files from a container to a host - {uri-github}/pull/57[Pull request 57].

      +
      • +
    +
    +

    v2.3 (April 18, 2015)

    +
    +
      +
    • +

      Added task DockerInspectContainer - {uri-github}/pull/44[Pull request 44].

      +
      • +
    • +

      Added property containerName to task DockerCreateContainer - {uri-github}/pull/44[Pull request 44].

      +
      • +
    • +

      Allow for linking containers for task DockerCreateContainer - {uri-github}/pull/53[Pull request 53].

      +
      • +
    • +

      Usage of docker-java library v1.2.0.

      +
      • +
    +
    +

    v2.2 (April 12, 2015)

    +
    + +
    +

    v2.1 (March 24, 2015)

    +
    +
      +
    • +

      Renamed property registry to registryCredentials for plugin extension and tasks implementing RegistryCredentialsAware to better indicate its purpose. +Note: This is a breaking change.

      +
      • +
    +
    +

    v2.0.3 (March 20, 2015)

    +
    +
      +
    • +

      Allow for specifying port bindings for container start command. - {uri-github}/issues/30[Issue 30].

      +
      • +
    • +

      Throw an exception if an error response is encountered - {uri-github}/issues/37[Issue 37].

      +
      • +
    • +

      Upgrade to Gradle 2.3.

      +
      • +
    +
    +

    v2.0.2 (February 19, 2015)

    +
    +
      +
    • +

      Set source and target compatibility to Java 6 - {uri-github}/issues/32[Issue 32].

      +
      • +
    +
    +

    v2.0.1 (February 10, 2015)

    +
    +
      +
    • +

      Extension configuration method for DockerJavaApplicationPlugin needs to be registered via extension instance - {uri-github}/issues/28[Issue 28].

      +
      • +
    +
    +

    v2.0 (February 4, 2015)

    +
    +
      +
    • +

      Upgrade to Gradle 2.2.1 including all compatible plugins and libraries.

      +
      • +
    +
    +

    v0.8.3 (February 4, 2015)

    +
    +
      +
    • +

      Add project group to default tag built by Docker Java application plugin - {uri-github}/issues/25[Issue 25].

      +
      • +
    +
    +

    v0.8.2 (January 30, 2015)

    +
    +
      +
    • +

      Expose method for task Dockerfile for providing vanilla Docker instructions.

      +
      • +
    +
    +

    v0.8.1 (January 24, 2015)

    +
    +
      +
    • +

      Usage of docker-java library v0.10.5.

      +
      • +
    • +

      Correctly create model instances for create container task - {uri-github}/issues/19[Issue 19].

      +
      • +
    +
    +

    v0.8 (January 7, 2014)

    +
    +
      +
    • +

      Allow for pushing to Docker Hub - {uri-github}/issues/18[Issue 18].

      +
      • +
    • +

      Better handling of API responses.

      +
      • +
    • +

      Note: Change to plugin extension. The property docker.serverUrl is now called docker.url. Instead of docker.credentials, you will need to use docker.registry.

      +
      • +
    +
    +

    v0.7.2 (December 23, 2014)

    +
    +
      +
    • +

      Dockerfile task is always marked UP-TO-DATE after first execution - {uri-github}/issues/13[Issue 13].

      +
      • +
    • +

      Improvements to Dockerfile task - {uri-github}/pull/16[Pull request 16].

      +
      • +
    • +

      Fixed wrong assignment of key field in environment variable instruction.

      +
      • +
    • +

      Allow for providing multiple ports to the expose instruction.

      +
      • +
    +
    +

    v0.7.1 (December 16, 2014)

    +
    +
      +
    • +

      Fixed entry point definition of Dockerfile set by Java application plugin.

      +
      • +
    +
    +

    v0.7 (December 14, 2014)

    +
    +
      +
    • +

      Allow for properly add user-based instructions to Dockfile task with predefined instructions without messing up the order. - {uri-github}/issues/12[Issue 12].

      +
      • +
    • +

      Renamed task dockerCopyDistTar to dockerCopyDistResources to better express intent.

      +
      • +
    +
    +

    v0.6.1 (December 11, 2014)

    +
    +
      +
    • +

      Allow for setting path to certificates for communicating with Docker over SSL - {uri-github}/issues/10[Issue 10].

      +
      • +
    +
    +

    v0.6 (December 7, 2014)

    +
    +
      +
    • +

      Usage of docker-java library v0.10.4.

      +
      • +
    • +

      Added Docker Java application plugin.

      +
      • +
    • +

      Better documentation.

      +
      • +
    +
    +

    v0.5 (December 6, 2014)

    +
    +
      +
    • +

      Fixed implementations of tasks DockerPushImage and DockerCommitImage - {uri-github}/issues/11[Issue 11].

      +
      • +
    +
    +

    v0.4 (November 27, 2014)

    +
    +
      +
    • +

      Added task for creating a Dockerfile.

      +
      • +
    +
    +

    v0.3 (November 23, 2014)

    +
    +
      +
    • +

      Usage of docker-java library v0.10.3.

      +
      • +
    • +

      Changed package name to com.bmuschko.gradle.docker.

      +
      • +
    • +

      Changed group ID to com.bmuschko.

      +
      • +
    • +

      Adapted plugin IDs to be compatible with Gradle’s plugin portal.

      +
      • +
    +
    +

    v0.2 (June 19, 2014)

    +
    +
      +
    • +

      Usage of docker-java library v0.8.2.

      +
      • +
    • +

      Provide custom task type for push operation.

      +
      • +
    • +

      Support for using remote URLs when building image - {uri-github}/issues/3[Issue 3].

      +
      • +
    +
    +

    v0.1 (May 11, 2014)

    +
    +
      +
    • +

      Initial release.

      +
      • +
    +
    +
    +
    +
    + + + + + \ No newline at end of file diff --git a/9.3.3/user-guide/index.html b/9.3.3/user-guide/index.html new file mode 100644 index 000000000..79c7e7fc9 --- /dev/null +++ b/9.3.3/user-guide/index.html @@ -0,0 +1,4131 @@ + + + + + + + +Gradle Docker Plugin User Guide & Examples + + + + + + +
    +
    +

    1. Introduction

    +
    +
    +

    Gradle plugin for managing Docker images and containers using via its +remote API. +The heavy lifting of communicating with the +Docker remote API is handled by the Docker Java library. +Please refer to the library’s documentation for more information on the supported Docker’s client API and Docker server version.

    +
    +
    + + + + + +
    + + +This plugin requires Gradle >= 7.4.0 to work properly. +
    +
    +
    +

    1.1. Benefits

    +
    +

    There are various benefits for using this plugin:

    +
    +
    +
      +
    1. +

      Seamless integration with the build tool Gradle and its DSL.

      +
      2. +
    2. +

      Handles complicated communication logic between Docker client and daemon under the covers.

      +
      3. +
    3. +

      Simplifies the definition of complex workflows.

      +
      4. +
    4. +

      Minimizes build script setup logic by providing sensible conventions for different use cases.

      +
      5. +
    +
    +
    +
    +

    1.2. Limitations

    +
    +

    The functionality of the plugin does not cover all possible use cases. +Be aware of the following limitations:

    +
    +
    +
      +
    • +

      A task type may not provide all possible options for the underlying Docker operation. +Open an issue if you feel like it should be supported.

      +
      • +
    • +

      You cannot build multi-container applications via Docker Compose. +The Avast Docker Compose plugin has proven to be a capable alternative.

      +
      • +
    • +

      Managing a Docker Swarm and/or Stack is not supported.

      +
      • +
    +
    +
    +
    +

    1.3. Further Readings

    +
    +

    Want to learn more about using this plugin in different contexts? The following blog posts should get you started.

    +
    +
    + +
    +
    +
    +

    1.4. Provided Plugins

    +
    +

    The binary distribution is available on the Gradle plugin portal, and Maven Central. +It contains the following plugins:

    +
    + ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Plugin IdAutomatically appliesTypeDescription

    com.bmuschko.docker-remote-api

    -

    DockerRemoteApiPlugin

    Provides custom tasks for interacting with Docker via its remote API.

    com.bmuschko.docker-java-application

    com.bmuschko.docker-remote-api

    DockerJavaApplicationPlugin

    Creates and pushes a Docker image for a Java application.

    com.bmuschko.docker-spring-boot-application

    com.bmuschko.docker-remote-api

    DockerSpringBootApplicationPlugin

    Creates and pushes a Docker image for a Spring Boot application.

    +
    +

    Which plugin you chose in your project entirely depends on the use case you want to fulfill. Refer to the relevant portions of the user guide that describe the purpose and usage of each plugin in more detail.

    +
    +
    +
    +

    1.5. Getting Started

    +
    +

    The plugin can be applied with the buildscript syntax or the plugin DSL. +Let’s say you’d want to go with the plugin that provides the plain Docker operations for managing Docker images and containers. +See the Gradle user guide for more information on applying plugins.

    +
    +
    +

    1.5.1. Applying the Plugin Using the buildscript Syntax

    +
    +
    Groovy
    +
    +
    buildscript {
+    repositories {
+        gradlePluginPortal()
+    }
+    dependencies {
+        classpath 'com.bmuschko:gradle-docker-plugin:9.3.3'
+    }
+}
+
+apply plugin: 'com.bmuschko.docker-remote-api'
    +
    +
    +
    +
    Kotlin
    +
    +
    buildscript {
+    repositories {
+        gradlePluginPortal()
+    }
+    dependencies {
+        classpath("com.bmuschko:gradle-docker-plugin:9.3.3")
+    }
+}
+
+apply(plugin = "com.bmuschko.docker-remote-api")
    +
    +
    +
    +
    +

    1.5.2. Applying the Plugin Using the Plugin DSL

    +
    +
    Groovy
    +
    +
    plugins {
+    id 'com.bmuschko.docker-remote-api' version '9.3.3'
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    plugins {
+    id("com.bmuschko.docker-remote-api") version "9.3.3"
+}
    +
    +
    +
    +
    +

    1.5.3. Applying the Plugin From a Script Plugin

    +
    +

    Applying the plugin from a script plugin requires the use of the fully-qualified class name due to a bug in Gradle core. Be aware that the plugin DSL cannot be used to apply a binary plugin from a script plugin.

    +
    +
    + + + + + +
    + + +When used with the Kotlin DSL, it is recommended to move your implementation into the buildSrc project. +
    +
    +
    +
    gradle/docker.gradle
    +
    +
    buildscript {
+    repositories {
+        gradlePluginPortal()
+    }
+    dependencies {
+        classpath 'com.bmuschko:gradle-docker-plugin:9.3.3'
+    }
+}
+
+apply plugin: com.bmuschko.gradle.docker.DockerRemoteApiPlugin
    +
    +
    +
    +
    build.gradle
    +
    +
    apply from: 'gradle/docker.gradle'
    +
    +
    +
    +
    +
    +
    +
    +

    2. Remote API Plugin

    +
    +
    +

    The plugin com.bmuschko.docker-remote-api allows for interacting with Docker via its remote API. +If no additional configuration has been provided by the build script, the plugin will try to resolve and use the credentials for registry authentication available from previous login operations (usually in $HOME/.docker/config.json). You can model any workflow imaginable by creating enhanced task of the custom task provided by the plugin.

    +
    +
    +

    2.1. Usage

    +
    +
    Groovy
    +
    +
    plugins {
+    id 'com.bmuschko.docker-remote-api' version '9.3.3'
+}
+
+// Import task types
+import com.bmuschko.gradle.docker.tasks.image.*
+
+// Use task types
+task buildMyAppImage(type: DockerBuildImage) {
+    inputDir = file('docker/myapp')
+    images.add('test/myapp:latest')
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    plugins {
+    id("com.bmuschko.docker-remote-api") version "9.3.3"
+}
+
+// Import task types
+import com.bmuschko.gradle.docker.tasks.image.*
+
+// Use task types
+tasks.create("buildMyAppImage", DockerBuildImage::class) {
+    inputDir.set(file("docker/myapp"))
+    images.add("test/myapp:latest")
+}
    +
    +
    +
    +

    The plugin automatically resolves the Docker Java library with the pre-configured version under the covers. +The only configuration you will have to provide in your build script is the repository hosting the library and its transitive dependencies. +One repository that hosts them all is Maven Central.

    +
    +
    +
    Groovy
    +
    +
    repositories {
+    mavenCentral()
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    repositories {
+    mavenCentral()
+}
    +
    +
    +
    +
    +

    2.2. Extension

    +
    +

    The plugin defines an extension with the namespace docker. +The following properties can be configured:

    +
    + ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Property nameTypeDefault valueDescription

    url

    Property<String>

    unix:///var/run/docker.sock (Unix), tcp://127.0.0.1:2375 (Windows)

    The server URL to connect to via Docker’s remote API.

    certPath

    DirectoryProperty

    Value of environment variable DOCKER_CERT_PATH if set

    The path to certificates for communicating with Docker over SSL.

    apiVersion

    Property<String>

    null

    The remote API version. For most cases this can be left null.

    +
    +

    Image pull or push operations against the public Docker Hub registry or a private registry may require authentication. By default, existing credentials are read from $HOME/.docker/config.json and reused for authentication purposes. You can overwrite those credentials with the help of the registryCredentials closure. The credentials provided in the extension automatically become available to all custom tasks that implement the interface RegistryCredentialsAware.

    +
    + ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Property nameTypeDefault valueDescription

    url

    Property<String>

    https://index.docker.io/v1/

    The registry URL.

    username

    Property<String>

    null

    The registry username.

    password

    Property<String>

    null

    The registry password.

    email

    Property<String>

    null

    The registry email address.

    +
    +

    2.2.1. Working With a TLS-enabled Docker Instance

    +
    +

    Starting with Docker version 1.3, TLS is enabled by default. +Please consult the Docker documentation "Protect the Docker daemon socket" to set up your certificate. The following example demonstrates how to configure the plugin to use those certificates. +Additionally, this code snippet shows how to set the user credentials.

    +
    +
    +
    Groovy
    +
    +
    docker {
+    url = 'https://192.168.59.103:2376'
+    certPath = new File(System.properties['user.home'], '.boot2docker/certs/boot2docker-vm')
+
+    registryCredentials {
+        url = 'https://index.docker.io/v1/'
+        username = 'bmuschko'
+        password = 'pwd'
+        email = 'benjamin.muschko@gmail.com'
+    }
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    docker {
+    url.set("https://192.168.59.103:2376")
+    certPath.set(File(System.getProperty("user.home"), ".boot2docker/certs/boot2docker-vm"))
+
+    registryCredentials {
+        url.set("https://index.docker.io/v1/")
+        username.set("bmuschko")
+        password.set("pwd")
+        email.set("benjamin.muschko@gmail.com")
+    }
+}
    +
    +
    +
    +
    +

    2.2.2. Working With Google Cloud And Using a Key File

    +
    +
    Groovy
    +
    +
    docker {
+    registryCredentials {
+        url = 'https://gcr.io'
+        username = '_json_key'
+        password = file('keyfile.json').text
+    }
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    docker {
+    registryCredentials {
+        url.set("https://gcr.io")
+        username.set("_json_key")
+        password.set(file("keyfile.json").readText())
+    }
+}
    +
    +
    +
    +
    +

    2.2.3. Working With a Docker Instance Without TLS

    +
    +

    The following example assumes that you disabled TLS on your Docker instance. +You can do so by setting DOCKER_TLS=no in the file /var/lib/boot2docker/profile.

    +
    +
    +
    Groovy
    +
    +
    docker {
+    url = 'tcp://192.168.59.103:2375'
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    docker {
+    url.set("tcp://192.168.59.103:2375")
+}
    +
    +
    +
    +

    On Unix the Docker daemon listens by default on unix:///var/run/docker.sock.

    +
    +
    +

    On Windows the Docker daemon listens by default on npipe:////./pipe/docker_engine if this exists. +We fall back to tcp://127.0.0.1:2375 where the pipe does not exist.

    +
    +
    +
    +
    +

    2.3. Custom task types

    +
    +

    2.3.1. Misc

    +
    +

    The plugin provides the following general-purpose custom task types:

    +
    + ++++ + + + + + + + + + + + + + + + + + + + + +
    TypeDescription

    DockerOperation

    Passes the raw docker-java client to the onNext closure if it’s defined.

    DockerInfo

    Displays system-wide information.

    DockerVersion

    Show the docker version information.

    +
    +
    +

    2.3.2. Images

    +
    +

    The plugin provides the following custom task types for managing images:

    +
    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeDescription

    Dockerfile

    Creates a Dockerfile based on the provided instructions.

    DockerBuildImage

    Builds an image from a Dockerfile.

    DockerCommitImage

    Creates a new image from a container’s changes.

    DockerInspectImage

    Returns low-level information on the image.

    DockerListImages

    Lists images in registry.

    DockerPullImage

    Pulls an image from the registry.

    DockerPushImage

    Pushes an image to a registry.

    DockerRemoveImage

    Removes an image from the filesystem.

    DockerTagImage

    Tags an image in registry.

    DockerSaveImage

    Saves an image to file.

    DockerLoadImage

    Loads an image from file.

    +
    +
    +

    2.3.3. Containers

    +
    +

    The plugin provides the following custom task types for managing containers:

    +
    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeDescription

    DockerCopyFileToContainer

    Copies a path from the host into the container.

    DockerCopyFileFromContainer

    Copies a path from the container as a tar file on to the host.

    DockerCreateContainer

    Creates a container.

    DockerInspectContainer

    Returns low-level information on the container.

    DockerKillContainer

    Kills the container for a given id.

    DockerRemoveContainer

    Removes the container for a given id from the filesystem.

    DockerRenameContainer

    Rename a container.

    DockerRestartContainer

    Restarts the container for a given id.

    DockerStartContainer

    Starts the container for a given id.

    DockerStopContainer

    Stops the container for a given id.

    DockerWaitContainer

    Blocks until container for a given id stops.

    DockerLogsContainer

    Copies the container output to the Gradle process standard out/err.

    DockerExecContainer

    Executes a command within a running container.

    DockerInspectExecContainer

    Inspects task executed inside container with DockerExecContainer command.

    +
    +
    +

    2.3.4. Networks

    +
    +

    The plugin provides the following custom task types for managing networks:

    +
    + ++++ + + + + + + + + + + + + + + + + + + + + +
    TypeDescription

    DockerCreateNetwork

    Creates a network.

    DockerInspectNetwork

    Returns low-level information on the network.

    DockerRemoveNetwork

    Removes the network.

    +
    +
    +
    +

    2.4. Reactive Streams

    +
    +

    As needed, we will implement reactive methods as described in reactive-streams. +We implement these here as optional closures for all tasks. +Currently the only supported methods are onError, onNext, onComplete. +Various examples on how to use these can be found in our reactive tests.

    +
    +
    +

    2.4.1. Reacting to an Error

    +
    +

    The onError closure is passed the exception that is thrown for you to handle. +If you silently ignore we will not throw the exception behind the scenes. +The below example is a common use-case that arises when someone wants to remove a container whether it exists or not but does not want to fail hard.

    +
    +
    +
    Groovy
    +
    +
    task removeContainer1(type: DockerRemoveContainer) {
+    targetContainerId 'container-that-does-not-exist'
+    onError { exception ->
+        // Ignore exception if container does not exist otherwise throw it
+        if (!exception.message.contains('No such container'))
+            throw exception
+    }
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    tasks.create("removeContainer1", DockerRemoveContainer::class) {
+    targetContainerId("container-that-does-not-exist")
+    onError {
+        // Ignore exception if container does not exist otherwise throw it
+        if (!this.message!!.contains("No such container"))
+            throw this
+    }
+}
    +
    +
    +
    +
    +

    2.4.2. Reacting to Data Returned by an Operation

    +
    +

    The onNext closure is passed the next iterative response upon execution. +For all other tasks we simply hand you back the object that is given to us by docker-java which is a pojo representation of the json handed back by docker. +Thus, and much like the onError closure, all delegation is now in your control. +Any properties/values expected to be set will not be done unless you do them.

    +
    +
    +

    Iterative tasks are things like DockerBuildImage, DockerLogsContainer, DockerListImages. +These tasks have output which can be iterated over. +The example below demonstrates how we iterate over each log message passing that to the closure for the user to work on.

    +
    +
    +
    Groovy
    +
    +
    task logContainer(type: DockerLogsContainer) {
+    targetContainerId 'container-that-does-exist'
+    follow = true
+    tailAll = true
+    onNext { message ->
+        // Each log message from the container will be passed as it's made available
+        logger.quiet message.toString()
+    }
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    tasks.create("logContainer", DockerLogsContainer::class) {
+    targetContainerId("container-that-does-not-exist")
+    follow.set(true)
+    tailAll.set(true)
+    onNext {
+        // Each log message from the container will be passed as it's made available
+        logger.quiet(this.toString())
+    }
+}
    +
    +
    +
    +
    +

    2.4.3. Reacting to the Completion of an Operation

    +
    +

    The onComplete closure is not passed anything upon execution. +It works in the same fashion that doLast does but is instead part of this task and thus executes before doLast does. +This closure executes only upon success. +The below example demonstrates how this works.

    +
    +
    +
    Groovy
    +
    +
    task removeContainer2(type: DockerRemoveContainer) {
+    targetContainerId 'container-that-does-exist'
+    onComplete {
+        println 'Executes first'
+    }
+    doLast {
+        println 'Executes second'
+    }
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    tasks.create("removeContainer2", DockerRemoveContainer::class) {
+    targetContainerId("container-that-does-exist")
+    onComplete {
+        println("Executes first")
+    }
+    doLast {
+        println("Executes second")
+    }
+}
    +
    +
    +
    +
    +
    +

    2.5. Examples

    +
    +

    The following usage examples demonstrate code for common use cases. +More scenarios can be found in the functional tests.

    +
    +
    +

    2.5.1. Modifying Instructions of a Dockerfile Task

    +
    +

    Sometimes do you do not have any control over the creation of a Dockerfile task. +For example the Docker Java Application Plugin already adds a Dockerfile task with a set of sensible instructions. +You can still modify those instructions if needed. +Let’s say you are dealing with the following Dockerfile definition.

    +
    +
    +
    Groovy
    +
    +
    tasks.create('createDockerfile', Dockerfile) {
+    from('openjdk:jre-alpine')
+    copyFile('my-app-1.0.jar', '/app/my-app-1.0.jar')
+    entryPoint('java')
+    defaultCommand('-jar', '/app/my-app-1.0.jar')
+    exposePort(8080)
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    tasks.create("createDockerfile", Dockerfile::class) {
+    from("openjdk:jre-alpine")
+    copyFile("my-app-1.0.jar", "/app/my-app-1.0.jar")
+    entryPoint("java")
+    defaultCommand("-jar", "/app/my-app-1.0.jar")
+    exposePort(8080)
+}
    +
    +
    +
    +

    Now, you may prefer a different base image than the one added by default. +The listing below demonstrates how to find it the FROM instruction and replace it with a different one.

    +
    +
    +
    Groovy
    +
    +
    createDockerfile {
+    List<Instruction> originalInstructions = new ArrayList<Instruction>(instructions.get())
+    int fromInstructionIndex = originalInstructions
+            .findIndexOf { it.keyword == FromInstruction.KEYWORD }
+    originalInstructions.remove(fromInstructionIndex)
+    FromInstruction baseImage = new FromInstruction(new From('openjdk:8-alpine'))
+    originalInstructions.add(0, baseImage)
+    instructions.set(originalInstructions)
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    tasks {
+    "createDockerfile"(Dockerfile::class) {
+        val originalInstructions = instructions.get().toMutableList()
+        val fromInstructionIndex = originalInstructions
+                .indexOfFirst { item -> item.keyword == FromInstruction.KEYWORD }
+        originalInstructions.removeAt(fromInstructionIndex)
+        val baseImage = FromInstruction(From("openjdk:8-alpine"))
+        originalInstructions.add(0, baseImage)
+        instructions.set(originalInstructions)
+    }
+}
    +
    +
    +
    +

    You can also add new instructions at a specific position in the existing list of instructions. +For example you may want to add a HEALTHCHECK to the end of the list.

    +
    +
    +
    Groovy
    +
    +
    createDockerfile {
+    instruction 'HEALTHCHECK CMD wget --quiet --tries=1 --spider http://localhost:8080/actuator/health || exit 1'
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    tasks {
+    "createDockerfile"(Dockerfile::class) {
+        instruction("HEALTHCHECK CMD wget --quiet --tries=1 --spider http://localhost:8080/actuator/health || exit 1")
+    }
+}
    +
    +
    +
    +
    +

    2.5.2. Creating a Dockerfile And Building an Image

    +
    +

    A Dockerfile can be created by the Dockerfile custom tasks. +The Dockerfile instructions need to be declare in the correct +order.

    +
    +
    +
    Groovy
    +
    +
    plugins {
+    id 'com.bmuschko.docker-remote-api' version '9.3.3'
+}
+
+import com.bmuschko.gradle.docker.tasks.image.Dockerfile
+import com.bmuschko.gradle.docker.tasks.image.DockerBuildImage
+
+task createDockerfile(type: Dockerfile) {
+    from 'ubuntu:12.04'
+    label(['maintainer': 'Benjamin Muschko "benjamin.muschko@gmail.com"'])
+}
+
+task buildImage(type: DockerBuildImage) {
+    dependsOn createDockerfile
+    images.add('bmuschko/myimage:latest')
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    plugins {
+    id("com.bmuschko.docker-remote-api") version "9.3.3"
+}
+
+import com.bmuschko.gradle.docker.tasks.image.Dockerfile
+import com.bmuschko.gradle.docker.tasks.image.DockerBuildImage
+
+val createDockerfile by tasks.creating(Dockerfile::class) {
+    from("ubuntu:12.04")
+    label(mapOf("maintainer" to "Benjamin Muschko 'benjamin.muschko@gmail.com'"))
+}
+
+tasks.create("buildImage", DockerBuildImage::class) {
+    dependsOn(createDockerfile)
+    images.add("bmuschko/myimage:latest")
+}
    +
    +
    +
    +
    +

    2.5.3. Executing Functional Tests Against a Running Container

    +
    +

    The following example code demonstrates how to build a Docker image from a Dockerfile, starts up a container for this image and exercises functional tests against the running container. +At the end of this operation, the container is stopped.

    +
    +
    +
    Groovy
    +
    +
    plugins {
+    id 'com.bmuschko.docker-remote-api' version '9.3.3'
+}
+
+import com.bmuschko.gradle.docker.tasks.container.*
+import com.bmuschko.gradle.docker.tasks.image.*
+
+task buildMyAppImage(type: DockerBuildImage) {
+    inputDir = file('docker/myapp')
+    images.add('test/myapp:latest')
+}
+
+task createMyAppContainer(type: DockerCreateContainer) {
+    dependsOn buildMyAppImage
+    targetImageId buildMyAppImage.getImageId()
+    hostConfig.portBindings = ['8080:8080']
+    hostConfig.autoRemove = true
+}
+
+task startMyAppContainer(type: DockerStartContainer) {
+    dependsOn createMyAppContainer
+    targetContainerId createMyAppContainer.getContainerId()
+}
+
+task stopMyAppContainer(type: DockerStopContainer) {
+    targetContainerId createMyAppContainer.getContainerId()
+}
+
+task functionalTestMyApp(type: Test) {
+    dependsOn startMyAppContainer
+    finalizedBy stopMyAppContainer
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    plugins {
+    id("com.bmuschko.docker-remote-api") version "9.3.3"
+}
+
+import com.bmuschko.gradle.docker.tasks.container.*
+import com.bmuschko.gradle.docker.tasks.image.*
+
+val buildMyAppImage by tasks.creating(DockerBuildImage::class) {
+    inputDir.set(file("docker/myapp"))
+    images.add("test/myapp:latest")
+}
+
+val createMyAppContainer by tasks.creating(DockerCreateContainer::class) {
+    dependsOn(buildMyAppImage)
+    targetImageId(buildMyAppImage.getImageId())
+    hostConfig.portBindings.set(listOf("8080:8080"))
+    hostConfig.autoRemove.set(true)
+}
+
+val startMyAppContainer by tasks.creating(DockerStartContainer::class) {
+    dependsOn(createMyAppContainer)
+    targetContainerId(createMyAppContainer.getContainerId())
+}
+
+val stopMyAppContainer by tasks.creating(DockerStopContainer::class) {
+    targetContainerId(createMyAppContainer.getContainerId())
+}
+
+tasks.create("functionalTestMyApp", Test::class) {
+    dependsOn(startMyAppContainer)
+    finalizedBy(stopMyAppContainer)
+}
    +
    +
    +
    +
    +

    2.5.4. Linking With Other Containers

    +
    +

    In many situations your container does not start without dependencies like database. +In that case you may wish using traditional linking:

    +
    +
    +
    Groovy
    +
    +
    plugins {
+    id 'com.bmuschko.docker-remote-api' version '9.3.3'
+}
+
+import com.bmuschko.gradle.docker.tasks.container.*
+import com.bmuschko.gradle.docker.tasks.image.*
+
+task buildMyAppImage(type: DockerBuildImage) {
+    inputDir = file('docker/myapp')
+    images.add('test/myapp')
+}
+
+task createDBContainer(type: DockerCreateContainer) {
+    targetImageId 'postgres:latest'
+    containerName = 'docker_auto'
+    hostConfig.autoRemove = true
+}
+
+task createMyAppContainer(type: DockerCreateContainer) {
+    dependsOn buildMyAppImage, createDBContainer
+    targetImageId buildMyAppImage.getImageId()
+    hostConfig.portBindings = ['8080:8080']
+    hostConfig.autoRemove = true
+    hostConfig.links = ["docker_auto:database"]
+
+    // If you use Systemd in containers you should also add lines. #320
+    hostConfig.binds = ['/sys/fs/cgroup': '/sys/fs/cgroup']
+    tty = true
+}
+
+task startMyAppContainer(type: DockerStartContainer) {
+    dependsOn createMyAppContainer
+    targetContainerId createMyAppContainer.getContainerId()
+}
+
+task stopMyAppContainer(type: DockerStopContainer) {
+    targetContainerId createMyAppContainer.getContainerId()
+}
+
+task functionalTestMyApp(type: Test) {
+    dependsOn startMyAppContainer
+    finalizedBy stopMyAppContainer
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    plugins {
+    id("com.bmuschko.docker-remote-api") version "9.3.3"
+}
+
+import com.bmuschko.gradle.docker.tasks.container.*
+import com.bmuschko.gradle.docker.tasks.image.*
+
+val buildMyAppImage by tasks.creating(DockerBuildImage::class) {
+    inputDir.set(file("docker/myapp"))
+    images.add("test/myapp")
+}
+
+val createDBContainer by tasks.creating(DockerCreateContainer::class) {
+    targetImageId("postgres:latest")
+    containerName.set("docker_auto")
+    hostConfig.autoRemove.set(true)
+}
+
+val createMyAppContainer by tasks.creating(DockerCreateContainer::class) {
+    dependsOn(buildMyAppImage, createDBContainer)
+    targetImageId(buildMyAppImage.getImageId())
+    hostConfig.portBindings.set(listOf("8080:8080"))
+    hostConfig.autoRemove.set(true)
+    hostConfig.links.set(listOf("docker_auto:database"))
+
+    // If you use Systemd in containers you should also add lines. #320
+    hostConfig.binds.set(mapOf("/sys/fs/cgroup" to "/sys/fs/cgroup"))
+    tty.set(true)
+}
+
+val startMyAppContainer by tasks.creating(DockerStartContainer::class) {
+    dependsOn(createMyAppContainer)
+    targetContainerId(createMyAppContainer.getContainerId())
+}
+
+val stopMyAppContainer by tasks.creating(DockerStopContainer::class) {
+    targetContainerId(createMyAppContainer.getContainerId())
+}
+
+tasks.create("functionalTestMyApp", Test::class) {
+    dependsOn(startMyAppContainer)
+    finalizedBy(stopMyAppContainer)
+}
    +
    +
    +
    +
    +

    2.5.5. Implementing Custom Docker Client Handling

    +
    +

    The plugin provides an opinionated set of custom tasks for the most common Docker operations. +Sometime the situation may arise that you want to have full control over what you want to call on the Docker client. +To do so you can implement your own custom task that extends from AbstractDockerRemoteApiTask. +The following example shows how to implement such a custom task:

    +
    +
    +
    Groovy
    +
    +
    class DockerImageIdForName extends AbstractDockerRemoteApiTask {
+    @Input
+    final Property<String> filteredImageName = project.objects.property(String)
+
+    @Internal
+    final Property<String> imageId = project.objects.property(String)
+
+    DockerImageIdForName() {
+        onNext({ image ->
+            imageId.set(image.id)
+        })
+    }
+
+    @Override
+    void runRemoteCommand() {
+        def images = dockerClient.listImagesCmd()
+            .withImageNameFilter(filteredImageName.get())
+            .exec()
+
+        for(image in images) {
+            nextHandler.execute(image)
+        }
+    }
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    open class DockerImageIdForName : AbstractDockerRemoteApiTask {
+    @Input
+    val filteredImageName : Property<String> = project.objects.property(String::class)
+
+    @Internal
+    val imageId : Property<String> = project.objects.property(String::class)
+
+    constructor() {
+        onNext(Action<Image> {
+            this.withGroovyBuilder {
+                imageId.set(getProperty("id") as String)
+            }
+        })
+    }
+
+    override fun runRemoteCommand() {
+        val images = getDockerClient().listImagesCmd()
+            .withImageNameFilter(filteredImageName.get())
+            .exec()
+
+        for(image in images) {
+            nextHandler.execute(image)
+        }
+    }
+}
    +
    +
    +
    +

    To use the custom task, simply create a task by type.

    +
    +
    +
    Groovy
    +
    +
    task imageIdForName(type: DockerImageIdForName) {
+    filteredImageName = 'alpine:3.4'
+}
+
+task printImageId {
+    dependsOn imageIdForName
+    doLast {
+        logger.quiet "Resolved image ID ${imageIdForName.imageId.get()} for name ${imageIdForName.filteredImageName.get()}"
+    }
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    val imageIdForName by tasks.creating(DockerImageIdForName::class) {
+    filteredImageName.set("alpine:3.4")
+}
+
+val printImageId by tasks.creating {
+    dependsOn(imageIdForName)
+    doLast {
+        logger.quiet("Resolved image ID ${imageIdForName.imageId.get()} for name ${imageIdForName.filteredImageName.get()}")
+    }
+}
    +
    +
    +
    +
    +
    +
    +
    +

    3. Java Application Plugin

    +
    +
    +

    The plugin com.bmuschko.docker-java-application is a highly opinionated plugin for projects applying the Java plugin. +Under the hood the plugin preconfigures tasks for creating and pushing Docker images for your Java application. +The default configuration is tweakable via an exposed extension.

    +
    +
    +

    3.1. Usage

    +
    +
    Groovy
    +
    +
    plugins {
+    id 'java'
+    id 'com.bmuschko.docker-java-application' version '9.3.3'
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    plugins {
+    java
+    id("com.bmuschko.docker-java-application") version "9.3.3"
+}
    +
    +
    +
    +
    +

    3.2. Extension

    +
    +

    The plugin defines an extension with the namespace javaApplication as a child of the docker namespace. By default, the main class will be configured automatically by looking for a class with a public static void main(String[]) method available in the classpath of the main source set.

    +
    +
    +

    The following properties can be configured:

    +
    + ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Property nameTypeDefault valueDescription

    baseImage

    Property<String>

    openjdk:11.0.16-jre-slim

    The Docker base image used for Java application.

    maintainer

    Property<String>

    Value of system property user.name

    The maintainer of the image.

    user

    Property<String>

    None

    The user name (or UID) and optionally the user group (or GID) to use as the default user and group to run the container.

    ports

    ListProperty<Integer>

    [8080]

    The Docker image exposed ports.

    images

    SetProperty<String>

    [<project.group>/<applicationName>:<project.version>]

    The images used for the build and push operation.

    jvmArgs

    ListProperty<String>

    []

    The JVM arguments passed to the java command.

    mainClassName

    Property<String>

    A unique main class +name discovered by scanning the classpath

    The main class name to use for starting the application. Setting an explicit value for this option is useful if your source code contains multiple main class files.

    args

    ListProperty<String>

    []

    The program arguments passed to the java command.

    +
    +
    Groovy
    +
    +
    docker {
+    javaApplication {
+        baseImage = 'dockerfile/java:openjdk-7-jre'
+        maintainer = 'Benjamin Muschko "benjamin.muschko@gmail.com"'
+        ports = [9090, 5701]
+        images = ['jettyapp:1.115', 'jettyapp:latest']
+        jvmArgs = ['-Xms256m', '-Xmx2048m']
+    }
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    docker {
+    javaApplication {
+        baseImage.set("dockerfile/java:openjdk-7-jre")
+        maintainer.set("Benjamin Muschko 'benjamin.muschko@gmail.com'")
+        ports.set(listOf(9090, 5701))
+        images.set(setOf("jettyapp:1.115", "jettyapp:latest"))
+        jvmArgs.set(listOf("-Xms256m", "-Xmx2048m"))
+    }
+}
    +
    +
    +
    +
    +

    3.3. Tasks

    +
    +

    The plugin provides a set of tasks for your project and preconfigures them with sensible defaults.

    +
    + ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Task nameDepends OnTypeDescription

    dockerSyncBuildContext

    classes

    TaskProvider<Sync>

    Copies the application files to a temporary directory for image creation.

    dockerCreateDockerfile

    dockerSyncBuildContext

    TaskProvider<Dockerfile>

    Creates the Docker image for the Java application.

    dockerBuildImage

    dockerCreateDockerfile

    TaskProvider<DockerBuildImage>

    Builds the Docker image for the Java application.

    dockerPushImage

    dockerBuildImage

    TaskProvider<DockerPushImage>

    Pushes created Docker image to the repository.

    +
    +
    +

    3.4. Generated Dockerfile

    +
    +

    The following Dockerfile shows the typical instructions generated by the plugin. It uses the default values defined by the extension. The resolved main class name is com.bmuschko.gradle.docker.application.JettyMain.

    +
    +
    +
    Dockerfile
    +
    +
    FROM openjdk:11-jre-slim
+LABEL maintainer=bmuschko
+WORKDIR /app
+COPY libs libs/
+COPY classes classes/
+ENTRYPOINT ["java", "-cp", "/app/resources:/app/classes:/app/libs/*", "com.bmuschko.gradle.docker.application.JettyMain"]
+EXPOSE 8080
    +
    +
    +
    +

    See additional examples for information on how to modify the Dockerfile instructions.

    +
    +
    +
    +

    3.5. Examples

    +
    +

    The following usage examples demonstrate code for common use cases. +More scenarios can be found in the functional tests.

    +
    +
    +

    3.5.1. Using the Plugin for an Application Run on Jetty

    +
    +
    Groovy
    +
    +
    plugins {
+    id 'java'
+    id 'com.bmuschko.docker-java-application' version '9.3.3'
+}
+
+version = '1.0'
+sourceCompatibility = 1.7
+
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+    implementation 'org.eclipse.jetty.aggregate:jetty-all:9.4.29.v20200521'
+}
+
+docker {
+    javaApplication {
+        maintainer = 'Jon Doe "jon.doe@gmail.com"'
+    }
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    plugins {
+    java
+    id("com.bmuschko.docker-java-application") version "9.3.3"
+}
+
+version = "1.0"
+
+java {
+    sourceCompatibility = JavaVersion.VERSION_1_7
+    targetCompatibility = JavaVersion.VERSION_1_7
+}
+
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+    implementation("org.eclipse.jetty.aggregate:jetty-all:9.4.29.v20200521")
+}
+
+docker {
+    javaApplication {
+        maintainer.set("Jon Doe 'jon.doe@gmail.com'")
+    }
+}
    +
    +
    +
    +
    +

    3.5.2. Additional Instructions in Dockerfile

    +
    +

    You can add additional instructions to the dockerfile using dockerDistTar and Dockerfile task DSL:

    +
    +
    +
    Groovy
    +
    +
    dockerCreateDockerfile {
+    instruction 'RUN ls -la'
+    environmentVariable 'JAVA_OPTS', '-XX:+UnlockExperimentalVMOptions -XX:+UseCGroupMemoryLimitForHeap'
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    tasks.named<Dockerfile>("dockerCreateDockerfile") {
+    instruction("RUN ls -la")
+    environmentVariable("JAVA_OPTS", "-XX:+UnlockExperimentalVMOptions -XX:+UseCGroupMemoryLimitForHeap")
+}
    +
    +
    +
    +

    Or you can use form

    +
    +
    +
    Groovy
    +
    +
    dockerCreateDockerfile.instructionsFromTemplate file('Dockerfile.tmpl')
    +
    +
    +
    +
    Kotlin
    +
    +
    tasks.named<Dockerfile>("dockerCreateDockerfile") {
+    instructionsFromTemplate(file("Dockerfile.tmpl"))
+}
    +
    +
    +
    +
    +
    +
    +
    +

    4. Spring Boot Application Plugin

    +
    +
    +

    The plugin com.bmuschko.docker-spring-boot-application is a highly opinionated plugin for projects applying the Spring Boot plugin. +Under the hood the plugin preconfigures tasks for creating and pushing Docker images for your Spring Boot application. +The default configuration is tweakable via an exposed extension. The plugin reacts to either the java or war plugin.

    +
    +
    + + + + + +
    + + +The plugin only supports projects that use a 2.x version of the Spring Boot plugin. +
    +
    +
    +

    4.1. Usage

    +
    +
    Groovy
    +
    +
    plugins {
+    id 'java'
+    id 'org.springframework.boot' version '2.0.3.RELEASE'
+    id 'com.bmuschko.docker-spring-boot-application' version '9.3.3'
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    plugins {
+    java
+    id("org.springframework.boot") version "2.0.3.RELEASE"
+    id("com.bmuschko.docker-spring-boot-application") version "9.3.3"
+}
    +
    +
    +
    +
    +

    4.2. Extension

    +
    +

    The plugin defines an extension with the namespace springBootApplication as a child of the docker namespace. By default, the main class will be configured automatically by looking for a class with a public static void main(String[]) method available in the classpath of the main source set. The main class needs to use the org.springframework.boot.autoconfigure.SpringBootApplication annotation to be discoverable.

    +
    +
    +

    The following properties can be configured:

    +
    + ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Property nameTypeDefault valueDescription

    baseImage

    Property<String>

    openjdk:11.0.16-jre-slim

    The Docker base image used for the Spring Boot application.

    maintainer

    Property<String>

    Value of system property user.name

    The maintainer of the image.

    user

    Property<String>

    None

    The user name (or UID) and optionally the user group (or GID) to use as the default user and group to run the container.

    ports

    ListProperty<Integer>

    [8080]

    The Docker image exposed ports.

    images

    SetProperty<String>

    [<project.group>/<applicationName>:<project.version>]

    The images used for the build and push operation.

    jvmArgs

    ListProperty<String>

    []

    The JVM arguments passed to the java command.

    mainClassName

    Property<String>

    A unique main class name discovered by scanning the classpath

    The main class name to use for starting the application. Setting an explicit value for this option is useful if your source code contains multiple main class files.

    args

    ListProperty<String>

    []

    The program arguments passed to the java command.

    +
    +
    Groovy
    +
    +
    docker {
+    springBootApplication {
+        baseImage = 'openjdk:8-alpine'
+        ports = [9090, 8080]
+        images = ['awesome-spring-boot:1.115', 'awesome-spring-boot:latest']
+        jvmArgs = ['-Dspring.profiles.active=production', '-Xmx2048m']
+    }
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    docker {
+    springBootApplication {
+        baseImage.set("openjdk:8-alpine")
+        ports.set(listOf(9090, 8080))
+        images.set(setOf("awesome-spring-boot:1.115", "awesome-spring-boot:latest"))
+        jvmArgs.set(listOf("-Dspring.profiles.active=production", "-Xmx2048m"))
+    }
+}
    +
    +
    +
    +
    +

    4.3. Tasks

    +
    +

    The plugin provides a set of tasks for your project and preconfigures them with sensible defaults.

    +
    + ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Task nameDepends OnTypeDescription

    dockerSyncBuildContext

    classes

    TaskProvider<Sync>

    Copies the application files to a temporary directory for image creation.

    dockerCreateDockerfile

    dockerSyncBuildContext

    TaskProvider<Dockerfile>

    Creates the Docker image for the Spring Boot application.

    dockerBuildImage

    dockerCreateDockerfile

    TaskProvider<DockerBuildImage>

    Builds the Docker image for the Spring Boot application.

    dockerPushImage

    dockerBuildImage

    TaskProvider<DockerPushImage>

    Pushes created Docker image to the repository.

    +
    +
    +

    4.4. Generated Dockerfile

    +
    +

    The following Dockerfile shows the typical instructions generated by the plugin. It uses the default values defined by the extension. The resolved main class name is com.bmuschko.gradle.docker.springboot.Application.

    +
    +
    +
    Dockerfile
    +
    +
    FROM openjdk:11-jre-slim
+LABEL maintainer=bmuschko
+WORKDIR /app
+COPY libs libs/
+COPY classes classes/
+ENTRYPOINT ["java", "-cp", "/app/resources:/app/classes:/app/libs/*", "com.bmuschko.gradle.docker.springboot.Application"]
+EXPOSE 8080
    +
    +
    +
    +

    See additional examples for information on how to modify the Dockerfile instructions.

    +
    +
    +
    +

    4.5. Examples

    +
    +

    The following usage examples demonstrate code for common use cases. More scenarios can be found in the functional tests.

    +
    +
    +

    4.5.1. Using the Plugin For an Application Run on Tomcat

    +
    +

    The Spring Boot archive can be created as executable JAR or WAR file. If you are target environment is a Servlet Container or Application Server, the WAR file is likely the better option. To generate a WAR file, simply apply the war plugin and declare the appropriate container-related dependencies to run the application locally.

    +
    +
    +
    Groovy
    +
    +
    plugins {
+    id 'war'
+    id 'org.springframework.boot' version '2.0.3.RELEASE'
+    id 'io.spring.dependency-management' version '1.0.5.RELEASE'
+    id 'com.bmuschko.docker-spring-boot-application' version '9.3.3'
+}
+
+version = '1.0'
+sourceCompatibility = JavaVersion.VERSION_1_8
+targetCompatibility = JavaVersion.VERSION_1_8
+
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+    implementation 'org.springframework.boot:spring-boot-starter-web'
+    providedRuntime 'org.springframework.boot:spring-boot-starter-tomcat'
+    providedRuntime 'org.apache.tomcat.embed:tomcat-embed-jasper'
+}
+
+docker {
+    springBootApplication {
+        baseImage = 'openjdk:8-alpine'
+    }
+}
    +
    +
    +
    +
    Kotlin
    +
    +
    plugins {
+    war
+    id("org.springframework.boot") version "2.0.3.RELEASE"
+    id("io.spring.dependency-management") version "1.0.5.RELEASE"
+    id("com.bmuschko.docker-spring-boot-application") version "9.3.3"
+}
+
+version = "1.0"
+
+java {
+    sourceCompatibility = JavaVersion.VERSION_1_8
+    targetCompatibility = JavaVersion.VERSION_1_8
+}
+
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+    implementation("org.springframework.boot:spring-boot-starter-web")
+    providedRuntime("org.springframework.boot:spring-boot-starter-tomcat")
+    providedRuntime("org.apache.tomcat.embed:tomcat-embed-jasper")
+}
+
+docker {
+    springBootApplication {
+        baseImage.set("openjdk:8-alpine")
+    }
+}
    +
    +
    +
    +
    +

    4.5.2. Providing Container Build-Time and Runtime Parameters

    +
    +

    It’s common practice to provide JVM parameters to a Spring Boot application running in a container. For example, you might want to provide memory parameters or set a specific Spring profile. There’s a two ways to achieve this. Each of them serve different use cases.

    +
    +
    +

    You may want to provide JVM parameters when you build the image with a Dockerfile. That’s likely the case if you don’t want to change the parameters later when running the image in a container. You can provide a list of JVM parameters that should be baked into image with the extension property jvmArgs.

    +
    +
    +

    Hard-coding a JVM parameter may not be the right solution to your problem. There are situations when you want to provide runtime behavior when starting the container. A typical example is a Spring profile that needs to be enabled depending on the environment you want to run.

    +
    +
    +

    If you are running the image with Docker, then you can just provide pre-built environment variables known to Spring Boot. Below, we are running an application with the prod profile.

    +
    +
    +
    +
    $ docker run -e "SPRING_PROFILES_ACTIVE=prod" -p 8080:8080 -t my-spring-boot-app:1.2.3
    +
    +
    +
    +

    You can achieve the same behavior in Kubernetes by defining an environment variable in your Pod or Deployment spec. The example below demonstrates the use of a Deployment.

    +
    +
    +
    deployment.yaml
    +
    +
    kind: Deployment
+apiVersion: apps/v1
+metadata:
+  name: my-spring-boot-app
+spec:
+  replicas: 3
+  selector:
+    matchLabels:
+      app: my-spring-boot-app
+  template:
+    metadata:
+      labels:
+        app: my-spring-boot-app
+    spec:
+      containers:
+        - name: my-spring-boot-app
+          image: my-spring-boot-app:1.2.3
+          env:
+          - name: SPRING_PROFILES_ACTIVE
+            value: prod
    +
    +
    +
    +
    +
    +
    +
    +

    5. Change Log

    +
    +

    v9.3.3 (September 20, 2023)

    +
    +
      +
    • +

      Make DockerRemoteApi plugin configuration cache compatible for Gradle 8.1+ - PR 1193

      +
      • +
    +
    +

    v9.3.2 (July 31, 2023)

    +
    +
      +
    • +

      Fail build upon error with push operation - PR 1183

      +
      • +
    • +

      Upgrade Docker Java to 3.3.2 - PR 1187

      +
      • +
    • +

      Upgrade ASM to 9.5 - PR 1188

      +
      • +
    +
    +

    v9.3.1 (April 8, 2023)

    +
    +
      +
    • +

      Revert automatically setting JAVA_OPTS environment variable - PR 1176

      +
      • +
    +
    +

    v9.3.0 (March 20, 2023)

    +
    +
      +
    • +

      Introduce property for setting a USER instruction in convention plugin extension - PR 1166

      +
      • +
    • +

      Add JAVA_OPTS to entrypoint instruction - PR 1167

      +
      • +
    • +

      Allow for setting platform for Dockerfile task - PR 1170

      +
      • +
    • +

      Upgrade Docker Java to 3.3.0 - PR 1171

      +
      • +
    +
    +

    v9.2.1 (February 7, 2023)

    +
    +
      +
    • +

      Correct input annotation for imageFile property of DockerLoadImage task - PR 1164

      +
      • +
    • +

      Fix NullPointer on docker hosts with <none> tags in DockerSaveImage task - PR 1163

      +
      • +
    +
    +

    v9.2.0 (January 31, 2023)

    +
    +
      +
    • +

      Revert shading of Docker Java - PR 1154

      +
      • +
    • +

      Writer type is not compatible with configuration cache - PR 1155

      +
      • +
    • +

      Assign correct annotation for DockerCopyFileToContainer property - PR 1156

      +
      • +
    • +

      Deprecate withCommand methods for DockerExecContainer task - PR 1161

      +
      • +
    +
    +

    v9.1.0 (December 20, 2022)

    +
    +
      +
    • +

      Fix shading of Docker Java and its transitive dependencies - PR 1144

      +
      • +
    • +

      Upgrade to Docker Java to 3.2.14 - PR 1142

      +
      • +
    • +

      Don’t use set method to define task default property values - PR 1124

      +
      • +
    • +

      Convert production source code from Groovy to Java - PR 1117

      +
      • +
    +
    +

    v9.0.1 (November 16, 2022)

    +
    +
      +
    • +

      Correct links in user guide that point to outdated API docs - PR 1122

      +
      • +
    +
    +

    v9.0.0 (November 12, 2022)

    +
    +
      +
    • +

      Configuration cache support - Issue 1102

      +
      • +
    • +

      Support Java up to version 20 with latest ASM library - PR 1107

      +
      • +
    • +

      Introduce extension attribute for setting program arguments in convention plugins - PR 1105

      +
      • +
    • +

      Breaking Change! Expose repository and tag properties for DockerCommitImage task - PR 1101

      +
      • +
    • +

      Support auto-detection DOCKER_HOST on macOS Ventura with latest Docker Desktop - PR 1111

      +
      • +
    +
    +

    v8.1.0 (September 20, 2022)

    +
    +
      +
    • +

      Fix custom registry in logs for DockerPullImage and DockerPushImage tasks - PR 1091

      +
      • +
    • +

      Add "add" and "drop" host config capability to DockerCreateContainer task - PR 1087

      +
      • +
    • +

      Split end user and developer guides - PR 1089

      +
      • +
    +
    +

    v8.0.0 (August 9, 2022)

    +
    +
      +
    • +

      Make DockerSaveImage task out of date if the input state on the daemon changed - PR 1073

      +
      • +
    • +

      Proper handling of onNext callbacks in DockerLogsContainer task - PR 1083

      +
      • +
    • +

      Close InputStream to avoid too many file handles when searching for main class - PR 1081

      +
      • +
    • +

      Support multiple images for DockerSaveImage task - PR 1069

      +
      • +
    • +

      Add IPAM configuration for a network in DockerCreateNetwork task - PR 1080

      +
      • +
    • +

      Make DockerBuildImage task out-of-date if configured tags are missing - PR 1072

      +
      • +
    • +

      Add support for docker tmpfs mounts in DockerCreateContainer task - PR 1036

      +
      • +
    • +

      Upgrade to Gradle 7, use version catalog - PR 1075

      +
      • +
    • +

      Use a stable tag for OpenJDK base image - PR 1074

      +
      • +
    +
    +

    v7.4.0 (May 23, 2022)

    +
    +
      +
    • +

      Credentials in the config.json are overwritten by default (but unset) auth-config - PR 1065

      +
      • +
    • +

      DockerBuildImage task creates image ID file and parent directory if it doesn’t exist - PR 1064

      +
      • +
    +
    +

    v7.3.0 (March 1, 2022)

    +
    +
      +
    • +

      Upgrade to Docker Java 3.2.13 - PR 1058

      +
      • +
    • +

      Fix images property in DockerSpringBootApplication javadoc - PR 1057

      +
      • +
    • +

      Introduce memory property in DockerBuildImage custom task - PR 1053

      +
      • +
    +
    +

    v7.2.0 (January 6, 2022)

    +
    +
      +
    • +

      Upgrade to Docker Java 3.2.12 - PR 1042

      +
      • +
    • +

      Better transparency for the generated Dockerfile in user guide - PR 1028

      +
      • +
    +
    +

    v7.1.0 (June 28, 2021)

    +
    +
      +
    • +

      Upgrade to Docker Java 3.2.10 - PR 1025

      +
      • +
    • +

      Introduce platform parameter for build image task - PR 1024

      +
      • +
    • +

      Introduce platform parameter for create container task - PR 1026

      +
      • +
    +
    +

    v7.0.1 (June 9, 2021)

    +
    +
      +
    • +

      Reduce Docker Java dependency size - PR 1016

      +
      • +
    • +

      Bump ASM opcode version for JVM convention plugins - PR 1012

      +
      • +
    • +

      Improve Groovydoc documentation of Dockerfile task - PR 1017

      +
      • +
    +
    +

    v7.0.0 (May 2, 2021)

    +
    +
      +
    • +

      Breaking Change! Change source and target compatibility of plugin to Java 11

      +
      • +
    • +

      Breaking Change! Correct method signature of Dockerfile.addFile(Dockerfile.File file) - Issue 990

      +
      • +
    • +

      Preserve documentation per version - PR 998

      +
      • +
    • +

      Upgrade ASM for JDK 16 support - PR 1002

      +
      • +
    • +

      Breaking Change! Upgrade image to Java 11 for convention plugins - PR 1005

      +
      • +
    • +

      Breaking Change! Upgrade to Docker Java 3.2.8 - PR 1005

      +
      • +
    • +

      Breaking Change! Remove extra tasks - PR 1004

      +
      • +
    • +

      Publish plugin artifacts Gradle Plugin Portal instead of Bintray JCenter - PR 1001

      +
      • +
    • +

      Explicitly spell out fully qualified class references to inner classes Dockerfile.File and Dockerfile.CopyFile - PR 997

      +
      • +
    +
    +

    v6.7.0 (January 10, 2021)

    +
    +
      +
    • +

      Turn on RegistryAuthLocator for Windows - PR 974

      +
      • +
    • +

      Handle missing ServerURL from auth helper response - PR 959

      +
      • +
    • +

      Add support for health check in DockerCreateContainer custom task - PR 978

      +
      • +
    • +

      Deprecate extra tasks - PR 981

      +
      • +
    • +

      Remove Netty exec factory support - PR 963

      +
      • +
    +
    +

    v6.6.1 (July 29, 2020)

    +
    +
      +
    • +

      Mapping of DSL property images should propagate down to build and push task in convention plugins - PR 956

      +
      • +
    +
    +

    v6.6.0 (July 16, 2020)

    +
    +
      +
    • +

      Use configuration avoidance API in convention plugins - PR 940

      +
      • +
    • +

      Configured registry credentials in build script should take precedence over Docker credential helper - PR 945

      +
      • +
    +
    +

    v6.5.0 (July 3, 2020)

    +
    +
      +
    • +

      Default to Docker Hub when no registry is explicitly given - PR 942

      +
      • +
    • +

      Upgrade of Docker Java library to version 3.2.5 and default to communication transport to Apache HttpClient 5 - PR 942

      +
      • +
    +
    +

    v6.4.0 (March 23, 2020)

    +
    +
      +
    • +

      Keep the network name and network ID separate in DockerCreateNetwork - PR 920

      +
      • +
    • +

      Upgrade ASM dependency to Java 13/14-compatible version - PR 929

      +
      • +
    +
    +

    v6.3.0 (March 14, 2020)

    +
    +
      +
    • +

      Retrieve all known credentials for DockerBuildImage custom task - PR 913

      +
      • +
    • +

      Add support for setting custom workingDir in DockerExecContainer task - PR 927

      +
      • +
    +
    +

    v6.2.0 (March 10, 2020)

    +
    +
      +
    • +

      Upgrade Docker Java to next minor version - PR 925

      +
      • +
    • +

      Expose property for providing extra hosts - PR 926

      +
      • +
    +
    +

    v6.1.4 (February 23, 2020)

    +
    +
      +
    • +

      Nested property FileInstruction.getFile() renders warning as it doesn’t provide input or output annotation - Issue 919

      +
      • +
    +
    +

    v6.1.3 (January 26, 2020)

    +
    +
      +
    • +

      Credentials helper JSON output parsing falls back to default if it cannot be read properly - PR 909

      +
      • +
    +
    +

    v6.1.2 (January 14, 2020)

    +
    +
      +
    • +

      Decode base64 auth header - PR 902

      +
      • +
    +
    +

    v6.1.1 (December 12, 2019)

    +
    +
      +
    • +

      Add debug logging in Docker configuration parsing - PR 898

      +
      • +
    +
    +

    v6.1.0 (December 12, 2019)

    +
    +
      +
    • +

      Allow configuring the main class name for convention plugins - PR 892

      +
      • +
    • +

      Do not parse config file if it doesn’t exist - Issue 887

      +
      • +
    +
    +

    v6.0.0 (November 16, 2019)

    +
    +
      +
    • +

      Breaking Change! Multi-tag support for push operation and convention plugins - PR 867

      +
      • +
    • +

      Breaking Change! Renamed property tags to images for extensions DockerJavaApplication and DockerSpringBootApplication.

      +
      • +
    • +

      Breaking Change! Renamed property tag to image for custom tasks DockerBuildImage, DockerCommitImage, DockerPullImage, DockerSaveImage, DockerListImages,DockerCreateContainer.

      +
      • +
    • +

      Breaking Change! Removal of method DockerPullImage.getImageId(). Use DockerPullImage.getImage() instead.

      +
      • +
    • +

      Breaking Change! Host-related configuration properties in DockerCreateContainer have been moved to nested property for better maintainability - PR 873

      +
      • +
    • +

      Add properties ipcMode and sysctls to DockerCreateContainer - PR 862

      +
      • +
    • +

      Gradle 6.0 compatibility fixes - PR 869

      +
      • +
    • +

      Improve DSL for configuring registry credentials for custom tasks - PR 879

      +
      • +
    • +

      Plugin resolves and uses Docker credential helper - PR 865

      +
      • +
    • +

      Upgrade of Docker Java library to version 3.1.5

      +
      • +
    +
    +

    v5.3.0 (October 30, 2019)

    +
    +
      +
    • +

      Expose project-prop/sys-prop/env-var to optionally use netty-exec-cmd-factory - PR 876

      +
      • +
    +
    +

    v5.2.0 (October 5, 2019)

    +
    +
      +
    • +

      Potentially Breaking Change! Remove duplicated code in convention plugins - PR 864

      +
      • +
    • +

      Restore compatibility with Gradle 5.1 as runtime version - Issue 866

      +
      • +
    +
    +

    v5.1.0 (September 18, 2019)

    +
    +
      +
    • +

      Potentially Breaking Change! Remove remaining use of Application Plugin in convention plugins - PR 852

      +
      • +
    +
    +

    v5.0.0 (August 13, 2019)

    +
    +
      +
    • +

      Breaking Change! Remove exec/cmd hooks in Docker application plugin - PR 806

      +
      • +
    • +

      Breaking Change! API cleanup of Dockerfile task - PR 812

      +
      • +
    • +

      Breaking Change! Removed ItemJoiner from public API - PR 836

      +
      • +
    • +

      Respect symlinks in build context - Issue 837

      +
      • +
    +
    +

    v4.10.0 (June 12, 2019)

    +
    +
      +
    • +

      Expose target property for BuildImageTask - PR 813

      +
      • +
    • +

      Remove final from DockerBuildImage.labels property - PR 823

      +
      • +
    • +

      Always set imageId within DockerBuildImage on success - PR 819

      +
      • +
    +
    +

    v4.9.0 (May 25, 2019)

    +
    +
      +
    • +

      Avoid memory leakage by replacing addShutdownHook with Gradle.buildFinished - PR 810

      +
      • +
    • +

      DockerBuildImage will print whole lines by collecting output and waiting for newline - PR 799

      +
      • +
    • +

      DockerBuildImage reinstated ImageId output file and check in Docker registry - PR 807

      +
      • +
    +
    +

    v4.8.1 (May 11, 2019)

    +
    +
      +
    • +

      Introduce maintainer property to extension of Spring Boot application plugin - Issue 779

      +
      • +
    • +

      Breaking Change! Removed RepositoriesFallbackPlugin that was applied automatically - Issue 794

      +
      • +
    • +

      Breaking Change! The Docker client in AbstractDockerRemoteApiTask is not inject into the method runRemoteCommand anymore - Issue 802

      +
      • +
    +
    +

    v4.8.0 (April 22, 2019)

    +
    +
      +
    • +

      Expose extension property for configuring JVM arguments - PR 790

      +
      • +
    +
    +

    v4.7.1 (April 13, 2019)

    +
    + +
    +

    v4.7.0 (April 9, 2019)

    +
    +
      +
    • +

      Tasks created by convention plugins should assign a task group - Issue 768

      +
      • +
    • +

      Main class detection should work with a Kotlin-based application - Issue 766

      +
      • +
    • +

      Fix gradle 5.x deprecation warnings - Issue 782

      +
      • +
    • +

      Bump docker-java to 3.1.2 - Issue 787

      +
      • +
    +
    +

    v4.6.2 (March 9, 2019)

    +
    +
      +
    • +

      Add shaded JAF dependency to simplify usage of plugin with Java 11 - Issue 764

      +
      • +
    +
    +

    v4.6.1 (March 6, 2019)

    +
    +
      +
    • +

      Fix setting binds in DockerCreateContainer task - Issue 758

      +
      • +
    +
    +

    v4.6.0 (March 3, 2019)

    +
    +
      +
    • +

      Breaking Change! Plugin declares and uses Docker Java as runtime library - PR 751

      +
      • +
    • +

      Breaking Change! Custom task DockerClient has been renamed to DockerOperation to avoid conflicting Docker Java class name

      +
      • +
    • +

      Shade plugin dependencies except Docker Java - PR 755

      +
      • +
    +
    +

    v4.5.0 (February 19, 2019)

    +
    +
      +
    • +

      Dockerfile.FileInstruction does not use flags if Dockerfile.File is passed in using a Provider - PR 753

      +
      • +
    • +

      Inline main class finder and avoid explicit dependency on Spring Boot - PR 752

      +
      • +
    +
    +

    v4.4.1 (February 5, 2019)

    +
    +
      +
    • +

      Cannot set publishAll property without error - PR 742

      +
      • +
    +
    +

    v4.4.0 (January 31, 2019)

    +
    +
      +
    • +

      Breaking Change! Define image with more fine-grained image layers - PR 736

      +
      • +
    • +

      Bump docker-java-shaded to latest version - PR 729

      +
      • +
    • +

      Task DockerCreateContainer gained option groups - Pull Request 731

      +
      • +
    +
    +

    v4.3.0 (January 12, 2019)

    +
    +
      +
    • +

      Breaking Change! The task DockerLoadImage should use Provider type for image file

      +
      • +
    • +

      Breaking Change! Use the default value $buildDir/docker for DockerBuildImage.inputDir to align with the default directory of the Dockerfile task

      +
      • +
    • +

      Breaking Change! Align task names in DockerJavaApplicationPlugin with the ones from the DockerSpringBootApplicationPlugin

      +
      • +
    • +

      Examples in user guide that demonstrate the creation of a custom Docker task and the modification of existing Dockerfile instructions

      +
      • +
    +
    +

    v4.2.0 (December 16, 2018)

    +
    +
      +
    • +

      Applying the Docker Spring Boot application plugin with the plugins DSL should not fail - Issue 702

      +
      • +
    • +

      Breaking Change! Remove all deprecations - Issue 675

      +
      +
        +
      • +

        Removed DockerCreateContainer.env, replaced by DockerCreateContainer.envVars

        +
        • +
      • +

        Removed DockerBuildImage.tag, replaced by DockerBuildImage.tags

        +
        • +
      • +

        Removed DockerExecContainer.cmd, replaced by DockerExecContainer.commands

        +
        • +
      • +

        Removed DockerExecContainer.execId, replaced by DockerExecContainer.execIds

        +
        • +
      +
      +
      • +
    • +

      DockerBuildImage.tags.add/addAll only work after using tags.set - Issue 712

      +
      • +
    • +

      User guide sample on Docker links should not use doFirst - Issue 715

      +
      • +
    • +

      DockerCommitImage task should not fail when accessing container ID property value - Issue 718

      +
      • +
    +
    +

    v4.1.0 (November 29, 2018)

    +
    + +
    +

    v4.0.5 (November 22, 2018)

    +
    +
      +
    • +

      Avoid the use of application plugin extension to ensure compatibility - Issue 706

      +
      • +
    +
    +

    v4.0.4 (November 4, 2018)

    +
    +
      +
    • +

      Implementation to make DockerBuildImage task incremental and cacheable is not sufficient - Issue 697

      +
      • +
    +
    +

    v4.0.3 (October 30, 2018)

    +
    +
      +
    • +

      Correctly handle the case where inputDir is not where dockerFile is located - Pull Request 693

      +
      • +
    +
    +

    v4.0.2 (October 27, 2018)

    +
    +
      +
    • +

      Output file name containing the image ID created by DockerBuildImage should work on Windows - Pull Request 690

      +
      • +
    +
    +

    v4.0.1 (October 20, 2018)

    +
    +
      +
    • +

      Returned image ID for a DockerBuildImage task should never be null - Pull Request 687

      +
      • +
    +
    +

    v4.0.0 (October 12, 2018)

    +
    +
      +
    • +

      Breaking Change! Use Provider concept throughout to support lazy evaluation via public API - Pull Request 659

      +
      • +
    • +

      Breaking Change! Consumers of this plugin will have to use Java 8 or higher - Pull Request 676

      +
      • +
    • +

      Breaking Change! Removal of AbstractReactiveStreamsTask from inherited custom task hierarchy

      +
      • +
    • +

      NEW Add tested, multi-lingual user guide - Pull Request 677

      +
      • +
    • +

      NEW Make DockerBuildImage task incremental and cacheable - Pull Request 672

      +
      • +
    • +

      Introduce method for translating username/password into a PasswordCredentials - Pull Request 668

      +
      • +
    • +

      Add @CompileStatic to much of the code base that can support it - Pull Request 676

      +
      • +
    • +

      Use appropriate types for Groovy/Kotlin DSL interoperability for reactive streams functionality - Pull Request 678

      +
      • +
    +
    +

    v3.6.2 (October 2, 2018)

    +
    +
      +
    • +

      DockerCreateContainer gained pid option - Pull Request 652

      +
      • +
    • +

      Dockerfile validation takes into account comments - Issue 657

      +
      • +
    • +

      Bump docker-java-shaded to rc-5 - Issue 660

      +
      • +
    • +

      DockerBuildImage gained network option - Issue 608

      +
      • +
    • +

      DockerCreateContainer gained autoRemove option - Issue 639

      +
      • +
    +
    +

    v3.6.1 (August 21, 2018)

    +
    +
      +
    • +

      Task DockerClient, and the passed dockerClient object, is now cached by configuration - Pull Request 644

      +
      • +
    • +

      Task DockerBuildImage gained option cacheFrom - Pull Request 646

      +
      • +
    +
    +

    v3.6.0 (August 7, 2018)

    +
    + +
    +

    v3.5.0 (July 24, 2018)

    +
    +
      +
    • +

      Support for dockerizing Spring Boot applications - Pull Request 619

      +
      • +
    • +

      Removed deprecated ResponseHandler - Pull Request 624

      +
      • +
    • +

      Introduce user guide for more readable, maintainable documentation - Pull Request 630

      +
      • +
    • +

      Upgrade to Gradle Wrapper 4.9

      +
      • +
    +
    +

    v3.4.4 (July 15, 2018)

    +
    +
      +
    • +

      Task DockerLivenessContainer had its polling logic reworked to be more failure proof.

      +
      • +
    +
    +

    v3.4.3 (July 8, 2018)

    +
    +
      +
    • +

      Task DockerCreateContainer has its method withEnvVars changed to accept a def, which in turn can be anything (String, Integer, Closure, etc) but will eventually have all its keys/values resolved to java strings. - Pull Request 617

      +
      • +
    • +

      Task DockerLivenessContainer had minor verbiage changes to its output. - Pull Request 617

      +
      • +
    • +

      Use -all wrapper to better integrate with IDE’s. - Pull Request 617

      +
      • +
    +
    +

    v3.4.2 (July 7, 2018)

    +
    + +
    +

    v3.4.1 (July 3, 2018)

    +
    +
      +
    • +

      BUGFIX for task DockerCreateContainer where envs were not being properly honored. - Pull Request 614

      +
      • +
    +
    +

    v3.4.0 (July 1, 2018)

    +
    +
      +
    • +

      Task Dockerfile now supports multi-stage builds - Pull Request 607

      +
      • +
    • +

      When plugin is applied to sub-projects we will additionally search rootProject for repos to use - Pull Request 610

      +
      • +
    • +

      Task DockerCreateContainer has deprecated env in favor of envVars which can ONLY be added to with a helper method withEnvVar that can be called N times for setting environment variables. - Pull Request 609

      +
      • +
    • +

      Task DockerLivenessProbeContainer has been renamed to DockerLivenessContainer. It’s probe method has been renamed to livnessProbe. Task DockerExecStopContainer had its probe method renamed to execStopProbe. - Pull Request 611

      +
      • +
    +
    +

    v3.3.6 (June 23, 2018)

    +
    +
      +
    • +

      Task DockerCopyFileToContainer can now copy N number of files via methods withFile and withTarFile. - Pull request 605

      +
      • +
    +
    +

    v3.3.5 (June 17, 2018)

    +
    +
      +
    • +

      Fix bug within DockerExecContainer when exitCode can be null (default to 0 if so). - Pull request 602

      +
      • +
    +
    +

    v3.3.4 (June 16, 2018)

    +
    +
      +
    • +

      Task DockerExecContainer gained ability to specify multiple execution commands to be run. - Pull request 600

      +
      • +
    • +

      Various tasks had their progress logger output cleaned up. - Pull request 601

      +
      • +
    +
    +

    v3.3.3 (June 8, 2018)

    +
    +
      +
    • +

      Explicitly call toString() on values in maps passed to Docker API. - Pull request 595

      +
      • +
    • +

      Task DockerLivenessProbeContainer gained method lastInspection() which will return the last "docker inspect container" response AFTER execution has completed. - Pull request 596

      +
      • +
    +
    +

    v3.3.2 (June 5, 2018)

    +
    +
      +
    • +

      Task DockerLivenessProbeContainer now has the probe option set to optional and if NOT defined will fallback to checking if container is in a running state. - Pull request 594

      +
      • +
    +
    +

    v3.3.1 (June 2, 2018)

    +
    +
      +
    • +

      Various minor refactorings surrounding new task DockerExecStopContainer. - Pull request 592

      +
      • +
    +
    +

    v3.3.0 (June 1, 2018)

    +
    +
      +
    • +

      Added task DockerClient to pass the raw docker-java client to the onNext closure if defined. - Pull request 589

      +
      • +
    • +

      Task DockerCreateContainer will now log the containerName if set, which is the standard within this plugin, otherwise fallback to the just created containerId.

      +
      • +
    • +

      Task DockerExecContainer gained option successOnExitCodes to allow user to define a list of successful exit codes the exec is allowed to return and will fail if not in list. Default behavior is to do no check. - Pull request 590

      +
      • +
    • +

      Added task DockerLivenessProbeContainer which will poll, for some defined amount of time, a running containers logs looking for a given message and fail if not found. - Pull request 587

      +
      • +
    • +

      Added task DockerExecStopContainer to allow the user to execute an arbitrary cmd against a container, polling for it to enter a non-running state, and if that does not succeed in time issue stop request. - Pull request 591

      +
      • +
    +
    +

    v3.2.9 (May 22, 2018)

    +
    +
      +
    • +

      Fixed a bug in task DockerCreateContainer where option cpuset is now renamed differently in docker-java. - Pull request 585

      +
      • +
    +
    +

    v3.2.8 (April 30, 2018)

    +
    +
      +
    • +

      Task DockerExecContainer gained option user to specify a user/group. - Pull request 574

      +
      • +
    • +

      Task DockerCreateContainer gained option ipV4Address to specify a specific ipv4 address to use. - Pull request 449

      +
      • +
    • +

      Bump gradle to 4.7. - Pull request 578

      +
      • +
    +
    +

    v3.2.7 (April 19, 2018)

    +
    +
      +
    • +

      Task DockerSaveImage gained option useCompression to optionally gzip the created tar. - Pull request 565

      +
      • +
    • +

      Add javax.activation dependency for users who are working with jdk9+. - Pull request 572

      +
      • +
    +
    +

    v3.2.6 (March 31, 2018)

    +
    +
      +
    • +

      Cache docker-java client instead of recreating for every request/task invocation. This is a somewhat big internal change but has a lot of consequences and so it was deserving of its own point release. - Pull request 558

      +
      • +
    +
    +

    v3.2.5 (March 2, 2018)

    +
    +
      +
    • +

      Added macAddress option to task DockerCreateContainer - Pull request 538

      +
      • +
    • +

      Initial work for codenarc analysis - Pull request 537

      +
      • +
    • +

      Use of docker-java-shaded library in favor of docker-java proper to get around class-loading/clobbering issues - Pull request 550

      +
      • +
    • +

      Honor DOCKER_CERT_PATH env var if present - Pull request 549

      +
      • +
    • +

      Task DockerSaveImage will now create file for you should it not exist - Pull request 552

      +
      • +
    • +

      Task DockerPushImage will now include tag info in logging if applicable - Pull request 554

      +
      • +
    • +

      !!!!! BREAKING: Property inputStream of task DockerLoadImage has been changed from type InputStream to Closure<InputStream>. This was done to allow scripts/code/pipelines to delay getting the image and side-step this property getting configured during gradles config-phase. - Pull request 552

      +
      • +
    +
    +

    v3.2.4 (February 5, 2018)

    +
    + +
    +

    v3.2.3 (January 26, 2018)

    +
    +
      +
    • +

      If DockerWaitHealthyContainer is run on an image which was not built with HEALTHCHECK than fallback to using generic status - Pull request 520

      +
      • +
    +
    +

    v3.2.2 (January 17, 2018)

    +
    + +
    +

    v3.2.1 (November 22, 2017)

    +
    + +
    +

    v3.2.0 (September 29, 2017)

    +
    +
      +
    • +

      Update createBind to use docker-java parse method - Pull request 452

      +
      • +
    • +

      Allow Docker to cache app libraries dir when DockerJavaApplication plugin is used - Pull request 459

      +
      • +
    +
    +

    v3.1.0 (August 21, 2017)

    +
    +
      +
    • +

      DockerListImages gained better support for filters - Pull request 414

      +
      • +
    • +

      Use alpine:3.4 image in functional tests - Pull request 416

      +
      • +
    • +

      DockerBuildImage and DockerCreateContainer gained optional argument shmSize - Pull request 413

      +
      • +
    • +

      Added tasks DockerInspectNetwork, DockerCreateNetwork, and DockerRemoveNetwork - Pull request 422

      +
      • +
    • +

      Add statically typed methods for configuring plugin with Kotlin - Pull request 426

      +
      • +
    • +

      Fix Dockerfile task up-to-date logic - Pull request 433

      +
      • +
    • +

      Multiple ENVs are not set the same way as single ENV instructions - Pull request 415

      +
      • +
    • +

      DockerCreateContainer changed optional input networkMode to network to better align with docker standatds - Pull request 440

      +
      • +
    • +

      The first instruction of a Dockerfile has to be FROM except for Docker versions later than 17.05 - Pull request 435

      +
      • +
    • +

      Bump verison of docker-java to 3.0.13 - Commit b2d936

      +
      • +
    +
    +

    v3.0.10 (July 7, 2017)

    +
    + +
    +

    v3.0.9 (July 4, 2017)

    +
    + +
    +

    v3.0.8 (June 16, 2017)

    +
    +
      +
    • +

      Task DockerPullImage gained method getImageId() which returns the fully qualified imageId of the image that was just pulled - Pull request 379

      +
      • +
    • +

      Task DockerBuildImage gained property tags which allows for multiple tags to be specified when building an image - Pull request 380

      +
      • +
    • +

      Task DockerCreateContainer gained property networkAliases - Pull request 384

      +
      • +
    +
    +

    v3.0.7 (May 17, 2017)

    +
    +
      +
    • +

      Invoke onNext closures call() method explicitly - Pull request 368

      +
      • +
    • +

      Adds new task DockerInspectExecContainer which allows to inspect exec instance - Pull request 362

      +
      • +
    • +

      `functionalTest’s can now run against a native docker instance - Pull request 369

      +
      • +
    • +

      DockerLogsContainer now preserves leading space - Pull request 370

      +
      • +
    • +

      Allow customization of app plugin entrypoint/cmd instructions - Pull request 359

      +
      • +
    • +

      Task Dockerfile will no longer be forced as UP-TO-DATE, instead the onus will be put on developers to code this should they want this functionality. - Issue 357

      +
      • +
    • +

      Now that functionalTest’s work natively, and in CI, add the test `started, passed and failed logging messages so as to make it absolutely clear to users what is being run vs having no output at all. - Pull request 373

      +
      • +
    • +

      Bump docker-java to v`3.0.10` - Pull request 378

      +
      • +
    +
    +

    v3.0.6 (March 2, 2017)

    +
    + +
    +

    v3.0.5 (December 27, 2016)

    +
    + +
    +

    v3.0.4 (December 1, 2016)

    +
    + +
    +

    v3.0.3 (September 6, 2016)

    +
    + +
    +

    v3.0.2 (August 14, 2016)

    +
    +
      +
    • +

      Add support for build-time variables in DockerBuildImage task - Pull request 240

      +
      • +
    • +

      Fix incorrect docker-java method name in DockerCreateContainer task - Pull request 242

      +
      • +
    • +

      Can define devices on DockerCreateContainer task - Pull request 245

      +
      • +
    • +

      Can now supply multiple ports when working with docker-java-application - Pull request 254

      +
      • +
    • +

      Bump docker-java to 3.0.2 - Pull request 259

      +
      • +
    • +

      If buildscript repos are required make sure they are added after evaluation - Pull request 260

      +
      • +
    +
    +

    v3.0.1 (July 6, 2016)

    +
    +
      +
    • +

      Simplify Gradle TestKit usage - Pull request 225

      +
      • +
    • +

      Ensure tlsVerify is set in addition to certPath for DockerClientConfig setup - Pull request 230

      +
      • +
    • +

      Upgrade to Gradle 2.14.

      +
      • +
    +
    +

    v3.0.0 (June 5, 2016)

    +
    +
      +
    • +

      Task DockerLogsContainer gained attribute sink - Pull request 203

      +
      • +
    • +

      Task DockerBuildImage will no longer insert extra newline as part of build output - Pull request 206

      +
      • +
    • +

      Upgrade to docker-java 3.0.0 - Pull request 217

      +
      • +
    • +

      Fallback to buildscript.repositories for internal dependency resolution if no repositories were defined - Pull request 218

      +
      • +
    • +

      Added task DockerExecContainer - Pull request 221

      +
      • +
    • +

      Added task DockerCopyFileToContainer - Pull request 222

      +
      • +
    • +

      Task DockerCreateContainer gained attribute restartPolicy - Pull request 224

      +
      • +
    • +

      Remove use of Gradle internal methods.

      +
      • +
    • +

      Added ISSUES.md file.

      +
      • +
    • +

      Upgrade to Gradle 2.13.

      +
      • +
    +
    +

    v2.6.8 (April 10, 2016)

    +
    + +
    +

    v2.6.7 (March 10, 2016)

    +
    +
      +
    • +

      Upgrade to Gradle 2.11.

      +
      • +
    • +

      Bug fix when copying single file from container and hostPath is set to directory for DockerCopyFileFromContainer - Pull request 163

      +
      • +
    • +

      Step reports are now printed to stdout by default for DockerBuildImage - Pull request 145

      +
      • +
    • +

      UP-TO-DATE functionality has been removed from DockerBuildImage as there were too many corner cases to account for - Pull request 172

      +
      • +
    +
    +

    v2.6.6 (February 27, 2016)

    +
    + +
    +

    v2.6.5 (January 16, 2016)

    +
    + +
    +

    v2.6.4 (December 24, 2015)

    +
    + +
    +

    v2.6.3 (December 23, 2015)

    +
    +
      +
    • +

      Expose force and removeVolumes properties on DockerRemoveContainer - Pull request 129.

      +
      • +
    +
    +

    v2.6.2 (December 22, 2015)

    +
    +
      +
    • +

      Expose support for LogDriver on DockerCreateContainer - Pull request 118.

      +
      • +
    • +

      Upgrade to Docker Java 2.1.2.

      +
      • +
    +
    +

    v2.6.1 (September 21, 2015)

    +
    +
      +
    • +

      Correct the withVolumesFrom call on DockerCreateContainer task which needs to get a VolumesFrom[] array as the parameter - Pull request 102.

      +
      • +
    • +

      Upgrade to Docker Java 2.1.1 - Pull request 109.

      +
      • +
    +
    +

    v2.6 (August 30, 2015)

    +
    +
      +
    • +

      Upgrade to Docker Java 2.1.0 - Pull request 92. +Note: The Docker Java API changed vastly with v2.0.0. The tasks DockerBuildImage, DockerPullImage and +DockerPushImage do not provide a response handler anymore. This is a breaking change. Future versions of the plugin +might open up the response handling again in some way.

      +
      • +
    • +

      DockerListImages with filter call a wrong function from ListImagesCmdImpl.java - Issue 105.

      +
      • +
    +
    +

    v2.5.2 (August 15, 2015)

    +
    +
      +
    • +

      Fix listImages task throwing GroovyCastException - Issue 96.

      +
      • +
    • +

      Add support for publishAll in DockerCreateContainer - Pull request 94.

      +
      • +
    • +

      Add optional dockerFile option to the DockerBuildImage task - Pull request 47.

      +
      • +
    +
    +

    v2.5.1 (July 29, 2015)

    +
    +
      +
    • +

      Adds Dockerfile support for the LABEL instruction - Pull request 86.

      +
      • +
    • +

      Usage of docker-java library v1.4.0. Underlying API does not provide +setting port bindings for task DockerStartContainer anymore. Needs to be set on DockerCreateContainer.

      +
      • +
    +
    +

    v2.5 (July 18, 2015)

    +
    +
      +
    • +

      Expose response handler for DockerListImages task - v[Issue 75].

      +
      • +
    • +

      Pass in credentials when building an image - Issue 76.

      +
      • +
    +
    +

    v2.4.1 (July 4, 2015)

    +
    + +
    +

    v2.4 (May 16, 2015)

    +
    +
      +
    • +

      Added missing support for properties portBindings and cpuset in CreateContainer - Pull request 66.

      +
      • +
    • +

      Expose response handlers so users can inject custom handling logic - Issue 65.

      +
      • +
    • +

      Upgrade to Gradle 2.4 including all compatible plugins and libraries.

      +
      • +
    +
    +

    v2.3.1 (April 25, 2015)

    +
    +
      +
    • +

      Added support for Binds when creating containers - Pull request 54.

      +
      • +
    • +

      Added task for copying files from a container to a host - Pull request 57.

      +
      • +
    +
    +

    v2.3 (April 18, 2015)

    +
    + +
    +

    v2.2 (April 12, 2015)

    +
    + +
    +

    v2.1 (March 24, 2015)

    +
    +
      +
    • +

      Renamed property registry to registryCredentials for plugin extension and tasks implementing RegistryCredentialsAware to better indicate its purpose. +Note: This is a breaking change.

      +
      • +
    +
    +

    v2.0.3 (March 20, 2015)

    +
    +
      +
    • +

      Allow for specifying port bindings for container start command. - Issue 30.

      +
      • +
    • +

      Throw an exception if an error response is encountered - Issue 37.

      +
      • +
    • +

      Upgrade to Gradle 2.3.

      +
      • +
    +
    +

    v2.0.2 (February 19, 2015)

    +
    +
      +
    • +

      Set source and target compatibility to Java 6 - Issue 32.

      +
      • +
    +
    +

    v2.0.1 (February 10, 2015)

    +
    +
      +
    • +

      Extension configuration method for DockerJavaApplicationPlugin needs to be registered via extension instance - Issue 28.

      +
      • +
    +
    +

    v2.0 (February 4, 2015)

    +
    +
      +
    • +

      Upgrade to Gradle 2.2.1 including all compatible plugins and libraries.

      +
      • +
    +
    +

    v0.8.3 (February 4, 2015)

    +
    +
      +
    • +

      Add project group to default tag built by Docker Java application plugin - Issue 25.

      +
      • +
    +
    +

    v0.8.2 (January 30, 2015)

    +
    +
      +
    • +

      Expose method for task Dockerfile for providing vanilla Docker instructions.

      +
      • +
    +
    +

    v0.8.1 (January 24, 2015)

    +
    + +
    +

    v0.8 (January 7, 2014)

    +
    +
      +
    • +

      Allow for pushing to Docker Hub - Issue 18.

      +
      • +
    • +

      Better handling of API responses.

      +
      • +
    • +

      Note: Change to plugin extension. The property docker.serverUrl is now called docker.url. Instead of docker.credentials, you will need to use docker.registry.

      +
      • +
    +
    +

    v0.7.2 (December 23, 2014)

    +
    +
      +
    • +

      Dockerfile task is always marked UP-TO-DATE after first execution - Issue 13.

      +
      • +
    • +

      Improvements to Dockerfile task - Pull request 16.

      +
      • +
    • +

      Fixed wrong assignment of key field in environment variable instruction.

      +
      • +
    • +

      Allow for providing multiple ports to the expose instruction.

      +
      • +
    +
    +

    v0.7.1 (December 16, 2014)

    +
    +
      +
    • +

      Fixed entry point definition of Dockerfile set by Java application plugin.

      +
      • +
    +
    +

    v0.7 (December 14, 2014)

    +
    +
      +
    • +

      Allow for properly add user-based instructions to Dockfile task with predefined instructions without messing up the order. - Issue 12.

      +
      • +
    • +

      Renamed task dockerCopyDistTar to dockerCopyDistResources to better express intent.

      +
      • +
    +
    +

    v0.6.1 (December 11, 2014)

    +
    +
      +
    • +

      Allow for setting path to certificates for communicating with Docker over SSL - Issue 10.

      +
      • +
    +
    +

    v0.6 (December 7, 2014)

    +
    +
      +
    • +

      Usage of docker-java library v0.10.4.

      +
      • +
    • +

      Added Docker Java application plugin.

      +
      • +
    • +

      Better documentation.

      +
      • +
    +
    +

    v0.5 (December 6, 2014)

    +
    +
      +
    • +

      Fixed implementations of tasks DockerPushImage and DockerCommitImage - Issue 11.

      +
      • +
    +
    +

    v0.4 (November 27, 2014)

    +
    +
      +
    • +

      Added task for creating a Dockerfile.

      +
      • +
    +
    +

    v0.3 (November 23, 2014)

    +
    +
      +
    • +

      Usage of docker-java library v0.10.3.

      +
      • +
    • +

      Changed package name to com.bmuschko.gradle.docker.

      +
      • +
    • +

      Changed group ID to com.bmuschko.

      +
      • +
    • +

      Adapted plugin IDs to be compatible with Gradle’s plugin portal.

      +
      • +
    +
    +

    v0.2 (June 19, 2014)

    +
    +
      +
    • +

      Usage of docker-java library v0.8.2.

      +
      • +
    • +

      Provide custom task type for push operation.

      +
      • +
    • +

      Support for using remote URLs when building image - Issue 3.

      +
      • +
    +
    +

    v0.1 (May 11, 2014)

    +
    +
      +
    • +

      Initial release.

      +
      • +
    +
    +
    +
    +
    + + + + + \ No newline at end of file diff --git a/current/api/allclasses-index.html b/current/api/allclasses-index.html index 92b495bc1..36c05f335 100644 --- a/current/api/allclasses-index.html +++ b/current/api/allclasses-index.html @@ -3,7 +3,7 @@ -All Classes (gradle-docker-plugin 9.3.2 API) +All Classes (gradle-docker-plugin 9.3.3 API) @@ -21,13 +21,13 @@ + + + + + + + + + +
    + +
    + +
    +
    +
    Package com.bmuschko.gradle.docker.internal
    +

    Class DefaultDockerUrlValueSource

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • com.bmuschko.gradle.docker.internal.DefaultDockerUrlValueSource
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/current/api/com/bmuschko/gradle/docker/internal/DockerConfigResolver.html b/current/api/com/bmuschko/gradle/docker/internal/DockerConfigResolver.html index 8fc2883ea..42df8c582 100644 --- a/current/api/com/bmuschko/gradle/docker/internal/DockerConfigResolver.html +++ b/current/api/com/bmuschko/gradle/docker/internal/DockerConfigResolver.html @@ -3,7 +3,7 @@ -DockerConfigResolver (gradle-docker-plugin 9.3.2 API) +DockerConfigResolver (gradle-docker-plugin 9.3.3 API) @@ -21,13 +21,13 @@