Package org.springframework.boot.cloud
Enum CloudPlatform
- java.lang.Object
- java.lang.Enum<CloudPlatform>
- org.springframework.boot.cloud.CloudPlatform
- All Implemented Interfaces:
Serializable
,Comparable<CloudPlatform>
public enum CloudPlatform extends Enum<CloudPlatform>
Simple detection for well known cloud platforms. For more advanced cloud provider integration consider the Spring Cloud project.- Since:
- 1.3.0
- See Also:
- "http://cloud.spring.io"
Enum Constant Summary
Enum Constants Enum Constant Description CLOUD_FOUNDRY
Cloud Foundry platform.HEROKU
Heroku platform.SAP
SAP Cloud platform.
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description static CloudPlatform
getActive(org.springframework.core.env.Environment environment)
Returns the activeCloudPlatform
ornull
if one cannot be deduced.abstract boolean
isActive(org.springframework.core.env.Environment environment)
Determines if the platform is active (i.e.boolean
isUsingForwardHeaders()
Returns if the platform is behind a load balancer and uses X-Forwarded-For headers.static CloudPlatform
valueOf(String name)
Returns the enum constant of this type with the specified name.static CloudPlatform[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
Enum Constant Detail
CLOUD_FOUNDRY
public static final CloudPlatform CLOUD_FOUNDRY
Cloud Foundry platform.
HEROKU
public static final CloudPlatform HEROKU
Heroku platform.
SAP
public static final CloudPlatform SAP
SAP Cloud platform.
Method Detail
values
public static CloudPlatform[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (CloudPlatform c : CloudPlatform.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
valueOf
public static CloudPlatform valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
isActive
public abstract boolean isActive(org.springframework.core.env.Environment environment)
Determines if the platform is active (i.e. the application is running in it).- Parameters:
environment
- the environment- Returns:
- if the platform is active.
isUsingForwardHeaders
public boolean isUsingForwardHeaders()
Returns if the platform is behind a load balancer and uses X-Forwarded-For headers.- Returns:
- if X-Forwarded-For headers are used
getActive
public static CloudPlatform getActive(org.springframework.core.env.Environment environment)
Returns the activeCloudPlatform
ornull
if one cannot be deduced.- Parameters:
environment
- the environment- Returns:
- the
CloudPlatform
ornull