com.nirima.jenkins.plugins.docker.client

Class ClientConfigBuilderForPlugin

java.lang.Object

com.nirima.jenkins.plugins.docker.client.ClientConfigBuilderForPlugin

public class ClientConfigBuilderForPlugin
extends Object

Author:

lanwen (Merkushev Kirill)

Method Summary

Modifier and Type	Method and Description
com.github.dockerjava.core.DockerClientConfig	build() Build the config
com.github.dockerjava.api.DockerClient	buildClient() Shortcut to build an actual client.
static ClientConfigBuilderForPlugin	dockerClientConfig()
ClientConfigBuilderForPlugin	forCloud(DockerCloud cloud) Provides ready to use docker client with information from docker cloud
ClientConfigBuilderForPlugin	forServer(String uri, String version) Method to setup url and docker-api version.
ClientConfigBuilderForPlugin	withCredentials(String credentialsId) Sets username and password or ssl config by credentials id

Methods inherited from class java.lang.Object

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

Method Detail

dockerClientConfig

public static ClientConfigBuilderForPlugin dockerClientConfig()

forCloud

public ClientConfigBuilderForPlugin forCloud(DockerCloud cloud)

Provides ready to use docker client with information from docker cloud

Parameters:

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

Returns:

docker-java client

forServer

public ClientConfigBuilderForPlugin 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 builder

withCredentials

public ClientConfigBuilderForPlugin withCredentials(String credentialsId)

Sets username and password or ssl config by credentials id

Parameters:

credentialsId - credentials to find in jenkins

Returns:

docker-java client

build

public com.github.dockerjava.core.DockerClientConfig build()

Build the config

buildClient

public com.github.dockerjava.api.DockerClient buildClient()

Shortcut to build an actual client. Consider if you actually want to do this or alternatively build the config then build the client, as if your activity is on a remote node, the client will fail to serialize.