biolockj.util.paths

Class CommonDockerMapper

java.lang.Object

biolockj.util.paths.BasicDockerMapper

biolockj.util.paths.CommonDockerMapper

All Implemented Interfaces:

DockerMountMapper, PathMapper

public class CommonDockerMapper
extends BasicDockerMapper

Introduced with BioLockJ v1.3.18. This represents the logic that had been used before version v1.3.18, but it is now represented as a separate class implementing the DockerMountMapper interface.

Author:

Ivory Blakley

Constructor Summary

Constructors

Constructor and Description
CommonDockerMapper()

Method Summary

Modifier and Type	Method and Description
String	builtForVersion() The BioLockJ version that a class was built for and tested with.
protected String	convertWindowsPath(String path)
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) In the docker json file, the host path is sometimes represented as the exact path that the user might see on their host machine, and sometimes it is pre-prended with /host_mnt/, and other other differences.
protected boolean	isWindowsHostPath(String path)
String	version() Changes to a mapper class should be accompanied by a increment in version.

Methods inherited from class biolockj.util.paths.BasicDockerMapper

asInnerPath, asOuterPath, formatInnerPath, getDockerInfoCmd, getMap, isParentDir, makeVolMap

Methods inherited from class java.lang.Object

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

Constructor Detail

CommonDockerMapper

public CommonDockerMapper()
                   throws DockerVolCreationException

Throws:

DockerVolCreationException

Method Detail

version

public String version()

Description copied from interface: DockerMountMapper

Changes to a mapper class should be accompanied by a increment in version. The is a string and open form, but using the major.minor.patch semantic versioning is recommended.

Returns:

builtForVersion

public String builtForVersion()

Description copied from interface: DockerMountMapper

The BioLockJ version that a class was built for and tested with.

Returns:

the current or previous BioLockJ version

formatHostPath

protected String formatHostPath(String path)

In the docker json file, the host path is sometimes represented as the exact path that the user might see on their host machine, and sometimes it is pre-prended with /host_mnt/, and other other differences. Presumably the version of docker is what dictates the difference in path appearance.

Overrides:

formatHostPath in class BasicDockerMapper

Parameters:

path -

Returns:

formatConfigPath

protected String formatConfigPath(String path)

Description copied from class: BasicDockerMapper

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

Overrides:

formatConfigPath in class BasicDockerMapper

Parameters:

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

Returns:

convertWindowsPath

protected String convertWindowsPath(String path)

isWindowsHostPath

protected boolean isWindowsHostPath(String path)