DefaultDockerClient (docker-client 3.6.8 API)

java.lang.Object
- com.spotify.docker.client.DefaultDockerClient

All Implemented Interfaces:: DockerClient, Closeable, AutoCloseable

public class DefaultDockerClient
extends Object
implements DockerClient, Closeable

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`DefaultDockerClient.Builder`
`private static class`	`DefaultDockerClient.LoadProgressHandler` Hack: this `ProgressHandler` is meant to capture the image ID (or image digest in Docker 1.10+) of an image being loaded.

Nested classes/interfaces inherited from interface com.spotify.docker.client.DockerClient
DockerClient.AttachParameter, DockerClient.BuildParam, DockerClient.EventsFilterParam, DockerClient.EventsParam, DockerClient.ExecCreateParam, DockerClient.ExecStartParameter, DockerClient.ListContainersFilterParam, DockerClient.ListContainersParam, DockerClient.ListImagesFilterParam, DockerClient.ListImagesParam, DockerClient.LogsParam, DockerClient.RemoveContainerParam

Field Summary

Fields
Modifier and Type	Field and Description
`private String`	`apiVersion`
`private AuthConfig`	`authConfig`
`private javax.ws.rs.client.Client`	`client`
`private static javax.ws.rs.core.GenericType<List<Container>>`	`CONTAINER_LIST`
`private static Pattern`	`CONTAINER_NAME_PATTERN`
`private static com.google.common.base.Supplier<javax.ws.rs.client.ClientBuilder>`	`DEFAULT_BUILDER_SUPPLIER`
`private static org.glassfish.jersey.client.ClientConfig`	`DEFAULT_CONFIG`
`private static long`	`DEFAULT_CONNECT_TIMEOUT_MILLIS`
`private static int`	`DEFAULT_CONNECTION_POOL_SIZE`
`static String`	`DEFAULT_HOST`
`static int`	`DEFAULT_PORT`
`private static long`	`DEFAULT_READ_TIMEOUT_MILLIS`
`static String`	`DEFAULT_UNIX_ENDPOINT`
`private Map<String,Object>`	`headers`
`private static javax.ws.rs.core.GenericType<List<Image>>`	`IMAGE_LIST`
`private static javax.ws.rs.core.GenericType<List<ImageSearchResult>>`	`IMAGES_SEARCH_RESULT_LIST`
`private static org.slf4j.Logger`	`log`
`private static javax.ws.rs.core.GenericType<List<Network>>`	`NETWORK_LIST`
`static long`	`NO_TIMEOUT`
`private javax.ws.rs.client.Client`	`noTimeoutClient`
`private static javax.ws.rs.core.GenericType<List<RemovedImage>>`	`REMOVED_IMAGE_LIST`
`private static String`	`UNIX_SCHEME`
`private URI`	`uri`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`DefaultDockerClient(DefaultDockerClient.Builder builder)` Create a new client using the configuration of the builder.
`(package private)`	`DefaultDockerClient(DefaultDockerClient.Builder builder, com.google.common.base.Supplier<javax.ws.rs.client.ClientBuilder> clientBuilderSupplier)`
	`DefaultDockerClient(String uri)` Create a new client with default configuration.
	`DefaultDockerClient(URI uri)` Create a new client with default configuration.
	`DefaultDockerClient(URI uri, DockerCertificates dockerCertificates)` Create a new client with default configuration.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`LogStream`	`attachContainer(String containerId, DockerClient.AttachParameter... params)` Attach to the container id
`int`	`auth(AuthConfig authConfig)` Check auth configuration.
`private String`	`authHeader()`
`private String`	`authHeader(AuthConfig authConfig)`
`private String`	`authRegistryHeader(AuthRegistryConfig authRegistryConfig)`
`String`	`build(Path directory, DockerClient.BuildParam... params)` Build a docker image.
`String`	`build(Path directory, ProgressHandler handler, DockerClient.BuildParam... params)` Build a docker image.
`String`	`build(Path directory, String name, DockerClient.BuildParam... params)` Build a docker image.
`String`	`build(Path directory, String name, ProgressHandler handler, DockerClient.BuildParam... params)` Build a docker image.
`String`	`build(Path directory, String name, String dockerfile, ProgressHandler handler, DockerClient.BuildParam... params)` Build a docker image.
`static DefaultDockerClient.Builder`	`builder()` Create a new `DefaultDockerClient` builder.
`void`	`close()` Closes any and all underlying connections to docker, and release resources.
`ContainerCreation`	`commitContainer(String containerId, String repo, String tag, ContainerConfig config, String comment, String author)` Create a new image from a container's changes.
`void`	`connectToNetwork(String containerId, String networkId)` Connects a docker container to a network.
`private void`	`containerAction(String containerId, String action)`
`InputStream`	`copyContainer(String containerId, String path)` Copies some files out of a container.
`void`	`copyToContainer(Path directory, String containerId, String path)` Copies some files from host to container.
`ContainerCreation`	`createContainer(ContainerConfig config)` Create a docker container.
`ContainerCreation`	`createContainer(ContainerConfig config, String name)` Create a docker container.
`NetworkCreation`	`createNetwork(NetworkConfig networkConfig)` Create a new network
`private static String`	`defaultCertPath()`
`private static String`	`defaultEndpoint()`
`void`	`disconnectFromNetwork(String containerId, String networkId)` Disconnects a docker container to a network.
`EventStream`	`events(DockerClient.EventsParam... params)` Watches the docker API for events.
`String`	`execCreate(String containerId, String[] cmd, DockerClient.ExecCreateParam... params)` Sets up an exec instance in a running container id.
`ExecState`	`execInspect(String execId)` Inspects a running or previously run exec instance id.
`LogStream`	`execStart(String execId, DockerClient.ExecStartParameter... params)` Starts a previously set up exec instance id.
`InputStream`	`exportContainer(String containerId)` Export a docker container as a tar archive.
`static DefaultDockerClient.Builder`	`fromEnv()` Create a new `DefaultDockerClient` builder prepopulated with values loaded from the DOCKER_HOST and DOCKER_CERT_PATH environment variables.
`(package private) javax.ws.rs.client.Client`	`getClient()`
`private org.apache.http.impl.conn.PoolingHttpClientConnectionManager`	`getConnectionManager(DefaultDockerClient.Builder builder)`
`String`	`getHost()` Get the Docker host address
`private LogStream`	`getLogStream(String method, javax.ws.rs.client.WebTarget resource, String containerId)`
`(package private) javax.ws.rs.client.Client`	`getNoTimeoutClient()`
`private org.apache.http.config.Registry<org.apache.http.conn.socket.ConnectionSocketFactory>`	`getSchemeRegistry(DefaultDockerClient.Builder builder)`
`private javax.ws.rs.client.Invocation.Builder`	`headers(javax.ws.rs.client.Invocation.Builder request)`
`Info`	`info()` Get docker instance information.
`ContainerInfo`	`inspectContainer(String containerId)` Inspect a docker container.
`ImageInfo`	`inspectImage(String image)` Inspect a docker container image.
`Network`	`inspectNetwork(String networkId)` Inspect a specific network
`void`	`killContainer(String containerId)` Kill a docker container.
`List<Container>`	`listContainers(DockerClient.ListContainersParam... params)` List docker containers.
`List<Image>`	`listImages(DockerClient.ListImagesParam... params)` List docker images.
`List<Network>`	`listNetworks()` List all networks
`void`	`load(String image, InputStream imagePayload)` Loads an image (the given input stream is closed internally).
`void`	`load(String image, InputStream imagePayload, AuthConfig authConfig)` Loads an image (the given input stream is closed internally).
`void`	`load(String image, InputStream imagePayload, AuthConfig authConfig, ProgressHandler handler)` Loads an image (the given input stream is closed internally).
`void`	`load(String image, InputStream imagePayload, ProgressHandler handler)` Loads an image (the given input stream is closed internally).
`LogStream`	`logs(String containerId, DockerClient.LogsParam... params)` Get docker container logs.
`private void`	`manageNetworkConnection(String containerId, String methodname, String networkId)`
`private String`	`message(javax.ws.rs.core.Response response)`
`private javax.ws.rs.client.WebTarget`	`noTimeoutResource()`
`void`	`pauseContainer(String containerId)` Pause a docker container.
`String`	`ping()` Ping the docker daemon.
`private RuntimeException`	`propagate(String method, javax.ws.rs.client.WebTarget resource, Exception e)`
`void`	`pull(String image)` Pull a docker container image.
`void`	`pull(String image, AuthConfig authConfig)` Pull a private docker container image.
`void`	`pull(String image, AuthConfig authConfig, ProgressHandler handler)` Pull a private docker container image, using a custom ProgressMessageHandler.
`void`	`pull(String image, ProgressHandler handler)` Pull a docker container image, using a custom ProgressMessageHandler
`void`	`push(String image)` Push a docker container image.
`void`	`push(String image, ProgressHandler handler)` Push a docker container image, using a custom ProgressHandler
`void`	`removeContainer(String containerId)` Remove a docker container.
`void`	`removeContainer(String containerId, boolean removeVolumes)` Deprecated.
`void`	`removeContainer(String containerId, DockerClient.RemoveContainerParam... params)` Remove a docker container.
`List<RemovedImage>`	`removeImage(String image)` Remove a docker image.
`List<RemovedImage>`	`removeImage(String image, boolean force, boolean noPrune)` Remove a docker image.
`void`	`removeNetwork(String networkId)` Remove a docker network.
`void`	`renameContainer(String containerId, String name)` Rename a docker container.
`private <T> T`	`request(String method, Class<T> clazz, javax.ws.rs.client.WebTarget resource, javax.ws.rs.client.Invocation.Builder request)`
`private <T> T`	`request(String method, Class<T> clazz, javax.ws.rs.client.WebTarget resource, javax.ws.rs.client.Invocation.Builder request, javax.ws.rs.client.Entity<?> entity)`
`private <T> T`	`request(String method, javax.ws.rs.core.GenericType<T> type, javax.ws.rs.client.WebTarget resource, javax.ws.rs.client.Invocation.Builder request)`
`private void`	`request(String method, javax.ws.rs.client.WebTarget resource, javax.ws.rs.client.Invocation.Builder request)`
`private javax.ws.rs.client.WebTarget`	`resource()`
`void`	`restartContainer(String containerId)` Restart a docker container.
`void`	`restartContainer(String containerId, int secondsToWaitBeforeRestart)` Restart a docker container.
`InputStream`	`save(String image)`
`InputStream`	`save(String image, AuthConfig authConfig)`
`List<ImageSearchResult>`	`searchImages(String term)` Search for images on Docker Hub This method is broken for Docker 1.7.x because of a Docker bug.
`void`	`startContainer(String containerId)` Start a docker container.
`ContainerStats`	`stats(String containerId)` Retrieves one-time stats (stream=0) for the container with the specified id.
`void`	`stopContainer(String containerId, int secondsToWaitBeforeKilling)` Stop a docker container by sending a SIGTERM, and following up with a SIGKILL if the container doesn't exit gracefully and in a timely manner.
`void`	`tag(String image, String name)` Tag a docker image.
`void`	`tag(String image, String name, boolean force)` Tag a docker image.
`void`	`unpauseContainer(String containerId)` Unpause a docker container.
`private String`	`urlEncode(String unencoded)` URL-encodes a string
`private String`	`urlEncodeFilters(Map<String,List<String>> filters)` Takes a map of filters and URL-encodes them.
`Version`	`version()` Get the docker version.
`ContainerExit`	`waitContainer(String containerId)` Wait for a docker container to exit.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_UNIX_ENDPOINT
```
public static final String DEFAULT_UNIX_ENDPOINT
```
    See Also:
    
    Constant Field Values
  - DEFAULT_HOST
```
public static final String DEFAULT_HOST
```
    See Also:
    
    Constant Field Values
  - DEFAULT_PORT
```
public static final int DEFAULT_PORT
```
    See Also:
    
    Constant Field Values
  - UNIX_SCHEME
```
private static final String UNIX_SCHEME
```
    See Also:
    
    Constant Field Values
  - log
```
private static final org.slf4j.Logger log
```
  - NO_TIMEOUT
```
public static final long NO_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - DEFAULT_CONNECT_TIMEOUT_MILLIS
```
private static final long DEFAULT_CONNECT_TIMEOUT_MILLIS
```
  - DEFAULT_READ_TIMEOUT_MILLIS
```
private static final long DEFAULT_READ_TIMEOUT_MILLIS
```
  - DEFAULT_CONNECTION_POOL_SIZE
```
private static final int DEFAULT_CONNECTION_POOL_SIZE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_CONFIG
```
private static final org.glassfish.jersey.client.ClientConfig DEFAULT_CONFIG
```
  - CONTAINER_NAME_PATTERN
```
private static final Pattern CONTAINER_NAME_PATTERN
```
  - CONTAINER_LIST
```
private static final javax.ws.rs.core.GenericType<List<Container>> CONTAINER_LIST
```
  - IMAGE_LIST
```
private static final javax.ws.rs.core.GenericType<List<Image>> IMAGE_LIST
```
  - NETWORK_LIST
```
private static final javax.ws.rs.core.GenericType<List<Network>> NETWORK_LIST
```
  - IMAGES_SEARCH_RESULT_LIST
```
private static final javax.ws.rs.core.GenericType<List<ImageSearchResult>> IMAGES_SEARCH_RESULT_LIST
```
  - REMOVED_IMAGE_LIST
```
private static final javax.ws.rs.core.GenericType<List<RemovedImage>> REMOVED_IMAGE_LIST
```
  - DEFAULT_BUILDER_SUPPLIER
```
private static final com.google.common.base.Supplier<javax.ws.rs.client.ClientBuilder> DEFAULT_BUILDER_SUPPLIER
```
  - client
```
private final javax.ws.rs.client.Client client
```
  - noTimeoutClient
```
private final javax.ws.rs.client.Client noTimeoutClient
```
  - uri
```
private final URI uri
```
  - apiVersion
```
private final String apiVersion
```
  - authConfig
```
private final AuthConfig authConfig
```
  - headers
```
private final Map<String,Object> headers
```
- Constructor Detail
  - DefaultDockerClient
```
public DefaultDockerClient(String uri)
```
    Create a new client with default configuration.
    
    Parameters:
    
    uri - The docker rest api uri.
  - DefaultDockerClient
```
public DefaultDockerClient(URI uri)
```
    Create a new client with default configuration.
    
    Parameters:
    
    uri - The docker rest api uri.
  - DefaultDockerClient
```
public DefaultDockerClient(URI uri,
                           DockerCertificates dockerCertificates)
```
    Create a new client with default configuration.
    
    Parameters:
    
    uri - The docker rest api uri.
    
    dockerCertificates - The certificates to use for HTTPS.
  - DefaultDockerClient
```
protected DefaultDockerClient(DefaultDockerClient.Builder builder)
```
    Create a new client using the configuration of the builder.
    
    Parameters:
    
    builder - DefaultDockerClient builder
  - DefaultDockerClient
```
DefaultDockerClient(DefaultDockerClient.Builder builder,
                    com.google.common.base.Supplier<javax.ws.rs.client.ClientBuilder> clientBuilderSupplier)
```
- Method Detail
  - getClient
```
javax.ws.rs.client.Client getClient()
```
  - getNoTimeoutClient
```
javax.ws.rs.client.Client getNoTimeoutClient()
```
  - getHost
```
public String getHost()
```
    Description copied from interface: DockerClient
    
    Get the Docker host address
    
    Specified by:
    
    getHost in interface DockerClient
    
    Returns:
    
    the docker host name or IP
  - getConnectionManager
```
private org.apache.http.impl.conn.PoolingHttpClientConnectionManager getConnectionManager(DefaultDockerClient.Builder builder)
```
  - getSchemeRegistry
```
private org.apache.http.config.Registry<org.apache.http.conn.socket.ConnectionSocketFactory> getSchemeRegistry(DefaultDockerClient.Builder builder)
```
  - close
```
public void close()
```
    Description copied from interface: DockerClient
    
    Closes any and all underlying connections to docker, and release resources.
    
    Specified by:
    
    close in interface DockerClient
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
  - ping
```
public String ping()
            throws DockerException,
                   InterruptedException
```
    Description copied from interface: DockerClient
    
    Ping the docker daemon. Returns "OK" if all is well, though that it simply returns a 200 status is probably sufficient information.
    
    Specified by:
    
    ping in interface DockerClient
    
    Returns:
    
    String "OK"
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - version
```
public Version version()
                throws DockerException,
                       InterruptedException
```
    Description copied from interface: DockerClient
    
    Get the docker version.
    
    Specified by:
    
    version in interface DockerClient
    
    Returns:
    
    docker version
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - auth
```
public int auth(AuthConfig authConfig)
         throws DockerException,
                InterruptedException
```
    Description copied from interface: DockerClient
    
    Check auth configuration.
    
    Specified by:
    
    auth in interface DockerClient
    
    Parameters:
    
    authConfig - The authentication config needed to pull the image.
    
    Returns:
    
    status code of auth request
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - info
```
public Info info()
          throws DockerException,
                 InterruptedException
```
    Description copied from interface: DockerClient
    
    Get docker instance information.
    
    Specified by:
    
    info in interface DockerClient
    
    Returns:
    
    docker info
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - listContainers
```
public List<Container> listContainers(DockerClient.ListContainersParam... params)
                               throws DockerException,
                                      InterruptedException
```
    Description copied from interface: DockerClient
    
    List docker containers.
    
    Specified by:
    
    listContainers in interface DockerClient
    
    Parameters:
    
    params - Container listing and filtering options.
    
    Returns:
    
    A list of containers.
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - urlEncode
```
private String urlEncode(String unencoded)
                  throws DockerException
```
    URL-encodes a string
    
    Parameters:
    
    unencoded - A string that may contain characters not allowed in URLs
    
    Returns:
    
    URL-encoded String
    
    Throws:
    
    DockerException - if there's an UnsupportedEncodingException
  - urlEncodeFilters
```
private String urlEncodeFilters(Map<String,List<String>> filters)
                         throws DockerException
```
    Takes a map of filters and URL-encodes them. If the map is empty or an exception occurs, return null.
    
    Parameters:
    
    filters - A map of filters.
    
    Returns:
    
    String
    
    Throws:
    
    DockerException - if there's an IOException
  - listImages
```
public List<Image> listImages(DockerClient.ListImagesParam... params)
                       throws DockerException,
                              InterruptedException
```
    Description copied from interface: DockerClient
    
    List docker images.
    
    Specified by:
    
    listImages in interface DockerClient
    
    Parameters:
    
    params - Image listing and filtering options.
    
    Returns:
    
    A list of images.
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - createContainer
```
public ContainerCreation createContainer(ContainerConfig config)
                                  throws DockerException,
                                         InterruptedException
```
    Description copied from interface: DockerClient
    
    Create a docker container.
    
    Specified by:
    
    createContainer in interface DockerClient
    
    Parameters:
    
    config - The container configuration.
    
    Returns:
    
    Container creation result with container id and eventual warnings from docker.
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - createContainer
```
public ContainerCreation createContainer(ContainerConfig config,
                                         String name)
                                  throws DockerException,
                                         InterruptedException
```
    Description copied from interface: DockerClient
    
    Create a docker container.
    
    Specified by:
    
    createContainer in interface DockerClient
    
    Parameters:
    
    config - The container configuration.
    
    name - The container name.
    
    Returns:
    
    Container creation result with container id and eventual warnings from docker.
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - startContainer
```
public void startContainer(String containerId)
                    throws DockerException,
                           InterruptedException
```
    Description copied from interface: DockerClient
    
    Start a docker container.
    
    Specified by:
    
    startContainer in interface DockerClient
    
    Parameters:
    
    containerId - The id of the container to start.
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - containerAction
```
private void containerAction(String containerId,
                             String action)
                      throws DockerException,
                             InterruptedException
```
    Throws:
    
    DockerException
    
    InterruptedException
  - pauseContainer
```
public void pauseContainer(String containerId)
                    throws DockerException,
                           InterruptedException
```
    Description copied from interface: DockerClient
    
    Pause a docker container.
    
    Specified by:
    
    pauseContainer in interface DockerClient
    
    Parameters:
    
    containerId - The id of the container to pause.
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - unpauseContainer
```
public void unpauseContainer(String containerId)
                      throws DockerException,
                             InterruptedException
```
    Description copied from interface: DockerClient
    
    Unpause a docker container.
    
    Specified by:
    
    unpauseContainer in interface DockerClient
    
    Parameters:
    
    containerId - The id of the container to pause.
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - restartContainer
```
public void restartContainer(String containerId)
                      throws DockerException,
                             InterruptedException
```
    Description copied from interface: DockerClient
    
    Restart a docker container. with a 10 second default wait
    
    Specified by:
    
    restartContainer in interface DockerClient
    
    Parameters:
    
    containerId - The id of the container to restart.
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - restartContainer
```
public void restartContainer(String containerId,
                             int secondsToWaitBeforeRestart)
                      throws DockerException,
                             InterruptedException
```
    Description copied from interface: DockerClient
    
    Restart a docker container.
    
    Specified by:
    
    restartContainer in interface DockerClient
    
    Parameters:
    
    containerId - The id of the container to restart.
    
    secondsToWaitBeforeRestart - number of seconds to wait before killing the container.
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - killContainer
```
public void killContainer(String containerId)
                   throws DockerException,
                          InterruptedException
```
    Description copied from interface: DockerClient
    
    Kill a docker container.
    
    Specified by:
    
    killContainer in interface DockerClient
    
    Parameters:
    
    containerId - The id of the container to kill.
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - stopContainer
```
public void stopContainer(String containerId,
                          int secondsToWaitBeforeKilling)
                   throws DockerException,
                          InterruptedException
```
    Description copied from interface: DockerClient
    
    Stop a docker container by sending a SIGTERM, and following up with a SIGKILL if the container doesn't exit gracefully and in a timely manner.
    
    Specified by:
    
    stopContainer in interface DockerClient
    
    Parameters:
    
    containerId - The id of the container to stop.
    
    secondsToWaitBeforeKilling - Time to wait after SIGTERM before sending SIGKILL.
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - waitContainer
```
public ContainerExit waitContainer(String containerId)
                            throws DockerException,
                                   InterruptedException
```
    Description copied from interface: DockerClient
    
    Wait for a docker container to exit.
    
    Specified by:
    
    waitContainer in interface DockerClient
    
    Parameters:
    
    containerId - The id of the container to wait for.
    
    Returns:
    
    Exit response with status code.
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - removeContainer
```
public void removeContainer(String containerId)
                     throws DockerException,
                            InterruptedException
```
    Description copied from interface: DockerClient
    
    Remove a docker container.
    
    Specified by:
    
    removeContainer in interface DockerClient
    
    Parameters:
    
    containerId - The id of the container to remove.
    
    Throws:
    
    DockerException - If a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - removeContainer
```
@Deprecated
public void removeContainer(String containerId,
                                        boolean removeVolumes)
                                 throws DockerException,
                                        InterruptedException
```
    Deprecated.
    
    Description copied from interface: DockerClient
    
    Remove a docker container.
    
    Specified by:
    
    removeContainer in interface DockerClient
    
    Parameters:
    
    containerId - The id of the container to remove.
    
    removeVolumes - Whether to remove volumes as well.
    
    Throws:
    
    DockerException - If a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - removeContainer
```
public void removeContainer(String containerId,
                            DockerClient.RemoveContainerParam... params)
                     throws DockerException,
                            InterruptedException
```
    Description copied from interface: DockerClient
    
    Remove a docker container.
    
    Specified by:
    
    removeContainer in interface DockerClient
    
    Parameters:
    
    containerId - The id of the container to remove.
    
    params - DockerClient.RemoveContainerParam
    
    Throws:
    
    DockerException - If a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - exportContainer
```
public InputStream exportContainer(String containerId)
                            throws DockerException,
                                   InterruptedException
```
    Description copied from interface: DockerClient
    
    Export a docker container as a tar archive.
    
    Specified by:
    
    exportContainer in interface DockerClient
    
    Parameters:
    
    containerId - The id of the container to export.
    
    Returns:
    
    A stream in tar format that contains the contents of the container file system.
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - copyContainer
```
public InputStream copyContainer(String containerId,
                                 String path)
                          throws DockerException,
                                 InterruptedException
```
    Description copied from interface: DockerClient
    
    Copies some files out of a container.
    
    Specified by:
    
    copyContainer in interface DockerClient
    
    Parameters:
    
    containerId - The id of the container to copy files from.
    
    path - The path inside of the container to copy. If this is a directory, it will be copied recursively. If this is a file, only that file will be copied.
    
    Returns:
    
    A stream in tar format that contains the copied files. If a directory was copied, the directory will be at the root of the tar archive (so copy(..., "/usr/share") will result in a directory called share in the tar archive). The directory name is completely resolved, so copying "/usr/share/././." will still create a directory called "share" in the tar archive. If a single file was copied, that file will be the sole entry in the tar archive. Copying "." or equivalently "/" will result in the tar archive containing a single folder named after the container ID.
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - copyToContainer
```
public void copyToContainer(Path directory,
                            String containerId,
                            String path)
                     throws DockerException,
                            InterruptedException,
                            IOException
```
    Description copied from interface: DockerClient
    
    Copies some files from host to container. (API version 1.20+)
    
    Specified by:
    
    copyToContainer in interface DockerClient
    
    Parameters:
    
    directory - The path to sent to container
    
    containerId - The id of the container to sent files.
    
    path - The path inside of the container to put files.
    
    Throws:
    
    DockerException - If a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
    
    IOException - If IOException
  - inspectContainer
```
public ContainerInfo inspectContainer(String containerId)
                               throws DockerException,
                                      InterruptedException
```
    Description copied from interface: DockerClient
    
    Inspect a docker container.
    
    Specified by:
    
    inspectContainer in interface DockerClient
    
    Parameters:
    
    containerId - The id of the container to inspect.
    
    Returns:
    
    Info about the container.
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - commitContainer
```
public ContainerCreation commitContainer(String containerId,
                                         String repo,
                                         String tag,
                                         ContainerConfig config,
                                         String comment,
                                         String author)
                                  throws DockerException,
                                         InterruptedException
```
    Description copied from interface: DockerClient
    
    Create a new image from a container's changes.
    
    Specified by:
    
    commitContainer in interface DockerClient
    
    Parameters:
    
    containerId - The id of the container to commit.
    
    repo - repository to commit to.
    
    tag - image tag.
    
    config - ContainerConfig to commit.
    
    comment - commit message.
    
    author - image author.
    
    Returns:
    
    ContainerCreation reply.
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - renameContainer
```
public void renameContainer(String containerId,
                            String name)
                     throws DockerException,
                            InterruptedException
```
    Description copied from interface: DockerClient
    
    Rename a docker container.
    
    Specified by:
    
    renameContainer in interface DockerClient
    
    Parameters:
    
    containerId - The id of the container to rename.
    
    name - The new name the container will have
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - searchImages
```
public List<ImageSearchResult> searchImages(String term)
                                     throws DockerException,
                                            InterruptedException
```
    Description copied from interface: DockerClient
    
    Search for images on Docker Hub This method is broken for Docker 1.7.x because of a Docker bug. See https://github.com/docker/docker/pull/14850.
    
    Specified by:
    
    searchImages in interface DockerClient
    
    Parameters:
    
    term - the search term
    
    Returns:
    
    a list of matches for the given search term
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - load
```
public void load(String image,
                 InputStream imagePayload)
          throws DockerException,
                 InterruptedException
```
    Description copied from interface: DockerClient
    
    Loads an image (the given input stream is closed internally). This method also tags the image with the given image name upon loading completion.
    
    Specified by:
    
    load in interface DockerClient
    
    Parameters:
    
    image - the name to assign to the image.
    
    imagePayload - the image's payload (i.e.: the stream corresponding to the image's .tar file).
    
    Throws:
    
    DockerException - if a server error occurred (500).
    
    InterruptedException - if the thread is interrupted.
  - load
```
public void load(String image,
                 InputStream imagePayload,
                 AuthConfig authConfig,
                 ProgressHandler handler)
          throws DockerException,
                 InterruptedException
```
    Description copied from interface: DockerClient
    
    Loads an image (the given input stream is closed internally). This method also tags the image with the given image name upon loading completion.
    
    Specified by:
    
    load in interface DockerClient
    
    Parameters:
    
    image - the name to assign to the image.
    
    imagePayload - the image's payload (i.e.: the stream corresponding to the image's .tar file).
    
    authConfig - The authentication config needed to pull the image.
    
    handler - The handler to use for processing each progress message received from Docker.
    
    Throws:
    
    DockerException - if a server error occurred (500).
    
    InterruptedException - if the thread is interrupted.
  - load
```
public void load(String image,
                 InputStream imagePayload,
                 AuthConfig authConfig)
          throws DockerException,
                 InterruptedException
```
    Description copied from interface: DockerClient
    
    Loads an image (the given input stream is closed internally). This method also tags the image with the given image name upon loading completion.
    
    Specified by:
    
    load in interface DockerClient
    
    Parameters:
    
    image - the name to assign to the image.
    
    imagePayload - the image's payload (i.e.: the stream corresponding to the image's .tar file).
    
    authConfig - The authentication config needed to pull the image.
    
    Throws:
    
    DockerException - if a server error occurred (500).
    
    InterruptedException - if the thread is interrupted.
  - load
```
public void load(String image,
                 InputStream imagePayload,
                 ProgressHandler handler)
          throws DockerException,
                 InterruptedException
```
    Description copied from interface: DockerClient
    
    Loads an image (the given input stream is closed internally). This method also tags the image with the given image name upon loading completion.
    
    Specified by:
    
    load in interface DockerClient
    
    Parameters:
    
    image - the name to assign to the image.
    
    imagePayload - the image's payload (i.e.: the stream corresponding to the image's .tar file).
    
    handler - The handler to use for processing each progress message received from Docker.
    
    Throws:
    
    DockerException - if a server error occurred (500).
    
    InterruptedException - if the thread is interrupted.
  - save
```
public InputStream save(String image)
                 throws DockerException,
                        IOException,
                        InterruptedException
```
    Specified by:
    
    save in interface DockerClient
    
    Parameters:
    
    image - the name of the image to save.
    
    Returns:
    
    the image's .tar stream.
    
    Throws:
    
    DockerException - if a server error occurred (500).
    
    IOException - if the server started returning, but an I/O error occurred in the context of processing it on the client-side.
    
    InterruptedException - if the thread is interrupted.
  - save
```
public InputStream save(String image,
                        AuthConfig authConfig)
                 throws DockerException,
                        IOException,
                        InterruptedException
```
    Specified by:
    
    save in interface DockerClient
    
    Parameters:
    
    image - the name of the image to save.
    
    authConfig - The authentication config needed to pull the image.
    
    Returns:
    
    the image's .tar stream.
    
    Throws:
    
    DockerException - if a server error occurred (500).
    
    IOException - if the server started returning, but an I/O error occurred in the context of processing it on the client-side.
    
    InterruptedException - if the thread is interrupted.
  - pull
```
public void pull(String image)
          throws DockerException,
                 InterruptedException
```
    Description copied from interface: DockerClient
    
    Pull a docker container image.
    
    Specified by:
    
    pull in interface DockerClient
    
    Parameters:
    
    image - The image to pull.
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - pull
```
public void pull(String image,
                 ProgressHandler handler)
          throws DockerException,
                 InterruptedException
```
    Description copied from interface: DockerClient
    
    Pull a docker container image, using a custom ProgressMessageHandler
    
    Specified by:
    
    pull in interface DockerClient
    
    Parameters:
    
    image - The image to pull.
    
    handler - The handler to use for processing each progress message received from Docker.
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - pull
```
public void pull(String image,
                 AuthConfig authConfig)
          throws DockerException,
                 InterruptedException
```
    Description copied from interface: DockerClient
    
    Pull a private docker container image.
    
    Specified by:
    
    pull in interface DockerClient
    
    Parameters:
    
    image - The image to pull.
    
    authConfig - The authentication config needed to pull the image.
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - pull
```
public void pull(String image,
                 AuthConfig authConfig,
                 ProgressHandler handler)
          throws DockerException,
                 InterruptedException
```
    Description copied from interface: DockerClient
    
    Pull a private docker container image, using a custom ProgressMessageHandler.
    
    Specified by:
    
    pull in interface DockerClient
    
    Parameters:
    
    image - The image to pull.
    
    authConfig - The authentication config needed to pull the image.
    
    handler - The handler to use for processing each progress message received from Docker.
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - push
```
public void push(String image)
          throws DockerException,
                 InterruptedException
```
    Description copied from interface: DockerClient
    
    Push a docker container image.
    
    Specified by:
    
    push in interface DockerClient
    
    Parameters:
    
    image - The image to push.
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - push
```
public void push(String image,
                 ProgressHandler handler)
          throws DockerException,
                 InterruptedException
```
    Description copied from interface: DockerClient
    
    Push a docker container image, using a custom ProgressHandler
    
    Specified by:
    
    push in interface DockerClient
    
    Parameters:
    
    image - The image to push.
    
    handler - The handler to use for processing each progress message received from Docker.
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - tag
```
public void tag(String image,
                String name)
         throws DockerException,
                InterruptedException
```
    Description copied from interface: DockerClient
    
    Tag a docker image.
    
    Specified by:
    
    tag in interface DockerClient
    
    Parameters:
    
    image - The image to tag.
    
    name - The new name that will be applied to the image.
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - tag
```
public void tag(String image,
                String name,
                boolean force)
         throws DockerException,
                InterruptedException
```
    Description copied from interface: DockerClient
    
    Tag a docker image.
    
    Specified by:
    
    tag in interface DockerClient
    
    Parameters:
    
    image - The image to tag.
    
    name - The new name that will be applied to the image.
    
    force - Whether to force the tagging even if the tag is already assigned to another image.
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - build
```
public String build(Path directory,
                    DockerClient.BuildParam... params)
             throws DockerException,
                    InterruptedException,
                    IOException
```
    Description copied from interface: DockerClient
    
    Build a docker image.
    
    Specified by:
    
    build in interface DockerClient
    
    Parameters:
    
    directory - The directory containing the dockerfile.
    
    params - Additional flags to use during build.
    
    Returns:
    
    The id of the built image if successful, otherwise null.
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
    
    IOException - If some IO shit happened.
  - build
```
public String build(Path directory,
                    String name,
                    DockerClient.BuildParam... params)
             throws DockerException,
                    InterruptedException,
                    IOException
```
    Description copied from interface: DockerClient
    
    Build a docker image.
    
    Specified by:
    
    build in interface DockerClient
    
    Parameters:
    
    directory - The directory containing the dockerfile.
    
    name - The repository name and optional tag to apply to the built image.
    
    params - Additional flags to use during build.
    
    Returns:
    
    The id of the built image if successful, otherwise null.
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
    
    IOException - If some IO shit happened.
  - build
```
public String build(Path directory,
                    ProgressHandler handler,
                    DockerClient.BuildParam... params)
             throws DockerException,
                    InterruptedException,
                    IOException
```
    Description copied from interface: DockerClient
    
    Build a docker image.
    
    Specified by:
    
    build in interface DockerClient
    
    Parameters:
    
    directory - The directory containing the dockerfile.
    
    handler - The handler to use for processing each progress message received from Docker.
    
    params - Additional flags to use during build.
    
    Returns:
    
    The id of the built image if successful, otherwise null.
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
    
    IOException - If some IO shit happened.
  - build
```
public String build(Path directory,
                    String name,
                    ProgressHandler handler,
                    DockerClient.BuildParam... params)
             throws DockerException,
                    InterruptedException,
                    IOException
```
    Description copied from interface: DockerClient
    
    Build a docker image.
    
    Specified by:
    
    build in interface DockerClient
    
    Parameters:
    
    directory - The directory containing the dockerfile.
    
    name - The repository name and optional tag to apply to the built image.
    
    handler - The handler to use for processing each progress message received from Docker.
    
    params - Additional flags to use during build.
    
    Returns:
    
    The id of the built image if successful, otherwise null.
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
    
    IOException - If some IO shit happened.
  - build
```
public String build(Path directory,
                    String name,
                    String dockerfile,
                    ProgressHandler handler,
                    DockerClient.BuildParam... params)
             throws DockerException,
                    InterruptedException,
                    IOException
```
    Description copied from interface: DockerClient
    
    Build a docker image.
    
    Specified by:
    
    build in interface DockerClient
    
    Parameters:
    
    directory - The directory containing the dockerfile.
    
    name - The repository name and optional tag to apply to the built image.
    
    dockerfile - The path within the build context to the Dockerfile
    
    handler - The handler to use for processing each progress message received from Docker.
    
    params - Additional flags to use during build.
    
    Returns:
    
    The id of the built image if successful, otherwise null.
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
    
    IOException - If some IO shit happened.
  - inspectImage
```
public ImageInfo inspectImage(String image)
                       throws DockerException,
                              InterruptedException
```
    Description copied from interface: DockerClient
    
    Inspect a docker container image.
    
    Specified by:
    
    inspectImage in interface DockerClient
    
    Parameters:
    
    image - The image to inspect.
    
    Returns:
    
    Info about the image.
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - removeImage
```
public List<RemovedImage> removeImage(String image)
                               throws DockerException,
                                      InterruptedException
```
    Description copied from interface: DockerClient
    
    Remove a docker image.
    
    Specified by:
    
    removeImage in interface DockerClient
    
    Parameters:
    
    image - The image to remove.
    
    Returns:
    
    A list describing each image which was removed.
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - removeImage
```
public List<RemovedImage> removeImage(String image,
                                      boolean force,
                                      boolean noPrune)
                               throws DockerException,
                                      InterruptedException
```
    Description copied from interface: DockerClient
    
    Remove a docker image.
    
    Specified by:
    
    removeImage in interface DockerClient
    
    Parameters:
    
    image - The image to remove.
    
    force - Force image removal.
    
    noPrune - Do not delete untagged parents.
    
    Returns:
    
    A list describing each image which was removed.
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - logs
```
public LogStream logs(String containerId,
                      DockerClient.LogsParam... params)
               throws DockerException,
                      InterruptedException
```
    Description copied from interface: DockerClient
    
    Get docker container logs.
    
    Specified by:
    
    logs in interface DockerClient
    
    Parameters:
    
    containerId - The id of the container to get logs for.
    
    params - Params for controlling what streams to get and whether to tail or not.
    
    Returns:
    
    A log message stream.
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - events
```
public EventStream events(DockerClient.EventsParam... params)
                   throws DockerException,
                          InterruptedException
```
    Description copied from interface: DockerClient
    
    Watches the docker API for events. This method is broken for Docker 1.7.x because of a Docker bug. See https://github.com/docker/docker/issues/14354.
    
    Specified by:
    
    events in interface DockerClient
    
    Parameters:
    
    params - The parameters to apply to the events request
    
    Returns:
    
    An event stream
    
    Throws:
    
    DockerException - If a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - attachContainer
```
public LogStream attachContainer(String containerId,
                                 DockerClient.AttachParameter... params)
                          throws DockerException,
                                 InterruptedException
```
    Description copied from interface: DockerClient
    
    Attach to the container id
    
    Specified by:
    
    attachContainer in interface DockerClient
    
    Parameters:
    
    containerId - The id of the container to get logs for.
    
    params - Params for controlling what streams to get and whether to tail or not.
    
    Returns:
    
    A log message stream.
    
    Throws:
    
    ContainerNotFoundException - if the container was not found (404).
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - getLogStream
```
private LogStream getLogStream(String method,
                               javax.ws.rs.client.WebTarget resource,
                               String containerId)
                        throws DockerException,
                               InterruptedException
```
    Throws:
    
    DockerException
    
    InterruptedException
  - execCreate
```
public String execCreate(String containerId,
                         String[] cmd,
                         DockerClient.ExecCreateParam... params)
                  throws DockerException,
                         InterruptedException
```
    Description copied from interface: DockerClient
    
    Sets up an exec instance in a running container id.
    
    Specified by:
    
    execCreate in interface DockerClient
    
    Parameters:
    
    containerId - The id of the container
    
    cmd - shell command
    
    params - Exec params
    
    Returns:
    
    exec id
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - execStart
```
public LogStream execStart(String execId,
                           DockerClient.ExecStartParameter... params)
                    throws DockerException,
                           InterruptedException
```
    Description copied from interface: DockerClient
    
    Starts a previously set up exec instance id. If detach is true, this API returns after starting the exec command. Otherwise, this API sets up an interactive session with the exec command.
    
    Specified by:
    
    execStart in interface DockerClient
    
    Parameters:
    
    execId - exec id
    
    params - Exec start params
    
    Returns:
    
    exec output
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - execInspect
```
public ExecState execInspect(String execId)
                      throws DockerException,
                             InterruptedException
```
    Description copied from interface: DockerClient
    
    Inspects a running or previously run exec instance id.
    
    Specified by:
    
    execInspect in interface DockerClient
    
    Parameters:
    
    execId - exec id
    
    Returns:
    
    state of this exec instance.
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - stats
```
public ContainerStats stats(String containerId)
                     throws DockerException,
                            InterruptedException
```
    Description copied from interface: DockerClient
    
    Retrieves one-time stats (stream=0) for the container with the specified id.
    
    Specified by:
    
    stats in interface DockerClient
    
    Parameters:
    
    containerId - The id of the container to retrieve stats for.
    
    Returns:
    
    The container stats
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - listNetworks
```
public List<Network> listNetworks()
                           throws DockerException,
                                  InterruptedException
```
    Description copied from interface: DockerClient
    
    List all networks
    
    Specified by:
    
    listNetworks in interface DockerClient
    
    Returns:
    
    networks
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - inspectNetwork
```
public Network inspectNetwork(String networkId)
                       throws DockerException,
                              InterruptedException
```
    Description copied from interface: DockerClient
    
    Inspect a specific network
    
    Specified by:
    
    inspectNetwork in interface DockerClient
    
    Parameters:
    
    networkId - The id of the network
    
    Returns:
    
    network information
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - createNetwork
```
public NetworkCreation createNetwork(NetworkConfig networkConfig)
                              throws DockerException,
                                     InterruptedException
```
    Description copied from interface: DockerClient
    
    Create a new network
    
    Specified by:
    
    createNetwork in interface DockerClient
    
    Parameters:
    
    networkConfig - The network creation parameters
    
    Returns:
    
    NetworkCreation
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - removeNetwork
```
public void removeNetwork(String networkId)
                   throws DockerException,
                          InterruptedException
```
    Description copied from interface: DockerClient
    
    Remove a docker network.
    
    Specified by:
    
    removeNetwork in interface DockerClient
    
    Parameters:
    
    networkId - The id of the network to remove.
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - connectToNetwork
```
public void connectToNetwork(String containerId,
                             String networkId)
                      throws DockerException,
                             InterruptedException
```
    Description copied from interface: DockerClient
    
    Connects a docker container to a network.
    
    Specified by:
    
    connectToNetwork in interface DockerClient
    
    Parameters:
    
    containerId - The id of the container to connect.
    
    networkId - The id of the network to connect.
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    ContainerNotFoundException - if the container was not found (404)
    
    InterruptedException - If the thread is interrupted
  - disconnectFromNetwork
```
public void disconnectFromNetwork(String containerId,
                                  String networkId)
                           throws DockerException,
                                  InterruptedException
```
    Description copied from interface: DockerClient
    
    Disconnects a docker container to a network.
    
    Specified by:
    
    disconnectFromNetwork in interface DockerClient
    
    Parameters:
    
    containerId - The id of the container to disconnect.
    
    networkId - The id of the network to disconnect.
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    ContainerNotFoundException - if the container was not found (404)
    
    InterruptedException - If the thread is interrupted
  - manageNetworkConnection
```
private void manageNetworkConnection(String containerId,
                                     String methodname,
                                     String networkId)
                              throws DockerException,
                                     InterruptedException
```
    Throws:
    
    DockerException
    
    InterruptedException
  - resource
```
private javax.ws.rs.client.WebTarget resource()
```
  - noTimeoutResource
```
private javax.ws.rs.client.WebTarget noTimeoutResource()
```
  - request
```
private <T> T request(String method,
                      javax.ws.rs.core.GenericType<T> type,
                      javax.ws.rs.client.WebTarget resource,
                      javax.ws.rs.client.Invocation.Builder request)
               throws DockerException,
                      InterruptedException
```
    Throws:
    
    DockerException
    
    InterruptedException
  - request
```
private <T> T request(String method,
                      Class<T> clazz,
                      javax.ws.rs.client.WebTarget resource,
                      javax.ws.rs.client.Invocation.Builder request)
               throws DockerException,
                      InterruptedException
```
    Throws:
    
    DockerException
    
    InterruptedException
  - request
```
private <T> T request(String method,
                      Class<T> clazz,
                      javax.ws.rs.client.WebTarget resource,
                      javax.ws.rs.client.Invocation.Builder request,
                      javax.ws.rs.client.Entity<?> entity)
               throws DockerException,
                      InterruptedException
```
    Throws:
    
    DockerException
    
    InterruptedException
  - request
```
private void request(String method,
                     javax.ws.rs.client.WebTarget resource,
                     javax.ws.rs.client.Invocation.Builder request)
              throws DockerException,
                     InterruptedException
```
    Throws:
    
    DockerException
    
    InterruptedException
  - headers
```
private javax.ws.rs.client.Invocation.Builder headers(javax.ws.rs.client.Invocation.Builder request)
```
  - propagate
```
private RuntimeException propagate(String method,
                                   javax.ws.rs.client.WebTarget resource,
                                   Exception e)
                            throws DockerException,
                                   InterruptedException
```
    Throws:
    
    DockerException
    
    InterruptedException
  - message
```
private String message(javax.ws.rs.core.Response response)
```
  - authHeader
```
private String authHeader()
                   throws DockerException
```
    Throws:
    
    DockerException
  - authHeader
```
private String authHeader(AuthConfig authConfig)
                   throws DockerException
```
    Throws:
    
    DockerException
  - authRegistryHeader
```
private String authRegistryHeader(AuthRegistryConfig authRegistryConfig)
                           throws DockerException
```
    Throws:
    
    DockerException
  - builder
```
public static DefaultDockerClient.Builder builder()
```
    Create a new DefaultDockerClient builder.
    
    Returns:
    
    Returns a builder that can be used to further customize and then build the client.
  - fromEnv
```
public static DefaultDockerClient.Builder fromEnv()
                                           throws DockerCertificateException
```
    Create a new DefaultDockerClient builder prepopulated with values loaded from the DOCKER_HOST and DOCKER_CERT_PATH environment variables.
    
    Returns:
    
    Returns a builder that can be used to further customize and then build the client.
    
    Throws:
    
    DockerCertificateException - if we could not build a DockerCertificates object
  - defaultEndpoint
```
private static String defaultEndpoint()
```
  - defaultCertPath
```
private static String defaultCertPath()
```

Class DefaultDockerClient

Nested Class Summary

Nested classes/interfaces inherited from interface com.spotify.docker.client.DockerClient

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_UNIX_ENDPOINT

DEFAULT_HOST

DEFAULT_PORT

UNIX_SCHEME

log

NO_TIMEOUT

DEFAULT_CONNECT_TIMEOUT_MILLIS

DEFAULT_READ_TIMEOUT_MILLIS

DEFAULT_CONNECTION_POOL_SIZE

DEFAULT_CONFIG

CONTAINER_NAME_PATTERN

CONTAINER_LIST

IMAGE_LIST

NETWORK_LIST

IMAGES_SEARCH_RESULT_LIST

REMOVED_IMAGE_LIST

DEFAULT_BUILDER_SUPPLIER

client

noTimeoutClient

uri

apiVersion

authConfig

headers

Constructor Detail

DefaultDockerClient

DefaultDockerClient

DefaultDockerClient

DefaultDockerClient

DefaultDockerClient

Method Detail

getClient

getNoTimeoutClient

getHost

getConnectionManager

getSchemeRegistry

close

ping

version

auth

info

listContainers

urlEncode

urlEncodeFilters

listImages

createContainer

createContainer

startContainer

containerAction

pauseContainer

unpauseContainer

restartContainer

restartContainer

killContainer

stopContainer

waitContainer

removeContainer

removeContainer

removeContainer

exportContainer

copyContainer

copyToContainer

inspectContainer

commitContainer

renameContainer

searchImages

load

load

load

load

save

save

pull