com.github.dockerjava.core.command

Class AttachContainerCmdImpl

java.lang.Object

com.github.dockerjava.core.command.AbstrDockerCmd<AttachContainerCmd,InputStream>

com.github.dockerjava.core.command.AttachContainerCmdImpl

All Implemented Interfaces:

AttachContainerCmd, DockerCmd<InputStream>, Closeable, AutoCloseable

public class AttachContainerCmdImpl
extends AbstrDockerCmd<AttachContainerCmd,InputStream>
implements AttachContainerCmd

Attach to container

Nested Class Summary

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

AttachContainerCmd.Exec

Field Summary

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

execution

Constructor Summary

Constructors

Constructor and Description
AttachContainerCmdImpl(AttachContainerCmd.Exec exec, String containerId)

Method Summary

Methods

Modifier and Type	Method and Description
InputStream	exec() Its the responsibility of the caller to consume and/or close the InputStream to prevent connection leaks.
String	getContainerId()
boolean	hasFollowStreamEnabled()
boolean	hasLogsEnabled()
boolean	hasStderrEnabled()
boolean	hasStdoutEnabled()
boolean	hasTimestampsEnabled()
AttachContainerCmd	withContainerId(String containerId)
AttachContainerCmd	withFollowStream() See AttachContainerCmd.withFollowStream(boolean)
AttachContainerCmd	withFollowStream(boolean followStream) Following the stream means the resulting InputStream returned by AttachContainerCmd.exec() reads infinitely.
AttachContainerCmd	withLogs()
AttachContainerCmd	withLogs(boolean logs)
AttachContainerCmd	withStdErr()
AttachContainerCmd	withStdErr(boolean stderr)
AttachContainerCmd	withStdOut()
AttachContainerCmd	withStdOut(boolean stdout)
AttachContainerCmd	withTimestamps(boolean timestamps)

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

close

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.io.Closeable

close

Constructor Detail

AttachContainerCmdImpl

public AttachContainerCmdImpl(AttachContainerCmd.Exec exec,
                      String containerId)

Method Detail

getContainerId

public String getContainerId()

Specified by:

getContainerId in interface AttachContainerCmd

hasLogsEnabled

public boolean hasLogsEnabled()

Specified by:

hasLogsEnabled in interface AttachContainerCmd

hasFollowStreamEnabled

public boolean hasFollowStreamEnabled()

Specified by:

hasFollowStreamEnabled in interface AttachContainerCmd

hasTimestampsEnabled

public boolean hasTimestampsEnabled()

Specified by:

hasTimestampsEnabled in interface AttachContainerCmd

hasStdoutEnabled

public boolean hasStdoutEnabled()

Specified by:

hasStdoutEnabled in interface AttachContainerCmd

hasStderrEnabled

public boolean hasStderrEnabled()

Specified by:

hasStderrEnabled in interface AttachContainerCmd

withContainerId

public AttachContainerCmd withContainerId(String containerId)

Specified by:

withContainerId in interface AttachContainerCmd

withFollowStream

public AttachContainerCmd withFollowStream()

Description copied from interface: AttachContainerCmd

See AttachContainerCmd.withFollowStream(boolean)

Specified by:

withFollowStream in interface AttachContainerCmd

withFollowStream

public AttachContainerCmd withFollowStream(boolean followStream)

Description copied from interface: AttachContainerCmd

Following the stream means the resulting InputStream returned by AttachContainerCmd.exec() reads infinitely. So a InputStream.read() MAY BLOCK FOREVER as long as no data is streamed from the docker host to DockerClient!

Specified by:

withFollowStream in interface AttachContainerCmd

withTimestamps

public AttachContainerCmd withTimestamps(boolean timestamps)

Specified by:

withTimestamps in interface AttachContainerCmd

withStdOut

public AttachContainerCmd withStdOut()

Specified by:

withStdOut in interface AttachContainerCmd

withStdOut

public AttachContainerCmd withStdOut(boolean stdout)

Specified by:

withStdOut in interface AttachContainerCmd

withStdErr

public AttachContainerCmd withStdErr()

Specified by:

withStdErr in interface AttachContainerCmd

withStdErr

public AttachContainerCmd withStdErr(boolean stderr)

Specified by:

withStdErr in interface AttachContainerCmd

withLogs

public AttachContainerCmd withLogs(boolean logs)

Specified by:

withLogs in interface AttachContainerCmd

withLogs

public AttachContainerCmd withLogs()

Specified by:

withLogs in interface AttachContainerCmd

exec

public InputStream exec()
                 throws NotFoundException

Description copied from interface: AttachContainerCmd

Its the responsibility of the caller to consume and/or close the InputStream to prevent connection leaks.

Specified by:

exec in interface AttachContainerCmd

Specified by:

exec in interface DockerCmd<InputStream>

Overrides:

exec in class AbstrDockerCmd<AttachContainerCmd,InputStream>

Throws:

NotFoundException - No such container