Property Detail

• CreateConfig createConfig

• DockerClient dockerClient

• java.lang.String id

• java.lang.String name

• StartConfig startConfig

• State state

Constructor Detail

• DockerContainer(DockerClient dockerClient, java.lang.String image, java.lang.String id = null)

Method Detail

• DockerContainer addCommand(java.lang.Object command)

  Add command to container.
  NOTE: if EntryPoint is set with "exec $@" at the end to run another command, then the commands should be written as bash script and supportMultiCommand should be set as FALSE. (e.g. createConfig.addCommand("ifconfig ; hostname ; env", false))

  Parameters:

  command - Command to run inside container.

• java.io.File copy(java.lang.String fileFromContainer, java.lang.String destinationFolder = null)

  Download file from the container.
  https://docs.docker.com/reference/api/docker_remote_api_v1.18/#copy-files-or-folders-from-a-container

  Returns:

  File and it places in project temp directory.

  Parameters:

  fileToExtract - File to download, pass full path, or relative to last working directory.

  destinationFolder - Folder to extract to, default is "tmp".

• java.lang.Object copyTo(java.lang.String sourceFilePath, java.lang.String destinationFolder)

  Copy local file into the container.
  https://docs.docker.com/reference/api/docker_remote_api_v1.18/#copy-files-or-folders-from-a-container

  Parameters:

  sourceFilePath - Path to a local file or a folder to push into the container archive.

  destinationFolder - Folder inside the container to copy

• DockerContainer doCreate(boolean throwsExceptionOnConflict = true, boolean forceRecreateOnConflict = false)

  Returns:

  Parameters:

  throwsExceptionOnConflict - - If true, will throw exception on conflict during creation

  forceRecreateOnConflict - - If true, will remove existing container roughly, and recreate container. this flag required 'throwsExceptionOnConflict' to be false.

• void doDelete(boolean force = false, boolean deleteVolume = false)

  Delete container.
  https://docs.docker.com/reference/api/docker_remote_api_v1.18/#remove-a-container

  Parameters:

  force - Deletes container even it is in running state

  deleteVolume - Deletes all the data associated to this container

• DockerContainer doPause()

  Pause all container processes.
  

• DockerContainer doRestart(int waitBeforeStopInSecs = 0)

• DockerContainer doStart()

  Start container and continue with the code immediately.
  If you would like to wait until it finishes use doStart(int waitExecutionToEndInSec).
  https://docs.docker.com/reference/api/docker_remote_api_v1.18/#start-a-container

• DockerContainer doStart(java.lang.Object startConfig)

  Start container.
  https://docs.docker.com/reference/api/docker_remote_api_v1.18/#start-a-container

  Parameters:

  startConfig - Pass specific startConfig without setting it in this object.

• DockerContainer doStart(int waitExecutionToEndInSec)

  Start container and wait until its execution finishes.
  https://docs.docker.com/reference/api/docker_remote_api_v1.18/#start-a-container

  Parameters:

  waitExecutionToEndInSec - Seconds to wait until execution finishes, 0 don't wait at all.

• DockerContainer doStart(boolean debugOutput)

• DockerContainer doStart(int waitExecutionToEndInSec, boolean debugOutput)

• DockerContainer doStart(int waitExecutionToEndInSec, java.lang.Object startConfig, boolean debugOutput = false)

  Start container.
  https://docs.docker.com/reference/api/docker_remote_api_v1.18/#start-a-container

  Parameters:

  waitExecutionToEndInSec - Seconds to wait until execution finishes, 0 don't wait at all.

  startConfig - Pass specific startConfig without setting it in this object.

• DockerContainer doStop(int waitBeforeStopInSecs = 0)

  Stop container.
  https://docs.docker.com/reference/api/docker_remote_api_v1.18/#stop-a-container

  Parameters:

  waitBeforeStopInSecs - Seconds to wait before sending the stop signal.

• DockerContainer doUnPause()

  Pause all container processes.
  

• java.io.File downloadFile(java.lang.String fileToExtract, java.lang.String destinationFolder = null)

  Download file from the container.
  https://docs.docker.com/reference/api/docker_remote_api_v1.18/#copy-files-or-folders-from-a-container

  Returns:

  File and it places in project temp directory.

  Parameters:

  fileToExtract - File to download, pass full path, or relative to last working directory.

  destinationFolder - Folder to extract to, default is "tmp".

• boolean equals(java.lang.Object o)

• DockerExec exec(java.lang.Object command, boolean attachStdout = true, boolean attachStdin = false, boolean attachStderr = false, boolean tty = false)

  Exec another process inside this container, available only if the container is in Running state.
  https://docs.docker.com/reference/api/docker_remote_api_v1.18/#exec-create

  Returns:

  DockerExec object which should be created using doCreate() and then started with doStart().

  Parameters:

  command - Command to execute inside the container

  attachStdout - Collect the output of the command

  attachStdin

  attachStderr - Collect the error output of the command

  tty

• int exitCode()

  Get status code of a container.
  

  Returns:

  Exit code of a container, -1 if container still running.

• java.lang.Object get(java.lang.String relativePath, groovyx.net.http.ContentType contentType, java.util.Map<java.lang.String, java.lang.String> query = null)

• java.util.Map<java.lang.String, java.lang.String> getEnvs()

  Get Map of all environment variables inside a container.

  Returns:

  Map of variables in a container

• int getExternalPort(int internalPort, java.lang.String protocol = "tcp")

• State getState()

  Get State of a container, extracted from inspect.

  Returns:

  Map of State element.

• java.lang.Object inspect()

  Inspect the container config and status.
  https://docs.docker.com/reference/api/docker_remote_api_v1.18/#inspect-a-container

  Returns:

  Map as representation of the json returned.

• boolean isExists()

  Check if container is exists in docker server.
  

  Returns:

  True only if exists on server, false if isn't.

• java.lang.String logs()

  Get logs of the container.

  Returns:

  Logs as string

• java.lang.Object stats(boolean stream = false)

  Show stats of running container. (Available from Docker remote-api v1.19)

  Returns:

  Map as representation of the json returned.

  Parameters:

  stream - Allows to stream the stats, default is false for a single request https://docs.docker.com/engine/reference/api/docker_remote_api_v1.18/#get-container-stats-based-on-resource-usage

• @java.lang.Override java.lang.String toString()

• java.lang.Object top()

  Show processes running inside container. https://docs.docker.com/reference/api/docker_remote_api_v1.18/#list-processes-running-inside-a-container

  Returns:

  Map as representation of the json returned.

• java.lang.Object uploadFile(java.lang.String fileToUpload, java.lang.String destinationFolder)

  Upload file to the container.
  https://docs.docker.com/reference/api/docker_remote_api_v1.18/#copy-files-or-folders-from-a-container

  Parameters:

  fileToUpload - Path to the file to upload, pass full path, or relative to last working directory.

  destinationFolder - Folder to upload to