Class Docker
java.lang.Object
de.iip_ecosphere.platform.ecsRuntime.EcsSetup.AbstractManagerSetup
de.iip_ecosphere.platform.ecsRuntime.docker.Docker
public class Docker
extends de.iip_ecosphere.platform.ecsRuntime.EcsSetup.AbstractManagerSetup
Implements the docker specific configuration.
- Author:
- Monika Staciwa, SSE
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanReturns True if Docker files should be removed when the corresponding container gets undeployed.Returns the docker host.Returns the name of the Yaml file with information about the Docker Image.Returns the download directory.Returns the host/port of the docker registry to use.voidsetDeleteWhenUndeployed(boolean deleteWhenUndeployed) Defines if Docker files should be deleted when the corresponding container gets undeployed.voidsetDockerHost(String dockerHost) Defines the docker host.voidsetDockerImageYamlFilename(String filename) Defines the standard name of the Yaml file with a information about the Docker Image.voidsetDownloadDirectory(String directory) Defines the download directory.voidsetRegistry(String registry) Defines the host/port of the docker registry to use.Methods inherited from class de.iip_ecosphere.platform.ecsRuntime.EcsSetup.AbstractManagerSetup
getAuthenticationKey, setAuthenticationKey
-
Field Details
-
dockerHost
-
dockerImageYamlFilename
-
deleteWhenUndeployed
private boolean deleteWhenUndeployed -
downloadDirectory
-
registry
-
-
Constructor Details
-
Docker
public Docker()
-
-
Method Details
-
getDockerHost
Returns the docker host.- Returns:
- the docker host as Docker host string, e.g., unix:///var/run/docker.sock
-
setDockerHost
Defines the docker host. [required by SnakeYaml]- Parameters:
dockerHost- the docker host as Docker host string, e.g., unix:///var/run/docker.sock
-
getDockerImageYamlFilename
Returns the name of the Yaml file with information about the Docker Image.- Returns:
- Name of the Yaml file
-
setDockerImageYamlFilename
Defines the standard name of the Yaml file with a information about the Docker Image.- Parameters:
filename- the name of the Yaml file
-
getDeleteWhenUndeployed
public boolean getDeleteWhenUndeployed()Returns True if Docker files should be removed when the corresponding container gets undeployed. Otherwise it returns False.- Returns:
- True/False
-
setDeleteWhenUndeployed
public void setDeleteWhenUndeployed(boolean deleteWhenUndeployed) Defines if Docker files should be deleted when the corresponding container gets undeployed. [required by SnakeYaml]- Parameters:
deleteWhenUndeployed- True or False
-
setDownloadDirectory
Defines the download directory. [required by SnakeYaml]- Parameters:
directory-
-
getDownloadDirectory
Returns the download directory. If the configured download directory is null or empty, it returns the system temporary directory.- Returns:
- directory, the system temporary directory if none is specified
-
getRegistry
Returns the host/port of the docker registry to use.- Returns:
- the registry, e.g., localhost:5050; may be null or empty
-
setRegistry
Defines the host/port of the docker registry to use. [required by SnakeYaml]- Parameters:
registry- the registry, e.g., localhost:5050
-