org.springframework.cloud.appbroker.deployer.cloudfoundry

Class CloudFoundryDeploymentProperties

java.lang.Object

org.springframework.cloud.appbroker.deployer.DeploymentProperties

org.springframework.cloud.appbroker.deployer.cloudfoundry.CloudFoundryDeploymentProperties

public class CloudFoundryDeploymentProperties
extends DeploymentProperties

Holds configuration properties for specifying what resources and services an app deployed to a Cloud Foundry runtime will get.

Author:

Eric Bottard, Greg Turnquist, Ilayaperumal Gopinathan

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	API_POLLING_TIMEOUT_PROPERTY_KEY Key for storing the api completion timeout property in seconds.
protected static String	BUILDPACK_PROPERTY_KEY Key for storing the buildpack deployment property
static long	DEFAULT_API_POLLING_TIMEOUT_SECONDS The default value for the apiPollingTimeout property.
protected static String	DOMAIN_PROPERTY Key for storing the domain deployment property
protected static String	DOMAINS_PROPERTY Key for storing the domains deployment property
protected static String	HEALTHCHECK_HTTP_ENDPOINT_PROPERTY_KEY Key for storing the health check endpoint deployment property
protected static String	HEALTHCHECK_PROPERTY_KEY Key for storing the health check deployment property
protected static String	HEALTHCHECK_TIMEOUT_PROPERTY_KEY Key for storing the health check timeout deployment property
protected static String	JAVA_OPTS_PROPERTY_KEY Key for storing JAVA_OPTS deployment property
protected static String	NO_ROUTE_PROPERTY Key for storing a property describing whether routes are defined
protected static String	ROUTE_PATH_PROPERTY Key for storing the route path deployment property
protected static String	ROUTES_PROPERTY Key for storing the routes deployment property

Fields inherited from class org.springframework.cloud.appbroker.deployer.DeploymentProperties

COUNT_PROPERTY_KEY, DISK_PROPERTY_KEY, HOST_PROPERTY_KEY, MEMORY_PROPERTY_KEY, START_PROPERTY_KEY, TARGET_PROPERTY_KEY, USE_SPRING_APPLICATION_JSON_KEY

Constructor Summary

Constructors

Constructor and Description
CloudFoundryDeploymentProperties()

Method Summary

Modifier and Type	Method and Description
long	getApiPollingTimeout()
long	getApiTimeout()
String	getBuildpack()
String	getDomain()
Set<String>	getDomains()
org.cloudfoundry.operations.applications.ApplicationHealthCheck	getHealthCheck()
String	getHealthCheckHttpEndpoint()
Integer	getHealthCheckTimeout()
String	getJavaOpts()
Set<String>	getRoutes()
Duration	getStagingTimeout()
Duration	getStartupTimeout()
long	getStatusTimeout()
boolean	isDeleteRoutes()
boolean	isEnableRandomAppNamePrefix()
void	setApiPollingTimeout(long apiPollingTimeout)
void	setApiTimeout(long apiTimeout)
void	setBuildpack(String buildpack)
void	setDeleteRoutes(boolean deleteRoutes)
void	setDomain(String domain)
void	setDomains(Set<String> domains)
void	setEnableRandomAppNamePrefix(boolean enableRandomAppNamePrefix)
void	setHealthCheck(org.cloudfoundry.operations.applications.ApplicationHealthCheck healthCheck)
void	setHealthCheckHttpEndpoint(String healthCheckHttpEndpoint)
void	setHealthCheckTimeout(Integer healthCheckTimeout)
void	setJavaOpts(String javaOpts)
void	setRoutes(Set<String> routes)
void	setStagingTimeout(Duration stagingTimeout)
void	setStartupTimeout(Duration startupTimeout)
void	setStatusTimeout(long statusTimeout)

Methods inherited from class org.springframework.cloud.appbroker.deployer.DeploymentProperties

getCount, getDisk, getHost, getMemory, isUseSpringApplicationJson, setCount, setDisk, setHost, setMemory, setUseSpringApplicationJson

Methods inherited from class java.lang.Object

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

Field Detail

HEALTHCHECK_PROPERTY_KEY

protected static final String HEALTHCHECK_PROPERTY_KEY

Key for storing the health check deployment property

See Also:

Constant Field Values

HEALTHCHECK_HTTP_ENDPOINT_PROPERTY_KEY

protected static final String HEALTHCHECK_HTTP_ENDPOINT_PROPERTY_KEY

Key for storing the health check endpoint deployment property

See Also:

Constant Field Values

HEALTHCHECK_TIMEOUT_PROPERTY_KEY

protected static final String HEALTHCHECK_TIMEOUT_PROPERTY_KEY

Key for storing the health check timeout deployment property

See Also:

Constant Field Values

API_POLLING_TIMEOUT_PROPERTY_KEY

protected static final String API_POLLING_TIMEOUT_PROPERTY_KEY

Key for storing the api completion timeout property in seconds.

See Also:

Constant Field Values

ROUTE_PATH_PROPERTY

protected static final String ROUTE_PATH_PROPERTY

Key for storing the route path deployment property

See Also:

Constant Field Values

ROUTES_PROPERTY

protected static final String ROUTES_PROPERTY

Key for storing the routes deployment property

See Also:

Constant Field Values

NO_ROUTE_PROPERTY

protected static final String NO_ROUTE_PROPERTY

Key for storing a property describing whether routes are defined

See Also:

Constant Field Values

DOMAIN_PROPERTY

protected static final String DOMAIN_PROPERTY

Key for storing the domain deployment property

See Also:

Constant Field Values

DOMAINS_PROPERTY

protected static final String DOMAINS_PROPERTY

Key for storing the domains deployment property

See Also:

Constant Field Values

BUILDPACK_PROPERTY_KEY

protected static final String BUILDPACK_PROPERTY_KEY

Key for storing the buildpack deployment property

See Also:

Constant Field Values

JAVA_OPTS_PROPERTY_KEY

protected static final String JAVA_OPTS_PROPERTY_KEY

Key for storing JAVA_OPTS deployment property

See Also:

Constant Field Values

DEFAULT_API_POLLING_TIMEOUT_SECONDS

public static final long DEFAULT_API_POLLING_TIMEOUT_SECONDS

The default value for the apiPollingTimeout property. Useful in unit tests to assert default value when not assigned specifically.

Constructor Detail

CloudFoundryDeploymentProperties

public CloudFoundryDeploymentProperties()

Method Detail

getBuildpack

public String getBuildpack()

setBuildpack

public void setBuildpack(String buildpack)

isEnableRandomAppNamePrefix

public boolean isEnableRandomAppNamePrefix()

setEnableRandomAppNamePrefix

public void setEnableRandomAppNamePrefix(boolean enableRandomAppNamePrefix)

getApiTimeout

public long getApiTimeout()

setApiTimeout

public void setApiTimeout(long apiTimeout)

getHealthCheck

public org.cloudfoundry.operations.applications.ApplicationHealthCheck getHealthCheck()

setHealthCheck

public void setHealthCheck(org.cloudfoundry.operations.applications.ApplicationHealthCheck healthCheck)

getHealthCheckHttpEndpoint

public String getHealthCheckHttpEndpoint()

setHealthCheckHttpEndpoint

public void setHealthCheckHttpEndpoint(String healthCheckHttpEndpoint)

getHealthCheckTimeout

public Integer getHealthCheckTimeout()

setHealthCheckTimeout

public void setHealthCheckTimeout(Integer healthCheckTimeout)

getDomain

public String getDomain()

setDomain

public void setDomain(String domain)

getDomains

public Set<String> getDomains()

setDomains

public void setDomains(Set<String> domains)

getRoutes

public Set<String> getRoutes()

setRoutes

public void setRoutes(Set<String> routes)

getStagingTimeout

public Duration getStagingTimeout()

setStagingTimeout

public void setStagingTimeout(Duration stagingTimeout)

getStartupTimeout

public Duration getStartupTimeout()

setStartupTimeout

public void setStartupTimeout(Duration startupTimeout)

getStatusTimeout

public long getStatusTimeout()

setStatusTimeout

public void setStatusTimeout(long statusTimeout)

isDeleteRoutes

public boolean isDeleteRoutes()

setDeleteRoutes

public void setDeleteRoutes(boolean deleteRoutes)

getJavaOpts

public String getJavaOpts()

setJavaOpts

public void setJavaOpts(String javaOpts)

getApiPollingTimeout

public long getApiPollingTimeout()

setApiPollingTimeout

public void setApiPollingTimeout(long apiPollingTimeout)