com.github.dockerjava.core.command

Class CopyArchiveToContainerCmdImpl

java.lang.Object

com.github.dockerjava.core.command.AbstrDockerCmd<CopyArchiveToContainerCmd,Void>

com.github.dockerjava.core.command.CopyArchiveToContainerCmdImpl

All Implemented Interfaces:

CopyArchiveToContainerCmd, DockerCmd<Void>, SyncDockerCmd<Void>, Closeable, AutoCloseable

public class CopyArchiveToContainerCmdImpl
extends AbstrDockerCmd<CopyArchiveToContainerCmd,Void>
implements CopyArchiveToContainerCmd

Nested Class Summary

Nested classes/interfaces inherited from interface com.github.dockerjava.api.command.CopyArchiveToContainerCmd

CopyArchiveToContainerCmd.Exec

Field Summary

Fields inherited from class com.github.dockerjava.core.command.AbstrDockerCmd

execution

Constructor Summary

Constructors

Constructor and Description
CopyArchiveToContainerCmdImpl(CopyArchiveToContainerCmd.Exec exec, String containerId)

Method Summary

Methods

Modifier and Type	Method and Description
Void	exec()
String	getContainerId()
String	getHostResource()
String	getRemotePath()
InputStream	getTarInputStream()
boolean	isDirChildrenOnly()
boolean	isNoOverwriteDirNonDir()
String	toString()
CopyArchiveToContainerCmd	withContainerId(String containerId) Set container's id
CopyArchiveToContainerCmd	withDirChildrenOnly(boolean dirChildrenOnly) If this flag is set to true, all children of the local directory will be copied to the remote without the root directory.
CopyArchiveToContainerCmd	withHostResource(String hostResource) Set path to the resource on the host machine
CopyArchiveToContainerCmd	withNoOverwriteDirNonDir(boolean noOverwriteDirNonDir) If set to true then it will be an error if unpacking the given content would cause an existing directory to be replaced with a non-directory and vice versa
CopyArchiveToContainerCmd	withRemotePath(String remotePath)
CopyArchiveToContainerCmd	withTarInputStream(InputStream tarInputStream) Set the tar input stream that will be uploaded to the container. withHostResource or withTarInputStream can be defined but not both.

Methods inherited from class com.github.dockerjava.core.command.AbstrDockerCmd

close, registryAuth

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.github.dockerjava.api.command.DockerCmd

close

Constructor Detail

CopyArchiveToContainerCmdImpl

public CopyArchiveToContainerCmdImpl(CopyArchiveToContainerCmd.Exec exec,
                             String containerId)

Method Detail

withContainerId

public CopyArchiveToContainerCmd withContainerId(String containerId)

Description copied from interface: CopyArchiveToContainerCmd

Set container's id

Specified by:

withContainerId in interface CopyArchiveToContainerCmd

Parameters:

containerId - id of the container to copy file to

withHostResource

public CopyArchiveToContainerCmd withHostResource(String hostResource)

Description copied from interface: CopyArchiveToContainerCmd

Set path to the resource on the host machine

Specified by:

withHostResource in interface CopyArchiveToContainerCmd

Parameters:

hostResource - path to the resource on the host machine

withNoOverwriteDirNonDir

public CopyArchiveToContainerCmd withNoOverwriteDirNonDir(boolean noOverwriteDirNonDir)

Description copied from interface: CopyArchiveToContainerCmd

If set to true then it will be an error if unpacking the given content would cause an existing directory to be replaced with a non-directory and vice versa

Specified by:

withNoOverwriteDirNonDir in interface CopyArchiveToContainerCmd

Parameters:

noOverwriteDirNonDir - flag to know if non directory can be overwritten

withRemotePath

public CopyArchiveToContainerCmd withRemotePath(String remotePath)

Specified by:

withRemotePath in interface CopyArchiveToContainerCmd

withTarInputStream

public CopyArchiveToContainerCmd withTarInputStream(InputStream tarInputStream)

Description copied from interface: CopyArchiveToContainerCmd

Set the tar input stream that will be uploaded to the container. withHostResource or withTarInputStream can be defined but not both.

Specified by:

withTarInputStream in interface CopyArchiveToContainerCmd

Parameters:

tarInputStream - the stream to upload to the container

withDirChildrenOnly

public CopyArchiveToContainerCmd withDirChildrenOnly(boolean dirChildrenOnly)

Description copied from interface: CopyArchiveToContainerCmd

If this flag is set to true, all children of the local directory will be copied to the remote without the root directory. For ex: if I have root/titi and root/tata and the remote path is /var/data. dirChildrenOnly = true will create /var/data/titi and /var/data/tata dirChildrenOnly = false will create /var/data/root/titi and /var/data/root/tata

Specified by:

withDirChildrenOnly in interface CopyArchiveToContainerCmd

Parameters:

dirChildrenOnly - if root directory is ignored

getTarInputStream

public InputStream getTarInputStream()

Specified by:

getTarInputStream in interface CopyArchiveToContainerCmd

getContainerId

public String getContainerId()

Specified by:

getContainerId in interface CopyArchiveToContainerCmd

getHostResource

public String getHostResource()

Specified by:

getHostResource in interface CopyArchiveToContainerCmd

isNoOverwriteDirNonDir

public boolean isNoOverwriteDirNonDir()

Specified by:

isNoOverwriteDirNonDir in interface CopyArchiveToContainerCmd

getRemotePath

public String getRemotePath()

Specified by:

getRemotePath in interface CopyArchiveToContainerCmd

isDirChildrenOnly

public boolean isDirChildrenOnly()

Specified by:

isDirChildrenOnly in interface CopyArchiveToContainerCmd

toString

public String toString()

Overrides:

toString in class AbstrDockerCmd<CopyArchiveToContainerCmd,Void>

exec

public Void exec()
          throws NotFoundException

Specified by:

exec in interface CopyArchiveToContainerCmd

Specified by:

exec in interface SyncDockerCmd<Void>

Overrides:

exec in class AbstrDockerCmd<CopyArchiveToContainerCmd,Void>

Throws:

NotFoundException - No such container