org.eclipse.jkube.kit.build.service.docker.access.hc

Class DockerAccessWithHcClient

java.lang.Object

org.eclipse.jkube.kit.build.service.docker.access.hc.DockerAccessWithHcClient

All Implemented Interfaces:

DockerAccess

public class DockerAccessWithHcClient
extends Object
implements DockerAccess

Implementation using Apache HttpComponents for remotely accessing the docker host.

The design goal here is to provide only the functionality required for this plugin in order to make it as robust as possible against docker API changes (which happen quite frequently). That's also the reason, why no framework like JAX-RS or docker-java is used so that the dependencies are kept low.

Of course, it's a bit more manual work, but it's worth the effort (as long as the Docker API functionality required is not too much).

Since:

26.03.14

Author:

roland

Field Summary

Fields

Modifier and Type	Field and Description
static String	API_VERSION

Constructor Summary

Constructors

Constructor and Description
DockerAccessWithHcClient(String baseUrl, String certPath, int maxConnections, org.eclipse.jkube.kit.common.KitLogger log) Create a new access for the given URL

Method Summary

Modifier and Type	Method and Description
void	buildImage(String image, File dockerArchive, BuildOptions options) Create a docker image from a given archive
String	fetchApiVersionFromServer(String baseUrl, ApacheHttpClientDelegate delegate)
String	getImageId(String name) Get the image id of a given name or null if no such image exists
boolean	hasImage(String name) Check whether the given name exists as image at the docker daemon
void	loadImage(String image, File tarArchive) Load an image from an archive.
void	pullImage(String image, AuthConfig authConfig, String registry, CreateImageOptions options) Pull an image from a remote registry and store it locally.
void	pushImage(String image, AuthConfig authConfig, String registry, int retries) Push an image to a registry.
boolean	removeImage(String image, boolean... forceOpt) Remove an image from this docker installation
void	saveImage(String image, String filename, org.eclipse.jkube.kit.common.archive.ArchiveCompression compression) Save an image to a tar file
void	shutdown() Lifecycle method which must be called when this object is not needed anymore.
void	start() Lifecycle method for this access class which must be called before any other method is called.
void	tag(String sourceImage, String targetImage, boolean force) Alias an image in the repository with a complete new name.

Methods inherited from class java.lang.Object

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

Field Detail

API_VERSION

public static final String API_VERSION

See Also:

Constant Field Values

Constructor Detail

DockerAccessWithHcClient

public DockerAccessWithHcClient(String baseUrl,
                                String certPath,
                                int maxConnections,
                                org.eclipse.jkube.kit.common.KitLogger log)
                         throws IOException

Create a new access for the given URL

Parameters:

baseUrl - base URL for accessing the docker Daemon

certPath - used to build up a keystore with the given keys and certificates found in this directory

maxConnections - maximum parallel connections allowed to docker daemon (if a pool is used)

log - a log handler for printing out logging information

Throws:

IOException - in case of I/O exception

Method Detail

buildImage

public void buildImage(String image,
                       File dockerArchive,
                       BuildOptions options)
                throws DockerAccessException

Description copied from interface: DockerAccess

Create a docker image from a given archive

Specified by:

buildImage in interface DockerAccess

Parameters:

image - name of the image to build or null if none should be used

dockerArchive - from which the docker image should be build

options - additional query arguments to add when building the image. Can be null.

Throws:

DockerAccessException - if docker host reports an error during building of an image

hasImage

public boolean hasImage(String name)
                 throws DockerAccessException

Description copied from interface: DockerAccess

Check whether the given name exists as image at the docker daemon

Specified by:

hasImage in interface DockerAccess

Parameters:

name - image name to check

Returns:

true if the image exists

Throws:

DockerAccessException - docker access exception

getImageId

public String getImageId(String name)
                  throws DockerAccessException

Description copied from interface: DockerAccess

Get the image id of a given name or null if no such image exists

Specified by:

getImageId in interface DockerAccess

Parameters:

name - name to lookup

Returns:

the image id or null

Throws:

DockerAccessException - docker access exception

loadImage

public void loadImage(String image,
                      File tarArchive)
               throws DockerAccessException

Description copied from interface: DockerAccess

Load an image from an archive.

Specified by:

loadImage in interface DockerAccess

Parameters:

image - the image to pull.

tarArchive - archive file

Throws:

DockerAccessException - if the image couldn't be loaded.

pullImage

public void pullImage(String image,
                      AuthConfig authConfig,
                      String registry,
                      CreateImageOptions options)
               throws DockerAccessException

Description copied from interface: DockerAccess

Pull an image from a remote registry and store it locally.

Specified by:

pullImage in interface DockerAccess

Parameters:

image - the image to pull.

authConfig - authentication configuration used when pulling an image

registry - an optional registry from where to pull the image. Can be null.

options - additional query arguments to add when creating the image. Can be null.

Throws:

DockerAccessException - if the image couldn't be pulled.

pushImage

public void pushImage(String image,
                      AuthConfig authConfig,
                      String registry,
                      int retries)
               throws DockerAccessException

Description copied from interface: DockerAccess

Push an image to a registry. An registry can be specified which is used as target if the image name the image does not contain a registry. If an optional registry is used, the image is also tagged with the full name containing the registry as part (if not already existent)

Specified by:

pushImage in interface DockerAccess

Parameters:

image - image name to push

authConfig - authentication configuration

registry - optional registry to which the image should be pushed.

retries - optional number of times the push should be retried on a 500 error

Throws:

DockerAccessException - in case pushing fails

saveImage

public void saveImage(String image,
                      String filename,
                      org.eclipse.jkube.kit.common.archive.ArchiveCompression compression)
               throws DockerAccessException

Description copied from interface: DockerAccess

Save an image to a tar file

Specified by:

saveImage in interface DockerAccess

Parameters:

image - image to save

filename - target filename

compression - compression to use for the archive

Throws:

DockerAccessException - if an image cannot be removed

tag

public void tag(String sourceImage,
                String targetImage,
                boolean force)
         throws DockerAccessException

Description copied from interface: DockerAccess

Alias an image in the repository with a complete new name. (Note that this maps to a Docker Remote API 'tag' operation, which IMO is badly named since it also can generate a complete alias to a given image)

Specified by:

tag in interface DockerAccess

Parameters:

sourceImage - full name (including tag) of the image to alias

targetImage - the alias name

force - forced tagging

Throws:

DockerAccessException - if the original image doesn't exist or another error occurs somehow.

removeImage

public boolean removeImage(String image,
                           boolean... forceOpt)
                    throws DockerAccessException

Description copied from interface: DockerAccess

Remove an image from this docker installation

Specified by:

removeImage in interface DockerAccess

Parameters:

image - image to remove

forceOpt - if set to true remove containers as well (only the first vararg is evaluated)

Returns:

true if an image was removed, false if none was removed

Throws:

DockerAccessException - if an image cannot be removed

start

public void start()

Description copied from interface: DockerAccess

Lifecycle method for this access class which must be called before any other method is called.

Specified by:

start in interface DockerAccess

shutdown

public void shutdown()

Description copied from interface: DockerAccess

Lifecycle method which must be called when this object is not needed anymore. This hook might be used for cleaning up things.

Specified by:

shutdown in interface DockerAccess

fetchApiVersionFromServer

public String fetchApiVersionFromServer(String baseUrl,
                                        ApacheHttpClientDelegate delegate)
                                 throws IOException

Throws:

IOException