org.springframework.cloud.deployer.spi.local

Interface CommandBuilder

All Known Implementing Classes:

DockerCommandBuilder, JavaCommandBuilder

public interface CommandBuilder

Strategy interface for Execution Command builder.

Author:

Ilayaperumal Gopinathan, Thomas Risberg, Michael Minella, Christian Tzolov

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> debugAddress) 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.
default String	getJdwpOptions(String suspend, String address) Computes the JDWP options with the provided suspend and address arguments.
int	getPortSuggestion(LocalDeployerProperties localDeployerProperties) Allow the concrete implementation to suggests the target application port.

Method Detail

buildExecutionCommand

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

Builds the execution command for an application.

Parameters:

request - the request for the application to execute.

appInstanceNumber - application instance id.

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

debugAddress - application remote debug address.

Returns:

the build command as a string array.

getBaseUrl

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

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

Parameters:

deploymentId - App deployment id.

index - App instance index.

port - App port.

Returns:

Returns app's URL.

getPortSuggestion

int getPortSuggestion(LocalDeployerProperties localDeployerProperties)

Allow the concrete implementation to suggests the target application port.

Parameters:

localDeployerProperties -

Returns:

Returns a port suggestion.

getJdwpOptions

default String getJdwpOptions(String suspend,
                              String address)

Computes the JDWP options with the provided suspend and address arguments.

Parameters:

suspend - suspend debug argument.

address - debug address.

Returns:

Returns the JDWP options with the provided suspend and address arguments.