org.springframework.cloud.deployer.spi.local

Class JavaCommandBuilder

java.lang.Object

org.springframework.cloud.deployer.spi.local.JavaCommandBuilder

All Implemented Interfaces:

CommandBuilder

public class JavaCommandBuilder
extends Object
implements CommandBuilder

Author:

Mark Pollack, Ilayaperumal Gopinathan, Thomas Risberg, Michael Minella

Constructor Summary

Constructors

Constructor and Description
JavaCommandBuilder(LocalDeployerProperties properties)

Method Summary

Modifier and Type	Method and Description
protected void	addJavaExecutionOptions(List<String> commands, org.springframework.cloud.deployer.spi.core.AppDeploymentRequest request)
protected void	addJavaOptions(List<String> commands, Map<String,String> deploymentProperties, LocalDeployerProperties localDeployerProperties)
protected LocalDeployerProperties	bindDeploymentProperties(Map<String,String> runtimeDeploymentProperties) This will merge the deployment properties that were passed in at runtime with the deployment properties of the Deployer instance.
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.
protected void	retainEnvVars(Map<String,String> vars, LocalDeployerProperties localDeployerProperties) Retain the environment variable strings in the provided set indicated by LocalDeployerProperties.getEnvVarsToInherit().

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

Constructor Detail

JavaCommandBuilder

public JavaCommandBuilder(LocalDeployerProperties properties)

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.

retainEnvVars

protected void retainEnvVars(Map<String,String> vars,
                             LocalDeployerProperties localDeployerProperties)

Retain the environment variable strings in the provided set indicated by LocalDeployerProperties.getEnvVarsToInherit(). This assumes that the provided set can be modified.

Parameters:

vars - set of environment variable strings

localDeployerProperties - local deployer properties

addJavaOptions

protected void addJavaOptions(List<String> commands,
                              Map<String,String> deploymentProperties,
                              LocalDeployerProperties localDeployerProperties)

addJavaExecutionOptions

protected void addJavaExecutionOptions(List<String> commands,
                                       org.springframework.cloud.deployer.spi.core.AppDeploymentRequest request)

bindDeploymentProperties

protected LocalDeployerProperties bindDeploymentProperties(Map<String,String> runtimeDeploymentProperties)

This will merge the deployment properties that were passed in at runtime with the deployment properties of the Deployer instance.

Parameters:

runtimeDeploymentProperties - deployment properties passed in at runtime

Returns:

merged deployer properties