Package 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	Description
QueryService(DockerAccess docker)	Constructor which gets its dependencies as args)

Method Summary

Modifier and Type	Method	Description
Container	getContainer(String containerIdOrName)	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, boolean all)	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
Container	getMandatoryContainer(String containerIdOrName)	Get container by id
Network	getNetworkByName(String networkName)	Get a network for a given network name.
Set<Network>	getNetworks()	Get all networks.
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	hasNetwork(String networkName)	Check whether a network with the given name exists
List<Container>	listContainers(boolean all)	List all containers on the Docker server.
List<Image>	listImages(boolean all)	Get all images on the Docker server.

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)

Constructor which gets its dependencies as args)

Parameters:

docker - remote access to docker daemon

Method Detail

getMandatoryContainer

public Container getMandatoryContainer(String containerIdOrName)
                                throws DockerAccessException

Get container by id

Parameters:

containerIdOrName - container id or name

Returns:

container found

Throws:

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

getContainer

public Container getContainer(String containerIdOrName)
                       throws DockerAccessException

Get a container running for a given container name.

Parameters:

containerIdOrName - name of container to lookup

Returns:

the container found or null if no container is available.

Throws:

DockerAccessException - in case of an remote error

getNetworkByName

public Network getNetworkByName(String networkName)
                         throws DockerAccessException

Get a network for a given network name.

Parameters:

networkName - name of network to lookup

Returns:

the network found or null if no network is available.

Throws:

DockerAccessException - in case of an remote error

getNetworks

public Set<Network> getNetworks()
                         throws DockerAccessException

Get all networks.

Returns:

the network found or null if no network 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

listContainers

public List<Container> listContainers(boolean all)
                               throws DockerAccessException

List all containers on the Docker server.

Parameters:

all - if true, list stopped containers as well as running containers.

Returns:

list of Container objects

Throws:

DockerAccessException - if the request fails

getContainersForImage

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

Get all containers which are build from an image. By default only the last containers are considered but this can be tuned with a global parameters.

Parameters:

image - for which its container are looked up

all - if true, fetch stopped containers as well as running containers.

Returns:

list of Container objects

Throws:

DockerAccessException - if the request fails

listImages

public List<Image> listImages(boolean all)
                       throws DockerAccessException

Get all images on the Docker server.

Parameters:

all - if true, fetch untagged images as well as tagged.

Returns:

list of Image 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

hasNetwork

public boolean hasNetwork(String networkName)
                   throws DockerAccessException

Check whether a network with the given name exists

Parameters:

networkName - network name

Returns:

true if a network 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