org.springframework.cloud.deployer.spi.local

Class AbstractLocalDeployerSupport

java.lang.Object

org.springframework.cloud.deployer.spi.local.AbstractLocalDeployerSupport

Direct Known Subclasses:

LocalAppDeployer, LocalTaskLauncher

public abstract class AbstractLocalDeployerSupport
extends Object

Base class for local app deployer and task launcher providing support for common functionality.

Author:

Janne Valkealahti, Mark Fisher

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	AbstractLocalDeployerSupport.Instance

Constructor Summary

Constructors

Constructor and Description
AbstractLocalDeployerSupport(LocalDeployerProperties properties) Instantiates a new abstract deployer support.

Method Summary

Methods

Modifier and Type	Method and Description
protected ProcessBuilder	buildProcessBuilder(AppDeploymentRequest request, Map<String,String> args) Builds the process builder.
protected LocalDeployerProperties	getLocalDeployerProperties() Gets the local deployer properties.
protected static boolean	isAlive(Process process)
protected void	retainEnvVars(Set<String> vars) Retain the environment variable strings in the provided set indicated by LocalDeployerProperties.getEnvVarsToInherit().
protected void	shutdownAndWait(AbstractLocalDeployerSupport.Instance instance) Shut down the Process backing the application AbstractLocalDeployerSupport.Instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractLocalDeployerSupport

public AbstractLocalDeployerSupport(LocalDeployerProperties properties)

Instantiates a new abstract deployer support.

Parameters:

properties - the local deployer properties

Method Detail

getLocalDeployerProperties

protected final LocalDeployerProperties getLocalDeployerProperties()

Gets the local deployer properties.

Returns:

the local deployer properties

retainEnvVars

protected void retainEnvVars(Set<String> vars)

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

buildProcessBuilder

protected ProcessBuilder buildProcessBuilder(AppDeploymentRequest request,
                                 Map<String,String> args)

Builds the process builder.

Parameters:

request - the request

args - the args

Returns:

the process builder

shutdownAndWait

protected void shutdownAndWait(AbstractLocalDeployerSupport.Instance instance)

Shut down the Process backing the application AbstractLocalDeployerSupport.Instance. If the application exposes a /shutdown endpoint, that will be invoked followed by a wait that will not exceed the number of seconds indicated by LocalDeployerProperties.shutdownTimeout. If the timeout period is exceeded (or if the /shutdown endpoint is not exposed), the process will be shut down via Process.destroy().

Parameters:

instance - the application instance to shut down

isAlive

protected static boolean isAlive(Process process)