biolockj.util.paths

Class BasicDockerMapper

java.lang.Object

biolockj.util.paths.BasicDockerMapper

All Implemented Interfaces:

DockerMountMapper, PathMapper

Direct Known Subclasses:

CommonDockerMapper, SimpleDockerMapper

public abstract class BasicDockerMapper
extends Object
implements DockerMountMapper

Introduced with BioLockJ v1.3.18.

Author:

Ivory Blakley

Constructor Summary

Constructors

Constructor and Description
BasicDockerMapper()

Method Summary

Modifier and Type	Method and Description
String	asInnerPath(String path) Convert path to inner path form.
String	asOuterPath(String innerPath) Convert path to outer path form.
protected String	formatConfigPath(String path) Give a path as it appears in the config file, convert it to a form suitable for matching to map keys.
protected String	formatHostPath(String path) Given a path as it appears in the Docker inspect Mount host info, convert the path to a form suitable for the map as a key.
protected String	formatInnerPath(String path) Given a path as it appears in the target portion of a Mount entry, convert the path to a form suitable for the map a value.
protected String	getDockerInfoCmd()
TreeMap<String,String>	getMap() The map at represents the connection of inner path to outer path.
protected boolean	isParentDir(String parent, String child)
protected void	makeVolMap() This map is a link between file paths inside the container (the containerized path) and paths outside the container (the decontainerized path).

Methods inherited from class java.lang.Object

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

Methods inherited from interface biolockj.util.paths.DockerMountMapper

builtForVersion, version

Constructor Detail

BasicDockerMapper

public BasicDockerMapper()
                  throws DockerVolCreationException

Throws:

DockerVolCreationException

Method Detail

makeVolMap

protected void makeVolMap()
                   throws DockerVolCreationException

This map is a link between file paths inside the container (the containerized path) and paths outside the container (the decontainerized path). This program and all scripts are (presumably) running inside the docker container, and need to use the containerized path. The user, and thus the logs and the config file(s), are outside of the docker container, and need to use the decontainerized path. In this map is built using the Mounts map from docker. Each value in this map is the containerized path; which is the destination (or "target") in the docker mounts map. Each key in this map is a representation of the original host file path; however the form of this path varies on different host systems (mac vs windows) and different versions of docker. The representation of a unix-like path is exactly the format that is produce by unix commands such as pwd. The path begins with "/" and uses "/" separators. The representation of windows file paths varies between docker versions. The representation in this map is:
/

Throws:

DockerVolCreationException

formatHostPath

protected String formatHostPath(String path)

Given a path as it appears in the Docker inspect Mount host info, convert the path to a form suitable for the map as a key.

Parameters:

path - A path taken from the host part of a Mount entry in the docker info.

Returns:

formatInnerPath

protected String formatInnerPath(String path)

Given a path as it appears in the target portion of a Mount entry, convert the path to a form suitable for the map a value.

Parameters:

path - A path taken from the target/destination part of a Mount entry in the docker info.

Returns:

formatConfigPath

protected String formatConfigPath(String path)

Give a path as it appears in the config file, convert it to a form suitable for matching to map keys.

Parameters:

path - A path taken from the config file. Relative paths should already be converted to absolute paths.

Returns:

getDockerInfoCmd

protected String getDockerInfoCmd()
                           throws IOException,
                                  DockerVolCreationException

Returns:

Throws:

IOException

DockerVolCreationException

getMap

public TreeMap<String,String> getMap()

Description copied from interface: DockerMountMapper

The map at represents the connection of inner path to outer path. Value is the inner path, the path form that can be used inside the docker container. Key is the outer path, the path form that represents the path on the host machine.

Specified by:

getMap in interface DockerMountMapper

Specified by:

getMap in interface PathMapper

Returns:

asInnerPath

public String asInnerPath(String path)
                   throws DockerVolCreationException

Description copied from interface: DockerMountMapper

Convert path to inner path form.

Specified by:

asInnerPath in interface DockerMountMapper

Specified by:

asInnerPath in interface PathMapper

Parameters:

path - A path represented as a String, representing the outer path form

Returns:

inner path form

Throws:

DockerVolCreationException

isParentDir

protected boolean isParentDir(String parent,
                              String child)

asOuterPath

public String asOuterPath(String innerPath)
                   throws DockerVolCreationException

Description copied from interface: DockerMountMapper

Convert path to outer path form.

Specified by:

asOuterPath in interface DockerMountMapper

Specified by:

asOuterPath in interface PathMapper

Parameters:

innerPath - A path represented as a String, representing the inner path form

Returns:

outer path form.

Throws:

DockerVolCreationException