Package com.spotify.docker.client
Class DefaultDockerClient.Builder
java.lang.Object
com.spotify.docker.client.DefaultDockerClient.Builder
- Enclosing class:
DefaultDockerClient
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate String
private int
private long
private boolean
private DockerCertificatesStore
static final String
private long
private RegistryAuth
private RegistryAuthSupplier
private org.glassfish.jersey.client.RequestEntityProcessing
private URI
private boolean
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionapiVersion
(String apiVersion) Set the Docker API version that will be used in the HTTP requests to Docker daemon.build()
int
connectionPoolSize
(int connectionPoolSize) Set the size of the connection pool for connections to Docker.long
connectTimeoutMillis
(long connectTimeoutMillis) Set the timeout in milliseconds until a connection to Docker is established.boolean
dockerAuth
(boolean dockerAuth) Deprecated.dockerCertificates
(DockerCertificatesStore dockerCertificatesStore) Provide certificates to secure the connection to Docker.org.glassfish.jersey.client.RequestEntityProcessing
Adds additional headers to be sent in all requests to the Docker Remote API.headers()
long
readTimeoutMillis
(long readTimeoutMillis) Set the SO_TIMEOUT in milliseconds.registryAuth
(RegistryAuth registryAuth) Deprecated.in favor ofregistryAuthSupplier(RegistryAuthSupplier)
registryAuthSupplier
(RegistryAuthSupplier registryAuthSupplier) uri()
Set the URI for connections to Docker.boolean
useProxy()
useProxy
(boolean useProxy) Allows connecting to Docker Daemon using HTTP proxy.useRequestEntityProcessing
(org.glassfish.jersey.client.RequestEntityProcessing requestEntityProcessing) Allows setting transfer encoding.
-
Field Details
-
ERROR_MESSAGE
- See Also:
-
uri
-
apiVersion
-
connectTimeoutMillis
private long connectTimeoutMillis -
readTimeoutMillis
private long readTimeoutMillis -
connectionPoolSize
private int connectionPoolSize -
dockerCertificatesStore
-
dockerAuth
private boolean dockerAuth -
useProxy
private boolean useProxy -
registryAuth
-
registryAuthSupplier
-
headers
-
requestEntityProcessing
private org.glassfish.jersey.client.RequestEntityProcessing requestEntityProcessing
-
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
uri
-
uri
-
uri
Set the URI for connections to Docker.- Parameters:
uri
- URI String for connections to Docker- Returns:
- Builder
-
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
-
connectTimeoutMillis
public long connectTimeoutMillis() -
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
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
-
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
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() -
dockerAuth
Deprecated.in favor ofregistryAuthSupplier(RegistryAuthSupplier)
Allows reusing Docker auth info.- Parameters:
dockerAuth
- tells if Docker auth info should be used- Returns:
- Builder
-
useProxy
public boolean useProxy() -
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
-
registryAuth
-
registryAuth
Deprecated.in favor ofregistryAuthSupplier(RegistryAuthSupplier)
Set the auth parameters for pull/push requests from/to private repositories.- Parameters:
registryAuth
- RegistryAuth object- Returns:
- Builder
-
registryAuthSupplier
-
header
Adds additional headers to be sent in all requests to the Docker Remote API. -
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() -
build
-
registryAuthSupplier(RegistryAuthSupplier)