Package com.spotify.docker.client

Class DefaultDockerClient.Builder

  • Enclosing class:
    DefaultDockerClient
    public static class DefaultDockerClient.Builder
extends java.lang.Object

    • Field Detail

      • uri

        private java.net.URI uri

      • apiVersion

        private java.lang.String apiVersion

      • connectTimeoutMillis

        private long connectTimeoutMillis

      • readTimeoutMillis

        private long readTimeoutMillis

      • connectionPoolSize

        private int connectionPoolSize

      • dockerAuth

        private boolean dockerAuth

      • useProxy

        private boolean useProxy

      • headers

        private java.util.Map<java.lang.String,​java.lang.Object> headers

      • requestEntityProcessing

        private org.glassfish.jersey.client.RequestEntityProcessing requestEntityProcessing

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • uri

        public java.net.URI uri()

      • uri

        public DefaultDockerClient.Builder uri​(java.lang.String uri)
        Set the URI for connections to Docker.
        Parameters:
        uri - URI String for connections to Docker
        Returns:
        Builder

      • apiVersion

        public DefaultDockerClient.Builder apiVersion​(java.lang.String apiVersion)
        Set the Docker API version that will be used in the HTTP requests to Docker daemon.
        Parameters:
        apiVersion - String for Docker API version
        Returns:
        Builder

      • apiVersion

        public java.lang.String apiVersion()

      • connectTimeoutMillis

        public long connectTimeoutMillis()

      • connectTimeoutMillis

        public DefaultDockerClient.Builder connectTimeoutMillis​(long connectTimeoutMillis)
        Set the timeout in milliseconds until a connection to Docker is established. A timeout value of zero is interpreted as an infinite timeout.
        Parameters:
        connectTimeoutMillis - connection timeout to Docker daemon in milliseconds
        Returns:
        Builder

      • readTimeoutMillis

        public long readTimeoutMillis()

      • readTimeoutMillis

        public DefaultDockerClient.Builder readTimeoutMillis​(long readTimeoutMillis)
        Set the SO_TIMEOUT in milliseconds. This is the maximum period of inactivity between receiving two consecutive data packets from Docker.
        Parameters:
        readTimeoutMillis - read timeout to Docker daemon in milliseconds
        Returns:
        Builder

      • dockerCertificates

        public DefaultDockerClient.Builder dockerCertificates​(DockerCertificatesStore dockerCertificatesStore)
        Provide certificates to secure the connection to Docker.
        Parameters:
        dockerCertificatesStore - DockerCertificatesStore object
        Returns:
        Builder

      • connectionPoolSize

        public int connectionPoolSize()

      • connectionPoolSize

        public DefaultDockerClient.Builder connectionPoolSize​(int connectionPoolSize)
        Set the size of the connection pool for connections to Docker. Note that due to a known issue, DefaultDockerClient maintains two separate connection pools, each of which is capped at this size. Therefore, the maximum number of concurrent connections to Docker may be up to 2 * connectionPoolSize.
        Parameters:
        connectionPoolSize - connection pool size
        Returns:
        Builder

      • dockerAuth

        public boolean dockerAuth()

      • useProxy

        public boolean useProxy()

      • useProxy

        public DefaultDockerClient.Builder useProxy​(boolean useProxy)
        Allows connecting to Docker Daemon using HTTP proxy.
        Parameters:
        useProxy - tells if Docker Client has to connect to docker daemon using HTTP Proxy
        Returns:
        Builder

      • header

        public DefaultDockerClient.Builder header​(java.lang.String name,
                                          java.lang.Object value)
        Adds additional headers to be sent in all requests to the Docker Remote API.

      • headers

        public java.util.Map<java.lang.String,​java.lang.Object> headers()

      • useRequestEntityProcessing

        public DefaultDockerClient.Builder useRequestEntityProcessing​(org.glassfish.jersey.client.RequestEntityProcessing requestEntityProcessing)
        Allows setting transfer encoding. CHUNKED does not send the content-length header while BUFFERED does.

        By default ApacheConnectorProvider uses CHUNKED mode. Some Docker API end-points seems to fail when no content-length is specified but a body is sent.

        Parameters:
        requestEntityProcessing - is the requested entity processing to use when calling docker daemon (tcp protocol).
        Returns:
        Builder

      • getRequestEntityProcessing

        public org.glassfish.jersey.client.RequestEntityProcessing getRequestEntityProcessing()