Package com.github.mwiede.dockerjava.jsch

Class JschDockerHttpClient.Builder

java.lang.Object

com.github.mwiede.dockerjava.jsch.JschDockerHttpClient.Builder

Enclosing class:

JschDockerHttpClient

public static final class JschDockerHttpClient.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
JschDockerHttpClient	build()
JschDockerHttpClient.Builder	connectTimeout(Duration value)
JschDockerHttpClient.Builder	dockerHost(URI value)
JschDockerHttpClient.Builder	identity(String privateKey)	set identityFile from ~/.ssh/ folder for public key authentication
JschDockerHttpClient.Builder	identityFile(File identityFile)	set identityFile for public key authentication
JschDockerHttpClient.Builder	identityRepository(com.jcraft.jsch.IdentityRepository identityRepository)
JschDockerHttpClient.Builder	interceptor(okhttp3.Interceptor interceptor)
JschDockerHttpClient.Builder	jschConfig(Hashtable jschConfig)	pass config which is used for Session.setConfig(Hashtable)
JschDockerHttpClient.Builder	readTimeout(Duration value)
JschDockerHttpClient.Builder	socatFlags(String socatFlags)	allows to set additional flags for the socat call, i.e.
JschDockerHttpClient.Builder	sshSession(com.jcraft.jsch.Session session)	pass Session if already connected
JschDockerHttpClient.Builder	sslConfig(com.github.dockerjava.transport.SSLConfig sslConfig)
JschDockerHttpClient.Builder	userInfo(com.jcraft.jsch.UserInfo userInfo)
JschDockerHttpClient.Builder	useSocat()
JschDockerHttpClient.Builder	useSocat(String socketPath)
JschDockerHttpClient.Builder	useSocket()
JschDockerHttpClient.Builder	useSocket(String socketPath)	use socket and overwrite default socket path JschDockerConfig.VAR_RUN_DOCKER_SOCK
JschDockerHttpClient.Builder	useTcp()
JschDockerHttpClient.Builder	useTcp(int port)

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

dockerHost

public JschDockerHttpClient.Builder dockerHost(URI value)

sslConfig

public JschDockerHttpClient.Builder sslConfig(com.github.dockerjava.transport.SSLConfig sslConfig)

readTimeout

public JschDockerHttpClient.Builder readTimeout(Duration value)

connectTimeout

public JschDockerHttpClient.Builder connectTimeout(Duration value)

useSocket

public JschDockerHttpClient.Builder useSocket(String socketPath)

use socket and overwrite default socket path JschDockerConfig.VAR_RUN_DOCKER_SOCK

Parameters:

socketPath -

Returns:

sshSession

public JschDockerHttpClient.Builder sshSession(com.jcraft.jsch.Session session)

pass Session if already connected

Parameters:

session -

Returns:

identityFile

public JschDockerHttpClient.Builder identityFile(File identityFile)

set identityFile for public key authentication

Parameters:

identityFile -

Returns:

identity

public JschDockerHttpClient.Builder identity(String privateKey)

set identityFile from ~/.ssh/ folder for public key authentication

Parameters:

privateKey - private key filename

Returns:

jschConfig

public JschDockerHttpClient.Builder jschConfig(Hashtable jschConfig)

pass config which is used for Session.setConfig(Hashtable)

Parameters:

jschConfig -

Returns:

interceptor

public JschDockerHttpClient.Builder interceptor(okhttp3.Interceptor interceptor)

useSocket

public JschDockerHttpClient.Builder useSocket()

useSocat

public JschDockerHttpClient.Builder useSocat()

useSocat

public JschDockerHttpClient.Builder useSocat(String socketPath)

socatFlags

public JschDockerHttpClient.Builder socatFlags(String socatFlags)

allows to set additional flags for the socat call, i.e. -v

Parameters:

socatFlags -

Returns:

useTcp

public JschDockerHttpClient.Builder useTcp()

useTcp

public JschDockerHttpClient.Builder useTcp(int port)

userInfo

public JschDockerHttpClient.Builder userInfo(com.jcraft.jsch.UserInfo userInfo)

identityRepository

public JschDockerHttpClient.Builder identityRepository(com.jcraft.jsch.IdentityRepository identityRepository)

build

public JschDockerHttpClient build()
                           throws IOException,
                                  com.jcraft.jsch.JSchException

Throws:

IOException

com.jcraft.jsch.JSchException