io.fabric8.maven.docker.service

Class QueryService

java.lang.Object

io.fabric8.maven.docker.service.QueryService

public class QueryService
extends Object

Query service for getting image and container information from the docker dameon

Constructor Summary

Constructors

Constructor and Description
QueryService(DockerAccess docker, Logger log) Constructor which gets its dependencies as args)

Method Summary

Modifier and Type	Method and Description
Container	getContainer(String containerId) Get container by id
Container	getContainerByName(String containerName) Get a container running for a given container name.
String	getContainerName(String containerId) Get name for single container when the id is given
List<Container>	getContainersForImage(String image) Get all containers which are build from an image.
String	getImageId(String imageName) Finds the id of an image.
Container	getLatestContainerForImage(String image) Get the id of the latest container started for an image
boolean	hasContainer(String containerName) Check whether a container with the given name exists
boolean	hasImage(String name) Check whether the given Image is locally available.
boolean	imageRequiresAutoPull(String mode, String imageName, boolean always) Check whether an image needs to be pulled.

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryService

public QueryService(DockerAccess docker,
                    Logger log)

Constructor which gets its dependencies as args)

Parameters:

docker - remote access to docker daemon

log - logger

Method Detail

getContainer

public Container getContainer(String containerId)
                       throws DockerAccessException

Get container by id

Parameters:

containerId - id

Returns:

container

Throws:

DockerAccessException - if an error occurs or no container with this id exists

getContainerByName

public Container getContainerByName(String containerName)
                             throws DockerAccessException

Get a container running for a given container name.

Parameters:

containerName - name of container to lookup

Returns:

the container found or null if no container is available.

Throws:

DockerAccessException - in case of an remote error

getContainerName

public String getContainerName(String containerId)
                        throws DockerAccessException

Get name for single container when the id is given

Parameters:

containerId - id of container to lookup

Returns:

the name of the container

Throws:

DockerAccessException - if access to the docker daemon fails

getContainersForImage

public List<Container> getContainersForImage(String image)
                                      throws DockerAccessException

Get all containers which are build from an image. Only the last 100 containers are considered

Parameters:

image - for which its container are looked up

Returns:

list of Container objects

Throws:

DockerAccessException - if the request fails

getImageId

public String getImageId(String imageName)
                  throws DockerAccessException

Finds the id of an image.

Parameters:

imageName - name of the image.

Returns:

the id of the image

Throws:

DockerAccessException - if the request fails

getLatestContainerForImage

public Container getLatestContainerForImage(String image)
                                     throws DockerAccessException

Get the id of the latest container started for an image

Parameters:

image - for which its container are looked up

Returns:

container or null if no container has been started for this image.

Throws:

DockerAccessException - if the request fails

hasContainer

public boolean hasContainer(String containerName)
                     throws DockerAccessException

Check whether a container with the given name exists

Parameters:

containerName - container name

Returns:

true if a container with this name exists, false otherwise.

Throws:

DockerAccessException

hasImage

public boolean hasImage(String name)
                 throws DockerAccessException

Check whether the given Image is locally available.

Parameters:

name - name of image to check, the image can contain a tag, otherwise 'latest' will be appended

Returns:

true if the image is locally available or false if it must be pulled.

Throws:

DockerAccessException - if the request fails

imageRequiresAutoPull

public boolean imageRequiresAutoPull(String mode,
                                     String imageName,
                                     boolean always)
                              throws DockerAccessException,
                                     org.apache.maven.plugin.MojoExecutionException

Check whether an image needs to be pulled.

Parameters:

mode - the auto pull mode coming from the configuration

imageName - name of the image to check

always - whether to a alwaysPull mode would be active or is always ignored

Returns:

Throws:

DockerAccessException

org.apache.maven.plugin.MojoExecutionException