com.github.kostyasha.yad.client

Class ClientBuilderForConnector

java.lang.Object

com.github.kostyasha.yad.client.ClientBuilderForConnector

public class ClientBuilderForConnector
extends Object

Builds ClientConfig with helper methods that extracts info for plugin routines. After the number of refactoring in docker-java and yad-plugin logic maybe messed.

Method Summary

Modifier and Type	Method and Description
com.github.kostyasha.yad_docker_java.com.github.dockerjava.api.DockerClient	build()
ClientBuilderForConnector	forConnector(DockerConnector connector) Provides ready to use docker client with information from docker connector
ClientBuilderForConnector	forServer(String uri, String version) Method to setup url and docker-api version.
static com.cloudbees.plugins.credentials.Credentials	lookupSystemCredentials(String credentialsId) Util method to find credential by id in jenkins
static ClientBuilderForConnector	newClientBuilderForConnector() helper class
ClientBuilderForConnector	withConfigBuilder(com.github.kostyasha.yad_docker_java.com.github.dockerjava.core.DefaultDockerClientConfig.Builder configBuilder)
ClientBuilderForConnector	withConnectorType(ConnectorType connectorType)
ClientBuilderForConnector	withConnectTimeout(Integer connectTimeout)
ClientBuilderForConnector	withCredentials(com.cloudbees.plugins.credentials.Credentials credentials)
ClientBuilderForConnector	withCredentialsId(String credentialsId) Sets SSLConfig from defined credentials id.
ClientBuilderForConnector	withDockerClientConfig(com.github.kostyasha.yad_docker_java.com.github.dockerjava.core.DockerClientConfig clientConfig)
ClientBuilderForConnector	withDockerCmdExecFactory(com.github.kostyasha.yad_docker_java.com.github.dockerjava.core.AbstractDockerCmdExecFactory dockerCmdExecFactory)
ClientBuilderForConnector	withDockerConnector(DockerConnector connector)
ClientBuilderForConnector	withReadTimeout(Integer readTimeout)
ClientBuilderForConnector	withSslConfig(com.github.kostyasha.yad_docker_java.com.github.dockerjava.core.SSLConfig sslConfig)

Methods inherited from class java.lang.Object

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

Method Detail

withDockerCmdExecFactory

public ClientBuilderForConnector withDockerCmdExecFactory(com.github.kostyasha.yad_docker_java.com.github.dockerjava.core.AbstractDockerCmdExecFactory dockerCmdExecFactory)

withSslConfig

public ClientBuilderForConnector withSslConfig(com.github.kostyasha.yad_docker_java.com.github.dockerjava.core.SSLConfig sslConfig)
                                        throws UnrecoverableKeyException,
                                               NoSuchAlgorithmException,
                                               KeyStoreException,
                                               KeyManagementException

Throws:

UnrecoverableKeyException

NoSuchAlgorithmException

KeyStoreException

KeyManagementException

forConnector

public ClientBuilderForConnector forConnector(DockerConnector connector)
                                       throws UnrecoverableKeyException,
                                              NoSuchAlgorithmException,
                                              KeyStoreException,
                                              KeyManagementException

Provides ready to use docker client with information from docker connector

Parameters:

connector - docker connector with info about url, version, creds and timeout

Returns:

docker-java client

Throws:

UnrecoverableKeyException

NoSuchAlgorithmException

KeyStoreException

KeyManagementException

withConnectorType

public ClientBuilderForConnector withConnectorType(ConnectorType connectorType)

withConnectTimeout

public ClientBuilderForConnector withConnectTimeout(Integer connectTimeout)

withReadTimeout

public ClientBuilderForConnector withReadTimeout(Integer readTimeout)

forServer

public ClientBuilderForConnector forServer(String uri,
                                           @Nullable
                                           String version)

Method to setup url and docker-api version. Convenient for test-connection purposes and quick requests

Parameters:

uri - docker server uri

version - docker-api version

Returns:

this newClientBuilderForConnector

withCredentialsId

public ClientBuilderForConnector withCredentialsId(String credentialsId)
                                            throws UnrecoverableKeyException,
                                                   NoSuchAlgorithmException,
                                                   KeyStoreException,
                                                   KeyManagementException

Sets SSLConfig from defined credentials id.

Parameters:

credentialsId - credentials to find in jenkins

Returns:

docker-java client

Throws:

UnrecoverableKeyException

NoSuchAlgorithmException

KeyStoreException

KeyManagementException

withCredentials

public ClientBuilderForConnector withCredentials(com.cloudbees.plugins.credentials.Credentials credentials)
                                          throws UnrecoverableKeyException,
                                                 NoSuchAlgorithmException,
                                                 KeyStoreException,
                                                 KeyManagementException

Throws:

UnrecoverableKeyException

NoSuchAlgorithmException

KeyStoreException

KeyManagementException

withConfigBuilder

public ClientBuilderForConnector withConfigBuilder(com.github.kostyasha.yad_docker_java.com.github.dockerjava.core.DefaultDockerClientConfig.Builder configBuilder)

withDockerClientConfig

public ClientBuilderForConnector withDockerClientConfig(com.github.kostyasha.yad_docker_java.com.github.dockerjava.core.DockerClientConfig clientConfig)

withDockerConnector

public ClientBuilderForConnector withDockerConnector(DockerConnector connector)
                                              throws UnrecoverableKeyException,
                                                     NoSuchAlgorithmException,
                                                     KeyStoreException,
                                                     KeyManagementException

Throws:

UnrecoverableKeyException

NoSuchAlgorithmException

KeyStoreException

KeyManagementException

build

public com.github.kostyasha.yad_docker_java.com.github.dockerjava.api.DockerClient build()

lookupSystemCredentials

public static com.cloudbees.plugins.credentials.Credentials lookupSystemCredentials(String credentialsId)

Util method to find credential by id in jenkins

Parameters:

credentialsId - credentials to find in jenkins

Returns:

CertificateCredentials or StandardUsernamePasswordCredentials expected

newClientBuilderForConnector

public static ClientBuilderForConnector newClientBuilderForConnector()

helper class