org.springframework.cloud.deployer.spi.local

Class DockerCommandBuilder

java.lang.Object

org.springframework.cloud.deployer.spi.local.DockerCommandBuilder

All Implemented Interfaces:

CommandBuilder

public class DockerCommandBuilder
extends Object
implements CommandBuilder

Command builder used to craft the command used when running apps inside docker containers.

Author:

Ilayaperumal Gopinathan, Eric Bottard, Henryk Konsek, Thomas Risberg, Michael Minella, Christian Tzolov

Field Summary

Fields

Modifier and Type	Field and Description
static String	DOCKER_CONTAINER_NAME_KEY Name of the deployment property used to specify the container name pattern to use.

Constructor Summary

Constructors

Constructor and Description
DockerCommandBuilder(String dockerNetwork)

Method Summary

Modifier and Type	Method and Description
ProcessBuilder	buildExecutionCommand(org.springframework.cloud.deployer.spi.core.AppDeploymentRequest request, Map<String,String> appInstanceEnv, String deployerId, Optional<Integer> appInstanceNumber, LocalDeployerProperties localDeployerProperties, Optional<DebugAddress> debugAddressOption) Builds the execution command for an application.
URL	getBaseUrl(String deploymentId, int index, int port) Compute an App unique URL over apps deployerId, instance index and computed port.
int	getPortSuggestion(LocalDeployerProperties localDeployerProperties) Allow the concrete implementation to suggests the target application port.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.cloud.deployer.spi.local.CommandBuilder

getJdwpOptions

Field Detail

DOCKER_CONTAINER_NAME_KEY

public static final String DOCKER_CONTAINER_NAME_KEY

Name of the deployment property used to specify the container name pattern to use.

See Also:

Constant Field Values

Constructor Detail

DockerCommandBuilder

public DockerCommandBuilder(String dockerNetwork)

Method Detail

getPortSuggestion

public int getPortSuggestion(LocalDeployerProperties localDeployerProperties)

Description copied from interface: CommandBuilder

Allow the concrete implementation to suggests the target application port.

Specified by:

getPortSuggestion in interface CommandBuilder

Returns:

Returns a port suggestion.

getBaseUrl

public URL getBaseUrl(String deploymentId,
                      int index,
                      int port)

Description copied from interface: CommandBuilder

Compute an App unique URL over apps deployerId, instance index and computed port.

Specified by:

getBaseUrl in interface CommandBuilder

Parameters:

deploymentId - App deployment id.

index - App instance index.

port - App port.

Returns:

Returns app's URL.

buildExecutionCommand

public ProcessBuilder buildExecutionCommand(org.springframework.cloud.deployer.spi.core.AppDeploymentRequest request,
                                            Map<String,String> appInstanceEnv,
                                            String deployerId,
                                            Optional<Integer> appInstanceNumber,
                                            LocalDeployerProperties localDeployerProperties,
                                            Optional<DebugAddress> debugAddressOption)

Description copied from interface: CommandBuilder

Builds the execution command for an application.

Specified by:

buildExecutionCommand in interface CommandBuilder

Parameters:

request - the request for the application to execute.

appInstanceEnv - the env vars tha might be needed when building the execution command.

appInstanceNumber - application instance id.

debugAddressOption - application remote debug address.

Returns:

the build command as a string array.